blob: 8988e9b81cec61ec87344318159a2971d56d1a2f [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.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertTrue;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Collections;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Optional;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.ExecutorService;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.SynchronousQueue;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.ThreadPoolExecutor;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.TimeUnit;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HBaseTestingUtility;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HColumnDescriptor;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.HTableDescriptor;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.TableName;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Durability;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.Put;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.Result;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Table;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.testclassification.CoprocessorTests;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.testclassification.MediumTests;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.util.Threads;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.After;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.junit.AfterClass;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.junit.BeforeClass;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.junit.ClassRule;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.junit.Test;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.junit.experimental.categories.Category;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>/**<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Test that a coprocessor can open a connection and write to another table, inside a hook.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span>@Category({CoprocessorTests.class, MediumTests.class})<a name="line.56"></a>
<span class="sourceLineNo">057</span>public class TestOpenTableInCoprocessor {<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @ClassRule<a name="line.59"></a>
<span class="sourceLineNo">060</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.60"></a>
<span class="sourceLineNo">061</span> HBaseClassTestRule.forClass(TestOpenTableInCoprocessor.class);<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private static final TableName otherTable = TableName.valueOf("otherTable");<a name="line.63"></a>
<span class="sourceLineNo">064</span> private static final TableName primaryTable = TableName.valueOf("primary");<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final byte[] family = new byte[] { 'f' };<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private static boolean[] completed = new boolean[1];<a name="line.67"></a>
<span class="sourceLineNo">068</span> /**<a name="line.68"></a>
<span class="sourceLineNo">069</span> * Custom coprocessor that just copies the write to another table.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> public static class SendToOtherTableCoprocessor implements RegionCoprocessor, RegionObserver {<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @Override<a name="line.73"></a>
<span class="sourceLineNo">074</span> public Optional&lt;RegionObserver&gt; getRegionObserver() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return Optional.of(this);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span> public void prePut(final ObserverContext&lt;RegionCoprocessorEnvironment&gt; e, final Put put,<a name="line.79"></a>
<span class="sourceLineNo">080</span> final WALEdit edit, final Durability durability) throws IOException {<a name="line.80"></a>
<span class="sourceLineNo">081</span> try (Table table = e.getEnvironment().getConnection().<a name="line.81"></a>
<span class="sourceLineNo">082</span> getTable(otherTable)) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> table.put(put);<a name="line.83"></a>
<span class="sourceLineNo">084</span> completed[0] = true;<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><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> private static boolean[] completedWithPool = new boolean[1];<a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Coprocessor that creates an HTable with a pool to write to another table<a name="line.92"></a>
<span class="sourceLineNo">093</span> */<a name="line.93"></a>
<span class="sourceLineNo">094</span> public static class CustomThreadPoolCoprocessor implements RegionCoprocessor, RegionObserver {<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 a pool that has one thread only at every time. A second action added to the pool (<a name="line.97"></a>
<span class="sourceLineNo">098</span> * running concurrently), will cause an exception.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> private ExecutorService getPool() {<a name="line.100"></a>
<span class="sourceLineNo">101</span> int maxThreads = 1;<a name="line.101"></a>
<span class="sourceLineNo">102</span> long keepAliveTime = 60;<a name="line.102"></a>
<span class="sourceLineNo">103</span> ThreadPoolExecutor pool =<a name="line.103"></a>
<span class="sourceLineNo">104</span> new ThreadPoolExecutor(1, maxThreads, keepAliveTime, TimeUnit.SECONDS,<a name="line.104"></a>
<span class="sourceLineNo">105</span> new SynchronousQueue&lt;&gt;(), Threads.newDaemonThreadFactory("hbase-table"));<a name="line.105"></a>
<span class="sourceLineNo">106</span> pool.allowCoreThreadTimeOut(true);<a name="line.106"></a>
<span class="sourceLineNo">107</span> return pool;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> @Override<a name="line.110"></a>
<span class="sourceLineNo">111</span> public Optional&lt;RegionObserver&gt; getRegionObserver() {<a name="line.111"></a>
<span class="sourceLineNo">112</span> return Optional.of(this);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> @Override<a name="line.115"></a>
<span class="sourceLineNo">116</span> public void prePut(final ObserverContext&lt;RegionCoprocessorEnvironment&gt; e, final Put put,<a name="line.116"></a>
<span class="sourceLineNo">117</span> final WALEdit edit, final Durability durability) throws IOException {<a name="line.117"></a>
<span class="sourceLineNo">118</span> try (Table table = e.getEnvironment().getConnection().getTable(otherTable, getPool())) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> Put p = new Put(new byte[]{'a'});<a name="line.119"></a>
<span class="sourceLineNo">120</span> p.addColumn(family, null, new byte[]{'a'});<a name="line.120"></a>
<span class="sourceLineNo">121</span> try {<a name="line.121"></a>
<span class="sourceLineNo">122</span> table.batch(Collections.singletonList(put), null);<a name="line.122"></a>
<span class="sourceLineNo">123</span> } catch (InterruptedException e1) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> throw new IOException(e1);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> completedWithPool[0] = true;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<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> private static HBaseTestingUtility UTIL = new HBaseTestingUtility();<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> @BeforeClass<a name="line.133"></a>
<span class="sourceLineNo">134</span> public static void setupCluster() throws Exception {<a name="line.134"></a>
<span class="sourceLineNo">135</span> UTIL.startMiniCluster();<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> @After<a name="line.138"></a>
<span class="sourceLineNo">139</span> public void cleanupTestTable() throws Exception {<a name="line.139"></a>
<span class="sourceLineNo">140</span> UTIL.getAdmin().disableTable(primaryTable);<a name="line.140"></a>
<span class="sourceLineNo">141</span> UTIL.getAdmin().deleteTable(primaryTable);<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> UTIL.getAdmin().disableTable(otherTable);<a name="line.143"></a>
<span class="sourceLineNo">144</span> UTIL.getAdmin().deleteTable(otherTable);<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> @AfterClass<a name="line.148"></a>
<span class="sourceLineNo">149</span> public static void teardownCluster() throws Exception {<a name="line.149"></a>
<span class="sourceLineNo">150</span> UTIL.shutdownMiniCluster();<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> @Test<a name="line.153"></a>
<span class="sourceLineNo">154</span> public void testCoprocessorCanCreateConnectionToRemoteTable() throws Throwable {<a name="line.154"></a>
<span class="sourceLineNo">155</span> runCoprocessorConnectionToRemoteTable(SendToOtherTableCoprocessor.class, completed);<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> @Test<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void testCoprocessorCanCreateConnectionToRemoteTableWithCustomPool() throws Throwable {<a name="line.159"></a>
<span class="sourceLineNo">160</span> runCoprocessorConnectionToRemoteTable(CustomThreadPoolCoprocessor.class, completedWithPool);<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> private void runCoprocessorConnectionToRemoteTable(Class clazz, boolean[] completeCheck)<a name="line.163"></a>
<span class="sourceLineNo">164</span> throws Throwable {<a name="line.164"></a>
<span class="sourceLineNo">165</span> // Check if given class implements RegionObserver.<a name="line.165"></a>
<span class="sourceLineNo">166</span> assert(RegionObserver.class.isAssignableFrom(clazz));<a name="line.166"></a>
<span class="sourceLineNo">167</span> HTableDescriptor primary = new HTableDescriptor(primaryTable);<a name="line.167"></a>
<span class="sourceLineNo">168</span> primary.addFamily(new HColumnDescriptor(family));<a name="line.168"></a>
<span class="sourceLineNo">169</span> // add our coprocessor<a name="line.169"></a>
<span class="sourceLineNo">170</span> primary.addCoprocessor(clazz.getName());<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> HTableDescriptor other = new HTableDescriptor(otherTable);<a name="line.172"></a>
<span class="sourceLineNo">173</span> other.addFamily(new HColumnDescriptor(family));<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> Admin admin = UTIL.getAdmin();<a name="line.176"></a>
<span class="sourceLineNo">177</span> admin.createTable(primary);<a name="line.177"></a>
<span class="sourceLineNo">178</span> admin.createTable(other);<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> Table table = UTIL.getConnection().getTable(TableName.valueOf("primary"));<a name="line.180"></a>
<span class="sourceLineNo">181</span> Put p = new Put(new byte[] { 'a' });<a name="line.181"></a>
<span class="sourceLineNo">182</span> p.addColumn(family, null, new byte[]{'a'});<a name="line.182"></a>
<span class="sourceLineNo">183</span> table.put(p);<a name="line.183"></a>
<span class="sourceLineNo">184</span> table.close();<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span> Table target = UTIL.getConnection().getTable(otherTable);<a name="line.186"></a>
<span class="sourceLineNo">187</span> assertTrue("Didn't complete update to target table!", completeCheck[0]);<a name="line.187"></a>
<span class="sourceLineNo">188</span> assertEquals("Didn't find inserted row", 1, getKeyValueCount(target));<a name="line.188"></a>
<span class="sourceLineNo">189</span> target.close();<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> /**<a name="line.192"></a>
<span class="sourceLineNo">193</span> * Count the number of keyvalue in the table. Scans all possible versions<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param table table to scan<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @return number of keyvalues over all rows in the table<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @throws IOException<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> private int getKeyValueCount(Table table) throws IOException {<a name="line.198"></a>
<span class="sourceLineNo">199</span> Scan scan = new Scan();<a name="line.199"></a>
<span class="sourceLineNo">200</span> scan.setMaxVersions(Integer.MAX_VALUE - 1);<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> ResultScanner results = table.getScanner(scan);<a name="line.202"></a>
<span class="sourceLineNo">203</span> int count = 0;<a name="line.203"></a>
<span class="sourceLineNo">204</span> for (Result res : results) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> count += res.listCells().size();<a name="line.205"></a>
<span class="sourceLineNo">206</span> System.out.println(count + ") " + res);<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> results.close();<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> return count;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span>}<a name="line.212"></a>
</pre>
</div>
</body>
</html>