Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / client / TestIllegalTableDescriptor.html
blob: 70471144664739d9716e0d904d213e90d75377a5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: TestIllegalTableDescriptor">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.junit.Assert.assertFalse;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertTrue;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.fail;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.mockito.ArgumentMatchers.contains;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.mockito.Mockito.mock;</span>
<span class="source-line-no">025</span><span id="line-25">import static org.mockito.Mockito.verify;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import java.io.IOException;</span>
<span class="source-line-no">028</span><span id="line-28">import java.lang.reflect.Field;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.testclassification.ClientTests;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.testclassification.LargeTests;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.util.TableDescriptorChecker;</span>
<span class="source-line-no">038</span><span id="line-38">import org.junit.AfterClass;</span>
<span class="source-line-no">039</span><span id="line-39">import org.junit.BeforeClass;</span>
<span class="source-line-no">040</span><span id="line-40">import org.junit.ClassRule;</span>
<span class="source-line-no">041</span><span id="line-41">import org.junit.Rule;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.Test;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.rules.TestName;</span>
<span class="source-line-no">045</span><span id="line-45">import org.slf4j.Logger;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">@Category({ LargeTests.class, ClientTests.class })</span>
<span class="source-line-no">048</span><span id="line-48">public class TestIllegalTableDescriptor {</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> @ClassRule</span>
<span class="source-line-no">051</span><span id="line-51"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">052</span><span id="line-52"> HBaseClassTestRule.forClass(TestIllegalTableDescriptor.class);</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> // NOTE: Increment tests were moved to their own class, TestIncrementsFromClientSide.</span>
<span class="source-line-no">055</span><span id="line-55"> private static final Logger LOGGER;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> protected final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> private static byte[] FAMILY = Bytes.toBytes("testFamily");</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @Rule</span>
<span class="source-line-no">062</span><span id="line-62"> public TestName name = new TestName();</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> static {</span>
<span class="source-line-no">065</span><span id="line-65"> LOGGER = mock(Logger.class);</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> @BeforeClass</span>
<span class="source-line-no">069</span><span id="line-69"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">070</span><span id="line-70"> // replacing HMaster.LOG with our mock logger for verifying logging</span>
<span class="source-line-no">071</span><span id="line-71"> Field field = TableDescriptorChecker.class.getDeclaredField("LOG");</span>
<span class="source-line-no">072</span><span id="line-72"> field.setAccessible(true);</span>
<span class="source-line-no">073</span><span id="line-73"> field.set(null, LOGGER);</span>
<span class="source-line-no">074</span><span id="line-74"> Configuration conf = TEST_UTIL.getConfiguration();</span>
<span class="source-line-no">075</span><span id="line-75"> conf.setBoolean(TableDescriptorChecker.TABLE_SANITY_CHECKS, true); // enable for below tests</span>
<span class="source-line-no">076</span><span id="line-76"> TEST_UTIL.startMiniCluster(1);</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> @AfterClass</span>
<span class="source-line-no">080</span><span id="line-80"> public static void tearDownAfterClass() throws Exception {</span>
<span class="source-line-no">081</span><span id="line-81"> TEST_UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> @Test</span>
<span class="source-line-no">085</span><span id="line-85"> public void testIllegalTableDescriptor() throws Exception {</span>
<span class="source-line-no">086</span><span id="line-86"> TableDescriptorBuilder builder =</span>
<span class="source-line-no">087</span><span id="line-87"> TableDescriptorBuilder.newBuilder(TableName.valueOf(name.getMethodName()));</span>
<span class="source-line-no">088</span><span id="line-88"> ColumnFamilyDescriptorBuilder cfBuilder = ColumnFamilyDescriptorBuilder.newBuilder(FAMILY);</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> // create table with 0 families</span>
<span class="source-line-no">091</span><span id="line-91"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">092</span><span id="line-92"> checkTableIsLegal(builder.setColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> builder.setMaxFileSize(1024); // 1K</span>
<span class="source-line-no">095</span><span id="line-95"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">096</span><span id="line-96"> builder.setMaxFileSize(0);</span>
<span class="source-line-no">097</span><span id="line-97"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">098</span><span id="line-98"> builder.setMaxFileSize(1024 * 1024 * 1024); // 1G</span>
<span class="source-line-no">099</span><span id="line-99"> checkTableIsLegal(builder.build());</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> builder.setMemStoreFlushSize(1024);</span>
<span class="source-line-no">102</span><span id="line-102"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">103</span><span id="line-103"> builder.setMemStoreFlushSize(0);</span>
<span class="source-line-no">104</span><span id="line-104"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">105</span><span id="line-105"> builder.setMemStoreFlushSize(128 * 1024 * 1024); // 128M</span>
<span class="source-line-no">106</span><span id="line-106"> checkTableIsLegal(builder.build());</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> builder.setRegionSplitPolicyClassName("nonexisting.foo.class");</span>
<span class="source-line-no">109</span><span id="line-109"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">110</span><span id="line-110"> builder.setRegionSplitPolicyClassName(null);</span>
<span class="source-line-no">111</span><span id="line-111"> checkTableIsLegal(builder.build());</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> builder.setValue(HConstants.HBASE_REGION_SPLIT_POLICY_KEY, "nonexisting.foo.class");</span>
<span class="source-line-no">114</span><span id="line-114"> checkTableIsIllegal(builder.build());</span>
<span class="source-line-no">115</span><span id="line-115"> builder.removeValue(Bytes.toBytes(HConstants.HBASE_REGION_SPLIT_POLICY_KEY));</span>
<span class="source-line-no">116</span><span id="line-116"> checkTableIsLegal(builder.build());</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> cfBuilder.setBlocksize(0);</span>
<span class="source-line-no">119</span><span id="line-119"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">120</span><span id="line-120"> cfBuilder.setBlocksize(1024 * 1024 * 128); // 128M</span>
<span class="source-line-no">121</span><span id="line-121"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">122</span><span id="line-122"> cfBuilder.setBlocksize(1024);</span>
<span class="source-line-no">123</span><span id="line-123"> checkTableIsLegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> cfBuilder.setTimeToLive(0);</span>
<span class="source-line-no">126</span><span id="line-126"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">127</span><span id="line-127"> cfBuilder.setTimeToLive(-1);</span>
<span class="source-line-no">128</span><span id="line-128"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">129</span><span id="line-129"> cfBuilder.setTimeToLive(1);</span>
<span class="source-line-no">130</span><span id="line-130"> checkTableIsLegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> cfBuilder.setMinVersions(-1);</span>
<span class="source-line-no">133</span><span id="line-133"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">134</span><span id="line-134"> cfBuilder.setMinVersions(3);</span>
<span class="source-line-no">135</span><span id="line-135"> try {</span>
<span class="source-line-no">136</span><span id="line-136"> cfBuilder.setMaxVersions(2);</span>
<span class="source-line-no">137</span><span id="line-137"> fail();</span>
<span class="source-line-no">138</span><span id="line-138"> } catch (IllegalArgumentException ex) {</span>
<span class="source-line-no">139</span><span id="line-139"> // expected</span>
<span class="source-line-no">140</span><span id="line-140"> cfBuilder.setMaxVersions(10);</span>
<span class="source-line-no">141</span><span id="line-141"> }</span>
<span class="source-line-no">142</span><span id="line-142"> checkTableIsLegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> // HBASE-13776 Setting illegal versions for HColumnDescriptor</span>
<span class="source-line-no">145</span><span id="line-145"> // does not throw IllegalArgumentException</span>
<span class="source-line-no">146</span><span id="line-146"> // finally, minVersions must be less than or equal to maxVersions</span>
<span class="source-line-no">147</span><span id="line-147"> cfBuilder.setMaxVersions(4);</span>
<span class="source-line-no">148</span><span id="line-148"> cfBuilder.setMinVersions(5);</span>
<span class="source-line-no">149</span><span id="line-149"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">150</span><span id="line-150"> cfBuilder.setMinVersions(3);</span>
<span class="source-line-no">151</span><span id="line-151"></span>
<span class="source-line-no">152</span><span id="line-152"> cfBuilder.setScope(-1);</span>
<span class="source-line-no">153</span><span id="line-153"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">154</span><span id="line-154"> cfBuilder.setScope(0);</span>
<span class="source-line-no">155</span><span id="line-155"> checkTableIsLegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> cfBuilder.setValue(ColumnFamilyDescriptorBuilder.IN_MEMORY_COMPACTION, "INVALID");</span>
<span class="source-line-no">158</span><span id="line-158"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">159</span><span id="line-159"> cfBuilder.setValue(ColumnFamilyDescriptorBuilder.IN_MEMORY_COMPACTION, "NONE");</span>
<span class="source-line-no">160</span><span id="line-160"> checkTableIsLegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> try {</span>
<span class="source-line-no">163</span><span id="line-163"> cfBuilder.setDFSReplication((short) -1);</span>
<span class="source-line-no">164</span><span id="line-164"> fail("Illegal value for setDFSReplication did not throw");</span>
<span class="source-line-no">165</span><span id="line-165"> } catch (IllegalArgumentException e) {</span>
<span class="source-line-no">166</span><span id="line-166"> // pass</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"> // set an illegal DFS replication value by hand</span>
<span class="source-line-no">169</span><span id="line-169"> cfBuilder.setValue(ColumnFamilyDescriptorBuilder.DFS_REPLICATION, "-1");</span>
<span class="source-line-no">170</span><span id="line-170"> checkTableIsIllegal(builder.modifyColumnFamily(cfBuilder.build()).build());</span>
<span class="source-line-no">171</span><span id="line-171"> try {</span>
<span class="source-line-no">172</span><span id="line-172"> cfBuilder.setDFSReplication((short) -1);</span>
<span class="source-line-no">173</span><span id="line-173"> fail("Should throw exception if an illegal value is explicitly being set");</span>
<span class="source-line-no">174</span><span id="line-174"> } catch (IllegalArgumentException e) {</span>
<span class="source-line-no">175</span><span id="line-175"> // pass</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> // check the conf settings to disable sanity checks</span>
<span class="source-line-no">179</span><span id="line-179"> builder.setMemStoreFlushSize(0);</span>
<span class="source-line-no">180</span><span id="line-180"></span>
<span class="source-line-no">181</span><span id="line-181"> // Check that logs warn on invalid table but allow it.</span>
<span class="source-line-no">182</span><span id="line-182"> builder.setValue(TableDescriptorChecker.TABLE_SANITY_CHECKS, Boolean.FALSE.toString());</span>
<span class="source-line-no">183</span><span id="line-183"> checkTableIsLegal(builder.build());</span>
<span class="source-line-no">184</span><span id="line-184"></span>
<span class="source-line-no">185</span><span id="line-185"> verify(LOGGER).warn(contains("MEMSTORE_FLUSHSIZE for table "</span>
<span class="source-line-no">186</span><span id="line-186"> + "descriptor or \"hbase.hregion.memstore.flush.size\" (0) is too small, which might "</span>
<span class="source-line-no">187</span><span id="line-187"> + "cause very frequent flushing."));</span>
<span class="source-line-no">188</span><span id="line-188"> }</span>
<span class="source-line-no">189</span><span id="line-189"></span>
<span class="source-line-no">190</span><span id="line-190"> private void checkTableIsLegal(TableDescriptor tableDescriptor) throws IOException {</span>
<span class="source-line-no">191</span><span id="line-191"> Admin admin = TEST_UTIL.getAdmin();</span>
<span class="source-line-no">192</span><span id="line-192"> admin.createTable(tableDescriptor);</span>
<span class="source-line-no">193</span><span id="line-193"> assertTrue(admin.tableExists(tableDescriptor.getTableName()));</span>
<span class="source-line-no">194</span><span id="line-194"> TEST_UTIL.deleteTable(tableDescriptor.getTableName());</span>
<span class="source-line-no">195</span><span id="line-195"> }</span>
<span class="source-line-no">196</span><span id="line-196"></span>
<span class="source-line-no">197</span><span id="line-197"> private void checkTableIsIllegal(TableDescriptor tableDescriptor) throws IOException {</span>
<span class="source-line-no">198</span><span id="line-198"> Admin admin = TEST_UTIL.getAdmin();</span>
<span class="source-line-no">199</span><span id="line-199"> try {</span>
<span class="source-line-no">200</span><span id="line-200"> admin.createTable(tableDescriptor);</span>
<span class="source-line-no">201</span><span id="line-201"> fail();</span>
<span class="source-line-no">202</span><span id="line-202"> } catch (Exception ex) {</span>
<span class="source-line-no">203</span><span id="line-203"> // should throw ex</span>
<span class="source-line-no">204</span><span id="line-204"> }</span>
<span class="source-line-no">205</span><span id="line-205"> assertFalse(admin.tableExists(tableDescriptor.getTableName()));</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207">}</span>
</pre>
</div>
</main>
</body>
</html>