Google Git
Sign in
apache / hbase-site / 82b7d6fa699c68d5902b74920e555d6ae22bcc01 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / procedure / TestProcedure.LatchedProcedure.html
blob: 6aae6d1a187d40340f78e53da2d4af7cb1ff0468 [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.procedure;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.mockito.Matchers.any;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.mockito.Matchers.anyString;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.mockito.Mockito.mock;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.mockito.Mockito.never;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.mockito.Mockito.spy;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import static org.mockito.Mockito.verify;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import static org.mockito.Mockito.when;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.ArrayList;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.concurrent.CountDownLatch;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.errorhandling.ForeignException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.errorhandling.ForeignExceptionDispatcher;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.testclassification.MasterTests;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.junit.Before;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.junit.ClassRule;<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> * Demonstrate how Procedure handles single members, multiple members, and errors semantics<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>@Category({ MasterTests.class, SmallTests.class })<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class TestProcedure {<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(TestProcedure.class);<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> ProcedureCoordinator coord;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> @Before<a name="line.53"></a>
<span class="sourceLineNo">054</span> public void setup() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> coord = mock(ProcedureCoordinator.class);<a name="line.55"></a>
<span class="sourceLineNo">056</span> final ProcedureCoordinatorRpcs comms = mock(ProcedureCoordinatorRpcs.class);<a name="line.56"></a>
<span class="sourceLineNo">057</span> when(coord.getRpcs()).thenReturn(comms); // make it not null<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> static class LatchedProcedure extends Procedure {<a name="line.60"></a>
<span class="sourceLineNo">061</span> CountDownLatch startedAcquireBarrier = new CountDownLatch(1);<a name="line.61"></a>
<span class="sourceLineNo">062</span> CountDownLatch startedDuringBarrier = new CountDownLatch(1);<a name="line.62"></a>
<span class="sourceLineNo">063</span> CountDownLatch completedProcedure = new CountDownLatch(1);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> public LatchedProcedure(ProcedureCoordinator coord, ForeignExceptionDispatcher monitor,<a name="line.65"></a>
<span class="sourceLineNo">066</span> long wakeFreq, long timeout, String opName, byte[] data, List&lt;String&gt; expectedMembers) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> super(coord, monitor, wakeFreq, timeout, opName, data, expectedMembers);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public void sendGlobalBarrierStart() {<a name="line.71"></a>
<span class="sourceLineNo">072</span> startedAcquireBarrier.countDown();<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public void sendGlobalBarrierReached() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> startedDuringBarrier.countDown();<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> public void sendGlobalBarrierComplete() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> completedProcedure.countDown();<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * With a single member, verify ordered execution. The Coordinator side is run in a separate<a name="line.87"></a>
<span class="sourceLineNo">088</span> * thread so we can only trigger from members and wait for particular state latches.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> @Test<a name="line.90"></a>
<span class="sourceLineNo">091</span> public void testSingleMember() throws Exception {<a name="line.91"></a>
<span class="sourceLineNo">092</span> // The member<a name="line.92"></a>
<span class="sourceLineNo">093</span> List&lt;String&gt; members = new ArrayList&lt;&gt;();<a name="line.93"></a>
<span class="sourceLineNo">094</span> members.add("member");<a name="line.94"></a>
<span class="sourceLineNo">095</span> LatchedProcedure proc = new LatchedProcedure(coord, new ForeignExceptionDispatcher(), 100,<a name="line.95"></a>
<span class="sourceLineNo">096</span> Integer.MAX_VALUE, "op", null, members);<a name="line.96"></a>
<span class="sourceLineNo">097</span> final LatchedProcedure procspy = spy(proc);<a name="line.97"></a>
<span class="sourceLineNo">098</span> // coordinator: start the barrier procedure<a name="line.98"></a>
<span class="sourceLineNo">099</span> new Thread() {<a name="line.99"></a>
<span class="sourceLineNo">100</span> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public void run() {<a name="line.101"></a>
<span class="sourceLineNo">102</span> procspy.call();<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }.start();<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> // coordinator: wait for the barrier to be acquired, then send start barrier<a name="line.106"></a>
<span class="sourceLineNo">107</span> proc.startedAcquireBarrier.await();<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> // we only know that {@link Procedure#sendStartBarrier()} was called, and others are blocked.<a name="line.109"></a>
<span class="sourceLineNo">110</span> verify(procspy).sendGlobalBarrierStart();<a name="line.110"></a>
<span class="sourceLineNo">111</span> verify(procspy, never()).sendGlobalBarrierReached();<a name="line.111"></a>
<span class="sourceLineNo">112</span> verify(procspy, never()).sendGlobalBarrierComplete();<a name="line.112"></a>
<span class="sourceLineNo">113</span> verify(procspy, never()).barrierAcquiredByMember(anyString());<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> // member: trigger global barrier acquisition<a name="line.115"></a>
<span class="sourceLineNo">116</span> proc.barrierAcquiredByMember(members.get(0));<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> // coordinator: wait for global barrier to be acquired.<a name="line.118"></a>
<span class="sourceLineNo">119</span> proc.acquiredBarrierLatch.await();<a name="line.119"></a>
<span class="sourceLineNo">120</span> verify(procspy).sendGlobalBarrierStart(); // old news<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> // since two threads, we cannot guarantee that {@link Procedure#sendSatsifiedBarrier()} was<a name="line.122"></a>
<span class="sourceLineNo">123</span> // or was not called here.<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> // member: trigger global barrier release<a name="line.125"></a>
<span class="sourceLineNo">126</span> proc.barrierReleasedByMember(members.get(0), new byte[0]);<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> // coordinator: wait for procedure to be completed<a name="line.128"></a>
<span class="sourceLineNo">129</span> proc.completedProcedure.await();<a name="line.129"></a>
<span class="sourceLineNo">130</span> verify(procspy).sendGlobalBarrierReached();<a name="line.130"></a>
<span class="sourceLineNo">131</span> verify(procspy).sendGlobalBarrierComplete();<a name="line.131"></a>
<span class="sourceLineNo">132</span> verify(procspy, never()).receive(any());<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<a name="line.135"></a>
<span class="sourceLineNo">136</span> public void testMultipleMember() throws Exception {<a name="line.136"></a>
<span class="sourceLineNo">137</span> // 2 members<a name="line.137"></a>
<span class="sourceLineNo">138</span> List&lt;String&gt; members = new ArrayList&lt;&gt;();<a name="line.138"></a>
<span class="sourceLineNo">139</span> members.add("member1");<a name="line.139"></a>
<span class="sourceLineNo">140</span> members.add("member2");<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> LatchedProcedure proc = new LatchedProcedure(coord, new ForeignExceptionDispatcher(), 100,<a name="line.142"></a>
<span class="sourceLineNo">143</span> Integer.MAX_VALUE, "op", null, members);<a name="line.143"></a>
<span class="sourceLineNo">144</span> final LatchedProcedure procspy = spy(proc);<a name="line.144"></a>
<span class="sourceLineNo">145</span> // start the barrier procedure<a name="line.145"></a>
<span class="sourceLineNo">146</span> new Thread() {<a name="line.146"></a>
<span class="sourceLineNo">147</span> @Override<a name="line.147"></a>
<span class="sourceLineNo">148</span> public void run() {<a name="line.148"></a>
<span class="sourceLineNo">149</span> procspy.call();<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> }.start();<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> // coordinator: wait for the barrier to be acquired, then send start barrier<a name="line.153"></a>
<span class="sourceLineNo">154</span> procspy.startedAcquireBarrier.await();<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> // we only know that {@link Procedure#sendStartBarrier()} was called, and others are blocked.<a name="line.156"></a>
<span class="sourceLineNo">157</span> verify(procspy).sendGlobalBarrierStart();<a name="line.157"></a>
<span class="sourceLineNo">158</span> verify(procspy, never()).sendGlobalBarrierReached();<a name="line.158"></a>
<span class="sourceLineNo">159</span> verify(procspy, never()).sendGlobalBarrierComplete();<a name="line.159"></a>
<span class="sourceLineNo">160</span> verify(procspy, never()).barrierAcquiredByMember(anyString()); // no externals<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> // member0: [1/2] trigger global barrier acquisition.<a name="line.162"></a>
<span class="sourceLineNo">163</span> procspy.barrierAcquiredByMember(members.get(0));<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> // coordinator not satisified.<a name="line.165"></a>
<span class="sourceLineNo">166</span> verify(procspy).sendGlobalBarrierStart();<a name="line.166"></a>
<span class="sourceLineNo">167</span> verify(procspy, never()).sendGlobalBarrierReached();<a name="line.167"></a>
<span class="sourceLineNo">168</span> verify(procspy, never()).sendGlobalBarrierComplete();<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> // member 1: [2/2] trigger global barrier acquisition.<a name="line.170"></a>
<span class="sourceLineNo">171</span> procspy.barrierAcquiredByMember(members.get(1));<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> // coordinator: wait for global barrier to be acquired.<a name="line.173"></a>
<span class="sourceLineNo">174</span> procspy.startedDuringBarrier.await();<a name="line.174"></a>
<span class="sourceLineNo">175</span> verify(procspy).sendGlobalBarrierStart(); // old news<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> // member 1, 2: trigger global barrier release<a name="line.177"></a>
<span class="sourceLineNo">178</span> procspy.barrierReleasedByMember(members.get(0), new byte[0]);<a name="line.178"></a>
<span class="sourceLineNo">179</span> procspy.barrierReleasedByMember(members.get(1), new byte[0]);<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> // coordinator wait for procedure to be completed<a name="line.181"></a>
<span class="sourceLineNo">182</span> procspy.completedProcedure.await();<a name="line.182"></a>
<span class="sourceLineNo">183</span> verify(procspy).sendGlobalBarrierReached();<a name="line.183"></a>
<span class="sourceLineNo">184</span> verify(procspy).sendGlobalBarrierComplete();<a name="line.184"></a>
<span class="sourceLineNo">185</span> verify(procspy, never()).receive(any());<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> @Test<a name="line.188"></a>
<span class="sourceLineNo">189</span> public void testErrorPropagation() throws Exception {<a name="line.189"></a>
<span class="sourceLineNo">190</span> List&lt;String&gt; members = new ArrayList&lt;&gt;();<a name="line.190"></a>
<span class="sourceLineNo">191</span> members.add("member");<a name="line.191"></a>
<span class="sourceLineNo">192</span> Procedure proc = new Procedure(coord, new ForeignExceptionDispatcher(), 100, Integer.MAX_VALUE,<a name="line.192"></a>
<span class="sourceLineNo">193</span> "op", null, members);<a name="line.193"></a>
<span class="sourceLineNo">194</span> final Procedure procspy = spy(proc);<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span> ForeignException cause = new ForeignException("SRC", "External Exception");<a name="line.196"></a>
<span class="sourceLineNo">197</span> proc.receive(cause);<a name="line.197"></a>
<span class="sourceLineNo">198</span><a name="line.198"></a>
<span class="sourceLineNo">199</span> // start the barrier procedure<a name="line.199"></a>
<span class="sourceLineNo">200</span> Thread t = new Thread() {<a name="line.200"></a>
<span class="sourceLineNo">201</span> @Override<a name="line.201"></a>
<span class="sourceLineNo">202</span> public void run() {<a name="line.202"></a>
<span class="sourceLineNo">203</span> procspy.call();<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> };<a name="line.205"></a>
<span class="sourceLineNo">206</span> t.start();<a name="line.206"></a>
<span class="sourceLineNo">207</span> t.join();<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> verify(procspy, never()).sendGlobalBarrierStart();<a name="line.209"></a>
<span class="sourceLineNo">210</span> verify(procspy, never()).sendGlobalBarrierReached();<a name="line.210"></a>
<span class="sourceLineNo">211</span> verify(procspy).sendGlobalBarrierComplete();<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span><a name="line.213"></a>
<span class="sourceLineNo">214</span> @Test<a name="line.214"></a>
<span class="sourceLineNo">215</span> public void testBarrieredErrorPropagation() throws Exception {<a name="line.215"></a>
<span class="sourceLineNo">216</span> List&lt;String&gt; members = new ArrayList&lt;&gt;();<a name="line.216"></a>
<span class="sourceLineNo">217</span> members.add("member");<a name="line.217"></a>
<span class="sourceLineNo">218</span> LatchedProcedure proc = new LatchedProcedure(coord, new ForeignExceptionDispatcher(), 100,<a name="line.218"></a>
<span class="sourceLineNo">219</span> Integer.MAX_VALUE, "op", null, members);<a name="line.219"></a>
<span class="sourceLineNo">220</span> final LatchedProcedure procspy = spy(proc);<a name="line.220"></a>
<span class="sourceLineNo">221</span><a name="line.221"></a>
<span class="sourceLineNo">222</span> // start the barrier procedure<a name="line.222"></a>
<span class="sourceLineNo">223</span> Thread t = new Thread() {<a name="line.223"></a>
<span class="sourceLineNo">224</span> @Override<a name="line.224"></a>
<span class="sourceLineNo">225</span> public void run() {<a name="line.225"></a>
<span class="sourceLineNo">226</span> procspy.call();<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span> };<a name="line.228"></a>
<span class="sourceLineNo">229</span> t.start();<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span> // now test that we can put an error in before the commit phase runs<a name="line.231"></a>
<span class="sourceLineNo">232</span> procspy.startedAcquireBarrier.await();<a name="line.232"></a>
<span class="sourceLineNo">233</span> ForeignException cause = new ForeignException("SRC", "External Exception");<a name="line.233"></a>
<span class="sourceLineNo">234</span> procspy.receive(cause);<a name="line.234"></a>
<span class="sourceLineNo">235</span> procspy.barrierAcquiredByMember(members.get(0));<a name="line.235"></a>
<span class="sourceLineNo">236</span> t.join();<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span> // verify state of all the object<a name="line.238"></a>
<span class="sourceLineNo">239</span> verify(procspy).sendGlobalBarrierStart();<a name="line.239"></a>
<span class="sourceLineNo">240</span> verify(procspy).sendGlobalBarrierComplete();<a name="line.240"></a>
<span class="sourceLineNo">241</span> verify(procspy, never()).sendGlobalBarrierReached();<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span>}<a name="line.243"></a>
</pre>
</div>
</body>
</html>