blob: 5210a068f8406a818d8efb6809d6d4a7f646ab45 [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.constraint, class: TestConstraint">
<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.constraint;</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"></span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.ColumnFamilyDescriptorBuilder;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.client.Put;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.client.Table;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.client.TableDescriptorBuilder;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.coprocessor.CoprocessorHost;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.testclassification.MediumTests;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.testclassification.MiscTests;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">035</span><span id="line-35">import org.junit.After;</span>
<span class="source-line-no">036</span><span id="line-36">import org.junit.AfterClass;</span>
<span class="source-line-no">037</span><span id="line-37">import org.junit.BeforeClass;</span>
<span class="source-line-no">038</span><span id="line-38">import org.junit.ClassRule;</span>
<span class="source-line-no">039</span><span id="line-39">import org.junit.Test;</span>
<span class="source-line-no">040</span><span id="line-40">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">041</span><span id="line-41">import org.slf4j.Logger;</span>
<span class="source-line-no">042</span><span id="line-42">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44">/**</span>
<span class="source-line-no">045</span><span id="line-45"> * Do the complex testing of constraints against a minicluster</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({ MiscTests.class, MediumTests.class })</span>
<span class="source-line-no">048</span><span id="line-48">public class TestConstraint {</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(TestConstraint.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"> private static final Logger LOG = LoggerFactory.getLogger(TestConstraint.class);</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private static HBaseTestingUtil util;</span>
<span class="source-line-no">057</span><span id="line-57"> private static final TableName tableName = TableName.valueOf("test");</span>
<span class="source-line-no">058</span><span id="line-58"> private static final byte[] dummy = Bytes.toBytes("dummy");</span>
<span class="source-line-no">059</span><span id="line-59"> private static final byte[] row1 = Bytes.toBytes("r1");</span>
<span class="source-line-no">060</span><span id="line-60"> private static final byte[] test = Bytes.toBytes("test");</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> @BeforeClass</span>
<span class="source-line-no">063</span><span id="line-63"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">064</span><span id="line-64"> util = new HBaseTestingUtil();</span>
<span class="source-line-no">065</span><span id="line-65"> util.getConfiguration().setBoolean(CoprocessorHost.ABORT_ON_ERROR_KEY, false);</span>
<span class="source-line-no">066</span><span id="line-66"> util.startMiniCluster();</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * Test that we run a passing constraint</span>
<span class="source-line-no">071</span><span id="line-71"> */</span>
<span class="source-line-no">072</span><span id="line-72"> @Test</span>
<span class="source-line-no">073</span><span id="line-73"> public void testConstraintPasses() throws Exception {</span>
<span class="source-line-no">074</span><span id="line-74"> // create the table</span>
<span class="source-line-no">075</span><span id="line-75"> // it would be nice if this was also a method on the util</span>
<span class="source-line-no">076</span><span id="line-76"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> for (byte[] family : new byte[][] { dummy, test }) {</span>
<span class="source-line-no">079</span><span id="line-79"> builder.setColumnFamily(ColumnFamilyDescriptorBuilder.of(family));</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"> // add a constraint</span>
<span class="source-line-no">082</span><span id="line-82"> Constraints.add(builder, CheckWasRunConstraint.class);</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> util.getAdmin().createTable(builder.build());</span>
<span class="source-line-no">085</span><span id="line-85"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">086</span><span id="line-86"> try {</span>
<span class="source-line-no">087</span><span id="line-87"> // test that we don't fail on a valid put</span>
<span class="source-line-no">088</span><span id="line-88"> Put put = new Put(row1);</span>
<span class="source-line-no">089</span><span id="line-89"> byte[] value = Bytes.toBytes(Integer.toString(10));</span>
<span class="source-line-no">090</span><span id="line-90"> byte[] qualifier = new byte[0];</span>
<span class="source-line-no">091</span><span id="line-91"> put.addColumn(dummy, qualifier, value);</span>
<span class="source-line-no">092</span><span id="line-92"> table.put(put);</span>
<span class="source-line-no">093</span><span id="line-93"> } finally {</span>
<span class="source-line-no">094</span><span id="line-94"> table.close();</span>
<span class="source-line-no">095</span><span id="line-95"> }</span>
<span class="source-line-no">096</span><span id="line-96"> assertTrue(CheckWasRunConstraint.wasRun);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> /**</span>
<span class="source-line-no">100</span><span id="line-100"> * Test that constraints will fail properly</span>
<span class="source-line-no">101</span><span id="line-101"> */</span>
<span class="source-line-no">102</span><span id="line-102"> @Test</span>
<span class="source-line-no">103</span><span id="line-103"> public void testConstraintFails() throws Exception {</span>
<span class="source-line-no">104</span><span id="line-104"> // create the table</span>
<span class="source-line-no">105</span><span id="line-105"> // it would be nice if this was also a method on the util</span>
<span class="source-line-no">106</span><span id="line-106"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">107</span><span id="line-107"> for (byte[] family : new byte[][] { dummy, test }) {</span>
<span class="source-line-no">108</span><span id="line-108"> builder.setColumnFamily(ColumnFamilyDescriptorBuilder.of(family));</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> // add a constraint that is sure to fail</span>
<span class="source-line-no">112</span><span id="line-112"> Constraints.add(builder, AllFailConstraint.class);</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> util.getAdmin().createTable(builder.build());</span>
<span class="source-line-no">115</span><span id="line-115"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> // test that we do fail on violation</span>
<span class="source-line-no">118</span><span id="line-118"> Put put = new Put(row1);</span>
<span class="source-line-no">119</span><span id="line-119"> byte[] qualifier = new byte[0];</span>
<span class="source-line-no">120</span><span id="line-120"> put.addColumn(dummy, qualifier, Bytes.toBytes("fail"));</span>
<span class="source-line-no">121</span><span id="line-121"> LOG.warn("Doing put in table");</span>
<span class="source-line-no">122</span><span id="line-122"> try {</span>
<span class="source-line-no">123</span><span id="line-123"> table.put(put);</span>
<span class="source-line-no">124</span><span id="line-124"> fail("This put should not have suceeded - AllFailConstraint was not run!");</span>
<span class="source-line-no">125</span><span id="line-125"> } catch (ConstraintException e) {</span>
<span class="source-line-no">126</span><span id="line-126"> // expected</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"> table.close();</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> /**</span>
<span class="source-line-no">132</span><span id="line-132"> * Check that if we just disable one constraint, then</span>
<span class="source-line-no">133</span><span id="line-133"> */</span>
<span class="source-line-no">134</span><span id="line-134"> @Test</span>
<span class="source-line-no">135</span><span id="line-135"> public void testDisableConstraint() throws Exception {</span>
<span class="source-line-no">136</span><span id="line-136"> // create the table</span>
<span class="source-line-no">137</span><span id="line-137"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">138</span><span id="line-138"> // add a family to the table</span>
<span class="source-line-no">139</span><span id="line-139"> for (byte[] family : new byte[][] { dummy, test }) {</span>
<span class="source-line-no">140</span><span id="line-140"> builder.setColumnFamily(ColumnFamilyDescriptorBuilder.of(family));</span>
<span class="source-line-no">141</span><span id="line-141"> }</span>
<span class="source-line-no">142</span><span id="line-142"> // add a constraint to make sure it others get run</span>
<span class="source-line-no">143</span><span id="line-143"> Constraints.add(builder, CheckWasRunConstraint.class);</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> // Add Constraint to check</span>
<span class="source-line-no">146</span><span id="line-146"> Constraints.add(builder, AllFailConstraint.class);</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> // and then disable the failing constraint</span>
<span class="source-line-no">149</span><span id="line-149"> Constraints.disableConstraint(builder, AllFailConstraint.class);</span>
<span class="source-line-no">150</span><span id="line-150"></span>
<span class="source-line-no">151</span><span id="line-151"> util.getAdmin().createTable(builder.build());</span>
<span class="source-line-no">152</span><span id="line-152"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">153</span><span id="line-153"> try {</span>
<span class="source-line-no">154</span><span id="line-154"> // test that we don't fail because its disabled</span>
<span class="source-line-no">155</span><span id="line-155"> Put put = new Put(row1);</span>
<span class="source-line-no">156</span><span id="line-156"> byte[] qualifier = new byte[0];</span>
<span class="source-line-no">157</span><span id="line-157"> put.addColumn(dummy, qualifier, Bytes.toBytes("pass"));</span>
<span class="source-line-no">158</span><span id="line-158"> table.put(put);</span>
<span class="source-line-no">159</span><span id="line-159"> } finally {</span>
<span class="source-line-no">160</span><span id="line-160"> table.close();</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"> assertTrue(CheckWasRunConstraint.wasRun);</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> /**</span>
<span class="source-line-no">166</span><span id="line-166"> * Test that if we disable all constraints, then nothing gets run</span>
<span class="source-line-no">167</span><span id="line-167"> */</span>
<span class="source-line-no">168</span><span id="line-168"> @Test</span>
<span class="source-line-no">169</span><span id="line-169"> public void testDisableConstraints() throws Exception {</span>
<span class="source-line-no">170</span><span id="line-170"> // create the table</span>
<span class="source-line-no">171</span><span id="line-171"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> // add a family to the table</span>
<span class="source-line-no">174</span><span id="line-174"> for (byte[] family : new byte[][] { dummy, test }) {</span>
<span class="source-line-no">175</span><span id="line-175"> builder.setColumnFamily(ColumnFamilyDescriptorBuilder.of(family));</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"> // add a constraint to check to see if is run</span>
<span class="source-line-no">178</span><span id="line-178"> Constraints.add(builder, CheckWasRunConstraint.class);</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> // then disable all the constraints</span>
<span class="source-line-no">181</span><span id="line-181"> Constraints.disable(builder);</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> util.getAdmin().createTable(builder.build());</span>
<span class="source-line-no">184</span><span id="line-184"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">185</span><span id="line-185"> try {</span>
<span class="source-line-no">186</span><span id="line-186"> // test that we do fail on violation</span>
<span class="source-line-no">187</span><span id="line-187"> Put put = new Put(row1);</span>
<span class="source-line-no">188</span><span id="line-188"> byte[] qualifier = new byte[0];</span>
<span class="source-line-no">189</span><span id="line-189"> put.addColumn(dummy, qualifier, Bytes.toBytes("pass"));</span>
<span class="source-line-no">190</span><span id="line-190"> LOG.warn("Doing put in table");</span>
<span class="source-line-no">191</span><span id="line-191"> table.put(put);</span>
<span class="source-line-no">192</span><span id="line-192"> } finally {</span>
<span class="source-line-no">193</span><span id="line-193"> table.close();</span>
<span class="source-line-no">194</span><span id="line-194"> }</span>
<span class="source-line-no">195</span><span id="line-195"> assertFalse(CheckWasRunConstraint.wasRun);</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197"></span>
<span class="source-line-no">198</span><span id="line-198"> /**</span>
<span class="source-line-no">199</span><span id="line-199"> * Check to make sure a constraint is unloaded when it fails</span>
<span class="source-line-no">200</span><span id="line-200"> */</span>
<span class="source-line-no">201</span><span id="line-201"> @Test</span>
<span class="source-line-no">202</span><span id="line-202"> public void testIsUnloaded() throws Exception {</span>
<span class="source-line-no">203</span><span id="line-203"> // create the table</span>
<span class="source-line-no">204</span><span id="line-204"> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(tableName);</span>
<span class="source-line-no">205</span><span id="line-205"></span>
<span class="source-line-no">206</span><span id="line-206"> // add a family to the table</span>
<span class="source-line-no">207</span><span id="line-207"> for (byte[] family : new byte[][] { dummy, test }) {</span>
<span class="source-line-no">208</span><span id="line-208"> builder.setColumnFamily(ColumnFamilyDescriptorBuilder.of(family));</span>
<span class="source-line-no">209</span><span id="line-209"> }</span>
<span class="source-line-no">210</span><span id="line-210"> // make sure that constraints are unloaded</span>
<span class="source-line-no">211</span><span id="line-211"> Constraints.add(builder, RuntimeFailConstraint.class);</span>
<span class="source-line-no">212</span><span id="line-212"> // add a constraint to check to see if is run</span>
<span class="source-line-no">213</span><span id="line-213"> Constraints.add(builder, CheckWasRunConstraint.class);</span>
<span class="source-line-no">214</span><span id="line-214"> CheckWasRunConstraint.wasRun = false;</span>
<span class="source-line-no">215</span><span id="line-215"></span>
<span class="source-line-no">216</span><span id="line-216"> util.getAdmin().createTable(builder.build());</span>
<span class="source-line-no">217</span><span id="line-217"> Table table = util.getConnection().getTable(tableName);</span>
<span class="source-line-no">218</span><span id="line-218"></span>
<span class="source-line-no">219</span><span id="line-219"> // test that we do fail on violation</span>
<span class="source-line-no">220</span><span id="line-220"> Put put = new Put(row1);</span>
<span class="source-line-no">221</span><span id="line-221"> byte[] qualifier = new byte[0];</span>
<span class="source-line-no">222</span><span id="line-222"> put.addColumn(dummy, qualifier, Bytes.toBytes("pass"));</span>
<span class="source-line-no">223</span><span id="line-223"></span>
<span class="source-line-no">224</span><span id="line-224"> try {</span>
<span class="source-line-no">225</span><span id="line-225"> table.put(put);</span>
<span class="source-line-no">226</span><span id="line-226"> fail("RuntimeFailConstraint wasn't triggered - this put shouldn't work!");</span>
<span class="source-line-no">227</span><span id="line-227"> } catch (Exception e) {// NOOP</span>
<span class="source-line-no">228</span><span id="line-228"> }</span>
<span class="source-line-no">229</span><span id="line-229"></span>
<span class="source-line-no">230</span><span id="line-230"> // try the put again, this time constraints are not used, so it works</span>
<span class="source-line-no">231</span><span id="line-231"> table.put(put);</span>
<span class="source-line-no">232</span><span id="line-232"> // and we make sure that constraints were not run...</span>
<span class="source-line-no">233</span><span id="line-233"> assertFalse(CheckWasRunConstraint.wasRun);</span>
<span class="source-line-no">234</span><span id="line-234"> table.close();</span>
<span class="source-line-no">235</span><span id="line-235"> }</span>
<span class="source-line-no">236</span><span id="line-236"></span>
<span class="source-line-no">237</span><span id="line-237"> @After</span>
<span class="source-line-no">238</span><span id="line-238"> public void cleanup() throws Exception {</span>
<span class="source-line-no">239</span><span id="line-239"> // cleanup</span>
<span class="source-line-no">240</span><span id="line-240"> CheckWasRunConstraint.wasRun = false;</span>
<span class="source-line-no">241</span><span id="line-241"> util.getAdmin().disableTable(tableName);</span>
<span class="source-line-no">242</span><span id="line-242"> util.getAdmin().deleteTable(tableName);</span>
<span class="source-line-no">243</span><span id="line-243"> }</span>
<span class="source-line-no">244</span><span id="line-244"></span>
<span class="source-line-no">245</span><span id="line-245"> @AfterClass</span>
<span class="source-line-no">246</span><span id="line-246"> public static void tearDownAfterClass() throws Exception {</span>
<span class="source-line-no">247</span><span id="line-247"> util.shutdownMiniCluster();</span>
<span class="source-line-no">248</span><span id="line-248"> }</span>
<span class="source-line-no">249</span><span id="line-249"></span>
<span class="source-line-no">250</span><span id="line-250"> /**</span>
<span class="source-line-no">251</span><span id="line-251"> * Constraint to check that it was actually run (or not)</span>
<span class="source-line-no">252</span><span id="line-252"> */</span>
<span class="source-line-no">253</span><span id="line-253"> public static class CheckWasRunConstraint extends BaseConstraint {</span>
<span class="source-line-no">254</span><span id="line-254"> public static boolean wasRun = false;</span>
<span class="source-line-no">255</span><span id="line-255"></span>
<span class="source-line-no">256</span><span id="line-256"> @Override</span>
<span class="source-line-no">257</span><span id="line-257"> public void check(Put p) {</span>
<span class="source-line-no">258</span><span id="line-258"> wasRun = true;</span>
<span class="source-line-no">259</span><span id="line-259"> }</span>
<span class="source-line-no">260</span><span id="line-260"> }</span>
<span class="source-line-no">261</span><span id="line-261"></span>
<span class="source-line-no">262</span><span id="line-262">}</span>
</pre>
</div>
</main>
</body>
</html>