| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase, class: MiniClusterRule"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.CompletableFuture;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.ExecutionException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.function.Supplier;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.AsyncConnection;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.Connection;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.ConnectionFactory;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.junit.ClassRule;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.junit.Rule;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.junit.rules.ExternalResource;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.junit.rules.TestRule;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33">/**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * A {@link TestRule} that manages an instance of the {@link SingleProcessHBaseCluster}. Can be used</span> |
| <span class="source-line-no">035</span><span id="line-35"> * in either the {@link Rule} or {@link ClassRule} positions. Built on top of an instance of</span> |
| <span class="source-line-no">036</span><span id="line-36"> * {@link HBaseTestingUtil}, so be weary of intermixing direct use of that class with this Rule.</span> |
| <span class="source-line-no">037</span><span id="line-37"> * </p></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Use in combination with {@link ConnectionRule}, for example:</span> |
| <span class="source-line-no">039</span><span id="line-39"> *</span> |
| <span class="source-line-no">040</span><span id="line-40"> * <pre></span> |
| <span class="source-line-no">041</span><span id="line-41"> * {</span> |
| <span class="source-line-no">042</span><span id="line-42"> * &#64;code</span> |
| <span class="source-line-no">043</span><span id="line-43"> * public class TestMyClass {</span> |
| <span class="source-line-no">044</span><span id="line-44"> * &#64;ClassRule</span> |
| <span class="source-line-no">045</span><span id="line-45"> * public static final MiniClusterRule miniClusterRule = MiniClusterRule.newBuilder().build();</span> |
| <span class="source-line-no">046</span><span id="line-46"> *</span> |
| <span class="source-line-no">047</span><span id="line-47"> * &#64;Rule</span> |
| <span class="source-line-no">048</span><span id="line-48"> * public final ConnectionRule connectionRule =</span> |
| <span class="source-line-no">049</span><span id="line-49"> * ConnectionRule.createAsyncConnectionRule(miniClusterRule::createAsyncConnection);</span> |
| <span class="source-line-no">050</span><span id="line-50"> * }</span> |
| <span class="source-line-no">051</span><span id="line-51"> * }</span> |
| <span class="source-line-no">052</span><span id="line-52"> * </pre></span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54">public final class MiniClusterRule extends ExternalResource {</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /**</span> |
| <span class="source-line-no">057</span><span id="line-57"> * A builder for fluent composition of a new {@link MiniClusterRule}.</span> |
| <span class="source-line-no">058</span><span id="line-58"> */</span> |
| <span class="source-line-no">059</span><span id="line-59"> public static class Builder {</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> private StartTestingClusterOption miniClusterOption;</span> |
| <span class="source-line-no">062</span><span id="line-62"> private Configuration conf;</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * Use the provided {@link StartTestingClusterOption} to construct the</span> |
| <span class="source-line-no">066</span><span id="line-66"> * {@link SingleProcessHBaseCluster}.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> public Builder setMiniClusterOption(final StartTestingClusterOption miniClusterOption) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> this.miniClusterOption = miniClusterOption;</span> |
| <span class="source-line-no">070</span><span id="line-70"> return this;</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * Seed the underlying {@link HBaseTestingUtil} with the provided {@link Configuration}.</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public Builder setConfiguration(final Configuration conf) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> this.conf = conf;</span> |
| <span class="source-line-no">078</span><span id="line-78"> return this;</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> public Builder setConfiguration(Supplier<Configuration> supplier) {</span> |
| <span class="source-line-no">082</span><span id="line-82"> return setConfiguration(supplier.get());</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> public MiniClusterRule build() {</span> |
| <span class="source-line-no">086</span><span id="line-86"> return new MiniClusterRule(conf,</span> |
| <span class="source-line-no">087</span><span id="line-87"> miniClusterOption != null</span> |
| <span class="source-line-no">088</span><span id="line-88"> ? miniClusterOption</span> |
| <span class="source-line-no">089</span><span id="line-89"> : StartTestingClusterOption.builder().build());</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> private final HBaseTestingUtil testingUtility;</span> |
| <span class="source-line-no">094</span><span id="line-94"> private final StartTestingClusterOption miniClusterOptions;</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> private SingleProcessHBaseCluster miniCluster;</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> private MiniClusterRule(final Configuration conf,</span> |
| <span class="source-line-no">099</span><span id="line-99"> final StartTestingClusterOption miniClusterOptions) {</span> |
| <span class="source-line-no">100</span><span id="line-100"> this.testingUtility = new HBaseTestingUtil(conf);</span> |
| <span class="source-line-no">101</span><span id="line-101"> this.miniClusterOptions = miniClusterOptions;</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> public static Builder newBuilder() {</span> |
| <span class="source-line-no">105</span><span id="line-105"> return new Builder();</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * Returns the underlying instance of {@link HBaseTestingUtil}</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> public HBaseTestingUtil getTestingUtility() {</span> |
| <span class="source-line-no">112</span><span id="line-112"> return testingUtility;</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Create a {@link Connection} to the managed {@link SingleProcessHBaseCluster}. It's up to the</span> |
| <span class="source-line-no">117</span><span id="line-117"> * caller to {@link Connection#close() close()} the connection when finished.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> public Connection createConnection() {</span> |
| <span class="source-line-no">120</span><span id="line-120"> try {</span> |
| <span class="source-line-no">121</span><span id="line-121"> return createAsyncConnection().get().toConnection();</span> |
| <span class="source-line-no">122</span><span id="line-122"> } catch (InterruptedException | ExecutionException e) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> throw new RuntimeException(e);</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> /**</span> |
| <span class="source-line-no">128</span><span id="line-128"> * Create a {@link AsyncConnection} to the managed {@link SingleProcessHBaseCluster}. It's up to</span> |
| <span class="source-line-no">129</span><span id="line-129"> * the caller to {@link AsyncConnection#close() close()} the connection when finished.</span> |
| <span class="source-line-no">130</span><span id="line-130"> */</span> |
| <span class="source-line-no">131</span><span id="line-131"> public CompletableFuture<AsyncConnection> createAsyncConnection() {</span> |
| <span class="source-line-no">132</span><span id="line-132"> if (miniCluster == null) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> throw new IllegalStateException("test cluster not initialized");</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"> return ConnectionFactory.createAsyncConnection(miniCluster.getConf());</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> @Override</span> |
| <span class="source-line-no">139</span><span id="line-139"> protected void before() throws Throwable {</span> |
| <span class="source-line-no">140</span><span id="line-140"> miniCluster = testingUtility.startMiniCluster(miniClusterOptions);</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> @Override</span> |
| <span class="source-line-no">144</span><span id="line-144"> protected void after() {</span> |
| <span class="source-line-no">145</span><span id="line-145"> try {</span> |
| <span class="source-line-no">146</span><span id="line-146"> testingUtility.shutdownMiniCluster();</span> |
| <span class="source-line-no">147</span><span id="line-147"> } catch (IOException e) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> throw new RuntimeException(e);</span> |
| <span class="source-line-no">149</span><span id="line-149"> }</span> |
| <span class="source-line-no">150</span><span id="line-150"> }</span> |
| <span class="source-line-no">151</span><span id="line-151">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
