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