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