blob: f2de760a85daeef1b6be6f43506097e7b2a28f95 [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.procedure2, class: TestProcedureEvents">
<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.procedure2;</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.assertEquals;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.atomic.AtomicInteger;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HBaseCommonTestingUtil;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.procedure2.ProcedureTestingUtility.NoopProcedure;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.procedure2.store.ProcedureStore;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.testclassification.MasterTests;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.testclassification.MediumTests;</span>
<span class="source-line-no">032</span><span id="line-32">import org.junit.After;</span>
<span class="source-line-no">033</span><span id="line-33">import org.junit.Before;</span>
<span class="source-line-no">034</span><span id="line-34">import org.junit.ClassRule;</span>
<span class="source-line-no">035</span><span id="line-35">import org.junit.Test;</span>
<span class="source-line-no">036</span><span id="line-36">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">037</span><span id="line-37">import org.slf4j.Logger;</span>
<span class="source-line-no">038</span><span id="line-38">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.com.google.protobuf.Int32Value;</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState;</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, MediumTests.class })</span>
<span class="source-line-no">045</span><span id="line-45">public class TestProcedureEvents {</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(TestProcedureEvents.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"> private static final Logger LOG = LoggerFactory.getLogger(TestProcedureEvents.class);</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> private TestProcEnv procEnv;</span>
<span class="source-line-no">054</span><span id="line-54"> private ProcedureStore procStore;</span>
<span class="source-line-no">055</span><span id="line-55"> private ProcedureExecutor&lt;TestProcEnv&gt; procExecutor;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> private HBaseCommonTestingUtil htu;</span>
<span class="source-line-no">058</span><span id="line-58"> private FileSystem fs;</span>
<span class="source-line-no">059</span><span id="line-59"> private Path logDir;</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @Before</span>
<span class="source-line-no">062</span><span id="line-62"> public void setUp() throws IOException {</span>
<span class="source-line-no">063</span><span id="line-63"> htu = new HBaseCommonTestingUtil();</span>
<span class="source-line-no">064</span><span id="line-64"> Path testDir = htu.getDataTestDir();</span>
<span class="source-line-no">065</span><span id="line-65"> fs = testDir.getFileSystem(htu.getConfiguration());</span>
<span class="source-line-no">066</span><span id="line-66"> logDir = new Path(testDir, "proc-logs");</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> procEnv = new TestProcEnv();</span>
<span class="source-line-no">069</span><span id="line-69"> procStore = ProcedureTestingUtility.createWalStore(htu.getConfiguration(), logDir);</span>
<span class="source-line-no">070</span><span id="line-70"> procExecutor = new ProcedureExecutor&lt;&gt;(htu.getConfiguration(), procEnv, procStore);</span>
<span class="source-line-no">071</span><span id="line-71"> procStore.start(1);</span>
<span class="source-line-no">072</span><span id="line-72"> ProcedureTestingUtility.initAndStartWorkers(procExecutor, 1, true);</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"> @After</span>
<span class="source-line-no">076</span><span id="line-76"> public void tearDown() throws IOException {</span>
<span class="source-line-no">077</span><span id="line-77"> procExecutor.stop();</span>
<span class="source-line-no">078</span><span id="line-78"> procStore.stop(false);</span>
<span class="source-line-no">079</span><span id="line-79"> procExecutor.join();</span>
<span class="source-line-no">080</span><span id="line-80"> fs.delete(logDir, true);</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> /**</span>
<span class="source-line-no">084</span><span id="line-84"> * Tests being able to suspend a Procedure for N timeouts and then failing.s Resets the timeout</span>
<span class="source-line-no">085</span><span id="line-85"> * after each elapses. See {@link TestTimeoutEventProcedure} for example of how to do this sort of</span>
<span class="source-line-no">086</span><span id="line-86"> * trickery with the ProcedureExecutor; i.e. suspend for a while, check for a condition and if not</span>
<span class="source-line-no">087</span><span id="line-87"> * set, suspend again, etc., ultimately failing or succeeding eventually.</span>
<span class="source-line-no">088</span><span id="line-88"> */</span>
<span class="source-line-no">089</span><span id="line-89"> @Test</span>
<span class="source-line-no">090</span><span id="line-90"> public void testTimeoutEventProcedure() throws Exception {</span>
<span class="source-line-no">091</span><span id="line-91"> final int NTIMEOUTS = 5;</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> TestTimeoutEventProcedure proc = new TestTimeoutEventProcedure(500, NTIMEOUTS);</span>
<span class="source-line-no">094</span><span id="line-94"> procExecutor.submitProcedure(proc);</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> ProcedureTestingUtility.waitProcedure(procExecutor, proc.getProcId());</span>
<span class="source-line-no">097</span><span id="line-97"> ProcedureTestingUtility.assertIsAbortException(procExecutor.getResult(proc.getProcId()));</span>
<span class="source-line-no">098</span><span id="line-98"> assertEquals(NTIMEOUTS + 1, proc.getTimeoutsCount());</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> @Test</span>
<span class="source-line-no">102</span><span id="line-102"> public void testTimeoutEventProcedureDoubleExecution() throws Exception {</span>
<span class="source-line-no">103</span><span id="line-103"> testTimeoutEventProcedureDoubleExecution(false);</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> @Test</span>
<span class="source-line-no">107</span><span id="line-107"> public void testTimeoutEventProcedureDoubleExecutionKillIfSuspended() throws Exception {</span>
<span class="source-line-no">108</span><span id="line-108"> testTimeoutEventProcedureDoubleExecution(true);</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"> private void testTimeoutEventProcedureDoubleExecution(final boolean killIfSuspended)</span>
<span class="source-line-no">112</span><span id="line-112"> throws Exception {</span>
<span class="source-line-no">113</span><span id="line-113"> TestTimeoutEventProcedure proc = new TestTimeoutEventProcedure(1000, 3);</span>
<span class="source-line-no">114</span><span id="line-114"> ProcedureTestingUtility.setKillAndToggleBeforeStoreUpdate(procExecutor, true);</span>
<span class="source-line-no">115</span><span id="line-115"> ProcedureTestingUtility.setKillIfSuspended(procExecutor, killIfSuspended);</span>
<span class="source-line-no">116</span><span id="line-116"> long procId = procExecutor.submitProcedure(proc);</span>
<span class="source-line-no">117</span><span id="line-117"> ProcedureTestingUtility.testRecoveryAndDoubleExecution(procExecutor, procId, true);</span>
<span class="source-line-no">118</span><span id="line-118"> ProcedureTestingUtility.assertIsAbortException(procExecutor.getResult(proc.getProcId()));</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> /**</span>
<span class="source-line-no">122</span><span id="line-122"> * This Event+Procedure exhibits following behavior:</span>
<span class="source-line-no">123</span><span id="line-123"> * &lt;ul&gt;</span>
<span class="source-line-no">124</span><span id="line-124"> * &lt;li&gt;On procedure execute()</span>
<span class="source-line-no">125</span><span id="line-125"> * &lt;ul&gt;</span>
<span class="source-line-no">126</span><span id="line-126"> * &lt;li&gt;If had enough timeouts, abort the procedure. Else....&lt;/li&gt;</span>
<span class="source-line-no">127</span><span id="line-127"> * &lt;li&gt;Suspend the event and add self to its suspend queue&lt;/li&gt;</span>
<span class="source-line-no">128</span><span id="line-128"> * &lt;li&gt;Go into waiting state&lt;/li&gt;</span>
<span class="source-line-no">129</span><span id="line-129"> * &lt;/ul&gt;</span>
<span class="source-line-no">130</span><span id="line-130"> * &lt;/li&gt;</span>
<span class="source-line-no">131</span><span id="line-131"> * &lt;li&gt;On waiting timeout</span>
<span class="source-line-no">132</span><span id="line-132"> * &lt;ul&gt;</span>
<span class="source-line-no">133</span><span id="line-133"> * &lt;li&gt;Wake the event (which adds this procedure back into scheduler queue), and set own's state</span>
<span class="source-line-no">134</span><span id="line-134"> * to RUNNABLE (so can be executed again).&lt;/li&gt;</span>
<span class="source-line-no">135</span><span id="line-135"> * &lt;/ul&gt;</span>
<span class="source-line-no">136</span><span id="line-136"> * &lt;/li&gt;</span>
<span class="source-line-no">137</span><span id="line-137"> * &lt;/ul&gt;</span>
<span class="source-line-no">138</span><span id="line-138"> */</span>
<span class="source-line-no">139</span><span id="line-139"> public static class TestTimeoutEventProcedure extends NoopProcedure&lt;TestProcEnv&gt; {</span>
<span class="source-line-no">140</span><span id="line-140"> private final ProcedureEvent event = new ProcedureEvent("timeout-event");</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> private final AtomicInteger ntimeouts = new AtomicInteger(0);</span>
<span class="source-line-no">143</span><span id="line-143"> private int maxTimeouts = 1;</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> public TestTimeoutEventProcedure() {</span>
<span class="source-line-no">146</span><span id="line-146"> }</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> public TestTimeoutEventProcedure(final int timeoutMsec, final int maxTimeouts) {</span>
<span class="source-line-no">149</span><span id="line-149"> this.maxTimeouts = maxTimeouts;</span>
<span class="source-line-no">150</span><span id="line-150"> setTimeout(timeoutMsec);</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> public int getTimeoutsCount() {</span>
<span class="source-line-no">154</span><span id="line-154"> return ntimeouts.get();</span>
<span class="source-line-no">155</span><span id="line-155"> }</span>
<span class="source-line-no">156</span><span id="line-156"></span>
<span class="source-line-no">157</span><span id="line-157"> @Override</span>
<span class="source-line-no">158</span><span id="line-158"> protected Procedure[] execute(final TestProcEnv env) throws ProcedureSuspendedException {</span>
<span class="source-line-no">159</span><span id="line-159"> LOG.info("EXECUTE " + this + " ntimeouts=" + ntimeouts);</span>
<span class="source-line-no">160</span><span id="line-160"> if (ntimeouts.get() &gt; maxTimeouts) {</span>
<span class="source-line-no">161</span><span id="line-161"> setAbortFailure("test", "give up after " + ntimeouts.get());</span>
<span class="source-line-no">162</span><span id="line-162"> return null;</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"> event.suspend();</span>
<span class="source-line-no">166</span><span id="line-166"> if (event.suspendIfNotReady(this)) {</span>
<span class="source-line-no">167</span><span id="line-167"> setState(ProcedureState.WAITING_TIMEOUT);</span>
<span class="source-line-no">168</span><span id="line-168"> throw new ProcedureSuspendedException();</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> return null;</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> @Override</span>
<span class="source-line-no">175</span><span id="line-175"> protected synchronized boolean setTimeoutFailure(final TestProcEnv env) {</span>
<span class="source-line-no">176</span><span id="line-176"> int n = ntimeouts.incrementAndGet();</span>
<span class="source-line-no">177</span><span id="line-177"> LOG.info("HANDLE TIMEOUT " + this + " ntimeouts=" + n);</span>
<span class="source-line-no">178</span><span id="line-178"> setState(ProcedureState.RUNNABLE);</span>
<span class="source-line-no">179</span><span id="line-179"> event.wake((AbstractProcedureScheduler) env.getProcedureScheduler());</span>
<span class="source-line-no">180</span><span id="line-180"> return false;</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> @Override</span>
<span class="source-line-no">184</span><span id="line-184"> protected void afterReplay(final TestProcEnv env) {</span>
<span class="source-line-no">185</span><span id="line-185"> if (getState() == ProcedureState.WAITING_TIMEOUT) {</span>
<span class="source-line-no">186</span><span id="line-186"> event.suspend();</span>
<span class="source-line-no">187</span><span id="line-187"> event.suspendIfNotReady(this);</span>
<span class="source-line-no">188</span><span id="line-188"> }</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"></span>
<span class="source-line-no">191</span><span id="line-191"> @Override</span>
<span class="source-line-no">192</span><span id="line-192"> protected void serializeStateData(ProcedureStateSerializer serializer) throws IOException {</span>
<span class="source-line-no">193</span><span id="line-193"> Int32Value.Builder ntimeoutsBuilder = Int32Value.newBuilder().setValue(ntimeouts.get());</span>
<span class="source-line-no">194</span><span id="line-194"> serializer.serialize(ntimeoutsBuilder.build());</span>
<span class="source-line-no">195</span><span id="line-195"></span>
<span class="source-line-no">196</span><span id="line-196"> Int32Value.Builder maxTimeoutsBuilder = Int32Value.newBuilder().setValue(maxTimeouts);</span>
<span class="source-line-no">197</span><span id="line-197"> serializer.serialize(maxTimeoutsBuilder.build());</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> @Override</span>
<span class="source-line-no">201</span><span id="line-201"> protected void deserializeStateData(ProcedureStateSerializer serializer) throws IOException {</span>
<span class="source-line-no">202</span><span id="line-202"> Int32Value ntimeoutsValue = serializer.deserialize(Int32Value.class);</span>
<span class="source-line-no">203</span><span id="line-203"> ntimeouts.set(ntimeoutsValue.getValue());</span>
<span class="source-line-no">204</span><span id="line-204"></span>
<span class="source-line-no">205</span><span id="line-205"> Int32Value maxTimeoutsValue = serializer.deserialize(Int32Value.class);</span>
<span class="source-line-no">206</span><span id="line-206"> maxTimeouts = maxTimeoutsValue.getValue();</span>
<span class="source-line-no">207</span><span id="line-207"> }</span>
<span class="source-line-no">208</span><span id="line-208"> }</span>
<span class="source-line-no">209</span><span id="line-209"></span>
<span class="source-line-no">210</span><span id="line-210"> private class TestProcEnv {</span>
<span class="source-line-no">211</span><span id="line-211"> public ProcedureScheduler getProcedureScheduler() {</span>
<span class="source-line-no">212</span><span id="line-212"> return procExecutor.getScheduler();</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215">}</span>
</pre>
</div>
</main>
</body>
</html>