View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.protobuf;
20  
21  import static org.junit.Assert.assertEquals;
22  
23  import java.io.IOException;
24  
25  import org.apache.hadoop.hbase.SmallTests;
26  import org.apache.hadoop.hbase.client.Append;
27  import org.apache.hadoop.hbase.client.Delete;
28  import org.apache.hadoop.hbase.client.Get;
29  import org.apache.hadoop.hbase.client.Increment;
30  import org.apache.hadoop.hbase.client.Put;
31  import org.apache.hadoop.hbase.client.Scan;
32  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos;
33  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Column;
34  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto;
35  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.ColumnValue;
36  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.ColumnValue.QualifierValue;
37  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.DeleteType;
38  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto.MutationType;
39  import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.NameBytesPair;
40  import org.apache.hadoop.hbase.util.Bytes;
41  import org.junit.Test;
42  import org.junit.experimental.categories.Category;
43  
44  import com.google.protobuf.ByteString;
45  import com.google.protobuf.ZeroCopyLiteralByteString;
46  
47  /**
48   * Class to test ProtobufUtil.
49   */
50  @Category(SmallTests.class)
51  public class TestProtobufUtil {
52    @Test
53    public void testException() throws IOException {
54      NameBytesPair.Builder builder = NameBytesPair.newBuilder();
55      final String omg = "OMG!!!";
56      builder.setName("java.io.IOException");
57      builder.setValue(ZeroCopyLiteralByteString.wrap(Bytes.toBytes(omg)));
58      Throwable t = ProtobufUtil.toException(builder.build());
59      assertEquals(omg, t.getMessage());
60      builder.clear();
61      builder.setName("org.apache.hadoop.ipc.RemoteException");
62      builder.setValue(ZeroCopyLiteralByteString.wrap(Bytes.toBytes(omg)));
63      t = ProtobufUtil.toException(builder.build());
64      assertEquals(omg, t.getMessage());
65    }
66  
67    /**
68     * Test basic Get conversions.
69     *
70     * @throws IOException
71     */
72    @Test
73    public void testGet() throws IOException {
74      ClientProtos.Get.Builder getBuilder = ClientProtos.Get.newBuilder();
75      getBuilder.setRow(ByteString.copyFromUtf8("row"));
76      Column.Builder columnBuilder = Column.newBuilder();
77      columnBuilder.setFamily(ByteString.copyFromUtf8("f1"));
78      columnBuilder.addQualifier(ByteString.copyFromUtf8("c1"));
79      columnBuilder.addQualifier(ByteString.copyFromUtf8("c2"));
80      getBuilder.addColumn(columnBuilder.build());
81  
82      columnBuilder.clear();
83      columnBuilder.setFamily(ByteString.copyFromUtf8("f2"));
84      getBuilder.addColumn(columnBuilder.build());
85  
86      ClientProtos.Get proto = getBuilder.build();
87      // default fields
88      assertEquals(1, proto.getMaxVersions());
89      assertEquals(true, proto.getCacheBlocks());
90  
91      // set the default value for equal comparison
92      getBuilder = ClientProtos.Get.newBuilder(proto);
93      getBuilder.setMaxVersions(1);
94      getBuilder.setCacheBlocks(true);
95  
96      Get get = ProtobufUtil.toGet(proto);
97      assertEquals(getBuilder.build(), ProtobufUtil.toGet(get));
98    }
99  
100   /**
101    * Test Append Mutate conversions.
102    *
103    * @throws IOException
104    */
105   @Test
106   public void testAppend() throws IOException {
107     MutationProto.Builder mutateBuilder = MutationProto.newBuilder();
108     mutateBuilder.setRow(ByteString.copyFromUtf8("row"));
109     mutateBuilder.setMutateType(MutationType.APPEND);
110     mutateBuilder.setTimestamp(111111);
111     ColumnValue.Builder valueBuilder = ColumnValue.newBuilder();
112     valueBuilder.setFamily(ByteString.copyFromUtf8("f1"));
113     QualifierValue.Builder qualifierBuilder = QualifierValue.newBuilder();
114     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c1"));
115     qualifierBuilder.setValue(ByteString.copyFromUtf8("v1"));
116     valueBuilder.addQualifierValue(qualifierBuilder.build());
117     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c2"));
118     qualifierBuilder.setValue(ByteString.copyFromUtf8("v2"));
119     valueBuilder.addQualifierValue(qualifierBuilder.build());
120     mutateBuilder.addColumnValue(valueBuilder.build());
121 
122     MutationProto proto = mutateBuilder.build();
123     // default fields
124     assertEquals(MutationProto.Durability.USE_DEFAULT, proto.getDurability());
125 
126     // set the default value for equal comparison
127     mutateBuilder = MutationProto.newBuilder(proto);
128     mutateBuilder.setDurability(MutationProto.Durability.USE_DEFAULT);
129 
130     Append append = ProtobufUtil.toAppend(proto, null);
131 
132     // append always use the latest timestamp,
133     // add the timestamp to the original mutate
134     long timestamp = append.getTimeStamp();
135     mutateBuilder.setTimestamp(timestamp);
136     for (ColumnValue.Builder column: mutateBuilder.getColumnValueBuilderList()) {
137       for (QualifierValue.Builder qualifier:
138           column.getQualifierValueBuilderList()) {
139         qualifier.setTimestamp(timestamp);
140       }
141     }
142     assertEquals(mutateBuilder.build(), ProtobufUtil.toMutation(MutationType.APPEND, append));
143   }
144 
145   /**
146    * Test Delete Mutate conversions.
147    *
148    * @throws IOException
149    */
150   @Test
151   public void testDelete() throws IOException {
152     MutationProto.Builder mutateBuilder = MutationProto.newBuilder();
153     mutateBuilder.setRow(ByteString.copyFromUtf8("row"));
154     mutateBuilder.setMutateType(MutationType.DELETE);
155     mutateBuilder.setTimestamp(111111);
156     ColumnValue.Builder valueBuilder = ColumnValue.newBuilder();
157     valueBuilder.setFamily(ByteString.copyFromUtf8("f1"));
158     QualifierValue.Builder qualifierBuilder = QualifierValue.newBuilder();
159     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c1"));
160     qualifierBuilder.setDeleteType(DeleteType.DELETE_ONE_VERSION);
161     qualifierBuilder.setTimestamp(111222);
162     valueBuilder.addQualifierValue(qualifierBuilder.build());
163     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c2"));
164     qualifierBuilder.setDeleteType(DeleteType.DELETE_MULTIPLE_VERSIONS);
165     qualifierBuilder.setTimestamp(111333);
166     valueBuilder.addQualifierValue(qualifierBuilder.build());
167     mutateBuilder.addColumnValue(valueBuilder.build());
168 
169     MutationProto proto = mutateBuilder.build();
170     // default fields
171     assertEquals(MutationProto.Durability.USE_DEFAULT, proto.getDurability());
172 
173     // set the default value for equal comparison
174     mutateBuilder = MutationProto.newBuilder(proto);
175     mutateBuilder.setDurability(MutationProto.Durability.USE_DEFAULT);
176 
177     Delete delete = ProtobufUtil.toDelete(proto);
178 
179     // delete always have empty value,
180     // add empty value to the original mutate
181     for (ColumnValue.Builder column:
182         mutateBuilder.getColumnValueBuilderList()) {
183       for (QualifierValue.Builder qualifier:
184           column.getQualifierValueBuilderList()) {
185         qualifier.setValue(ByteString.EMPTY);
186       }
187     }
188     assertEquals(mutateBuilder.build(),
189       ProtobufUtil.toMutation(MutationType.DELETE, delete));
190   }
191 
192   /**
193    * Test Increment Mutate conversions.
194    *
195    * @throws IOException
196    */
197   @Test
198   public void testIncrement() throws IOException {
199     MutationProto.Builder mutateBuilder = MutationProto.newBuilder();
200     mutateBuilder.setRow(ByteString.copyFromUtf8("row"));
201     mutateBuilder.setMutateType(MutationType.INCREMENT);
202     ColumnValue.Builder valueBuilder = ColumnValue.newBuilder();
203     valueBuilder.setFamily(ByteString.copyFromUtf8("f1"));
204     QualifierValue.Builder qualifierBuilder = QualifierValue.newBuilder();
205     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c1"));
206     qualifierBuilder.setValue(ZeroCopyLiteralByteString.wrap(Bytes.toBytes(11L)));
207     valueBuilder.addQualifierValue(qualifierBuilder.build());
208     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c2"));
209     qualifierBuilder.setValue(ZeroCopyLiteralByteString.wrap(Bytes.toBytes(22L)));
210     valueBuilder.addQualifierValue(qualifierBuilder.build());
211     mutateBuilder.addColumnValue(valueBuilder.build());
212 
213     MutationProto proto = mutateBuilder.build();
214     // default fields
215     assertEquals(MutationProto.Durability.USE_DEFAULT, proto.getDurability());
216 
217     // set the default value for equal comparison
218     mutateBuilder = MutationProto.newBuilder(proto);
219     mutateBuilder.setDurability(MutationProto.Durability.USE_DEFAULT);
220 
221     Increment increment = ProtobufUtil.toIncrement(proto, null);
222     assertEquals(mutateBuilder.build(),
223       ProtobufUtil.toMutation(increment, MutationProto.newBuilder()));
224   }
225 
226   /**
227    * Test Put Mutate conversions.
228    *
229    * @throws IOException
230    */
231   @Test
232   public void testPut() throws IOException {
233     MutationProto.Builder mutateBuilder = MutationProto.newBuilder();
234     mutateBuilder.setRow(ByteString.copyFromUtf8("row"));
235     mutateBuilder.setMutateType(MutationType.PUT);
236     mutateBuilder.setTimestamp(111111);
237     ColumnValue.Builder valueBuilder = ColumnValue.newBuilder();
238     valueBuilder.setFamily(ByteString.copyFromUtf8("f1"));
239     QualifierValue.Builder qualifierBuilder = QualifierValue.newBuilder();
240     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c1"));
241     qualifierBuilder.setValue(ByteString.copyFromUtf8("v1"));
242     valueBuilder.addQualifierValue(qualifierBuilder.build());
243     qualifierBuilder.setQualifier(ByteString.copyFromUtf8("c2"));
244     qualifierBuilder.setValue(ByteString.copyFromUtf8("v2"));
245     qualifierBuilder.setTimestamp(222222);
246     valueBuilder.addQualifierValue(qualifierBuilder.build());
247     mutateBuilder.addColumnValue(valueBuilder.build());
248 
249     MutationProto proto = mutateBuilder.build();
250     // default fields
251     assertEquals(MutationProto.Durability.USE_DEFAULT, proto.getDurability());
252 
253     // set the default value for equal comparison
254     mutateBuilder = MutationProto.newBuilder(proto);
255     mutateBuilder.setDurability(MutationProto.Durability.USE_DEFAULT);
256 
257     Put put = ProtobufUtil.toPut(proto);
258 
259     // put value always use the default timestamp if no
260     // value level timestamp specified,
261     // add the timestamp to the original mutate
262     long timestamp = put.getTimeStamp();
263     for (ColumnValue.Builder column:
264         mutateBuilder.getColumnValueBuilderList()) {
265       for (QualifierValue.Builder qualifier:
266           column.getQualifierValueBuilderList()) {
267         if (!qualifier.hasTimestamp()) {
268           qualifier.setTimestamp(timestamp);
269         }
270       }
271     }
272     assertEquals(mutateBuilder.build(),
273       ProtobufUtil.toMutation(MutationType.PUT, put));
274   }
275 
276   /**
277    * Test basic Scan conversions.
278    *
279    * @throws IOException
280    */
281   @Test
282   public void testScan() throws IOException {
283     ClientProtos.Scan.Builder scanBuilder = ClientProtos.Scan.newBuilder();
284     scanBuilder.setStartRow(ByteString.copyFromUtf8("row1"));
285     scanBuilder.setStopRow(ByteString.copyFromUtf8("row2"));
286     Column.Builder columnBuilder = Column.newBuilder();
287     columnBuilder.setFamily(ByteString.copyFromUtf8("f1"));
288     columnBuilder.addQualifier(ByteString.copyFromUtf8("c1"));
289     columnBuilder.addQualifier(ByteString.copyFromUtf8("c2"));
290     scanBuilder.addColumn(columnBuilder.build());
291 
292     columnBuilder.clear();
293     columnBuilder.setFamily(ByteString.copyFromUtf8("f2"));
294     scanBuilder.addColumn(columnBuilder.build());
295 
296     ClientProtos.Scan proto = scanBuilder.build();
297     // default fields
298     assertEquals(1, proto.getMaxVersions());
299     assertEquals(true, proto.getCacheBlocks());
300 
301     scanBuilder = ClientProtos.Scan.newBuilder(proto);
302     scanBuilder.setMaxVersions(1);
303     scanBuilder.setCacheBlocks(true);
304 
305     Scan scan = ProtobufUtil.toScan(proto);
306     assertEquals(scanBuilder.build(), ProtobufUtil.toScan(scan));
307   }
308 }