blob: 10a922e4bfa093b0577a08d840201a00920ce304 [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.coprocessor;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.fail;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseTestingUtility;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.HConstants;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.MiniHBaseCluster;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.Waiter.Predicate;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.Durability;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.Put;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Table;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.regionserver.HRegionServer;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.testclassification.CoprocessorTests;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.junit.Assert;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.junit.ClassRule;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.junit.Test;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.experimental.categories.Category;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.slf4j.Logger;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.slf4j.LoggerFactory;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>/**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Tests unhandled exceptions thrown by coprocessors running on a regionserver..<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Expected result is that the regionserver will abort with an informative<a name="line.48"></a>
<span class="sourceLineNo">049</span> * error message describing the set of its loaded coprocessors for crash<a name="line.49"></a>
<span class="sourceLineNo">050</span> * diagnosis. (HBASE-4014).<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span>@Category({CoprocessorTests.class, MediumTests.class})<a name="line.52"></a>
<span class="sourceLineNo">053</span>public class TestRegionServerCoprocessorExceptionWithAbort {<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(TestRegionServerCoprocessorExceptionWithAbort.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> private static final Logger LOG = LoggerFactory.getLogger(<a name="line.59"></a>
<span class="sourceLineNo">060</span> TestRegionServerCoprocessorExceptionWithAbort.class);<a name="line.60"></a>
<span class="sourceLineNo">061</span> private static final HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();<a name="line.61"></a>
<span class="sourceLineNo">062</span> private static final TableName TABLE_NAME = TableName.valueOf("observed_table");<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> @Test<a name="line.64"></a>
<span class="sourceLineNo">065</span> public void testExceptionDuringInitialization() throws Exception {<a name="line.65"></a>
<span class="sourceLineNo">066</span> Configuration conf = TEST_UTIL.getConfiguration();<a name="line.66"></a>
<span class="sourceLineNo">067</span> conf.setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 2); // Let's fail fast.<a name="line.67"></a>
<span class="sourceLineNo">068</span> conf.setBoolean(CoprocessorHost.ABORT_ON_ERROR_KEY, true);<a name="line.68"></a>
<span class="sourceLineNo">069</span> conf.set(CoprocessorHost.REGION_COPROCESSOR_CONF_KEY, "");<a name="line.69"></a>
<span class="sourceLineNo">070</span> TEST_UTIL.startMiniCluster(2);<a name="line.70"></a>
<span class="sourceLineNo">071</span> try {<a name="line.71"></a>
<span class="sourceLineNo">072</span> MiniHBaseCluster cluster = TEST_UTIL.getHBaseCluster();<a name="line.72"></a>
<span class="sourceLineNo">073</span> // Trigger one regionserver to fail as if it came up with a coprocessor<a name="line.73"></a>
<span class="sourceLineNo">074</span> // that fails during initialization<a name="line.74"></a>
<span class="sourceLineNo">075</span> final HRegionServer regionServer = cluster.getRegionServer(0);<a name="line.75"></a>
<span class="sourceLineNo">076</span> conf.set(CoprocessorHost.REGION_COPROCESSOR_CONF_KEY,<a name="line.76"></a>
<span class="sourceLineNo">077</span> FailedInitializationObserver.class.getName());<a name="line.77"></a>
<span class="sourceLineNo">078</span> regionServer.getRegionServerCoprocessorHost().loadSystemCoprocessors(conf,<a name="line.78"></a>
<span class="sourceLineNo">079</span> CoprocessorHost.REGION_COPROCESSOR_CONF_KEY);<a name="line.79"></a>
<span class="sourceLineNo">080</span> TEST_UTIL.waitFor(10000, 1000, new Predicate&lt;Exception&gt;() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public boolean evaluate() throws Exception {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return regionServer.isAborted();<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> } finally {<a name="line.86"></a>
<span class="sourceLineNo">087</span> TEST_UTIL.shutdownMiniCluster();<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> @Test<a name="line.91"></a>
<span class="sourceLineNo">092</span> public void testExceptionFromCoprocessorDuringPut() throws Exception {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // set configure to indicate which cp should be loaded<a name="line.93"></a>
<span class="sourceLineNo">094</span> Configuration conf = TEST_UTIL.getConfiguration();<a name="line.94"></a>
<span class="sourceLineNo">095</span> conf.setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 2); // Let's fail fast.<a name="line.95"></a>
<span class="sourceLineNo">096</span> conf.set(CoprocessorHost.REGION_COPROCESSOR_CONF_KEY, BuggyRegionObserver.class.getName());<a name="line.96"></a>
<span class="sourceLineNo">097</span> conf.setBoolean(CoprocessorHost.ABORT_ON_ERROR_KEY, true);<a name="line.97"></a>
<span class="sourceLineNo">098</span> TEST_UTIL.startMiniCluster(2);<a name="line.98"></a>
<span class="sourceLineNo">099</span> try {<a name="line.99"></a>
<span class="sourceLineNo">100</span> // When we try to write to TEST_TABLE, the buggy coprocessor will<a name="line.100"></a>
<span class="sourceLineNo">101</span> // cause a NullPointerException, which will cause the regionserver (which<a name="line.101"></a>
<span class="sourceLineNo">102</span> // hosts the region we attempted to write to) to abort.<a name="line.102"></a>
<span class="sourceLineNo">103</span> final byte[] TEST_FAMILY = Bytes.toBytes("aaa");<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> Table table = TEST_UTIL.createMultiRegionTable(TABLE_NAME, TEST_FAMILY);<a name="line.105"></a>
<span class="sourceLineNo">106</span> TEST_UTIL.waitUntilAllRegionsAssigned(TABLE_NAME);<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> // Note which regionServer will abort (after put is attempted).<a name="line.108"></a>
<span class="sourceLineNo">109</span> final HRegionServer regionServer = TEST_UTIL.getRSForFirstRegionInTable(TABLE_NAME);<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> try {<a name="line.111"></a>
<span class="sourceLineNo">112</span> final byte[] ROW = Bytes.toBytes("aaa");<a name="line.112"></a>
<span class="sourceLineNo">113</span> Put put = new Put(ROW);<a name="line.113"></a>
<span class="sourceLineNo">114</span> put.addColumn(TEST_FAMILY, ROW, ROW);<a name="line.114"></a>
<span class="sourceLineNo">115</span> table.put(put);<a name="line.115"></a>
<span class="sourceLineNo">116</span> } catch (IOException e) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> // The region server is going to be aborted.<a name="line.117"></a>
<span class="sourceLineNo">118</span> // We may get an exception if we retry,<a name="line.118"></a>
<span class="sourceLineNo">119</span> // which is not guaranteed.<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> // Wait 10 seconds for the regionserver to abort: expected result is that<a name="line.122"></a>
<span class="sourceLineNo">123</span> // it will abort.<a name="line.123"></a>
<span class="sourceLineNo">124</span> boolean aborted = false;<a name="line.124"></a>
<span class="sourceLineNo">125</span> for (int i = 0; i &lt; 10; i++) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> aborted = regionServer.isAborted();<a name="line.126"></a>
<span class="sourceLineNo">127</span> if (aborted) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> break;<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> try {<a name="line.130"></a>
<span class="sourceLineNo">131</span> Thread.sleep(1000);<a name="line.131"></a>
<span class="sourceLineNo">132</span> } catch (InterruptedException e) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> fail("InterruptedException while waiting for regionserver " +<a name="line.133"></a>
<span class="sourceLineNo">134</span> "zk node to be deleted.");<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> Assert.assertTrue("The region server should have aborted", aborted);<a name="line.137"></a>
<span class="sourceLineNo">138</span> table.close();<a name="line.138"></a>
<span class="sourceLineNo">139</span> } finally {<a name="line.139"></a>
<span class="sourceLineNo">140</span> TEST_UTIL.shutdownMiniCluster();<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> public static class FailedInitializationObserver implements RegionServerCoprocessor {<a name="line.144"></a>
<span class="sourceLineNo">145</span> @SuppressWarnings("null")<a name="line.145"></a>
<span class="sourceLineNo">146</span> @Override<a name="line.146"></a>
<span class="sourceLineNo">147</span> public void start(CoprocessorEnvironment e) throws IOException {<a name="line.147"></a>
<span class="sourceLineNo">148</span> // Trigger a NPE to fail the coprocessor<a name="line.148"></a>
<span class="sourceLineNo">149</span> Integer i = null;<a name="line.149"></a>
<span class="sourceLineNo">150</span> i = i + 1;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<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> public static class BuggyRegionObserver extends SimpleRegionObserver {<a name="line.154"></a>
<span class="sourceLineNo">155</span> @SuppressWarnings("null")<a name="line.155"></a>
<span class="sourceLineNo">156</span> @Override<a name="line.156"></a>
<span class="sourceLineNo">157</span> public void prePut(final ObserverContext&lt;RegionCoprocessorEnvironment&gt; c,<a name="line.157"></a>
<span class="sourceLineNo">158</span> final Put put, final WALEdit edit,<a name="line.158"></a>
<span class="sourceLineNo">159</span> final Durability durability) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> String tableName =<a name="line.160"></a>
<span class="sourceLineNo">161</span> c.getEnvironment().getRegion().getRegionInfo().getTable().getNameAsString();<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (tableName.equals("observed_table")) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> // Trigger a NPE to fail the coprocessor<a name="line.163"></a>
<span class="sourceLineNo">164</span> Integer i = null;<a name="line.164"></a>
<span class="sourceLineNo">165</span> i = i + 1;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span>}<a name="line.169"></a>
</pre>
</div>
</body>
</html>