blob: 9cb657253aee95b6757a501dd648f89104b4902d [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.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.hamcrest.CoreMatchers.instanceOf;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.hamcrest.MatcherAssert.assertThat;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.assertArrayEquals;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import static org.junit.Assert.assertTrue;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import static org.junit.Assert.fail;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.IOException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Optional;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.TableName;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.coprocessor.ObserverContext;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessor;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.coprocessor.RegionObserver;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.exceptions.ScannerResetException;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.InternalScanner;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.testclassification.ClientTests;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.AfterClass;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.Before;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.BeforeClass;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.ClassRule;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.junit.Test;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.junit.experimental.categories.Category;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hbase.thirdparty.com.google.common.io.Closeables;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>@Category({ MediumTests.class, ClientTests.class })<a name="line.52"></a>
<span class="sourceLineNo">053</span>public class TestAsyncTableScanException {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> @ClassRule<a name="line.55"></a>
<span class="sourceLineNo">056</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.56"></a>
<span class="sourceLineNo">057</span> HBaseClassTestRule.forClass(TestAsyncTableScanException.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> private static final HBaseTestingUtil UTIL = new HBaseTestingUtil();<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> private static TableName TABLE_NAME = TableName.valueOf("scan");<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private static byte[] FAMILY = Bytes.toBytes("family");<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private static byte[] QUAL = Bytes.toBytes("qual");<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private static AsyncConnection CONN;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> private static AtomicInteger REQ_COUNT = new AtomicInteger();<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> private static volatile int ERROR_AT;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> private static volatile boolean ERROR;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> private static volatile boolean DO_NOT_RETRY;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> private static final int ROW_COUNT = 100;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> public static final class ErrorCP implements RegionObserver, RegionCoprocessor {<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public Optional&lt;RegionObserver&gt; getRegionObserver() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return Optional.of(this);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span> public boolean postScannerNext(ObserverContext&lt;RegionCoprocessorEnvironment&gt; c,<a name="line.87"></a>
<span class="sourceLineNo">088</span> InternalScanner s, List&lt;Result&gt; result, int limit, boolean hasNext) throws IOException {<a name="line.88"></a>
<span class="sourceLineNo">089</span> REQ_COUNT.incrementAndGet();<a name="line.89"></a>
<span class="sourceLineNo">090</span> if ((ERROR_AT == REQ_COUNT.get()) || ERROR) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (DO_NOT_RETRY) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> throw new DoNotRetryIOException("Injected exception");<a name="line.92"></a>
<span class="sourceLineNo">093</span> } else {<a name="line.93"></a>
<span class="sourceLineNo">094</span> throw new IOException("Injected exception");<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> return RegionObserver.super.postScannerNext(c, s, result, limit, hasNext);<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><a name="line.101"></a>
<span class="sourceLineNo">102</span> @BeforeClass<a name="line.102"></a>
<span class="sourceLineNo">103</span> public static void setUp() throws Exception {<a name="line.103"></a>
<span class="sourceLineNo">104</span> UTIL.startMiniCluster(1);<a name="line.104"></a>
<span class="sourceLineNo">105</span> UTIL.getAdmin()<a name="line.105"></a>
<span class="sourceLineNo">106</span> .createTable(TableDescriptorBuilder.newBuilder(TABLE_NAME)<a name="line.106"></a>
<span class="sourceLineNo">107</span> .setColumnFamily(ColumnFamilyDescriptorBuilder.of(FAMILY))<a name="line.107"></a>
<span class="sourceLineNo">108</span> .setCoprocessor(ErrorCP.class.getName()).build());<a name="line.108"></a>
<span class="sourceLineNo">109</span> try (Table table = UTIL.getConnection().getTable(TABLE_NAME)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> for (int i = 0; i &lt; ROW_COUNT; i++) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> table.put(new Put(Bytes.toBytes(i)).addColumn(FAMILY, QUAL, Bytes.toBytes(i)));<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> CONN = ConnectionFactory.createAsyncConnection(UTIL.getConfiguration()).get();<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> @AfterClass<a name="line.117"></a>
<span class="sourceLineNo">118</span> public static void tearDown() throws Exception {<a name="line.118"></a>
<span class="sourceLineNo">119</span> Closeables.close(CONN, true);<a name="line.119"></a>
<span class="sourceLineNo">120</span> UTIL.shutdownMiniCluster();<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> @Before<a name="line.123"></a>
<span class="sourceLineNo">124</span> public void setUpBeforeTest() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> REQ_COUNT.set(0);<a name="line.125"></a>
<span class="sourceLineNo">126</span> ERROR_AT = 0;<a name="line.126"></a>
<span class="sourceLineNo">127</span> ERROR = false;<a name="line.127"></a>
<span class="sourceLineNo">128</span> DO_NOT_RETRY = false;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> @Test(expected = DoNotRetryIOException.class)<a name="line.131"></a>
<span class="sourceLineNo">132</span> public void testDoNotRetryIOException() throws IOException {<a name="line.132"></a>
<span class="sourceLineNo">133</span> ERROR_AT = 1;<a name="line.133"></a>
<span class="sourceLineNo">134</span> DO_NOT_RETRY = true;<a name="line.134"></a>
<span class="sourceLineNo">135</span> try (ResultScanner scanner = CONN.getTable(TABLE_NAME).getScanner(FAMILY)) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> scanner.next();<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> @Test<a name="line.140"></a>
<span class="sourceLineNo">141</span> public void testIOException() throws IOException {<a name="line.141"></a>
<span class="sourceLineNo">142</span> ERROR = true;<a name="line.142"></a>
<span class="sourceLineNo">143</span> try (ResultScanner scanner =<a name="line.143"></a>
<span class="sourceLineNo">144</span> CONN.getTableBuilder(TABLE_NAME).setMaxAttempts(3).build().getScanner(FAMILY)) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> scanner.next();<a name="line.145"></a>
<span class="sourceLineNo">146</span> fail();<a name="line.146"></a>
<span class="sourceLineNo">147</span> } catch (RetriesExhaustedException e) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> // expected<a name="line.148"></a>
<span class="sourceLineNo">149</span> assertThat(e.getCause(), instanceOf(ScannerResetException.class));<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> assertTrue(REQ_COUNT.get() &gt;= 3);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> private void count() throws IOException {<a name="line.154"></a>
<span class="sourceLineNo">155</span> try (ResultScanner scanner = CONN.getTable(TABLE_NAME).getScanner(new Scan().setCaching(1))) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> for (int i = 0; i &lt; ROW_COUNT; i++) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> Result result = scanner.next();<a name="line.157"></a>
<span class="sourceLineNo">158</span> assertArrayEquals(Bytes.toBytes(i), result.getRow());<a name="line.158"></a>
<span class="sourceLineNo">159</span> assertArrayEquals(Bytes.toBytes(i), result.getValue(FAMILY, QUAL));<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Test<a name="line.164"></a>
<span class="sourceLineNo">165</span> public void testRecoveryFromScannerResetWhileOpening() throws IOException {<a name="line.165"></a>
<span class="sourceLineNo">166</span> ERROR_AT = 1;<a name="line.166"></a>
<span class="sourceLineNo">167</span> count();<a name="line.167"></a>
<span class="sourceLineNo">168</span> // we should at least request 1 time otherwise the error will not be triggered, and then we<a name="line.168"></a>
<span class="sourceLineNo">169</span> // need at least one more request to get the remaining results.<a name="line.169"></a>
<span class="sourceLineNo">170</span> assertTrue(REQ_COUNT.get() &gt;= 2);<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> @Test<a name="line.173"></a>
<span class="sourceLineNo">174</span> public void testRecoveryFromScannerResetInTheMiddle() throws IOException {<a name="line.174"></a>
<span class="sourceLineNo">175</span> ERROR_AT = 2;<a name="line.175"></a>
<span class="sourceLineNo">176</span> count();<a name="line.176"></a>
<span class="sourceLineNo">177</span> // we should at least request 2 times otherwise the error will not be triggered, and then we<a name="line.177"></a>
<span class="sourceLineNo">178</span> // need at least one more request to get the remaining results.<a name="line.178"></a>
<span class="sourceLineNo">179</span> assertTrue(REQ_COUNT.get() &gt;= 3);<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span>}<a name="line.181"></a>
</pre>
</div>
</body>
</html>