| <!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;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.concurrent.CompletableFuture;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.conf.Configuration;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.AsyncConnection;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.client.ConnectionFactory;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.junit.ClassRule;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.junit.Rule;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.junit.rules.ExternalResource;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.junit.rules.TestRule;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>/**<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * A {@link TestRule} that manages an instance of the {@link MiniHBaseCluster}. Can be used in<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * either the {@link Rule} or {@link ClassRule} positions. Built on top of an instance of<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * {@link HBaseTestingUtility}, so be weary of intermixing direct use of that class with this Rule.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * </p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Use in combination with {@link ConnectionRule}, for example:<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <pre>{@code<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * public class TestMyClass {<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @ClassRule<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * public static final MiniClusterRule miniClusterRule = MiniClusterRule.newBuilder().build();<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @Rule<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * public final ConnectionRule connectionRule =<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * new ConnectionRule(miniClusterRule::createConnection);<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * }<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * }</pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>public final class MiniClusterRule extends ExternalResource {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * A builder for fluent composition of a new {@link MiniClusterRule}.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public static class Builder {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> private StartMiniClusterOption miniClusterOption;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private Configuration conf;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Use the provided {@link StartMiniClusterOption} to construct the {@link MiniHBaseCluster}.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> public Builder setMiniClusterOption(final StartMiniClusterOption miniClusterOption) {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this.miniClusterOption = miniClusterOption;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> return this;<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> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Seed the underlying {@link HBaseTestingUtility} with the provided {@link Configuration}.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public Builder setConfiguration(final Configuration conf) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> this.conf = conf;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> return this;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public MiniClusterRule build() {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return new MiniClusterRule(<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> conf,<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> miniClusterOption != null<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> ? miniClusterOption<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> : StartMiniClusterOption.builder().build());<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><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private final HBaseTestingUtility testingUtility;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private final StartMiniClusterOption miniClusterOptions;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private MiniHBaseCluster miniCluster;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private MiniClusterRule(final Configuration conf,<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> final StartMiniClusterOption miniClusterOptions) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> this.testingUtility = new HBaseTestingUtility(conf);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> this.miniClusterOptions = miniClusterOptions;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public static Builder newBuilder() {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return new Builder();<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> * @return the underlying instance of {@link HBaseTestingUtility}<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> */<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public HBaseTestingUtility getTestingUtility() {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return testingUtility;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Create a {@link AsyncConnection} to the managed {@link MiniHBaseCluster}. It's up to the caller<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * to {@link AsyncConnection#close() close()} the connection when finished.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public CompletableFuture<AsyncConnection> createConnection() {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (miniCluster == null) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> throw new IllegalStateException("test cluster not initialized");<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return ConnectionFactory.createAsyncConnection(miniCluster.getConf());<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> @Override<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> protected void before() throws Throwable {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> miniCluster = testingUtility.startMiniCluster(miniClusterOptions);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> @Override<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> protected void after() {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> try {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> testingUtility.shutdownMiniCluster();<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> } catch (IOException e) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> throw new RuntimeException(e);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |