blob: 01ccf3a2b7caf7f1ce167b3f3080c0d558237d24 [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.client, class: TestClientTimeouts, class: RandomTimeoutRpcChannel">
<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;</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.assertTrue;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span>
<span class="source-line-no">024</span><span id="line-24">import java.net.SocketAddress;</span>
<span class="source-line-no">025</span><span id="line-25">import java.net.SocketTimeoutException;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Map;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.ThreadLocalRandom;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.atomic.AtomicInteger;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.HBaseConfiguration;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.ipc.AbstractRpcClient;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.ipc.BlockingRpcClient;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.ipc.HBaseRpcController;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.ipc.RpcClientFactory;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.net.Address;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.testclassification.ClientTests;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.testclassification.MediumTests;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.AfterClass;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.BeforeClass;</span>
<span class="source-line-no">045</span><span id="line-45">import org.junit.ClassRule;</span>
<span class="source-line-no">046</span><span id="line-46">import org.junit.Test;</span>
<span class="source-line-no">047</span><span id="line-47">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49">import org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel;</span>
<span class="source-line-no">050</span><span id="line-50">import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor;</span>
<span class="source-line-no">051</span><span id="line-51">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span>
<span class="source-line-no">052</span><span id="line-52">import org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback;</span>
<span class="source-line-no">053</span><span id="line-53">import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;</span>
<span class="source-line-no">054</span><span id="line-54">import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;</span>
<span class="source-line-no">055</span><span id="line-55">import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57">@Category({ MediumTests.class, ClientTests.class })</span>
<span class="source-line-no">058</span><span id="line-58">public class TestClientTimeouts {</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> @ClassRule</span>
<span class="source-line-no">061</span><span id="line-61"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">062</span><span id="line-62"> HBaseClassTestRule.forClass(TestClientTimeouts.class);</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> private final static HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();</span>
<span class="source-line-no">065</span><span id="line-65"> protected static int SLAVES = 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"> @BeforeClass</span>
<span class="source-line-no">068</span><span id="line-68"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">069</span><span id="line-69"> TEST_UTIL.startMiniCluster(SLAVES);</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> @AfterClass</span>
<span class="source-line-no">073</span><span id="line-73"> public static void tearDownAfterClass() throws Exception {</span>
<span class="source-line-no">074</span><span id="line-74"> TEST_UTIL.shutdownMiniCluster();</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> private Connection createConnection() {</span>
<span class="source-line-no">078</span><span id="line-78"> // Ensure the HBaseAdmin uses a new connection by changing Configuration.</span>
<span class="source-line-no">079</span><span id="line-79"> Configuration conf = HBaseConfiguration.create(TEST_UTIL.getConfiguration());</span>
<span class="source-line-no">080</span><span id="line-80"> // Set the custom RPC client with random timeouts as the client</span>
<span class="source-line-no">081</span><span id="line-81"> conf.set(RpcClientFactory.CUSTOM_RPC_CLIENT_IMPL_CONF_KEY,</span>
<span class="source-line-no">082</span><span id="line-82"> RandomTimeoutRpcClient.class.getName());</span>
<span class="source-line-no">083</span><span id="line-83"> conf.set(HConstants.HBASE_CLIENT_INSTANCE_ID, String.valueOf(-1));</span>
<span class="source-line-no">084</span><span id="line-84"> for (;;) {</span>
<span class="source-line-no">085</span><span id="line-85"> try {</span>
<span class="source-line-no">086</span><span id="line-86"> return ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">087</span><span id="line-87"> } catch (IOException e) {</span>
<span class="source-line-no">088</span><span id="line-88"> // since we randomly throw SocketTimeoutException, it is possible that we fail when creating</span>
<span class="source-line-no">089</span><span id="line-89"> // the Connection, but this is not what we want to test here, so just ignore it and try</span>
<span class="source-line-no">090</span><span id="line-90"> // again</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"> }</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"> * Test that a client that fails an RPC to the master retries properly and doesn't throw any</span>
<span class="source-line-no">097</span><span id="line-97"> * unexpected exceptions.</span>
<span class="source-line-no">098</span><span id="line-98"> */</span>
<span class="source-line-no">099</span><span id="line-99"> @Test</span>
<span class="source-line-no">100</span><span id="line-100"> public void testAdminTimeout() throws Exception {</span>
<span class="source-line-no">101</span><span id="line-101"> try (Connection conn = createConnection(); Admin admin = conn.getAdmin()) {</span>
<span class="source-line-no">102</span><span id="line-102"> int initialInvocations = invokations.get();</span>
<span class="source-line-no">103</span><span id="line-103"> boolean balanceEnabled = admin.isBalancerEnabled();</span>
<span class="source-line-no">104</span><span id="line-104"> for (int i = 0; i &lt; 5; i++) {</span>
<span class="source-line-no">105</span><span id="line-105"> assertEquals(balanceEnabled, admin.balancerSwitch(!balanceEnabled, false));</span>
<span class="source-line-no">106</span><span id="line-106"> balanceEnabled = !balanceEnabled;</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"> // Ensure the RandomTimeoutRpcEngine is actually being used.</span>
<span class="source-line-no">109</span><span id="line-109"> assertTrue(invokations.get() &gt; initialInvocations);</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"> /**</span>
<span class="source-line-no">114</span><span id="line-114"> * Rpc Channel implementation with RandomTimeoutBlockingRpcChannel</span>
<span class="source-line-no">115</span><span id="line-115"> */</span>
<span class="source-line-no">116</span><span id="line-116"> public static class RandomTimeoutRpcClient extends BlockingRpcClient {</span>
<span class="source-line-no">117</span><span id="line-117"> public RandomTimeoutRpcClient(Configuration conf, String clusterId, SocketAddress localAddr,</span>
<span class="source-line-no">118</span><span id="line-118"> MetricsConnection metrics, Map&lt;String, byte[]&gt; connectionAttributes) {</span>
<span class="source-line-no">119</span><span id="line-119"> super(conf, clusterId, localAddr, metrics, connectionAttributes);</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> // Return my own instance, one that does random timeouts</span>
<span class="source-line-no">123</span><span id="line-123"> @Override</span>
<span class="source-line-no">124</span><span id="line-124"> public BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User ticket, int rpcTimeout) {</span>
<span class="source-line-no">125</span><span id="line-125"> return new RandomTimeoutBlockingRpcChannel(this, sn, ticket, rpcTimeout);</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> @Override</span>
<span class="source-line-no">129</span><span id="line-129"> public RpcChannel createRpcChannel(ServerName sn, User ticket, int rpcTimeout) {</span>
<span class="source-line-no">130</span><span id="line-130"> return new RandomTimeoutRpcChannel(this, sn, ticket, rpcTimeout);</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"> }</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> private static AtomicInteger invokations = new AtomicInteger();</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> private static final double CHANCE_OF_TIMEOUT = 0.3;</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> /**</span>
<span class="source-line-no">139</span><span id="line-139"> * Blocking rpc channel that goes via hbase rpc.</span>
<span class="source-line-no">140</span><span id="line-140"> */</span>
<span class="source-line-no">141</span><span id="line-141"> private static class RandomTimeoutBlockingRpcChannel</span>
<span class="source-line-no">142</span><span id="line-142"> extends AbstractRpcClient.BlockingRpcChannelImplementation {</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> RandomTimeoutBlockingRpcChannel(BlockingRpcClient rpcClient, ServerName sn, User ticket,</span>
<span class="source-line-no">145</span><span id="line-145"> int rpcTimeout) {</span>
<span class="source-line-no">146</span><span id="line-146"> super(rpcClient, Address.fromParts(sn.getHostname(), sn.getPort()), ticket, rpcTimeout);</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> @Override</span>
<span class="source-line-no">150</span><span id="line-150"> public Message callBlockingMethod(MethodDescriptor md, RpcController controller, Message param,</span>
<span class="source-line-no">151</span><span id="line-151"> Message returnType) throws ServiceException {</span>
<span class="source-line-no">152</span><span id="line-152"> invokations.getAndIncrement();</span>
<span class="source-line-no">153</span><span id="line-153"> if (ThreadLocalRandom.current().nextFloat() &lt; CHANCE_OF_TIMEOUT) {</span>
<span class="source-line-no">154</span><span id="line-154"> // throw a ServiceException, becuase that is the only exception type that</span>
<span class="source-line-no">155</span><span id="line-155"> // {@link ProtobufRpcEngine} throws. If this RpcEngine is used with a different</span>
<span class="source-line-no">156</span><span id="line-156"> // "actual" type, this may not properly mimic the underlying RpcEngine.</span>
<span class="source-line-no">157</span><span id="line-157"> throw new ServiceException(new SocketTimeoutException("fake timeout"));</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"> return super.callBlockingMethod(md, controller, param, returnType);</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> private static class RandomTimeoutRpcChannel extends AbstractRpcClient.RpcChannelImplementation {</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> RandomTimeoutRpcChannel(AbstractRpcClient&lt;?&gt; rpcClient, ServerName sn, User ticket,</span>
<span class="source-line-no">166</span><span id="line-166"> int rpcTimeout) {</span>
<span class="source-line-no">167</span><span id="line-167"> super(rpcClient, Address.fromParts(sn.getHostname(), sn.getPort()), ticket, rpcTimeout);</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> @Override</span>
<span class="source-line-no">171</span><span id="line-171"> public void callMethod(MethodDescriptor md, RpcController controller, Message param,</span>
<span class="source-line-no">172</span><span id="line-172"> Message returnType, RpcCallback&lt;Message&gt; done) {</span>
<span class="source-line-no">173</span><span id="line-173"> invokations.getAndIncrement();</span>
<span class="source-line-no">174</span><span id="line-174"> if (ThreadLocalRandom.current().nextFloat() &lt; CHANCE_OF_TIMEOUT) {</span>
<span class="source-line-no">175</span><span id="line-175"> // throw a ServiceException, because that is the only exception type that</span>
<span class="source-line-no">176</span><span id="line-176"> // {@link ProtobufRpcEngine} throws. If this RpcEngine is used with a different</span>
<span class="source-line-no">177</span><span id="line-177"> // "actual" type, this may not properly mimic the underlying RpcEngine.</span>
<span class="source-line-no">178</span><span id="line-178"> ((HBaseRpcController) controller).setFailed(new SocketTimeoutException("fake timeout"));</span>
<span class="source-line-no">179</span><span id="line-179"> done.run(null);</span>
<span class="source-line-no">180</span><span id="line-180"> return;</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"> super.callMethod(md, controller, param, returnType, done);</span>
<span class="source-line-no">183</span><span id="line-183"> }</span>
<span class="source-line-no">184</span><span id="line-184"> }</span>
<span class="source-line-no">185</span><span id="line-185">}</span>
</pre>
</div>
</main>
</body>
</html>