Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import static org.junit.jupiter.api.Assertions.assertEquals;
021import static org.junit.jupiter.api.Assertions.assertNull;
022import static org.junit.jupiter.api.Assertions.assertThrows;
023import static org.junit.jupiter.api.Assertions.assertTrue;
024
025import java.util.Map;
026import org.apache.hadoop.hbase.HConstants;
027import org.apache.hadoop.hbase.KeepDeletedCells;
028import org.apache.hadoop.hbase.exceptions.DeserializationException;
029import org.apache.hadoop.hbase.exceptions.HBaseException;
030import org.apache.hadoop.hbase.io.compress.Compression;
031import org.apache.hadoop.hbase.io.compress.Compression.Algorithm;
032import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;
033import org.apache.hadoop.hbase.io.encoding.IndexBlockEncoding;
034import org.apache.hadoop.hbase.regionserver.BloomType;
035import org.apache.hadoop.hbase.testclassification.MiscTests;
036import org.apache.hadoop.hbase.testclassification.SmallTests;
037import org.apache.hadoop.hbase.util.BuilderStyleTest;
038import org.apache.hadoop.hbase.util.Bytes;
039import org.apache.hadoop.hbase.util.PrettyPrinter;
040import org.junit.jupiter.api.Tag;
041import org.junit.jupiter.api.Test;
042
043@Tag(MiscTests.TAG)
044@Tag(SmallTests.TAG)
045public class TestColumnFamilyDescriptorBuilder {
046
047  @Test
048  public void testBuilder() throws DeserializationException {
049    ColumnFamilyDescriptorBuilder builder =
050      ColumnFamilyDescriptorBuilder.newBuilder(HConstants.CATALOG_FAMILY).setInMemory(true)
051        .setScope(HConstants.REPLICATION_SCOPE_LOCAL).setBloomFilterType(BloomType.NONE);
052    final int v = 123;
053    builder.setBlocksize(v);
054    builder.setTimeToLive(v);
055    builder.setBlockCacheEnabled(!ColumnFamilyDescriptorBuilder.DEFAULT_BLOCKCACHE);
056    builder.setValue(Bytes.toBytes("a"), Bytes.toBytes("b"));
057    builder.setMaxVersions(v);
058    assertEquals(v, builder.build().getMaxVersions());
059    builder.setMinVersions(v);
060    assertEquals(v, builder.build().getMinVersions());
061    builder.setKeepDeletedCells(KeepDeletedCells.TRUE);
062    builder.setInMemory(!ColumnFamilyDescriptorBuilder.DEFAULT_IN_MEMORY);
063    boolean inmemory = builder.build().isInMemory();
064    builder.setScope(v);
065    builder.setDataBlockEncoding(DataBlockEncoding.FAST_DIFF);
066    builder.setBloomFilterType(BloomType.ROW);
067    builder.setCompressionType(Algorithm.SNAPPY);
068    builder.setMobEnabled(true);
069    builder.setMobThreshold(1000L);
070    builder.setDFSReplication((short) v);
071
072    ColumnFamilyDescriptor hcd = builder.build();
073    byte[] bytes = ColumnFamilyDescriptorBuilder.toByteArray(hcd);
074    ColumnFamilyDescriptor deserializedHcd = ColumnFamilyDescriptorBuilder.parseFrom(bytes);
075    assertTrue(hcd.equals(deserializedHcd));
076    assertEquals(v, hcd.getBlocksize());
077    assertEquals(v, hcd.getTimeToLive());
078    assertTrue(
079      Bytes.equals(hcd.getValue(Bytes.toBytes("a")), deserializedHcd.getValue(Bytes.toBytes("a"))));
080    assertEquals(hcd.getMaxVersions(), deserializedHcd.getMaxVersions());
081    assertEquals(hcd.getMinVersions(), deserializedHcd.getMinVersions());
082    assertEquals(hcd.getKeepDeletedCells(), deserializedHcd.getKeepDeletedCells());
083    assertEquals(inmemory, deserializedHcd.isInMemory());
084    assertEquals(hcd.getScope(), deserializedHcd.getScope());
085    assertTrue(deserializedHcd.getCompressionType().equals(Compression.Algorithm.SNAPPY));
086    assertTrue(deserializedHcd.getDataBlockEncoding().equals(DataBlockEncoding.FAST_DIFF));
087    assertTrue(deserializedHcd.getBloomFilterType().equals(BloomType.ROW));
088    assertEquals(hcd.isMobEnabled(), deserializedHcd.isMobEnabled());
089    assertEquals(hcd.getMobThreshold(), deserializedHcd.getMobThreshold());
090    assertEquals(v, deserializedHcd.getDFSReplication());
091  }
092
093  /**
094   * Tests HColumnDescriptor with empty familyName
095   */
096  @Test
097  public void testHColumnDescriptorShouldThrowIAEWhenFamilyNameEmpty() throws Exception {
098    assertThrows(IllegalArgumentException.class, () -> ColumnFamilyDescriptorBuilder.of(""),
099      "Column Family name can not be empty");
100  }
101
102  /**
103   * Test that we add and remove strings from configuration properly.
104   */
105  @Test
106  public void testAddGetRemoveConfiguration() {
107    ColumnFamilyDescriptorBuilder builder =
108      ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"));
109    String key = "Some";
110    String value = "value";
111    builder.setConfiguration(key, value);
112    assertEquals(value, builder.build().getConfigurationValue(key));
113    builder.removeConfiguration(key);
114    assertEquals(null, builder.build().getConfigurationValue(key));
115  }
116
117  @Test
118  public void testGetConfigurationValueFallsBackToValues() {
119    // The shell writes settings into the values map (HBASE-20819). getConfigurationValue must see
120    // them, not just keys set via setConfiguration.
121    String key = "some.key";
122    ColumnFamilyDescriptor viaValue =
123      ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo")).setValue(key, "v").build();
124    assertEquals("v", viaValue.getConfigurationValue(key));
125
126    ColumnFamilyDescriptor viaConf = ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"))
127      .setConfiguration(key, "c").build();
128    assertEquals("c", viaConf.getConfigurationValue(key));
129
130    // Values win on collision.
131    ColumnFamilyDescriptor both = ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"))
132      .setConfiguration(key, "c").setValue(key, "v").build();
133    assertEquals("v", both.getConfigurationValue(key));
134    assertNull(both.getConfigurationValue("absent"));
135  }
136
137  @Test
138  public void testMobValuesInHColumnDescriptorShouldReadable() {
139    boolean isMob = true;
140    long threshold = 1000;
141    String policy = "weekly";
142    // We unify the format of all values saved in the descriptor.
143    // Each value is stored as bytes of string.
144    String isMobString = PrettyPrinter.format(String.valueOf(isMob),
145      ColumnFamilyDescriptorBuilder.getUnit(ColumnFamilyDescriptorBuilder.IS_MOB));
146    String thresholdString = PrettyPrinter.format(String.valueOf(threshold),
147      ColumnFamilyDescriptorBuilder.getUnit(ColumnFamilyDescriptorBuilder.MOB_THRESHOLD));
148    String policyString = PrettyPrinter.format(Bytes.toStringBinary(Bytes.toBytes(policy)),
149      ColumnFamilyDescriptorBuilder
150        .getUnit(ColumnFamilyDescriptorBuilder.MOB_COMPACT_PARTITION_POLICY));
151    assertEquals(String.valueOf(isMob), isMobString);
152    assertEquals(String.valueOf(threshold), thresholdString);
153    assertEquals(String.valueOf(policy), policyString);
154  }
155
156  @Test
157  public void testClassMethodsAreBuilderStyle() {
158    /*
159     * ColumnFamilyDescriptorBuilder should have a builder style setup where setXXX/addXXX methods
160     * can be chainable together: . For example: ColumnFamilyDescriptorBuilder builder =
161     * ColumnFamilyDescriptorBuilder.newBuilder() .setFoo(foo) .setBar(bar) .setBuz(buz) This test
162     * ensures that all methods starting with "set" returns the declaring object
163     */
164
165    BuilderStyleTest.assertClassesAreBuilderStyle(ColumnFamilyDescriptorBuilder.class);
166  }
167
168  @Test
169  public void testSetTimeToLive() throws HBaseException {
170    String ttl;
171    ColumnFamilyDescriptorBuilder builder =
172      ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"));
173
174    ttl = "50000";
175    builder.setTimeToLive(ttl);
176    assertEquals(50000, builder.build().getTimeToLive());
177
178    ttl = "50000 seconds";
179    builder.setTimeToLive(ttl);
180    assertEquals(50000, builder.build().getTimeToLive());
181
182    ttl = "";
183    builder.setTimeToLive(ttl);
184    assertEquals(0, builder.build().getTimeToLive());
185
186    ttl = "FOREVER";
187    builder.setTimeToLive(ttl);
188    assertEquals(HConstants.FOREVER, builder.build().getTimeToLive());
189
190    ttl = "1 HOUR 10 minutes 1 second";
191    builder.setTimeToLive(ttl);
192    assertEquals(4201, builder.build().getTimeToLive());
193
194    ttl = "500 Days 23 HOURS";
195    builder.setTimeToLive(ttl);
196    assertEquals(43282800, builder.build().getTimeToLive());
197
198    ttl = "43282800 SECONDS (500 Days 23 hours)";
199    builder.setTimeToLive(ttl);
200    assertEquals(43282800, builder.build().getTimeToLive());
201  }
202
203  @Test
204  public void testSetBlocksize() throws HBaseException {
205    String blocksize;
206    ColumnFamilyDescriptorBuilder builder =
207      ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"));
208
209    blocksize = "131072";
210    builder.setBlocksize(blocksize);
211    assertEquals(131072, builder.build().getBlocksize());
212
213    blocksize = "100KB";
214    builder.setBlocksize(blocksize);
215    assertEquals(102400, builder.build().getBlocksize());
216
217    blocksize = "1MB";
218    builder.setBlocksize(blocksize);
219    assertEquals(1048576, builder.build().getBlocksize());
220
221    // ignore case
222    blocksize = "64kb 512B";
223    builder.setBlocksize(blocksize);
224    assertEquals(66048, builder.build().getBlocksize());
225
226    blocksize = "66048 B (64KB 512B)";
227    builder.setBlocksize(blocksize);
228    assertEquals(66048, builder.build().getBlocksize());
229  }
230
231  /**
232   * Test for verifying the ColumnFamilyDescriptorBuilder's default values so that backward
233   * compatibility with hbase-1.x can be mantained (see HBASE-24981).
234   */
235  @Test
236  public void testDefaultBuilder() {
237    final Map<String, String> defaultValueMap = ColumnFamilyDescriptorBuilder.getDefaultValues();
238    assertEquals(defaultValueMap.size(), 12);
239    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOOMFILTER),
240      BloomType.ROW.toString());
241    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.REPLICATION_SCOPE), "0");
242    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.MAX_VERSIONS), "1");
243    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.MIN_VERSIONS), "0");
244    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.COMPRESSION),
245      Compression.Algorithm.NONE.toString());
246    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.TTL),
247      Integer.toString(Integer.MAX_VALUE));
248    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOCKSIZE),
249      Integer.toString(64 * 1024));
250    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.IN_MEMORY),
251      Boolean.toString(false));
252    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOCKCACHE),
253      Boolean.toString(true));
254    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.KEEP_DELETED_CELLS),
255      KeepDeletedCells.FALSE.toString());
256    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.DATA_BLOCK_ENCODING),
257      DataBlockEncoding.NONE.toString());
258    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.INDEX_BLOCK_ENCODING),
259      IndexBlockEncoding.NONE.toString());
260  }
261
262  @Test
263  public void testSetEmptyValue() {
264    ColumnFamilyDescriptorBuilder builder =
265      ColumnFamilyDescriptorBuilder.newBuilder(HConstants.CATALOG_FAMILY);
266    String testConf = "TestConfiguration";
267    String testValue = "TestValue";
268    // test set value
269    builder.setValue(testValue, "2");
270    assertEquals("2", Bytes.toString(builder.build().getValue(Bytes.toBytes(testValue))));
271    builder.setValue(testValue, "");
272    assertNull(builder.build().getValue(Bytes.toBytes(testValue)));
273
274    // test set configuration
275    builder.setConfiguration(testConf, "1");
276    assertEquals("1", builder.build().getConfigurationValue(testConf));
277    builder.setConfiguration(testConf, "");
278    assertNull(builder.build().getConfigurationValue(testConf));
279  }
280}