blob: c9e08d52e83d9e36bbbd5fa14a94b1cfbb22184a [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.ipc, class: TestIPCUtil">
<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.ipc;</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.hamcrest.CoreMatchers.instanceOf;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.hamcrest.MatcherAssert.assertThat;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.assertFalse;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.junit.Assert.assertTrue;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">import java.io.IOException;</span>
<span class="source-line-no">026</span><span id="line-26">import java.lang.reflect.Constructor;</span>
<span class="source-line-no">027</span><span id="line-27">import java.lang.reflect.InvocationTargetException;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.ArrayList;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.List;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">031</span><span id="line-31">import java.util.concurrent.TimeoutException;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.commons.lang3.mutable.MutableInt;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.RegionInfoBuilder;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.exceptions.ClientExceptionsUtil;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.exceptions.TimeoutIOException;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.net.Address;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.testclassification.ClientTests;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.testclassification.SmallTests;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.util.FutureUtils;</span>
<span class="source-line-no">041</span><span id="line-41">import org.junit.ClassRule;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.Test;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hbase.thirdparty.io.netty.channel.DefaultEventLoop;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hbase.thirdparty.io.netty.channel.EventLoop;</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ExceptionResponse;</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50">@Category({ ClientTests.class, SmallTests.class })</span>
<span class="source-line-no">051</span><span id="line-51">public class TestIPCUtil {</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> @ClassRule</span>
<span class="source-line-no">054</span><span id="line-54"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">055</span><span id="line-55"> HBaseClassTestRule.forClass(TestIPCUtil.class);</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> private static Throwable create(Class&lt;? extends Throwable&gt; clazz) throws InstantiationException,</span>
<span class="source-line-no">058</span><span id="line-58"> IllegalAccessException, InvocationTargetException, NoSuchMethodException {</span>
<span class="source-line-no">059</span><span id="line-59"> try {</span>
<span class="source-line-no">060</span><span id="line-60"> Constructor&lt;? extends Throwable&gt; c = clazz.getDeclaredConstructor();</span>
<span class="source-line-no">061</span><span id="line-61"> c.setAccessible(true);</span>
<span class="source-line-no">062</span><span id="line-62"> return c.newInstance();</span>
<span class="source-line-no">063</span><span id="line-63"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">064</span><span id="line-64"> // fall through</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> try {</span>
<span class="source-line-no">068</span><span id="line-68"> Constructor&lt;? extends Throwable&gt; c = clazz.getDeclaredConstructor(String.class);</span>
<span class="source-line-no">069</span><span id="line-69"> c.setAccessible(true);</span>
<span class="source-line-no">070</span><span id="line-70"> return c.newInstance("error");</span>
<span class="source-line-no">071</span><span id="line-71"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">072</span><span id="line-72"> // fall through</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> try {</span>
<span class="source-line-no">076</span><span id="line-76"> Constructor&lt;? extends Throwable&gt; c = clazz.getDeclaredConstructor(Throwable.class);</span>
<span class="source-line-no">077</span><span id="line-77"> c.setAccessible(true);</span>
<span class="source-line-no">078</span><span id="line-78"> return c.newInstance(new Exception("error"));</span>
<span class="source-line-no">079</span><span id="line-79"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">080</span><span id="line-80"> // fall through</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> try {</span>
<span class="source-line-no">084</span><span id="line-84"> Constructor&lt;? extends Throwable&gt; c =</span>
<span class="source-line-no">085</span><span id="line-85"> clazz.getDeclaredConstructor(String.class, Throwable.class);</span>
<span class="source-line-no">086</span><span id="line-86"> c.setAccessible(true);</span>
<span class="source-line-no">087</span><span id="line-87"> return c.newInstance("error", new Exception("error"));</span>
<span class="source-line-no">088</span><span id="line-88"> } catch (NoSuchMethodException e) {</span>
<span class="source-line-no">089</span><span id="line-89"> // fall through</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> Constructor&lt;? extends Throwable&gt; c =</span>
<span class="source-line-no">093</span><span id="line-93"> clazz.getDeclaredConstructor(Throwable.class, Throwable.class);</span>
<span class="source-line-no">094</span><span id="line-94"> c.setAccessible(true);</span>
<span class="source-line-no">095</span><span id="line-95"> return c.newInstance(new Exception("error"), "error");</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> /**</span>
<span class="source-line-no">099</span><span id="line-99"> * See HBASE-21862, it is important to keep original exception type for connection exceptions.</span>
<span class="source-line-no">100</span><span id="line-100"> */</span>
<span class="source-line-no">101</span><span id="line-101"> @Test</span>
<span class="source-line-no">102</span><span id="line-102"> public void testWrapConnectionException() throws Exception {</span>
<span class="source-line-no">103</span><span id="line-103"> List&lt;Throwable&gt; exceptions = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">104</span><span id="line-104"> for (Class&lt;? extends Throwable&gt; clazz : ClientExceptionsUtil.getConnectionExceptionTypes()) {</span>
<span class="source-line-no">105</span><span id="line-105"> exceptions.add(create(clazz));</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> Address addr = Address.fromParts("127.0.0.1", 12345);</span>
<span class="source-line-no">108</span><span id="line-108"> for (Throwable exception : exceptions) {</span>
<span class="source-line-no">109</span><span id="line-109"> if (exception instanceof TimeoutException) {</span>
<span class="source-line-no">110</span><span id="line-110"> assertThat(IPCUtil.wrapException(addr, null, exception),</span>
<span class="source-line-no">111</span><span id="line-111"> instanceOf(TimeoutIOException.class));</span>
<span class="source-line-no">112</span><span id="line-112"> } else {</span>
<span class="source-line-no">113</span><span id="line-113"> IOException ioe =</span>
<span class="source-line-no">114</span><span id="line-114"> IPCUtil.wrapException(addr, RegionInfoBuilder.FIRST_META_REGIONINFO, exception);</span>
<span class="source-line-no">115</span><span id="line-115"> // Assert that the exception contains the Region name if supplied. HBASE-25735.</span>
<span class="source-line-no">116</span><span id="line-116"> // Not all exceptions get the region stuffed into it.</span>
<span class="source-line-no">117</span><span id="line-117"> if (ioe.getMessage() != null) {</span>
<span class="source-line-no">118</span><span id="line-118"> assertTrue(ioe.getMessage()</span>
<span class="source-line-no">119</span><span id="line-119"> .contains(RegionInfoBuilder.FIRST_META_REGIONINFO.getRegionNameAsString()));</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"> assertThat(ioe, instanceOf(exception.getClass()));</span>
<span class="source-line-no">122</span><span id="line-122"> }</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</span>
<span class="source-line-no">127</span><span id="line-127"> public void testExecute() throws Exception {</span>
<span class="source-line-no">128</span><span id="line-128"> EventLoop eventLoop = new DefaultEventLoop();</span>
<span class="source-line-no">129</span><span id="line-129"> MutableInt executed = new MutableInt(0);</span>
<span class="source-line-no">130</span><span id="line-130"> MutableInt numStackTraceElements = new MutableInt(0);</span>
<span class="source-line-no">131</span><span id="line-131"> CompletableFuture&lt;Void&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">132</span><span id="line-132"> try {</span>
<span class="source-line-no">133</span><span id="line-133"> IPCUtil.execute(eventLoop, new Runnable() {</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> @Override</span>
<span class="source-line-no">136</span><span id="line-136"> public void run() {</span>
<span class="source-line-no">137</span><span id="line-137"> int numElements = new Exception().getStackTrace().length;</span>
<span class="source-line-no">138</span><span id="line-138"> int depth = executed.getAndIncrement();</span>
<span class="source-line-no">139</span><span id="line-139"> if (depth &lt;= IPCUtil.MAX_DEPTH) {</span>
<span class="source-line-no">140</span><span id="line-140"> if (numElements &lt;= numStackTraceElements.intValue()) {</span>
<span class="source-line-no">141</span><span id="line-141"> future.completeExceptionally(</span>
<span class="source-line-no">142</span><span id="line-142"> new AssertionError("should call run directly but stack trace decreased from "</span>
<span class="source-line-no">143</span><span id="line-143"> + numStackTraceElements.intValue() + " to " + numElements));</span>
<span class="source-line-no">144</span><span id="line-144"> return;</span>
<span class="source-line-no">145</span><span id="line-145"> }</span>
<span class="source-line-no">146</span><span id="line-146"> numStackTraceElements.setValue(numElements);</span>
<span class="source-line-no">147</span><span id="line-147"> IPCUtil.execute(eventLoop, this);</span>
<span class="source-line-no">148</span><span id="line-148"> } else {</span>
<span class="source-line-no">149</span><span id="line-149"> if (numElements &gt;= numStackTraceElements.intValue()) {</span>
<span class="source-line-no">150</span><span id="line-150"> future.completeExceptionally(</span>
<span class="source-line-no">151</span><span id="line-151"> new AssertionError("should call eventLoop.execute to prevent stack overflow but"</span>
<span class="source-line-no">152</span><span id="line-152"> + " stack trace increased from " + numStackTraceElements.intValue() + " to "</span>
<span class="source-line-no">153</span><span id="line-153"> + numElements));</span>
<span class="source-line-no">154</span><span id="line-154"> } else {</span>
<span class="source-line-no">155</span><span id="line-155"> future.complete(null);</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"> });</span>
<span class="source-line-no">160</span><span id="line-160"> FutureUtils.get(future);</span>
<span class="source-line-no">161</span><span id="line-161"> } finally {</span>
<span class="source-line-no">162</span><span id="line-162"> eventLoop.shutdownGracefully().get();</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"></span>
<span class="source-line-no">166</span><span id="line-166"> @Test</span>
<span class="source-line-no">167</span><span id="line-167"> public void testIsFatalConnectionException() {</span>
<span class="source-line-no">168</span><span id="line-168"> // intentionally not reference the class object directly, so here we will not load the class, to</span>
<span class="source-line-no">169</span><span id="line-169"> // make sure that in isFatalConnectionException, we can use initialized = false when calling</span>
<span class="source-line-no">170</span><span id="line-170"> // Class.forName</span>
<span class="source-line-no">171</span><span id="line-171"> ExceptionResponse resp = ExceptionResponse.newBuilder()</span>
<span class="source-line-no">172</span><span id="line-172"> .setExceptionClassName("org.apache.hadoop.hbase.ipc.DummyFatalConnectionException").build();</span>
<span class="source-line-no">173</span><span id="line-173"> assertTrue(IPCUtil.isFatalConnectionException(resp));</span>
<span class="source-line-no">174</span><span id="line-174"></span>
<span class="source-line-no">175</span><span id="line-175"> resp = ExceptionResponse.newBuilder()</span>
<span class="source-line-no">176</span><span id="line-176"> .setExceptionClassName("org.apache.hadoop.hbase.ipc.DummyException").build();</span>
<span class="source-line-no">177</span><span id="line-177"> assertFalse(IPCUtil.isFatalConnectionException(resp));</span>
<span class="source-line-no">178</span><span id="line-178"></span>
<span class="source-line-no">179</span><span id="line-179"> // class not found</span>
<span class="source-line-no">180</span><span id="line-180"> resp = ExceptionResponse.newBuilder()</span>
<span class="source-line-no">181</span><span id="line-181"> .setExceptionClassName("org.apache.hadoop.hbase.ipc.WhatEver").build();</span>
<span class="source-line-no">182</span><span id="line-182"> assertFalse(IPCUtil.isFatalConnectionException(resp));</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>
</pre>
</div>
</main>
</body>
</html>