blob: 4e3ccc7674954f08ee9535bbe078b7444e4c3616 [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: TestProcedureMember, class: EmptySubprocedure">
<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.ArgumentMatchers.eq;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.mockito.Mockito.doAnswer;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.mockito.Mockito.doThrow;</span>
<span class="source-line-no">025</span><span id="line-25">import static org.mockito.Mockito.inOrder;</span>
<span class="source-line-no">026</span><span id="line-26">import static org.mockito.Mockito.mock;</span>
<span class="source-line-no">027</span><span id="line-27">import static org.mockito.Mockito.never;</span>
<span class="source-line-no">028</span><span id="line-28">import static org.mockito.Mockito.reset;</span>
<span class="source-line-no">029</span><span id="line-29">import static org.mockito.Mockito.spy;</span>
<span class="source-line-no">030</span><span id="line-30">import static org.mockito.Mockito.verifyNoInteractions;</span>
<span class="source-line-no">031</span><span id="line-31">import static org.mockito.Mockito.when;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">import java.io.IOException;</span>
<span class="source-line-no">034</span><span id="line-34">import java.util.concurrent.ThreadPoolExecutor;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.errorhandling.ForeignException;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.errorhandling.ForeignExceptionDispatcher;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.errorhandling.TimeoutException;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.procedure.Subprocedure.SubprocedureImpl;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.testclassification.MasterTests;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.testclassification.SmallTests;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.After;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.ClassRule;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.Test;</span>
<span class="source-line-no">045</span><span id="line-45">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">046</span><span id="line-46">import org.mockito.InOrder;</span>
<span class="source-line-no">047</span><span id="line-47">import org.mockito.Mockito;</span>
<span class="source-line-no">048</span><span id="line-48">import org.mockito.invocation.InvocationOnMock;</span>
<span class="source-line-no">049</span><span id="line-49">import org.mockito.stubbing.Answer;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51">import org.apache.hbase.thirdparty.com.google.common.io.Closeables;</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53">/**</span>
<span class="source-line-no">054</span><span id="line-54"> * Test the procedure member, and it's error handling mechanisms.</span>
<span class="source-line-no">055</span><span id="line-55"> */</span>
<span class="source-line-no">056</span><span id="line-56">@Category({ MasterTests.class, SmallTests.class })</span>
<span class="source-line-no">057</span><span id="line-57">public class TestProcedureMember {</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> @ClassRule</span>
<span class="source-line-no">060</span><span id="line-60"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">061</span><span id="line-61"> HBaseClassTestRule.forClass(TestProcedureMember.class);</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> private static final long WAKE_FREQUENCY = 100;</span>
<span class="source-line-no">064</span><span id="line-64"> private static final long TIMEOUT = 100000;</span>
<span class="source-line-no">065</span><span id="line-65"> private static final long POOL_KEEP_ALIVE = 1;</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> private final String op = "some op";</span>
<span class="source-line-no">068</span><span id="line-68"> private final byte[] data = new byte[0];</span>
<span class="source-line-no">069</span><span id="line-69"> private final ForeignExceptionDispatcher mockListener =</span>
<span class="source-line-no">070</span><span id="line-70"> Mockito.spy(new ForeignExceptionDispatcher());</span>
<span class="source-line-no">071</span><span id="line-71"> private final SubprocedureFactory mockBuilder = mock(SubprocedureFactory.class);</span>
<span class="source-line-no">072</span><span id="line-72"> private final ProcedureMemberRpcs mockMemberComms = Mockito.mock(ProcedureMemberRpcs.class);</span>
<span class="source-line-no">073</span><span id="line-73"> private ProcedureMember member;</span>
<span class="source-line-no">074</span><span id="line-74"> private ForeignExceptionDispatcher dispatcher;</span>
<span class="source-line-no">075</span><span id="line-75"> Subprocedure spySub;</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> /**</span>
<span class="source-line-no">078</span><span id="line-78"> * Reset all the mock objects</span>
<span class="source-line-no">079</span><span id="line-79"> */</span>
<span class="source-line-no">080</span><span id="line-80"> @After</span>
<span class="source-line-no">081</span><span id="line-81"> public void resetTest() throws IOException {</span>
<span class="source-line-no">082</span><span id="line-82"> reset(mockListener, mockBuilder, mockMemberComms);</span>
<span class="source-line-no">083</span><span id="line-83"> Closeables.close(member, true);</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"> * Build a member using the class level mocks</span>
<span class="source-line-no">088</span><span id="line-88"> * @return member to use for tests</span>
<span class="source-line-no">089</span><span id="line-89"> */</span>
<span class="source-line-no">090</span><span id="line-90"> private ProcedureMember buildCohortMember() {</span>
<span class="source-line-no">091</span><span id="line-91"> String name = "node";</span>
<span class="source-line-no">092</span><span id="line-92"> ThreadPoolExecutor pool = ProcedureMember.defaultPool(name, 1, POOL_KEEP_ALIVE);</span>
<span class="source-line-no">093</span><span id="line-93"> return new ProcedureMember(mockMemberComms, pool, mockBuilder);</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> /**</span>
<span class="source-line-no">097</span><span id="line-97"> * Setup a procedure member that returns the spied-upon {@link Subprocedure}.</span>
<span class="source-line-no">098</span><span id="line-98"> */</span>
<span class="source-line-no">099</span><span id="line-99"> private void buildCohortMemberPair() throws IOException {</span>
<span class="source-line-no">100</span><span id="line-100"> dispatcher = new ForeignExceptionDispatcher();</span>
<span class="source-line-no">101</span><span id="line-101"> String name = "node";</span>
<span class="source-line-no">102</span><span id="line-102"> ThreadPoolExecutor pool = ProcedureMember.defaultPool(name, 1, POOL_KEEP_ALIVE);</span>
<span class="source-line-no">103</span><span id="line-103"> member = new ProcedureMember(mockMemberComms, pool, mockBuilder);</span>
<span class="source-line-no">104</span><span id="line-104"> when(mockMemberComms.getMemberName()).thenReturn("membername"); // needed for generating</span>
<span class="source-line-no">105</span><span id="line-105"> // exception</span>
<span class="source-line-no">106</span><span id="line-106"> Subprocedure subproc = new EmptySubprocedure(member, dispatcher);</span>
<span class="source-line-no">107</span><span id="line-107"> spySub = spy(subproc);</span>
<span class="source-line-no">108</span><span id="line-108"> when(mockBuilder.buildSubprocedure(op, data)).thenReturn(spySub);</span>
<span class="source-line-no">109</span><span id="line-109"> addCommitAnswer();</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> /**</span>
<span class="source-line-no">113</span><span id="line-113"> * Add a 'in barrier phase' response to the mock controller when it gets a acquired notification</span>
<span class="source-line-no">114</span><span id="line-114"> */</span>
<span class="source-line-no">115</span><span id="line-115"> private void addCommitAnswer() throws IOException {</span>
<span class="source-line-no">116</span><span id="line-116"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">117</span><span id="line-117"> @Override</span>
<span class="source-line-no">118</span><span id="line-118"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">119</span><span id="line-119"> member.receivedReachedGlobalBarrier(op);</span>
<span class="source-line-no">120</span><span id="line-120"> return null;</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> }).when(mockMemberComms).sendMemberAcquired(any());</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> /**</span>
<span class="source-line-no">126</span><span id="line-126"> * Test the normal sub procedure execution case.</span>
<span class="source-line-no">127</span><span id="line-127"> */</span>
<span class="source-line-no">128</span><span id="line-128"> @Test</span>
<span class="source-line-no">129</span><span id="line-129"> public void testSimpleRun() throws Exception {</span>
<span class="source-line-no">130</span><span id="line-130"> member = buildCohortMember();</span>
<span class="source-line-no">131</span><span id="line-131"> EmptySubprocedure subproc = new EmptySubprocedure(member, mockListener);</span>
<span class="source-line-no">132</span><span id="line-132"> EmptySubprocedure spy = spy(subproc);</span>
<span class="source-line-no">133</span><span id="line-133"> when(mockBuilder.buildSubprocedure(op, data)).thenReturn(spy);</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> // when we get a prepare, then start the commit phase</span>
<span class="source-line-no">136</span><span id="line-136"> addCommitAnswer();</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> // run the operation</span>
<span class="source-line-no">139</span><span id="line-139"> // build a new operation</span>
<span class="source-line-no">140</span><span id="line-140"> Subprocedure subproc1 = member.createSubprocedure(op, data);</span>
<span class="source-line-no">141</span><span id="line-141"> member.submitSubprocedure(subproc1);</span>
<span class="source-line-no">142</span><span id="line-142"> // and wait for it to finish</span>
<span class="source-line-no">143</span><span id="line-143"> subproc.waitForLocallyCompleted();</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> // make sure everything ran in order</span>
<span class="source-line-no">146</span><span id="line-146"> InOrder order = inOrder(mockMemberComms, spy);</span>
<span class="source-line-no">147</span><span id="line-147"> order.verify(spy).acquireBarrier();</span>
<span class="source-line-no">148</span><span id="line-148"> order.verify(mockMemberComms).sendMemberAcquired(eq(spy));</span>
<span class="source-line-no">149</span><span id="line-149"> order.verify(spy).insideBarrier();</span>
<span class="source-line-no">150</span><span id="line-150"> order.verify(mockMemberComms).sendMemberCompleted(eq(spy), eq(data));</span>
<span class="source-line-no">151</span><span id="line-151"> order.verify(mockMemberComms, never()).sendMemberAborted(eq(spy), any());</span>
<span class="source-line-no">152</span><span id="line-152"> }</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> /**</span>
<span class="source-line-no">155</span><span id="line-155"> * Make sure we call cleanup etc, when we have an exception during</span>
<span class="source-line-no">156</span><span id="line-156"> * {@link Subprocedure#acquireBarrier()}.</span>
<span class="source-line-no">157</span><span id="line-157"> */</span>
<span class="source-line-no">158</span><span id="line-158"> @Test</span>
<span class="source-line-no">159</span><span id="line-159"> public void testMemberPrepareException() throws Exception {</span>
<span class="source-line-no">160</span><span id="line-160"> buildCohortMemberPair();</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> // mock an exception on Subprocedure's prepare</span>
<span class="source-line-no">163</span><span id="line-163"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">164</span><span id="line-164"> @Override</span>
<span class="source-line-no">165</span><span id="line-165"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">166</span><span id="line-166"> throw new IOException("Forced IOException in member acquireBarrier");</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"> }).when(spySub).acquireBarrier();</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> // run the operation</span>
<span class="source-line-no">171</span><span id="line-171"> // build a new operation</span>
<span class="source-line-no">172</span><span id="line-172"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">173</span><span id="line-173"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">174</span><span id="line-174"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">175</span><span id="line-175"> member.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">176</span><span id="line-176"></span>
<span class="source-line-no">177</span><span id="line-177"> // make sure everything ran in order</span>
<span class="source-line-no">178</span><span id="line-178"> InOrder order = inOrder(mockMemberComms, spySub);</span>
<span class="source-line-no">179</span><span id="line-179"> order.verify(spySub).acquireBarrier();</span>
<span class="source-line-no">180</span><span id="line-180"> // Later phases not run</span>
<span class="source-line-no">181</span><span id="line-181"> order.verify(mockMemberComms, never()).sendMemberAcquired(eq(spySub));</span>
<span class="source-line-no">182</span><span id="line-182"> order.verify(spySub, never()).insideBarrier();</span>
<span class="source-line-no">183</span><span id="line-183"> order.verify(mockMemberComms, never()).sendMemberCompleted(eq(spySub), eq(data));</span>
<span class="source-line-no">184</span><span id="line-184"> // error recovery path exercised</span>
<span class="source-line-no">185</span><span id="line-185"> order.verify(spySub).cancel(anyString(), any());</span>
<span class="source-line-no">186</span><span id="line-186"> order.verify(spySub).cleanup(any());</span>
<span class="source-line-no">187</span><span id="line-187"> }</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"> * Make sure we call cleanup etc, when we have an exception during prepare.</span>
<span class="source-line-no">191</span><span id="line-191"> */</span>
<span class="source-line-no">192</span><span id="line-192"> @Test</span>
<span class="source-line-no">193</span><span id="line-193"> public void testSendMemberAcquiredCommsFailure() throws Exception {</span>
<span class="source-line-no">194</span><span id="line-194"> buildCohortMemberPair();</span>
<span class="source-line-no">195</span><span id="line-195"></span>
<span class="source-line-no">196</span><span id="line-196"> // mock an exception on Subprocedure's prepare</span>
<span class="source-line-no">197</span><span id="line-197"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">198</span><span id="line-198"> @Override</span>
<span class="source-line-no">199</span><span id="line-199"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">200</span><span id="line-200"> throw new IOException("Forced IOException in member prepare");</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"> }).when(mockMemberComms).sendMemberAcquired(any());</span>
<span class="source-line-no">203</span><span id="line-203"></span>
<span class="source-line-no">204</span><span id="line-204"> // run the operation</span>
<span class="source-line-no">205</span><span id="line-205"> // build a new operation</span>
<span class="source-line-no">206</span><span id="line-206"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">207</span><span id="line-207"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">208</span><span id="line-208"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">209</span><span id="line-209"> member.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">210</span><span id="line-210"></span>
<span class="source-line-no">211</span><span id="line-211"> // make sure everything ran in order</span>
<span class="source-line-no">212</span><span id="line-212"> InOrder order = inOrder(mockMemberComms, spySub);</span>
<span class="source-line-no">213</span><span id="line-213"> order.verify(spySub).acquireBarrier();</span>
<span class="source-line-no">214</span><span id="line-214"> order.verify(mockMemberComms).sendMemberAcquired(eq(spySub));</span>
<span class="source-line-no">215</span><span id="line-215"></span>
<span class="source-line-no">216</span><span id="line-216"> // Later phases not run</span>
<span class="source-line-no">217</span><span id="line-217"> order.verify(spySub, never()).insideBarrier();</span>
<span class="source-line-no">218</span><span id="line-218"> order.verify(mockMemberComms, never()).sendMemberCompleted(eq(spySub), eq(data));</span>
<span class="source-line-no">219</span><span id="line-219"> // error recovery path exercised</span>
<span class="source-line-no">220</span><span id="line-220"> order.verify(spySub).cancel(anyString(), any());</span>
<span class="source-line-no">221</span><span id="line-221"> order.verify(spySub).cleanup(any());</span>
<span class="source-line-no">222</span><span id="line-222"> }</span>
<span class="source-line-no">223</span><span id="line-223"></span>
<span class="source-line-no">224</span><span id="line-224"> /**</span>
<span class="source-line-no">225</span><span id="line-225"> * Fail correctly if coordinator aborts the procedure. The subprocedure will not interrupt a</span>
<span class="source-line-no">226</span><span id="line-226"> * running {@link Subprocedure#acquireBarrier()} -- prepare needs to finish first, and the the</span>
<span class="source-line-no">227</span><span id="line-227"> * abort is checked. Thus, the {@link Subprocedure#acquireBarrier()} should succeed but later get</span>
<span class="source-line-no">228</span><span id="line-228"> * rolled back via {@link Subprocedure#cleanup}.</span>
<span class="source-line-no">229</span><span id="line-229"> */</span>
<span class="source-line-no">230</span><span id="line-230"> @Test</span>
<span class="source-line-no">231</span><span id="line-231"> public void testCoordinatorAbort() throws Exception {</span>
<span class="source-line-no">232</span><span id="line-232"> buildCohortMemberPair();</span>
<span class="source-line-no">233</span><span id="line-233"></span>
<span class="source-line-no">234</span><span id="line-234"> // mock that another node timed out or failed to prepare</span>
<span class="source-line-no">235</span><span id="line-235"> final TimeoutException oate = new TimeoutException("bogus timeout", 1, 2, 0);</span>
<span class="source-line-no">236</span><span id="line-236"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">237</span><span id="line-237"> @Override</span>
<span class="source-line-no">238</span><span id="line-238"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">239</span><span id="line-239"> // inject a remote error (this would have come from an external thread)</span>
<span class="source-line-no">240</span><span id="line-240"> spySub.cancel("bogus message", oate);</span>
<span class="source-line-no">241</span><span id="line-241"> // sleep the wake frequency since that is what we promised</span>
<span class="source-line-no">242</span><span id="line-242"> Thread.sleep(WAKE_FREQUENCY);</span>
<span class="source-line-no">243</span><span id="line-243"> return null;</span>
<span class="source-line-no">244</span><span id="line-244"> }</span>
<span class="source-line-no">245</span><span id="line-245"> }).when(spySub).waitForReachedGlobalBarrier();</span>
<span class="source-line-no">246</span><span id="line-246"></span>
<span class="source-line-no">247</span><span id="line-247"> // run the operation</span>
<span class="source-line-no">248</span><span id="line-248"> // build a new operation</span>
<span class="source-line-no">249</span><span id="line-249"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">250</span><span id="line-250"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">251</span><span id="line-251"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">252</span><span id="line-252"> member.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">253</span><span id="line-253"></span>
<span class="source-line-no">254</span><span id="line-254"> // make sure everything ran in order</span>
<span class="source-line-no">255</span><span id="line-255"> InOrder order = inOrder(mockMemberComms, spySub);</span>
<span class="source-line-no">256</span><span id="line-256"> order.verify(spySub).acquireBarrier();</span>
<span class="source-line-no">257</span><span id="line-257"> order.verify(mockMemberComms).sendMemberAcquired(eq(spySub));</span>
<span class="source-line-no">258</span><span id="line-258"> // Later phases not run</span>
<span class="source-line-no">259</span><span id="line-259"> order.verify(spySub, never()).insideBarrier();</span>
<span class="source-line-no">260</span><span id="line-260"> order.verify(mockMemberComms, never()).sendMemberCompleted(eq(spySub), eq(data));</span>
<span class="source-line-no">261</span><span id="line-261"> // error recovery path exercised</span>
<span class="source-line-no">262</span><span id="line-262"> order.verify(spySub).cancel(anyString(), any());</span>
<span class="source-line-no">263</span><span id="line-263"> order.verify(spySub).cleanup(any());</span>
<span class="source-line-no">264</span><span id="line-264"> }</span>
<span class="source-line-no">265</span><span id="line-265"></span>
<span class="source-line-no">266</span><span id="line-266"> /**</span>
<span class="source-line-no">267</span><span id="line-267"> * Handle failures if a member's commit phase fails.</span>
<span class="source-line-no">268</span><span id="line-268"> * &lt;p/&gt;</span>
<span class="source-line-no">269</span><span id="line-269"> * NOTE: This is the core difference that makes this different from traditional 2PC. In true 2PC</span>
<span class="source-line-no">270</span><span id="line-270"> * the transaction is committed just before the coordinator sends commit messages to the member.</span>
<span class="source-line-no">271</span><span id="line-271"> * Members are then responsible for reading its TX log. This implementation actually rolls back,</span>
<span class="source-line-no">272</span><span id="line-272"> * and thus breaks the normal TX guarantees.</span>
<span class="source-line-no">273</span><span id="line-273"> */</span>
<span class="source-line-no">274</span><span id="line-274"> @Test</span>
<span class="source-line-no">275</span><span id="line-275"> public void testMemberCommitException() throws Exception {</span>
<span class="source-line-no">276</span><span id="line-276"> buildCohortMemberPair();</span>
<span class="source-line-no">277</span><span id="line-277"></span>
<span class="source-line-no">278</span><span id="line-278"> // mock an exception on Subprocedure's prepare</span>
<span class="source-line-no">279</span><span id="line-279"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">280</span><span id="line-280"> @Override</span>
<span class="source-line-no">281</span><span id="line-281"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">282</span><span id="line-282"> throw new IOException("Forced IOException in member prepare");</span>
<span class="source-line-no">283</span><span id="line-283"> }</span>
<span class="source-line-no">284</span><span id="line-284"> }).when(spySub).insideBarrier();</span>
<span class="source-line-no">285</span><span id="line-285"></span>
<span class="source-line-no">286</span><span id="line-286"> // run the operation</span>
<span class="source-line-no">287</span><span id="line-287"> // build a new operation</span>
<span class="source-line-no">288</span><span id="line-288"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">289</span><span id="line-289"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">290</span><span id="line-290"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">291</span><span id="line-291"> member.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">292</span><span id="line-292"></span>
<span class="source-line-no">293</span><span id="line-293"> // make sure everything ran in order</span>
<span class="source-line-no">294</span><span id="line-294"> InOrder order = inOrder(mockMemberComms, spySub);</span>
<span class="source-line-no">295</span><span id="line-295"> order.verify(spySub).acquireBarrier();</span>
<span class="source-line-no">296</span><span id="line-296"> order.verify(mockMemberComms).sendMemberAcquired(eq(spySub));</span>
<span class="source-line-no">297</span><span id="line-297"> order.verify(spySub).insideBarrier();</span>
<span class="source-line-no">298</span><span id="line-298"></span>
<span class="source-line-no">299</span><span id="line-299"> // Later phases not run</span>
<span class="source-line-no">300</span><span id="line-300"> order.verify(mockMemberComms, never()).sendMemberCompleted(eq(spySub), eq(data));</span>
<span class="source-line-no">301</span><span id="line-301"> // error recovery path exercised</span>
<span class="source-line-no">302</span><span id="line-302"> order.verify(spySub).cancel(anyString(), any());</span>
<span class="source-line-no">303</span><span id="line-303"> order.verify(spySub).cleanup(any());</span>
<span class="source-line-no">304</span><span id="line-304"> }</span>
<span class="source-line-no">305</span><span id="line-305"></span>
<span class="source-line-no">306</span><span id="line-306"> /**</span>
<span class="source-line-no">307</span><span id="line-307"> * Handle Failures if a member's commit phase succeeds but notification to coordinator fails</span>
<span class="source-line-no">308</span><span id="line-308"> * &lt;p/&gt;</span>
<span class="source-line-no">309</span><span id="line-309"> * NOTE: This is the core difference that makes this different from traditional 2PC. In true 2PC</span>
<span class="source-line-no">310</span><span id="line-310"> * the transaction is committed just before the coordinator sends commit messages to the member.</span>
<span class="source-line-no">311</span><span id="line-311"> * Members are then responsible for reading its TX log. This implementation actually rolls back,</span>
<span class="source-line-no">312</span><span id="line-312"> * and thus breaks the normal TX guarantees.</span>
<span class="source-line-no">313</span><span id="line-313"> */</span>
<span class="source-line-no">314</span><span id="line-314"> @Test</span>
<span class="source-line-no">315</span><span id="line-315"> public void testMemberCommitCommsFailure() throws Exception {</span>
<span class="source-line-no">316</span><span id="line-316"> buildCohortMemberPair();</span>
<span class="source-line-no">317</span><span id="line-317"> final TimeoutException oate = new TimeoutException("bogus timeout", 1, 2, 0);</span>
<span class="source-line-no">318</span><span id="line-318"> doAnswer(new Answer&lt;Void&gt;() {</span>
<span class="source-line-no">319</span><span id="line-319"> @Override</span>
<span class="source-line-no">320</span><span id="line-320"> public Void answer(InvocationOnMock invocation) throws Throwable {</span>
<span class="source-line-no">321</span><span id="line-321"> // inject a remote error (this would have come from an external thread)</span>
<span class="source-line-no">322</span><span id="line-322"> spySub.cancel("commit comms fail", oate);</span>
<span class="source-line-no">323</span><span id="line-323"> // sleep the wake frequency since that is what we promised</span>
<span class="source-line-no">324</span><span id="line-324"> Thread.sleep(WAKE_FREQUENCY);</span>
<span class="source-line-no">325</span><span id="line-325"> return null;</span>
<span class="source-line-no">326</span><span id="line-326"> }</span>
<span class="source-line-no">327</span><span id="line-327"> }).when(mockMemberComms).sendMemberCompleted(any(), eq(data));</span>
<span class="source-line-no">328</span><span id="line-328"></span>
<span class="source-line-no">329</span><span id="line-329"> // run the operation</span>
<span class="source-line-no">330</span><span id="line-330"> // build a new operation</span>
<span class="source-line-no">331</span><span id="line-331"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">332</span><span id="line-332"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">333</span><span id="line-333"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">334</span><span id="line-334"> member.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">335</span><span id="line-335"></span>
<span class="source-line-no">336</span><span id="line-336"> // make sure everything ran in order</span>
<span class="source-line-no">337</span><span id="line-337"> InOrder order = inOrder(mockMemberComms, spySub);</span>
<span class="source-line-no">338</span><span id="line-338"> order.verify(spySub).acquireBarrier();</span>
<span class="source-line-no">339</span><span id="line-339"> order.verify(mockMemberComms).sendMemberAcquired(eq(spySub));</span>
<span class="source-line-no">340</span><span id="line-340"> order.verify(spySub).insideBarrier();</span>
<span class="source-line-no">341</span><span id="line-341"> order.verify(mockMemberComms).sendMemberCompleted(eq(spySub), eq(data));</span>
<span class="source-line-no">342</span><span id="line-342"> // error recovery path exercised</span>
<span class="source-line-no">343</span><span id="line-343"> order.verify(spySub).cancel(anyString(), any());</span>
<span class="source-line-no">344</span><span id="line-344"> order.verify(spySub).cleanup(any());</span>
<span class="source-line-no">345</span><span id="line-345"> }</span>
<span class="source-line-no">346</span><span id="line-346"></span>
<span class="source-line-no">347</span><span id="line-347"> /**</span>
<span class="source-line-no">348</span><span id="line-348"> * Fail correctly on getting an external error while waiting for the prepared latch</span>
<span class="source-line-no">349</span><span id="line-349"> * @throws Exception on failure</span>
<span class="source-line-no">350</span><span id="line-350"> */</span>
<span class="source-line-no">351</span><span id="line-351"> @Test</span>
<span class="source-line-no">352</span><span id="line-352"> public void testPropagateConnectionErrorBackToManager() throws Exception {</span>
<span class="source-line-no">353</span><span id="line-353"> // setup the operation</span>
<span class="source-line-no">354</span><span id="line-354"> member = buildCohortMember();</span>
<span class="source-line-no">355</span><span id="line-355"> ProcedureMember memberSpy = spy(member);</span>
<span class="source-line-no">356</span><span id="line-356"></span>
<span class="source-line-no">357</span><span id="line-357"> // setup the commit and the spy</span>
<span class="source-line-no">358</span><span id="line-358"> final ForeignExceptionDispatcher dispatcher = new ForeignExceptionDispatcher();</span>
<span class="source-line-no">359</span><span id="line-359"> ForeignExceptionDispatcher dispSpy = spy(dispatcher);</span>
<span class="source-line-no">360</span><span id="line-360"> Subprocedure commit = new EmptySubprocedure(member, dispatcher);</span>
<span class="source-line-no">361</span><span id="line-361"> Subprocedure spy = spy(commit);</span>
<span class="source-line-no">362</span><span id="line-362"> when(mockBuilder.buildSubprocedure(op, data)).thenReturn(spy);</span>
<span class="source-line-no">363</span><span id="line-363"></span>
<span class="source-line-no">364</span><span id="line-364"> // fail during the prepare phase</span>
<span class="source-line-no">365</span><span id="line-365"> doThrow(new ForeignException("SRC", "prepare exception")).when(spy).acquireBarrier();</span>
<span class="source-line-no">366</span><span id="line-366"> // and throw a connection error when we try to tell the controller about it</span>
<span class="source-line-no">367</span><span id="line-367"> doThrow(new IOException("Controller is down!")).when(mockMemberComms).sendMemberAborted(eq(spy),</span>
<span class="source-line-no">368</span><span id="line-368"> any());</span>
<span class="source-line-no">369</span><span id="line-369"></span>
<span class="source-line-no">370</span><span id="line-370"> // run the operation</span>
<span class="source-line-no">371</span><span id="line-371"> // build a new operation</span>
<span class="source-line-no">372</span><span id="line-372"> Subprocedure subproc = memberSpy.createSubprocedure(op, data);</span>
<span class="source-line-no">373</span><span id="line-373"> memberSpy.submitSubprocedure(subproc);</span>
<span class="source-line-no">374</span><span id="line-374"> // if the operation doesn't die properly, then this will timeout</span>
<span class="source-line-no">375</span><span id="line-375"> memberSpy.closeAndWait(TIMEOUT);</span>
<span class="source-line-no">376</span><span id="line-376"></span>
<span class="source-line-no">377</span><span id="line-377"> // make sure everything ran in order</span>
<span class="source-line-no">378</span><span id="line-378"> InOrder order = inOrder(mockMemberComms, spy, dispSpy);</span>
<span class="source-line-no">379</span><span id="line-379"> // make sure we acquire.</span>
<span class="source-line-no">380</span><span id="line-380"> order.verify(spy).acquireBarrier();</span>
<span class="source-line-no">381</span><span id="line-381"> order.verify(mockMemberComms, never()).sendMemberAcquired(spy);</span>
<span class="source-line-no">382</span><span id="line-382"></span>
<span class="source-line-no">383</span><span id="line-383"> // TODO Need to do another refactor to get this to propagate to the coordinator.</span>
<span class="source-line-no">384</span><span id="line-384"> // make sure we pass a remote exception back the controller</span>
<span class="source-line-no">385</span><span id="line-385"> // order.verify(mockMemberComms).sendMemberAborted(eq(spy),</span>
<span class="source-line-no">386</span><span id="line-386"> // any());</span>
<span class="source-line-no">387</span><span id="line-387"> // order.verify(dispSpy).receiveError(anyString(),</span>
<span class="source-line-no">388</span><span id="line-388"> // any(), any());</span>
<span class="source-line-no">389</span><span id="line-389"> }</span>
<span class="source-line-no">390</span><span id="line-390"></span>
<span class="source-line-no">391</span><span id="line-391"> /**</span>
<span class="source-line-no">392</span><span id="line-392"> * Test that the cohort member correctly doesn't attempt to start a task when the builder cannot</span>
<span class="source-line-no">393</span><span id="line-393"> * correctly build a new task for the requested operation</span>
<span class="source-line-no">394</span><span id="line-394"> * @throws Exception on failure</span>
<span class="source-line-no">395</span><span id="line-395"> */</span>
<span class="source-line-no">396</span><span id="line-396"> @Test</span>
<span class="source-line-no">397</span><span id="line-397"> public void testNoTaskToBeRunFromRequest() throws Exception {</span>
<span class="source-line-no">398</span><span id="line-398"> ThreadPoolExecutor pool = mock(ThreadPoolExecutor.class);</span>
<span class="source-line-no">399</span><span id="line-399"> when(mockBuilder.buildSubprocedure(op, data)).thenReturn(null).thenThrow(</span>
<span class="source-line-no">400</span><span id="line-400"> new IllegalStateException("Wrong state!"),</span>
<span class="source-line-no">401</span><span id="line-401"> new IllegalArgumentException("can't understand the args"));</span>
<span class="source-line-no">402</span><span id="line-402"> member = new ProcedureMember(mockMemberComms, pool, mockBuilder);</span>
<span class="source-line-no">403</span><span id="line-403"> // builder returns null</span>
<span class="source-line-no">404</span><span id="line-404"> // build a new operation</span>
<span class="source-line-no">405</span><span id="line-405"> Subprocedure subproc = member.createSubprocedure(op, data);</span>
<span class="source-line-no">406</span><span id="line-406"> member.submitSubprocedure(subproc);</span>
<span class="source-line-no">407</span><span id="line-407"> // throws an illegal state exception</span>
<span class="source-line-no">408</span><span id="line-408"> try {</span>
<span class="source-line-no">409</span><span id="line-409"> // build a new operation</span>
<span class="source-line-no">410</span><span id="line-410"> Subprocedure subproc2 = member.createSubprocedure(op, data);</span>
<span class="source-line-no">411</span><span id="line-411"> member.submitSubprocedure(subproc2);</span>
<span class="source-line-no">412</span><span id="line-412"> } catch (IllegalStateException ise) {</span>
<span class="source-line-no">413</span><span id="line-413"> }</span>
<span class="source-line-no">414</span><span id="line-414"> // throws an illegal argument exception</span>
<span class="source-line-no">415</span><span id="line-415"> try {</span>
<span class="source-line-no">416</span><span id="line-416"> // build a new operation</span>
<span class="source-line-no">417</span><span id="line-417"> Subprocedure subproc3 = member.createSubprocedure(op, data);</span>
<span class="source-line-no">418</span><span id="line-418"> member.submitSubprocedure(subproc3);</span>
<span class="source-line-no">419</span><span id="line-419"> } catch (IllegalArgumentException iae) {</span>
<span class="source-line-no">420</span><span id="line-420"> }</span>
<span class="source-line-no">421</span><span id="line-421"></span>
<span class="source-line-no">422</span><span id="line-422"> // no request should reach the pool</span>
<span class="source-line-no">423</span><span id="line-423"> verifyNoInteractions(pool);</span>
<span class="source-line-no">424</span><span id="line-424"> // get two abort requests</span>
<span class="source-line-no">425</span><span id="line-425"> // TODO Need to do another refactor to get this to propagate to the coordinator.</span>
<span class="source-line-no">426</span><span id="line-426"> // verify(mockMemberComms, times(2)).sendMemberAborted(any(), any());</span>
<span class="source-line-no">427</span><span id="line-427"> }</span>
<span class="source-line-no">428</span><span id="line-428"></span>
<span class="source-line-no">429</span><span id="line-429"> /**</span>
<span class="source-line-no">430</span><span id="line-430"> * Helper {@link Procedure} who's phase for each step is just empty</span>
<span class="source-line-no">431</span><span id="line-431"> */</span>
<span class="source-line-no">432</span><span id="line-432"> public class EmptySubprocedure extends SubprocedureImpl {</span>
<span class="source-line-no">433</span><span id="line-433"> public EmptySubprocedure(ProcedureMember member, ForeignExceptionDispatcher dispatcher) {</span>
<span class="source-line-no">434</span><span id="line-434"> super(member, op, dispatcher,</span>
<span class="source-line-no">435</span><span id="line-435"> // TODO 1000000 is an arbitrary number that I picked.</span>
<span class="source-line-no">436</span><span id="line-436"> WAKE_FREQUENCY, TIMEOUT);</span>
<span class="source-line-no">437</span><span id="line-437"> }</span>
<span class="source-line-no">438</span><span id="line-438"> }</span>
<span class="source-line-no">439</span><span id="line-439">}</span>
</pre>
</div>
</main>
</body>
</html>