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  
20  package org.apache.hadoop.hbase.client;
21  
22  import static org.junit.Assert.assertEquals;
23  import static org.junit.Assert.assertFalse;
24  import static org.junit.Assert.assertTrue;
25  import static org.junit.Assert.fail;
26  
27  import java.io.File;
28  import java.io.FileOutputStream;
29  import java.io.IOException;
30  import java.lang.reflect.InvocationTargetException;
31  import java.util.Arrays;
32  import java.util.List;
33  import java.util.Set;
34  
35  import org.apache.hadoop.conf.Configuration;
36  import org.apache.hadoop.hbase.HBaseConfiguration;
37  import org.apache.hadoop.hbase.testclassification.SmallTests;
38  import org.apache.hadoop.hbase.exceptions.DeserializationException;
39  import org.apache.hadoop.hbase.filter.Filter;
40  import org.apache.hadoop.hbase.filter.FilterList;
41  import org.apache.hadoop.hbase.filter.KeyOnlyFilter;
42  import org.apache.hadoop.hbase.protobuf.ProtobufUtil;
43  import org.apache.hadoop.hbase.protobuf.generated.ClientProtos;
44  import org.apache.hadoop.hbase.util.Base64;
45  import org.apache.hadoop.hbase.util.Bytes;
46  import org.junit.Assert;
47  import org.junit.Test;
48  import org.junit.experimental.categories.Category;
49  
50  // TODO: cover more test cases
51  @Category(SmallTests.class)
52  public class TestGet {
53    private static final byte [] ROW = new byte [] {'r'};
54  
55    private static final String PB_GET = "CgNyb3ciEwoPdGVzdC5Nb2NrRmlsdGVyEgAwATgB";
56    private static final String PB_GET_WITH_FILTER_LIST =
57      "CgFyIosBCilvcmcuYXBhY2hlLmhhZG9vcC5oYmFzZS5maWx0ZXIuRmlsdGVyTGlzdBJeCAESEwoP" +
58      "dGVzdC5Nb2NrRmlsdGVyEgASEQoNbXkuTW9ja0ZpbHRlchIAEjIKLG9yZy5hcGFjaGUuaGFkb29w" +
59      "LmhiYXNlLmZpbHRlci5LZXlPbmx5RmlsdGVyEgIIADABOAE=";
60  
61    private static final String MOCK_FILTER_JAR =
62      "UEsDBBQACAgIANWDlEMAAAAAAAAAAAAAAAAJAAQATUVUQS1JTkYv/soAAAMAUEsHCAAAAAACAAAA" +
63      "AAAAAFBLAwQUAAgICADVg5RDAAAAAAAAAAAAAAAAFAAAAE1FVEEtSU5GL01BTklGRVNULk1G803M" +
64      "y0xLLS7RDUstKs7Mz7NSMNQz4OVyLkpNLElN0XWqBAmY6xnEG1gqaPgXJSbnpCo45xcV5BcllgCV" +
65      "a/Jy8XIBAFBLBwgxyqRbQwAAAEQAAABQSwMEFAAICAgAUoOUQwAAAAAAAAAAAAAAABMAAABteS9N" +
66      "b2NrRmlsdGVyLmNsYXNzdZHPTsJAEMa/LYVCRVFQMd68gQc38YrxUJUTetGQGE7bstrVwjbbYsSn" +
67      "0hOJJj6AD2WcFoP/4iYzX+bb32xmd9/en18B7GPLhY11BxsurEw3GUoHaqzSQ4ZCq91nsI/0UDLU" +
68      "emoszyYjX5oL4Ufk1Hs6EFFfGJXVn6adhirJ6NGUn+rgtquiVJoOQyUWJpFdo0cMjdbAa/8hnNj3" +
69      "pqmkbmvgMbgn94GMU6XHiYMm1ed6YgJJeDbNV+fejbgTVRRRYlj+cSZDW5trLmIRhJKHYqh1zENf" +
70      "JJJf5QCfcx45DJ3/WLmYgx/LRNJ1I/UgMmMxIXbo9WxkywLLZqHsUMVJGWlxdwb2lG+XKZdys4kK" +
71      "5eocgIsl0grVy0Q5+e9Y+V75BdblDIXHX/3b3/rLWEGNdJXCJmeNop7zjQ9QSwcI1kzyMToBAADs" +
72      "AQAAUEsDBBQACAgIAFKDlEMAAAAAAAAAAAAAAAAVAAAAdGVzdC9Nb2NrRmlsdGVyLmNsYXNzdVHB" +
73      "TsJAFJwthUJFERQx3ryBBzfxivFQlRN60ZAYTtuy2tXCNtti1K/SE4kmfoAfZXwtBg3RTd6bzOy8" +
74      "zezux+frO4ADbLuwsemg6cLKcIuhdKgmKj1iKLQ7Awb7WI8kQ62vJvJ8OvaluRR+REqjrwMRDYRR" +
75      "Gf8W7TRUCUO9n8ok5Wc6uOupKJWmy1CJhUlkz+gxQ7M99Dp/eJzY9x5JZrCGHoN7+hDIOFV6kjho" +
76      "Eb/QUxNIsmeJfib3b8W9qKKIEslLpzJ0tLnhIhZBKHkoRlrHPPRFIvl1buBzn0cKQ/c/r1wk4Scy" +
77      "kXTpSD2JTFhkxC69oY1sWWBZGuoOMU7ICIt7M7CXfLtMvZSLLVSoV+cGuFghrBBfJZeT/5GV75Xf" +
78      "YF3NUHhemt/5NV/GGmqE61Q2KXWqRu7f+AJQSwcIrS5nKDoBAADyAQAAUEsBAhQAFAAICAgA1YOU" +
79      "QwAAAAACAAAAAAAAAAkABAAAAAAAAAAAAAAAAAAAAE1FVEEtSU5GL/7KAABQSwECFAAUAAgICADV" +
80      "g5RDMcqkW0MAAABEAAAAFAAAAAAAAAAAAAAAAAA9AAAATUVUQS1JTkYvTUFOSUZFU1QuTUZQSwEC" +
81      "FAAUAAgICABSg5RD1kzyMToBAADsAQAAEwAAAAAAAAAAAAAAAADCAAAAbXkvTW9ja0ZpbHRlci5j" +
82      "bGFzc1BLAQIUABQACAgIAFKDlEOtLmcoOgEAAPIBAAAVAAAAAAAAAAAAAAAAAD0CAAB0ZXN0L01v" +
83      "Y2tGaWx0ZXIuY2xhc3NQSwUGAAAAAAQABAABAQAAugMAAAAA";
84  
85    @Test
86    public void testAttributesSerialization() throws IOException {
87      Get get = new Get(Bytes.toBytes("row"));
88      get.setAttribute("attribute1", Bytes.toBytes("value1"));
89      get.setAttribute("attribute2", Bytes.toBytes("value2"));
90      get.setAttribute("attribute3", Bytes.toBytes("value3"));
91  
92      ClientProtos.Get getProto = ProtobufUtil.toGet(get);
93  
94      Get get2 = ProtobufUtil.toGet(getProto);
95      Assert.assertNull(get2.getAttribute("absent"));
96      Assert.assertTrue(Arrays.equals(Bytes.toBytes("value1"), get2.getAttribute("attribute1")));
97      Assert.assertTrue(Arrays.equals(Bytes.toBytes("value2"), get2.getAttribute("attribute2")));
98      Assert.assertTrue(Arrays.equals(Bytes.toBytes("value3"), get2.getAttribute("attribute3")));
99      Assert.assertEquals(3, get2.getAttributesMap().size());
100   }
101 
102   @Test
103   public void testGetAttributes() {
104     Get get = new Get(ROW);
105     Assert.assertTrue(get.getAttributesMap().isEmpty());
106     Assert.assertNull(get.getAttribute("absent"));
107 
108     get.setAttribute("absent", null);
109     Assert.assertTrue(get.getAttributesMap().isEmpty());
110     Assert.assertNull(get.getAttribute("absent"));
111 
112     // adding attribute
113     get.setAttribute("attribute1", Bytes.toBytes("value1"));
114     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value1"), get.getAttribute("attribute1")));
115     Assert.assertEquals(1, get.getAttributesMap().size());
116     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value1"), get.getAttributesMap().get("attribute1")));
117 
118     // overriding attribute value
119     get.setAttribute("attribute1", Bytes.toBytes("value12"));
120     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value12"), get.getAttribute("attribute1")));
121     Assert.assertEquals(1, get.getAttributesMap().size());
122     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value12"), get.getAttributesMap().get("attribute1")));
123 
124     // adding another attribute
125     get.setAttribute("attribute2", Bytes.toBytes("value2"));
126     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value2"), get.getAttribute("attribute2")));
127     Assert.assertEquals(2, get.getAttributesMap().size());
128     Assert.assertTrue(Arrays.equals(Bytes.toBytes("value2"), get.getAttributesMap().get("attribute2")));
129 
130     // removing attribute
131     get.setAttribute("attribute2", null);
132     Assert.assertNull(get.getAttribute("attribute2"));
133     Assert.assertEquals(1, get.getAttributesMap().size());
134     Assert.assertNull(get.getAttributesMap().get("attribute2"));
135 
136     // removing non-existed attribute
137     get.setAttribute("attribute2", null);
138     Assert.assertNull(get.getAttribute("attribute2"));
139     Assert.assertEquals(1, get.getAttributesMap().size());
140     Assert.assertNull(get.getAttributesMap().get("attribute2"));
141 
142     // removing another attribute
143     get.setAttribute("attribute1", null);
144     Assert.assertNull(get.getAttribute("attribute1"));
145     Assert.assertTrue(get.getAttributesMap().isEmpty());
146     Assert.assertNull(get.getAttributesMap().get("attribute1"));
147   }
148 
149   @Test
150   public void testNullQualifier() {
151     Get get = new Get(ROW);
152     byte[] family = Bytes.toBytes("family");
153     get.addColumn(family, null);
154     Set<byte[]> qualifiers = get.getFamilyMap().get(family);
155     Assert.assertEquals(1, qualifiers.size());
156   }
157 
158   @Test
159   public void testDynamicFilter() throws Exception {
160     Configuration conf = HBaseConfiguration.create();
161     String localPath = conf.get("hbase.local.dir")
162       + File.separator + "jars" + File.separator;
163     File jarFile = new File(localPath, "MockFilter.jar");
164     jarFile.delete();
165     assertFalse("Should be deleted: " + jarFile.getPath(), jarFile.exists());
166 
167     ClientProtos.Get getProto1 =
168       ClientProtos.Get.parseFrom(Base64.decode(PB_GET));
169     ClientProtos.Get getProto2 =
170       ClientProtos.Get.parseFrom(Base64.decode(PB_GET_WITH_FILTER_LIST));
171     try {
172       ProtobufUtil.toGet(getProto1);
173       fail("Should not be able to load the filter class");
174     } catch (IOException ioe) {
175       assertTrue(ioe.getCause() instanceof ClassNotFoundException);
176     }
177     try {
178       ProtobufUtil.toGet(getProto2);
179       fail("Should not be able to load the filter class");
180     } catch (IOException ioe) {
181       assertTrue(ioe.getCause() instanceof InvocationTargetException);
182       InvocationTargetException ite = (InvocationTargetException)ioe.getCause();
183       assertTrue(ite.getTargetException()
184         instanceof DeserializationException);
185     }
186     FileOutputStream fos = new FileOutputStream(jarFile);
187     fos.write(Base64.decode(MOCK_FILTER_JAR));
188     fos.close();
189 
190     Get get1 = ProtobufUtil.toGet(getProto1);
191     assertEquals("test.MockFilter", get1.getFilter().getClass().getName());
192 
193     Get get2 = ProtobufUtil.toGet(getProto2);
194     assertTrue(get2.getFilter() instanceof FilterList);
195     List<Filter> filters = ((FilterList)get2.getFilter()).getFilters();
196     assertEquals(3, filters.size());
197     assertEquals("test.MockFilter", filters.get(0).getClass().getName());
198     assertEquals("my.MockFilter", filters.get(1).getClass().getName());
199     assertTrue(filters.get(2) instanceof KeyOnlyFilter);
200   }
201 }