blob: f0d6dd0ace6605876903a427078c83799ec2c7f2 [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.filter;<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.assertArrayEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertEquals;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.assertFalse;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Cell;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HBaseClassTestRule;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseTestingUtility;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HColumnDescriptor;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HRegionInfo;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.HTableDescriptor;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.HTestConst;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.TableName;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Put;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.regionserver.HRegion;<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.SmallTests;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.AfterClass;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.BeforeClass;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.ClassRule;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.Test;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.experimental.categories.Category;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>/**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * To test behavior of filters at server from region side.<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@Category(SmallTests.class)<a name="line.51"></a>
<span class="sourceLineNo">052</span>public class TestFilterFromRegionSide {<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> @ClassRule<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final HBaseClassTestRule CLASS_RULE =<a name="line.55"></a>
<span class="sourceLineNo">056</span> HBaseClassTestRule.forClass(TestFilterFromRegionSide.class);<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private final static HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();<a name="line.58"></a>
<span class="sourceLineNo">059</span> private static HRegion REGION;<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("TestFilterFromRegionSide");<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private static int NUM_ROWS = 5;<a name="line.63"></a>
<span class="sourceLineNo">064</span> private static byte[] ROW = Bytes.toBytes("testRow");<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static byte[][] ROWS = HTestConst.makeNAscii(ROW, NUM_ROWS);<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> // Should keep this value below 10 to keep generation of expected kv's simple. If above 10 then<a name="line.67"></a>
<span class="sourceLineNo">068</span> // table/row/cf1/... will be followed by table/row/cf10/... instead of table/row/cf2/... which<a name="line.68"></a>
<span class="sourceLineNo">069</span> // breaks the simple generation of expected kv's<a name="line.69"></a>
<span class="sourceLineNo">070</span> private static int NUM_FAMILIES = 5;<a name="line.70"></a>
<span class="sourceLineNo">071</span> private static byte[] FAMILY = Bytes.toBytes("testFamily");<a name="line.71"></a>
<span class="sourceLineNo">072</span> private static byte[][] FAMILIES = HTestConst.makeNAscii(FAMILY, NUM_FAMILIES);<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> private static int NUM_QUALIFIERS = 5;<a name="line.74"></a>
<span class="sourceLineNo">075</span> private static byte[] QUALIFIER = Bytes.toBytes("testQualifier");<a name="line.75"></a>
<span class="sourceLineNo">076</span> private static byte[][] QUALIFIERS = HTestConst.makeNAscii(QUALIFIER, NUM_QUALIFIERS);<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private static int VALUE_SIZE = 1024;<a name="line.78"></a>
<span class="sourceLineNo">079</span> private static byte[] VALUE = Bytes.createMaxByteArray(VALUE_SIZE);<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> private static int NUM_COLS = NUM_FAMILIES * NUM_QUALIFIERS;<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> @BeforeClass<a name="line.83"></a>
<span class="sourceLineNo">084</span> public static void setUpBeforeClass() throws Exception {<a name="line.84"></a>
<span class="sourceLineNo">085</span> HTableDescriptor htd = new HTableDescriptor(TABLE_NAME);<a name="line.85"></a>
<span class="sourceLineNo">086</span> for (byte[] family : FAMILIES) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> HColumnDescriptor hcd = new HColumnDescriptor(family);<a name="line.87"></a>
<span class="sourceLineNo">088</span> htd.addFamily(hcd);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> HRegionInfo info = new HRegionInfo(htd.getTableName(), null, null, false);<a name="line.90"></a>
<span class="sourceLineNo">091</span> REGION = HBaseTestingUtility<a name="line.91"></a>
<span class="sourceLineNo">092</span> .createRegionAndWAL(info, TEST_UTIL.getDataTestDir(), TEST_UTIL.getConfiguration(), htd);<a name="line.92"></a>
<span class="sourceLineNo">093</span> for(Put put:createPuts(ROWS, FAMILIES, QUALIFIERS, VALUE)){<a name="line.93"></a>
<span class="sourceLineNo">094</span> REGION.put(put);<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><a name="line.97"></a>
<span class="sourceLineNo">098</span> private static ArrayList&lt;Put&gt; createPuts(byte[][] rows, byte[][] families, byte[][] qualifiers,<a name="line.98"></a>
<span class="sourceLineNo">099</span> byte[] value) throws IOException {<a name="line.99"></a>
<span class="sourceLineNo">100</span> Put put;<a name="line.100"></a>
<span class="sourceLineNo">101</span> ArrayList&lt;Put&gt; puts = new ArrayList&lt;&gt;();<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> for (byte[] row1 : rows) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> put = new Put(row1);<a name="line.104"></a>
<span class="sourceLineNo">105</span> for (byte[] family : families) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> for (int qual = 0; qual &lt; qualifiers.length; qual++) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> KeyValue kv = new KeyValue(row1, family, qualifiers[qual], qual, value);<a name="line.107"></a>
<span class="sourceLineNo">108</span> put.add(kv);<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> puts.add(put);<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> return puts;<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 tearDownAfterClass() throws Exception {<a name="line.118"></a>
<span class="sourceLineNo">119</span> REGION.close();<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> @Test<a name="line.122"></a>
<span class="sourceLineNo">123</span> public void testFirstKeyOnlyFilterAndBatch() throws IOException {<a name="line.123"></a>
<span class="sourceLineNo">124</span> Scan scan = new Scan();<a name="line.124"></a>
<span class="sourceLineNo">125</span> scan.setFilter(new FirstKeyOnlyFilter());<a name="line.125"></a>
<span class="sourceLineNo">126</span> scan.setBatch(1);<a name="line.126"></a>
<span class="sourceLineNo">127</span> InternalScanner scanner = REGION.getScanner(scan);<a name="line.127"></a>
<span class="sourceLineNo">128</span> List&lt;Cell&gt; results = new ArrayList&lt;&gt;();<a name="line.128"></a>
<span class="sourceLineNo">129</span> for (int i = 0; i &lt; NUM_ROWS; i++) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> results.clear();<a name="line.130"></a>
<span class="sourceLineNo">131</span> scanner.next(results);<a name="line.131"></a>
<span class="sourceLineNo">132</span> assertEquals(1, results.size());<a name="line.132"></a>
<span class="sourceLineNo">133</span> Cell cell = results.get(0);<a name="line.133"></a>
<span class="sourceLineNo">134</span> assertArrayEquals(ROWS[i],<a name="line.134"></a>
<span class="sourceLineNo">135</span> Bytes.copy(cell.getRowArray(), cell.getRowOffset(), cell.getRowLength()));<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> assertFalse(scanner.next(results));<a name="line.137"></a>
<span class="sourceLineNo">138</span> scanner.close();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> public static class FirstSeveralCellsFilter extends FilterBase{<a name="line.141"></a>
<span class="sourceLineNo">142</span> private int count = 0;<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> @Override<a name="line.144"></a>
<span class="sourceLineNo">145</span> public void reset() {<a name="line.145"></a>
<span class="sourceLineNo">146</span> count = 0;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span> public boolean filterRowKey(Cell cell) throws IOException {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return false;<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> @Override<a name="line.154"></a>
<span class="sourceLineNo">155</span> public ReturnCode filterCell(final Cell v) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (count++ &lt; NUM_COLS) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> return ReturnCode.INCLUDE;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> return ReturnCode.SKIP;<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> public static Filter parseFrom(final byte [] pbBytes){<a name="line.162"></a>
<span class="sourceLineNo">163</span> return new FirstSeveralCellsFilter();<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> @Test<a name="line.167"></a>
<span class="sourceLineNo">168</span> public void testFirstSeveralCellsFilterAndBatch() throws IOException {<a name="line.168"></a>
<span class="sourceLineNo">169</span> Scan scan = new Scan();<a name="line.169"></a>
<span class="sourceLineNo">170</span> scan.setFilter(new FirstSeveralCellsFilter());<a name="line.170"></a>
<span class="sourceLineNo">171</span> scan.setBatch(NUM_COLS);<a name="line.171"></a>
<span class="sourceLineNo">172</span> InternalScanner scanner = REGION.getScanner(scan);<a name="line.172"></a>
<span class="sourceLineNo">173</span> List&lt;Cell&gt; results = new ArrayList&lt;&gt;();<a name="line.173"></a>
<span class="sourceLineNo">174</span> for (int i = 0; i &lt; NUM_ROWS; i++) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> results.clear();<a name="line.175"></a>
<span class="sourceLineNo">176</span> scanner.next(results);<a name="line.176"></a>
<span class="sourceLineNo">177</span> assertEquals(NUM_COLS, results.size());<a name="line.177"></a>
<span class="sourceLineNo">178</span> Cell cell = results.get(0);<a name="line.178"></a>
<span class="sourceLineNo">179</span> assertArrayEquals(ROWS[i],<a name="line.179"></a>
<span class="sourceLineNo">180</span> Bytes.copy(cell.getRowArray(), cell.getRowOffset(), cell.getRowLength()));<a name="line.180"></a>
<span class="sourceLineNo">181</span> assertArrayEquals(FAMILIES[0],<a name="line.181"></a>
<span class="sourceLineNo">182</span> Bytes.copy(cell.getFamilyArray(), cell.getFamilyOffset(), cell.getFamilyLength()));<a name="line.182"></a>
<span class="sourceLineNo">183</span> assertArrayEquals(QUALIFIERS[0], Bytes.copy(cell.getQualifierArray(),<a name="line.183"></a>
<span class="sourceLineNo">184</span> cell.getQualifierOffset(), cell.getQualifierLength()));<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span> assertFalse(scanner.next(results));<a name="line.186"></a>
<span class="sourceLineNo">187</span> scanner.close();<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
</pre>
</div>
</body>
</html>