blob: b0a2115627c2ae3ce2abc21d85f1045f85562375 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.constraint;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertFalse;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.assertTrue;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.junit.Assert.fail;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.TableNameTestRule;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.Put;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.constraint.TestConstraint.CheckWasRunConstraint;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.constraint.WorksConstraint.NameConstraint;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.testclassification.MiscTests;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.junit.ClassRule;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.junit.Rule;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.junit.Test;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.junit.experimental.categories.Category;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Test reading/writing the constraints into the {@link TableDescriptorBuilder}.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>@Category({ MiscTests.class, SmallTests.class })<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class TestConstraints {<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> @ClassRule<a name="line.47"></a>
<span class="sourceLineNo">048</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.48"></a>
<span class="sourceLineNo">049</span> HBaseClassTestRule.forClass(TestConstraints.class);<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> @Rule<a name="line.51"></a>
<span class="sourceLineNo">052</span> public TableNameTestRule name = new TableNameTestRule();<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> @Test<a name="line.54"></a>
<span class="sourceLineNo">055</span> public void testSimpleReadWrite() throws Exception {<a name="line.55"></a>
<span class="sourceLineNo">056</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.56"></a>
<span class="sourceLineNo">057</span> Constraints.add(builder, WorksConstraint.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> List&lt;? extends Constraint&gt; constraints =<a name="line.59"></a>
<span class="sourceLineNo">060</span> Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.60"></a>
<span class="sourceLineNo">061</span> assertEquals(1, constraints.size());<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> assertEquals(WorksConstraint.class, constraints.get(0).getClass());<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> // Check that we can add more than 1 constraint and that ordering is<a name="line.65"></a>
<span class="sourceLineNo">066</span> // preserved<a name="line.66"></a>
<span class="sourceLineNo">067</span> Constraints.add(builder, AlsoWorks.class, NameConstraint.class);<a name="line.67"></a>
<span class="sourceLineNo">068</span> constraints = Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.68"></a>
<span class="sourceLineNo">069</span> assertEquals(3, constraints.size());<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> assertEquals(WorksConstraint.class, constraints.get(0).getClass());<a name="line.71"></a>
<span class="sourceLineNo">072</span> assertEquals(AlsoWorks.class, constraints.get(1).getClass());<a name="line.72"></a>
<span class="sourceLineNo">073</span> assertEquals(NameConstraint.class, constraints.get(2).getClass());<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> @Test<a name="line.77"></a>
<span class="sourceLineNo">078</span> public void testReadWriteWithConf() throws Exception {<a name="line.78"></a>
<span class="sourceLineNo">079</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.79"></a>
<span class="sourceLineNo">080</span> Constraints.add(builder, new Pair&lt;&gt;(CheckConfigurationConstraint.class,<a name="line.80"></a>
<span class="sourceLineNo">081</span> CheckConfigurationConstraint.getConfiguration()));<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> List&lt;? extends Constraint&gt; c =<a name="line.83"></a>
<span class="sourceLineNo">084</span> Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.84"></a>
<span class="sourceLineNo">085</span> assertEquals(1, c.size());<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> assertEquals(CheckConfigurationConstraint.class, c.get(0).getClass());<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> // check to make sure that we overwrite configurations<a name="line.89"></a>
<span class="sourceLineNo">090</span> Constraints.add(builder,<a name="line.90"></a>
<span class="sourceLineNo">091</span> new Pair&lt;&gt;(CheckConfigurationConstraint.class, new Configuration(false)));<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> try {<a name="line.93"></a>
<span class="sourceLineNo">094</span> Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.94"></a>
<span class="sourceLineNo">095</span> fail("No exception thrown - configuration not overwritten");<a name="line.95"></a>
<span class="sourceLineNo">096</span> } catch (IllegalArgumentException e) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> // expect to have the exception, so don't do anything<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> /**<a name="line.101"></a>
<span class="sourceLineNo">102</span> * Test that Constraints are properly enabled, disabled, and removed<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> @Test<a name="line.104"></a>
<span class="sourceLineNo">105</span> public void testEnableDisableRemove() throws Exception {<a name="line.105"></a>
<span class="sourceLineNo">106</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.106"></a>
<span class="sourceLineNo">107</span> // check general enabling/disabling of constraints<a name="line.107"></a>
<span class="sourceLineNo">108</span> // first add a constraint<a name="line.108"></a>
<span class="sourceLineNo">109</span> Constraints.add(builder, AllPassConstraint.class);<a name="line.109"></a>
<span class="sourceLineNo">110</span> // make sure everything is enabled<a name="line.110"></a>
<span class="sourceLineNo">111</span> assertTrue(Constraints.enabled(builder.build(), AllPassConstraint.class));<a name="line.111"></a>
<span class="sourceLineNo">112</span> assertTrue(builder.hasCoprocessor(ConstraintProcessor.class.getName()));<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> // check disabling<a name="line.114"></a>
<span class="sourceLineNo">115</span> Constraints.disable(builder);<a name="line.115"></a>
<span class="sourceLineNo">116</span> assertFalse(builder.hasCoprocessor(ConstraintProcessor.class.getName()));<a name="line.116"></a>
<span class="sourceLineNo">117</span> // make sure the added constraints are still present<a name="line.117"></a>
<span class="sourceLineNo">118</span> assertTrue(Constraints.enabled(builder.build(), AllPassConstraint.class));<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> // check just removing the single constraint<a name="line.120"></a>
<span class="sourceLineNo">121</span> Constraints.remove(builder, AllPassConstraint.class);<a name="line.121"></a>
<span class="sourceLineNo">122</span> assertFalse(Constraints.has(builder.build(), AllPassConstraint.class));<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> // Add back the single constraint<a name="line.124"></a>
<span class="sourceLineNo">125</span> Constraints.add(builder, AllPassConstraint.class);<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> // and now check that when we remove constraints, all are gone<a name="line.127"></a>
<span class="sourceLineNo">128</span> Constraints.remove(builder);<a name="line.128"></a>
<span class="sourceLineNo">129</span> assertFalse(builder.hasCoprocessor(ConstraintProcessor.class.getName()));<a name="line.129"></a>
<span class="sourceLineNo">130</span> assertFalse(Constraints.has(builder.build(), AllPassConstraint.class));<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
<span class="sourceLineNo">135</span> * Test that when we update a constraint the ordering is not modified.<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> @Test<a name="line.137"></a>
<span class="sourceLineNo">138</span> public void testUpdateConstraint() throws Exception {<a name="line.138"></a>
<span class="sourceLineNo">139</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.139"></a>
<span class="sourceLineNo">140</span> Constraints.add(builder, CheckConfigurationConstraint.class, CheckWasRunConstraint.class);<a name="line.140"></a>
<span class="sourceLineNo">141</span> Constraints.setConfiguration(builder, CheckConfigurationConstraint.class,<a name="line.141"></a>
<span class="sourceLineNo">142</span> CheckConfigurationConstraint.getConfiguration());<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> List&lt;? extends Constraint&gt; constraints =<a name="line.144"></a>
<span class="sourceLineNo">145</span> Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> assertEquals(2, constraints.size());<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> // check to make sure the order didn't change<a name="line.149"></a>
<span class="sourceLineNo">150</span> assertEquals(CheckConfigurationConstraint.class, constraints.get(0).getClass());<a name="line.150"></a>
<span class="sourceLineNo">151</span> assertEquals(CheckWasRunConstraint.class, constraints.get(1).getClass());<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * Test that if a constraint hasn't been set that there are no problems with attempting to remove<a name="line.155"></a>
<span class="sourceLineNo">156</span> * it.<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> @Test<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void testRemoveUnsetConstraint() throws Exception {<a name="line.159"></a>
<span class="sourceLineNo">160</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.160"></a>
<span class="sourceLineNo">161</span> Constraints.remove(builder);<a name="line.161"></a>
<span class="sourceLineNo">162</span> Constraints.remove(builder, AlsoWorks.class);<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> @Test<a name="line.165"></a>
<span class="sourceLineNo">166</span> public void testConfigurationPreserved() throws Exception {<a name="line.166"></a>
<span class="sourceLineNo">167</span> Configuration conf = new Configuration();<a name="line.167"></a>
<span class="sourceLineNo">168</span> conf.setBoolean("_ENABLED", false);<a name="line.168"></a>
<span class="sourceLineNo">169</span> conf.setLong("_PRIORITY", 10);<a name="line.169"></a>
<span class="sourceLineNo">170</span> TableDescriptorBuilder builder = TableDescriptorBuilder.newBuilder(name.getTableName());<a name="line.170"></a>
<span class="sourceLineNo">171</span> Constraints.add(builder, AlsoWorks.class, conf);<a name="line.171"></a>
<span class="sourceLineNo">172</span> Constraints.add(builder, WorksConstraint.class);<a name="line.172"></a>
<span class="sourceLineNo">173</span> assertFalse(Constraints.enabled(builder.build(), AlsoWorks.class));<a name="line.173"></a>
<span class="sourceLineNo">174</span> List&lt;? extends Constraint&gt; constraints =<a name="line.174"></a>
<span class="sourceLineNo">175</span> Constraints.getConstraints(builder.build(), this.getClass().getClassLoader());<a name="line.175"></a>
<span class="sourceLineNo">176</span> for (Constraint c : constraints) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> Configuration storedConf = c.getConf();<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (c instanceof AlsoWorks) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> assertEquals(10, storedConf.getLong("_PRIORITY", -1));<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> // its just a worksconstraint<a name="line.181"></a>
<span class="sourceLineNo">182</span> else {<a name="line.182"></a>
<span class="sourceLineNo">183</span> assertEquals(2, storedConf.getLong("_PRIORITY", -1));<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> // ---------- Constraints just used for testing<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Also just works<a name="line.191"></a>
<span class="sourceLineNo">192</span> */<a name="line.192"></a>
<span class="sourceLineNo">193</span> public static class AlsoWorks extends BaseConstraint {<a name="line.193"></a>
<span class="sourceLineNo">194</span> @Override<a name="line.194"></a>
<span class="sourceLineNo">195</span> public void check(Put p) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> // NOOP<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span>}<a name="line.200"></a>
</pre>
</div>
</body>
</html>