blob: 5a1dbb0fc9e5cb8eef37a096e76fe12ae0237e6c [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.apache.hadoop.hbase.coprocessor.CoprocessorHost.REGION_COPROCESSOR_CONF_KEY;<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 java.util.Optional;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<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.HBaseConfiguration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.RegionInfoBuilder;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.regionserver.FlushLifeCycleTracker;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.regionserver.HRegion;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.regionserver.InternalScanner;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.regionserver.RegionServerServices;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.regionserver.ScanType;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.regionserver.Store;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.testclassification.CoprocessorTests;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.testclassification.SmallTests;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.junit.ClassRule;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.junit.Rule;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.junit.Test;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.junit.experimental.categories.Category;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.junit.rules.TestName;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.mockito.Mockito;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>/**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Test that we fail if a Coprocessor tries to return a null scanner out<a name="line.50"></a>
<span class="sourceLineNo">051</span> * {@link RegionObserver#preFlush(ObserverContext, Store, InternalScanner, FlushLifeCycleTracker)}<a name="line.51"></a>
<span class="sourceLineNo">052</span> * or {@link RegionObserver#preCompact(ObserverContext, Store, InternalScanner, ScanType,<a name="line.52"></a>
<span class="sourceLineNo">053</span> * CompactionLifeCycleTracker, CompactionRequest)}<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @see &lt;a href=https://issues.apache.org/jira/browse/HBASE-19122&gt;HBASE-19122&lt;/a&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span>@Category({CoprocessorTests.class, SmallTests.class})<a name="line.56"></a>
<span class="sourceLineNo">057</span>public class TestRegionObserverPreFlushAndPreCompact {<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(TestRegionObserverPreFlushAndPreCompact.class);<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> @Rule public TestName name = new TestName();<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * Coprocessor that returns null when preCompact or preFlush is called.<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public static class TestRegionObserver implements RegionObserver, RegionCoprocessor {<a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public InternalScanner preFlush(ObserverContext&lt;RegionCoprocessorEnvironment&gt; c, Store store,<a name="line.70"></a>
<span class="sourceLineNo">071</span> InternalScanner scanner, FlushLifeCycleTracker tracker) throws IOException {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return null;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public InternalScanner preCompact(ObserverContext&lt;RegionCoprocessorEnvironment&gt; c, Store store,<a name="line.76"></a>
<span class="sourceLineNo">077</span> InternalScanner scanner, ScanType scanType, CompactionLifeCycleTracker tracker,<a name="line.77"></a>
<span class="sourceLineNo">078</span> CompactionRequest request) throws IOException {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return null;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> @Override<a name="line.82"></a>
<span class="sourceLineNo">083</span> public Optional&lt;RegionObserver&gt; getRegionObserver() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return Optional.of(this);<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> * Ensure we get expected exception when we try to return null from a preFlush call.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @throws IOException We expect it to throw {@link CoprocessorException}<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> @Test (expected = CoprocessorException.class)<a name="line.92"></a>
<span class="sourceLineNo">093</span> public void testPreFlushReturningNull() throws IOException {<a name="line.93"></a>
<span class="sourceLineNo">094</span> RegionCoprocessorHost rch = getRegionCoprocessorHost();<a name="line.94"></a>
<span class="sourceLineNo">095</span> rch.preFlush(null, null, null);<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> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Ensure we get expected exception when we try to return null from a preCompact call.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @throws IOException We expect it to throw {@link CoprocessorException}<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> @Test (expected = CoprocessorException.class)<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void testPreCompactReturningNull() throws IOException {<a name="line.103"></a>
<span class="sourceLineNo">104</span> RegionCoprocessorHost rch = getRegionCoprocessorHost();<a name="line.104"></a>
<span class="sourceLineNo">105</span> rch.preCompact(null, null, null, null, null, null);<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> private RegionCoprocessorHost getRegionCoprocessorHost() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> // Make up an HRegion instance. Use the hbase:meta first region as our RegionInfo. Use<a name="line.109"></a>
<span class="sourceLineNo">110</span> // hbase:meta table name for building the TableDescriptor our mock returns when asked schema<a name="line.110"></a>
<span class="sourceLineNo">111</span> // down inside RegionCoprocessorHost. Pass in mocked RegionServerServices too.<a name="line.111"></a>
<span class="sourceLineNo">112</span> RegionInfo ri = RegionInfoBuilder.FIRST_META_REGIONINFO;<a name="line.112"></a>
<span class="sourceLineNo">113</span> HRegion mockedHRegion = Mockito.mock(HRegion.class);<a name="line.113"></a>
<span class="sourceLineNo">114</span> Mockito.when(mockedHRegion.getRegionInfo()).thenReturn(ri);<a name="line.114"></a>
<span class="sourceLineNo">115</span> TableDescriptor td = TableDescriptorBuilder.newBuilder(ri.getTable()).build();<a name="line.115"></a>
<span class="sourceLineNo">116</span> Mockito.when(mockedHRegion.getTableDescriptor()).thenReturn(td);<a name="line.116"></a>
<span class="sourceLineNo">117</span> RegionServerServices mockedServices = Mockito.mock(RegionServerServices.class);<a name="line.117"></a>
<span class="sourceLineNo">118</span> Configuration conf = HBaseConfiguration.create();<a name="line.118"></a>
<span class="sourceLineNo">119</span> // Load our test coprocessor defined above.<a name="line.119"></a>
<span class="sourceLineNo">120</span> conf.set(REGION_COPROCESSOR_CONF_KEY, TestRegionObserver.class.getName());<a name="line.120"></a>
<span class="sourceLineNo">121</span> return new RegionCoprocessorHost(mockedHRegion, mockedServices, conf);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span>}<a name="line.123"></a>
</pre>
</div>
</body>
</html>