1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 package com.google.protobuf;
32 
33 
34 import protobuf_unittest.UnittestProto;
35 
36 import junit.framework.TestCase;
37 
38 import java.io.IOException;
39 
40 /**
41  * Tests to make sure the lazy conversion of UTF8-encoded byte arrays to
42  * strings works correctly.
43  *
44  * @author jonp@google.com (Jon Perlow)
45  */
46 public class LazyStringEndToEndTest extends TestCase {
47 
48   private static ByteString TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8 =
49       ByteString.copyFrom(new byte[] {
50           114, 4, -1, 0, -1, 0, -30, 2, 4, -1,
51           0, -1, 0, -30, 2, 4, -1, 0, -1, 0, });
52 
53   private ByteString encodedTestAllTypes;
54 
55   @Override
setUp()56   protected void setUp() throws Exception {
57     super.setUp();
58     this.encodedTestAllTypes = UnittestProto.TestAllTypes.newBuilder()
59         .setOptionalString("foo")
60         .addRepeatedString("bar")
61         .addRepeatedString("baz")
62         .build()
63         .toByteString();
64   }
65 
66   /**
67    * Tests that an invalid UTF8 string will roundtrip through a parse
68    * and serialization.
69    */
testParseAndSerialize()70   public void testParseAndSerialize() throws InvalidProtocolBufferException {
71     UnittestProto.TestAllTypes tV2 = UnittestProto.TestAllTypes.parseFrom(
72         TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8);
73     ByteString bytes = tV2.toByteString();
74     assertEquals(TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8, bytes);
75 
76     tV2.getOptionalString();
77     bytes = tV2.toByteString();
78     assertEquals(TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8, bytes);
79   }
80 
testParseAndWrite()81   public void testParseAndWrite() throws IOException {
82     UnittestProto.TestAllTypes tV2 = UnittestProto.TestAllTypes.parseFrom(
83         TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8);
84     byte[] sink = new byte[TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8.size()];
85     CodedOutputStream outputStream = CodedOutputStream.newInstance(sink);
86     tV2.writeTo(outputStream);
87     outputStream.flush();
88     assertEquals(
89         TEST_ALL_TYPES_SERIALIZED_WITH_ILLEGAL_UTF8,
90         ByteString.copyFrom(sink));
91   }
92 
testCaching()93   public void testCaching() {
94     String a = "a";
95     String b = "b";
96     String c = "c";
97     UnittestProto.TestAllTypes proto = UnittestProto.TestAllTypes.newBuilder()
98         .setOptionalString(a)
99         .addRepeatedString(b)
100         .addRepeatedString(c)
101         .build();
102 
103     // String should be the one we passed it.
104     assertSame(a, proto.getOptionalString());
105     assertSame(b, proto.getRepeatedString(0));
106     assertSame(c, proto.getRepeatedString(1));
107 
108 
109     // Ensure serialization keeps strings cached.
110     proto.toByteString();
111 
112     // And now the string should stay cached.
113     assertSame(a, proto.getOptionalString());
114     assertSame(b, proto.getRepeatedString(0));
115     assertSame(c, proto.getRepeatedString(1));
116   }
117 
testNoStringCachingIfOnlyBytesAccessed()118   public void testNoStringCachingIfOnlyBytesAccessed() throws Exception {
119     UnittestProto.TestAllTypes proto =
120         UnittestProto.TestAllTypes.parseFrom(encodedTestAllTypes);
121     ByteString optional = proto.getOptionalStringBytes();
122     assertSame(optional, proto.getOptionalStringBytes());
123     assertSame(optional, proto.toBuilder().getOptionalStringBytes());
124 
125     ByteString repeated0 = proto.getRepeatedStringBytes(0);
126     ByteString repeated1 = proto.getRepeatedStringBytes(1);
127     assertSame(repeated0, proto.getRepeatedStringBytes(0));
128     assertSame(repeated1, proto.getRepeatedStringBytes(1));
129     assertSame(repeated0, proto.toBuilder().getRepeatedStringBytes(0));
130     assertSame(repeated1, proto.toBuilder().getRepeatedStringBytes(1));
131   }
132 }
133