| <!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.client.locking, class: TestEntityLocks"> |
| <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.client.locking;</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">import static org.junit.Assert.assertFalse;</span> |
| <span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.assertTrue;</span> |
| <span class="source-line-no">023</span><span id="line-23">import static org.mockito.ArgumentMatchers.any;</span> |
| <span class="source-line-no">024</span><span id="line-24">import static org.mockito.ArgumentMatchers.eq;</span> |
| <span class="source-line-no">025</span><span id="line-25">import static org.mockito.ArgumentMatchers.isA;</span> |
| <span class="source-line-no">026</span><span id="line-26">import static org.mockito.Mockito.atLeastOnce;</span> |
| <span class="source-line-no">027</span><span id="line-27">import static org.mockito.Mockito.times;</span> |
| <span class="source-line-no">028</span><span id="line-28">import static org.mockito.Mockito.verify;</span> |
| <span class="source-line-no">029</span><span id="line-29">import static org.mockito.Mockito.when;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.concurrent.ThreadLocalRandom;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.Abortable;</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.HBaseConfiguration;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.HBaseIOException;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.PerClientRandomNonceGenerator;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.testclassification.ClientTests;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.testclassification.SmallTests;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.Threads;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.junit.Before;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.junit.ClassRule;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.junit.Test;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.junit.experimental.categories.Category;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.mockito.ArgumentCaptor;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.mockito.Mockito;</span> |
| <span class="source-line-no">049</span><span id="line-49">import org.slf4j.Logger;</span> |
| <span class="source-line-no">050</span><span id="line-50">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52">import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockHeartbeatRequest;</span> |
| <span class="source-line-no">055</span><span id="line-55">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockHeartbeatResponse;</span> |
| <span class="source-line-no">056</span><span id="line-56">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockRequest;</span> |
| <span class="source-line-no">057</span><span id="line-57">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockResponse;</span> |
| <span class="source-line-no">058</span><span id="line-58">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockService;</span> |
| <span class="source-line-no">059</span><span id="line-59">import org.apache.hadoop.hbase.shaded.protobuf.generated.LockServiceProtos.LockType;</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61">@Category({ ClientTests.class, SmallTests.class })</span> |
| <span class="source-line-no">062</span><span id="line-62">public class TestEntityLocks {</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> @ClassRule</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final HBaseClassTestRule CLASS_RULE =</span> |
| <span class="source-line-no">066</span><span id="line-66"> HBaseClassTestRule.forClass(TestEntityLocks.class);</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> private static final Logger LOG = LoggerFactory.getLogger(TestEntityLocks.class);</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> private final Configuration conf = HBaseConfiguration.create();</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> private final LockService.BlockingInterface master =</span> |
| <span class="source-line-no">073</span><span id="line-73"> Mockito.mock(LockService.BlockingInterface.class);</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> private LockServiceClient admin;</span> |
| <span class="source-line-no">076</span><span id="line-76"> private ArgumentCaptor<LockRequest> lockReqArgCaptor;</span> |
| <span class="source-line-no">077</span><span id="line-77"> private ArgumentCaptor<LockHeartbeatRequest> lockHeartbeatReqArgCaptor;</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> private static final LockHeartbeatResponse UNLOCKED_RESPONSE = LockHeartbeatResponse.newBuilder()</span> |
| <span class="source-line-no">080</span><span id="line-80"> .setLockStatus(LockHeartbeatResponse.LockStatus.UNLOCKED).build();</span> |
| <span class="source-line-no">081</span><span id="line-81"> // timeout such that worker thread waits for 500ms for each heartbeat.</span> |
| <span class="source-line-no">082</span><span id="line-82"> private static final LockHeartbeatResponse LOCKED_RESPONSE = LockHeartbeatResponse.newBuilder()</span> |
| <span class="source-line-no">083</span><span id="line-83"> .setLockStatus(LockHeartbeatResponse.LockStatus.LOCKED).setTimeoutMs(10000).build();</span> |
| <span class="source-line-no">084</span><span id="line-84"> private long procId;</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> // Setup mock admin.</span> |
| <span class="source-line-no">087</span><span id="line-87"> LockServiceClient getAdmin() throws Exception {</span> |
| <span class="source-line-no">088</span><span id="line-88"> conf.setInt("hbase.client.retries.number", 3);</span> |
| <span class="source-line-no">089</span><span id="line-89"> conf.setInt("hbase.client.pause", 1); // 1ms. Immediately retry rpc on failure.</span> |
| <span class="source-line-no">090</span><span id="line-90"> return new LockServiceClient(conf, master, PerClientRandomNonceGenerator.get());</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> @Before</span> |
| <span class="source-line-no">094</span><span id="line-94"> public void setUp() throws Exception {</span> |
| <span class="source-line-no">095</span><span id="line-95"> admin = getAdmin();</span> |
| <span class="source-line-no">096</span><span id="line-96"> lockReqArgCaptor = ArgumentCaptor.forClass(LockRequest.class);</span> |
| <span class="source-line-no">097</span><span id="line-97"> lockHeartbeatReqArgCaptor = ArgumentCaptor.forClass(LockHeartbeatRequest.class);</span> |
| <span class="source-line-no">098</span><span id="line-98"> procId = ThreadLocalRandom.current().nextLong();</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"> private boolean waitLockTimeOut(EntityLock lock, long maxWaitTimeMillis) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> long startMillis = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">103</span><span id="line-103"> while (lock.isLocked()) {</span> |
| <span class="source-line-no">104</span><span id="line-104"> LOG.info("Sleeping...");</span> |
| <span class="source-line-no">105</span><span id="line-105"> Threads.sleepWithoutInterrupt(100);</span> |
| <span class="source-line-no">106</span><span id="line-106"> if (!lock.isLocked()) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> return true;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"> if (EnvironmentEdgeManager.currentTime() - startMillis > maxWaitTimeMillis) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> LOG.info("Timedout...");</span> |
| <span class="source-line-no">111</span><span id="line-111"> return false;</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"> return true; // to make compiler happy.</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * Test basic lock function - requestLock, await, unlock.</span> |
| <span class="source-line-no">119</span><span id="line-119"> */</span> |
| <span class="source-line-no">120</span><span id="line-120"> @Test</span> |
| <span class="source-line-no">121</span><span id="line-121"> public void testEntityLock() throws Exception {</span> |
| <span class="source-line-no">122</span><span id="line-122"> final long procId = 100;</span> |
| <span class="source-line-no">123</span><span id="line-123"> final long workerSleepTime = 200; // in ms</span> |
| <span class="source-line-no">124</span><span id="line-124"> EntityLock lock = admin.namespaceLock("namespace", "description", null);</span> |
| <span class="source-line-no">125</span><span id="line-125"> lock.setTestingSleepTime(workerSleepTime);</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> when(master.requestLock(any(), any()))</span> |
| <span class="source-line-no">128</span><span id="line-128"> .thenReturn(LockResponse.newBuilder().setProcId(procId).build());</span> |
| <span class="source-line-no">129</span><span id="line-129"> when(master.lockHeartbeat(any(), any())).thenReturn(UNLOCKED_RESPONSE, UNLOCKED_RESPONSE,</span> |
| <span class="source-line-no">130</span><span id="line-130"> UNLOCKED_RESPONSE, LOCKED_RESPONSE);</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> lock.requestLock();</span> |
| <span class="source-line-no">133</span><span id="line-133"> // we return unlock response 3 times, so actual wait time should be around 2 * workerSleepTime</span> |
| <span class="source-line-no">134</span><span id="line-134"> lock.await(4 * workerSleepTime, TimeUnit.MILLISECONDS);</span> |
| <span class="source-line-no">135</span><span id="line-135"> assertTrue(lock.isLocked());</span> |
| <span class="source-line-no">136</span><span id="line-136"> lock.unlock();</span> |
| <span class="source-line-no">137</span><span id="line-137"> assertTrue(!lock.getWorker().isAlive());</span> |
| <span class="source-line-no">138</span><span id="line-138"> assertFalse(lock.isLocked());</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> // check LockRequest in requestLock()</span> |
| <span class="source-line-no">141</span><span id="line-141"> verify(master, times(1)).requestLock(any(), lockReqArgCaptor.capture());</span> |
| <span class="source-line-no">142</span><span id="line-142"> LockRequest request = lockReqArgCaptor.getValue();</span> |
| <span class="source-line-no">143</span><span id="line-143"> assertEquals("namespace", request.getNamespace());</span> |
| <span class="source-line-no">144</span><span id="line-144"> assertEquals("description", request.getDescription());</span> |
| <span class="source-line-no">145</span><span id="line-145"> assertEquals(LockType.EXCLUSIVE, request.getLockType());</span> |
| <span class="source-line-no">146</span><span id="line-146"> assertEquals(0, request.getRegionInfoCount());</span> |
| <span class="source-line-no">147</span><span id="line-147"></span> |
| <span class="source-line-no">148</span><span id="line-148"> // check LockHeartbeatRequest in lockHeartbeat()</span> |
| <span class="source-line-no">149</span><span id="line-149"> verify(master, atLeastOnce()).lockHeartbeat(any(), lockHeartbeatReqArgCaptor.capture());</span> |
| <span class="source-line-no">150</span><span id="line-150"> for (LockHeartbeatRequest req : lockHeartbeatReqArgCaptor.getAllValues()) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> assertEquals(procId, req.getProcId());</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"> /**</span> |
| <span class="source-line-no">156</span><span id="line-156"> * Test that abort is called when lock times out.</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 testEntityLockTimeout() throws Exception {</span> |
| <span class="source-line-no">160</span><span id="line-160"> final long workerSleepTime = 200; // in ms</span> |
| <span class="source-line-no">161</span><span id="line-161"> Abortable abortable = Mockito.mock(Abortable.class);</span> |
| <span class="source-line-no">162</span><span id="line-162"> EntityLock lock = admin.namespaceLock("namespace", "description", abortable);</span> |
| <span class="source-line-no">163</span><span id="line-163"> lock.setTestingSleepTime(workerSleepTime);</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> when(master.requestLock(any(), any()))</span> |
| <span class="source-line-no">166</span><span id="line-166"> .thenReturn(LockResponse.newBuilder().setProcId(procId).build());</span> |
| <span class="source-line-no">167</span><span id="line-167"> // Acquires the lock, but then it times out (since we don't call unlock() on it).</span> |
| <span class="source-line-no">168</span><span id="line-168"> when(master.lockHeartbeat(any(), any())).thenReturn(LOCKED_RESPONSE, UNLOCKED_RESPONSE);</span> |
| <span class="source-line-no">169</span><span id="line-169"></span> |
| <span class="source-line-no">170</span><span id="line-170"> lock.requestLock();</span> |
| <span class="source-line-no">171</span><span id="line-171"> lock.await();</span> |
| <span class="source-line-no">172</span><span id="line-172"> assertTrue(lock.isLocked());</span> |
| <span class="source-line-no">173</span><span id="line-173"> // Should get unlocked in next heartbeat i.e. after workerSleepTime. Wait 10x time to be sure.</span> |
| <span class="source-line-no">174</span><span id="line-174"> assertTrue(waitLockTimeOut(lock, 10 * workerSleepTime));</span> |
| <span class="source-line-no">175</span><span id="line-175"></span> |
| <span class="source-line-no">176</span><span id="line-176"> // Works' run() returns, there is a small gap that the thread is still alive(os</span> |
| <span class="source-line-no">177</span><span id="line-177"> // has not declare it is dead yet), so remove the following assertion.</span> |
| <span class="source-line-no">178</span><span id="line-178"> // assertFalse(lock.getWorker().isAlive());</span> |
| <span class="source-line-no">179</span><span id="line-179"> verify(abortable, times(1)).abort(any(), eq(null));</span> |
| <span class="source-line-no">180</span><span id="line-180"> }</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"> * Test that abort is called when lockHeartbeat fails with IOException.</span> |
| <span class="source-line-no">184</span><span id="line-184"> */</span> |
| <span class="source-line-no">185</span><span id="line-185"> @Test</span> |
| <span class="source-line-no">186</span><span id="line-186"> public void testHeartbeatException() throws Exception {</span> |
| <span class="source-line-no">187</span><span id="line-187"> final long workerSleepTime = 100; // in ms</span> |
| <span class="source-line-no">188</span><span id="line-188"> Abortable abortable = Mockito.mock(Abortable.class);</span> |
| <span class="source-line-no">189</span><span id="line-189"> EntityLock lock = admin.namespaceLock("namespace", "description", abortable);</span> |
| <span class="source-line-no">190</span><span id="line-190"> lock.setTestingSleepTime(workerSleepTime);</span> |
| <span class="source-line-no">191</span><span id="line-191"></span> |
| <span class="source-line-no">192</span><span id="line-192"> when(master.requestLock(any(), any()))</span> |
| <span class="source-line-no">193</span><span id="line-193"> .thenReturn(LockResponse.newBuilder().setProcId(procId).build());</span> |
| <span class="source-line-no">194</span><span id="line-194"> when(master.lockHeartbeat(any(), any())).thenReturn(LOCKED_RESPONSE)</span> |
| <span class="source-line-no">195</span><span id="line-195"> .thenThrow(new ServiceException("Failed heartbeat!"));</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> lock.requestLock();</span> |
| <span class="source-line-no">198</span><span id="line-198"> lock.await();</span> |
| <span class="source-line-no">199</span><span id="line-199"> assertTrue(waitLockTimeOut(lock, 100 * workerSleepTime));</span> |
| <span class="source-line-no">200</span><span id="line-200"> while (lock.getWorker().isAlive()) {</span> |
| <span class="source-line-no">201</span><span id="line-201"> TimeUnit.MILLISECONDS.sleep(100);</span> |
| <span class="source-line-no">202</span><span id="line-202"> }</span> |
| <span class="source-line-no">203</span><span id="line-203"> verify(abortable, times(1)).abort(any(), isA(HBaseIOException.class));</span> |
| <span class="source-line-no">204</span><span id="line-204"> assertFalse(lock.getWorker().isAlive());</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
