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.Assert.assertEquals;
021import static org.junit.Assert.assertTrue;
022
023import org.apache.hadoop.hbase.HBaseClassTestRule;
024import org.apache.hadoop.hbase.HColumnDescriptor;
025import org.apache.hadoop.hbase.HConstants;
026import org.apache.hadoop.hbase.KeepDeletedCells;
027import org.apache.hadoop.hbase.exceptions.DeserializationException;
028import org.apache.hadoop.hbase.exceptions.HBaseException;
029import org.apache.hadoop.hbase.io.compress.Compression;
030import org.apache.hadoop.hbase.io.compress.Compression.Algorithm;
031import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;
032import org.apache.hadoop.hbase.regionserver.BloomType;
033import org.apache.hadoop.hbase.testclassification.MiscTests;
034import org.apache.hadoop.hbase.testclassification.SmallTests;
035import org.apache.hadoop.hbase.util.BuilderStyleTest;
036import org.apache.hadoop.hbase.util.Bytes;
037import org.apache.hadoop.hbase.util.PrettyPrinter;
038import org.junit.Assert;
039import org.junit.ClassRule;
040import org.junit.Rule;
041import org.junit.Test;
042import org.junit.experimental.categories.Category;
043import org.junit.rules.ExpectedException;
044import java.util.Map;
045
046@Category({MiscTests.class, SmallTests.class})
047public class TestColumnFamilyDescriptorBuilder {
048  @ClassRule
049  public static final HBaseClassTestRule CLASS_RULE =
050      HBaseClassTestRule.forClass(TestColumnFamilyDescriptorBuilder.class);
051
052  @Rule
053  public ExpectedException expectedEx = ExpectedException.none();
054
055  @Test
056  public void testBuilder() throws DeserializationException {
057    ColumnFamilyDescriptorBuilder builder
058      = ColumnFamilyDescriptorBuilder.newBuilder(HConstants.CATALOG_FAMILY)
059            .setInMemory(true)
060            .setScope(HConstants.REPLICATION_SCOPE_LOCAL)
061            .setBloomFilterType(BloomType.NONE);
062    final int v = 123;
063    builder.setBlocksize(v);
064    builder.setTimeToLive(v);
065    builder.setBlockCacheEnabled(!HColumnDescriptor.DEFAULT_BLOCKCACHE);
066    builder.setValue(Bytes.toBytes("a"), Bytes.toBytes("b"));
067    builder.setMaxVersions(v);
068    assertEquals(v, builder.build().getMaxVersions());
069    builder.setMinVersions(v);
070    assertEquals(v, builder.build().getMinVersions());
071    builder.setKeepDeletedCells(KeepDeletedCells.TRUE);
072    builder.setInMemory(!HColumnDescriptor.DEFAULT_IN_MEMORY);
073    boolean inmemory = builder.build().isInMemory();
074    builder.setScope(v);
075    builder.setDataBlockEncoding(DataBlockEncoding.FAST_DIFF);
076    builder.setBloomFilterType(BloomType.ROW);
077    builder.setCompressionType(Algorithm.SNAPPY);
078    builder.setMobEnabled(true);
079    builder.setMobThreshold(1000L);
080    builder.setDFSReplication((short) v);
081
082    ColumnFamilyDescriptor hcd = builder.build();
083    byte [] bytes = ColumnFamilyDescriptorBuilder.toByteArray(hcd);
084    ColumnFamilyDescriptor deserializedHcd = ColumnFamilyDescriptorBuilder.parseFrom(bytes);
085    assertTrue(hcd.equals(deserializedHcd));
086    assertEquals(v, hcd.getBlocksize());
087    assertEquals(v, hcd.getTimeToLive());
088    assertTrue(Bytes.equals(hcd.getValue(Bytes.toBytes("a")),
089        deserializedHcd.getValue(Bytes.toBytes("a"))));
090    assertEquals(hcd.getMaxVersions(), deserializedHcd.getMaxVersions());
091    assertEquals(hcd.getMinVersions(), deserializedHcd.getMinVersions());
092    assertEquals(hcd.getKeepDeletedCells(), deserializedHcd.getKeepDeletedCells());
093    assertEquals(inmemory, deserializedHcd.isInMemory());
094    assertEquals(hcd.getScope(), deserializedHcd.getScope());
095    assertTrue(deserializedHcd.getCompressionType().equals(Compression.Algorithm.SNAPPY));
096    assertTrue(deserializedHcd.getDataBlockEncoding().equals(DataBlockEncoding.FAST_DIFF));
097    assertTrue(deserializedHcd.getBloomFilterType().equals(BloomType.ROW));
098    assertEquals(hcd.isMobEnabled(), deserializedHcd.isMobEnabled());
099    assertEquals(hcd.getMobThreshold(), deserializedHcd.getMobThreshold());
100    assertEquals(v, deserializedHcd.getDFSReplication());
101  }
102
103  /**
104   * Tests HColumnDescriptor with empty familyName
105   */
106  @Test
107  public void testHColumnDescriptorShouldThrowIAEWhenFamilyNameEmpty() throws Exception {
108    expectedEx.expect(IllegalArgumentException.class);
109    expectedEx.expectMessage("Column Family name can not be empty");
110    ColumnFamilyDescriptorBuilder.of("");
111  }
112
113  /**
114   * Test that we add and remove strings from configuration properly.
115   */
116  @Test
117  public void testAddGetRemoveConfiguration() {
118    ColumnFamilyDescriptorBuilder builder
119      = ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"));
120    String key = "Some";
121    String value = "value";
122    builder.setConfiguration(key, value);
123    assertEquals(value, builder.build().getConfigurationValue(key));
124    builder.removeConfiguration(key);
125    assertEquals(null, builder.build().getConfigurationValue(key));
126  }
127
128  @Test
129  public void testMobValuesInHColumnDescriptorShouldReadable() {
130    boolean isMob = true;
131    long threshold = 1000;
132    String policy = "weekly";
133    // We unify the format of all values saved in the descriptor.
134    // Each value is stored as bytes of string.
135    String isMobString = PrettyPrinter.format(String.valueOf(isMob),
136            HColumnDescriptor.getUnit(HColumnDescriptor.IS_MOB));
137    String thresholdString = PrettyPrinter.format(String.valueOf(threshold),
138            HColumnDescriptor.getUnit(HColumnDescriptor.MOB_THRESHOLD));
139    String policyString = PrettyPrinter.format(Bytes.toStringBinary(Bytes.toBytes(policy)),
140        HColumnDescriptor.getUnit(HColumnDescriptor.MOB_COMPACT_PARTITION_POLICY));
141    assertEquals(String.valueOf(isMob), isMobString);
142    assertEquals(String.valueOf(threshold), thresholdString);
143    assertEquals(String.valueOf(policy), policyString);
144  }
145
146  @Test
147  public void testClassMethodsAreBuilderStyle() {
148    /* HColumnDescriptor should have a builder style setup where setXXX/addXXX methods
149     * can be chainable together:
150     * . For example:
151     * HColumnDescriptor hcd
152     *   = new HColumnDescriptor()
153     *     .setFoo(foo)
154     *     .setBar(bar)
155     *     .setBuz(buz)
156     *
157     * This test ensures that all methods starting with "set" returns the declaring object
158     */
159
160    BuilderStyleTest.assertClassesAreBuilderStyle(ColumnFamilyDescriptorBuilder.class);
161  }
162
163  @Test
164  public void testSetTimeToLive() throws HBaseException {
165    String ttl;
166    ColumnFamilyDescriptorBuilder builder
167      = ColumnFamilyDescriptorBuilder.newBuilder(Bytes.toBytes("foo"));
168
169    ttl = "50000";
170    builder.setTimeToLive(ttl);
171    Assert.assertEquals(50000, builder.build().getTimeToLive());
172
173    ttl = "50000 seconds";
174    builder.setTimeToLive(ttl);
175    Assert.assertEquals(50000, builder.build().getTimeToLive());
176
177    ttl = "";
178    builder.setTimeToLive(ttl);
179    Assert.assertEquals(0, builder.build().getTimeToLive());
180
181    ttl = "FOREVER";
182    builder.setTimeToLive(ttl);
183    Assert.assertEquals(HConstants.FOREVER, builder.build().getTimeToLive());
184
185    ttl = "1 HOUR 10 minutes 1 second";
186    builder.setTimeToLive(ttl);
187    Assert.assertEquals(4201, builder.build().getTimeToLive());
188
189    ttl = "500 Days 23 HOURS";
190    builder.setTimeToLive(ttl);
191    Assert.assertEquals(43282800, builder.build().getTimeToLive());
192
193    ttl = "43282800 SECONDS (500 Days 23 hours)";
194    builder.setTimeToLive(ttl);
195    Assert.assertEquals(43282800, builder.build().getTimeToLive());
196  }
197
198  /**
199   * Test for verifying the ColumnFamilyDescriptorBuilder's default values so that backward
200   * compatibility with hbase-1.x can be mantained (see HBASE-24981).
201   */
202  @Test
203  public void testDefaultBuilder() {
204    final Map<String, String> defaultValueMap = ColumnFamilyDescriptorBuilder.getDefaultValues();
205    assertEquals(defaultValueMap.size(), 11);
206    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOOMFILTER),
207      BloomType.ROW.toString());
208    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.REPLICATION_SCOPE), "0");
209    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.MAX_VERSIONS), "1");
210    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.MIN_VERSIONS), "0");
211    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.COMPRESSION),
212      Compression.Algorithm.NONE.toString());
213    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.TTL),
214      Integer.toString(Integer.MAX_VALUE));
215    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOCKSIZE),
216      Integer.toString(64 * 1024));
217    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.IN_MEMORY),
218      Boolean.toString(false));
219    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.BLOCKCACHE),
220      Boolean.toString(true));
221    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.KEEP_DELETED_CELLS),
222      KeepDeletedCells.FALSE.toString());
223    assertEquals(defaultValueMap.get(ColumnFamilyDescriptorBuilder.DATA_BLOCK_ENCODING),
224      DataBlockEncoding.NONE.toString());
225
226  }
227}