| <!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: HBaseZKTestingUtility"> |
| <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.File;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.zookeeper.ZKWatcher;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Helpers for testing HBase that do not depend on specific server/etc. things. The main difference</span> |
| <span class="source-line-no">030</span><span id="line-30"> * from {@link HBaseCommonTestingUtility} is that we can start a zookeeper cluster.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * @deprecated since 3.0.0, will be removed in 4.0.0. Use</span> |
| <span class="source-line-no">032</span><span id="line-32"> * {@link org.apache.hadoop.hbase.testing.TestingHBaseCluster} instead.</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Public</span> |
| <span class="source-line-no">035</span><span id="line-35">@Deprecated</span> |
| <span class="source-line-no">036</span><span id="line-36">public class HBaseZKTestingUtility extends HBaseCommonTestingUtility {</span> |
| <span class="source-line-no">037</span><span id="line-37"> private MiniZooKeeperCluster zkCluster;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39"> /**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Set if we were passed a zkCluster. If so, we won't shutdown zk as part of general shutdown.</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42"> private boolean passedZkCluster;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> protected ZKWatcher zooKeeperWatcher;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /** Directory (a subdirectory of dataTestDir) used by the dfs cluster if any */</span> |
| <span class="source-line-no">047</span><span id="line-47"> protected File clusterTestDir;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> public HBaseZKTestingUtility() {</span> |
| <span class="source-line-no">050</span><span id="line-50"> this(HBaseConfiguration.create());</span> |
| <span class="source-line-no">051</span><span id="line-51"> }</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> public HBaseZKTestingUtility(Configuration conf) {</span> |
| <span class="source-line-no">054</span><span id="line-54"> super(conf);</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"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @return Where the cluster will write data on the local subsystem. Creates it if it does not</span> |
| <span class="source-line-no">059</span><span id="line-59"> * exist already. A subdir of {@code HBaseCommonTestingUtility#getBaseTestDir()}</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> Path getClusterTestDir() {</span> |
| <span class="source-line-no">062</span><span id="line-62"> if (clusterTestDir == null) {</span> |
| <span class="source-line-no">063</span><span id="line-63"> setupClusterTestDir();</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"> return new Path(clusterTestDir.getAbsolutePath());</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /**</span> |
| <span class="source-line-no">069</span><span id="line-69"> * Creates a directory for the cluster, under the test data</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> protected void setupClusterTestDir() {</span> |
| <span class="source-line-no">072</span><span id="line-72"> if (clusterTestDir != null) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return;</span> |
| <span class="source-line-no">074</span><span id="line-74"> }</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> // Using randomUUID ensures that multiple clusters can be launched by</span> |
| <span class="source-line-no">077</span><span id="line-77"> // a same test, if it stops & starts them</span> |
| <span class="source-line-no">078</span><span id="line-78"> Path testDir = getDataTestDir("cluster_" + getRandomUUID().toString());</span> |
| <span class="source-line-no">079</span><span id="line-79"> clusterTestDir = new File(testDir.toString()).getAbsoluteFile();</span> |
| <span class="source-line-no">080</span><span id="line-80"> // Have it cleaned up on exit</span> |
| <span class="source-line-no">081</span><span id="line-81"> boolean b = deleteOnExit();</span> |
| <span class="source-line-no">082</span><span id="line-82"> if (b) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> clusterTestDir.deleteOnExit();</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"> LOG.info("Created new mini-cluster data directory: " + clusterTestDir + ", deleteOnExit=" + b);</span> |
| <span class="source-line-no">086</span><span id="line-86"> }</span> |
| <span class="source-line-no">087</span><span id="line-87"></span> |
| <span class="source-line-no">088</span><span id="line-88"> /**</span> |
| <span class="source-line-no">089</span><span id="line-89"> * Call this if you only want a zk cluster.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @see #shutdownMiniZKCluster()</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @return zk cluster started.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> public MiniZooKeeperCluster startMiniZKCluster() throws Exception {</span> |
| <span class="source-line-no">094</span><span id="line-94"> return startMiniZKCluster(1);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> /**</span> |
| <span class="source-line-no">098</span><span id="line-98"> * Call this if you only want a zk cluster.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @see #shutdownMiniZKCluster()</span> |
| <span class="source-line-no">100</span><span id="line-100"> * @return zk cluster started.</span> |
| <span class="source-line-no">101</span><span id="line-101"> */</span> |
| <span class="source-line-no">102</span><span id="line-102"> public MiniZooKeeperCluster startMiniZKCluster(int zooKeeperServerNum, int... clientPortList)</span> |
| <span class="source-line-no">103</span><span id="line-103"> throws Exception {</span> |
| <span class="source-line-no">104</span><span id="line-104"> setupClusterTestDir();</span> |
| <span class="source-line-no">105</span><span id="line-105"> return startMiniZKCluster(clusterTestDir, zooKeeperServerNum, clientPortList);</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"> * Start a mini ZK cluster. If the property "test.hbase.zookeeper.property.clientPort" is set the</span> |
| <span class="source-line-no">110</span><span id="line-110"> * port mentioned is used as the default port for ZooKeeper.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> private MiniZooKeeperCluster startMiniZKCluster(File dir, int zooKeeperServerNum,</span> |
| <span class="source-line-no">113</span><span id="line-113"> int[] clientPortList) throws Exception {</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (this.zkCluster != null) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> throw new IOException("Cluster already running at " + dir);</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"> this.passedZkCluster = false;</span> |
| <span class="source-line-no">118</span><span id="line-118"> this.zkCluster = new MiniZooKeeperCluster(this.getConfiguration());</span> |
| <span class="source-line-no">119</span><span id="line-119"> int defPort = this.conf.getInt("test.hbase.zookeeper.property.clientPort", 0);</span> |
| <span class="source-line-no">120</span><span id="line-120"> if (defPort > 0) {</span> |
| <span class="source-line-no">121</span><span id="line-121"> // If there is a port in the config file, we use it.</span> |
| <span class="source-line-no">122</span><span id="line-122"> this.zkCluster.setDefaultClientPort(defPort);</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> if (clientPortList != null) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> // Ignore extra client ports</span> |
| <span class="source-line-no">127</span><span id="line-127"> int clientPortListSize = Math.min(clientPortList.length, zooKeeperServerNum);</span> |
| <span class="source-line-no">128</span><span id="line-128"> for (int i = 0; i < clientPortListSize; i++) {</span> |
| <span class="source-line-no">129</span><span id="line-129"> this.zkCluster.addClientPort(clientPortList[i]);</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> int clientPort = this.zkCluster.startup(dir, zooKeeperServerNum);</span> |
| <span class="source-line-no">133</span><span id="line-133"> this.conf.set(HConstants.ZOOKEEPER_CLIENT_PORT, Integer.toString(clientPort));</span> |
| <span class="source-line-no">134</span><span id="line-134"> return this.zkCluster;</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> public MiniZooKeeperCluster getZkCluster() {</span> |
| <span class="source-line-no">138</span><span id="line-138"> return zkCluster;</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> public void setZkCluster(MiniZooKeeperCluster zkCluster) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> this.passedZkCluster = true;</span> |
| <span class="source-line-no">143</span><span id="line-143"> this.zkCluster = zkCluster;</span> |
| <span class="source-line-no">144</span><span id="line-144"> conf.setInt(HConstants.ZOOKEEPER_CLIENT_PORT, zkCluster.getClientPort());</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Shuts down zk cluster created by call to {@link #startMiniZKCluster()} or does nothing.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @see #startMiniZKCluster()</span> |
| <span class="source-line-no">150</span><span id="line-150"> */</span> |
| <span class="source-line-no">151</span><span id="line-151"> public void shutdownMiniZKCluster() throws IOException {</span> |
| <span class="source-line-no">152</span><span id="line-152"> if (!passedZkCluster && this.zkCluster != null) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> this.zkCluster.shutdown();</span> |
| <span class="source-line-no">154</span><span id="line-154"> this.zkCluster = null;</span> |
| <span class="source-line-no">155</span><span id="line-155"> }</span> |
| <span class="source-line-no">156</span><span id="line-156"> }</span> |
| <span class="source-line-no">157</span><span id="line-157"></span> |
| <span class="source-line-no">158</span><span id="line-158"> /**</span> |
| <span class="source-line-no">159</span><span id="line-159"> * Returns a ZKWatcher instance. This instance is shared between HBaseTestingUtility instance</span> |
| <span class="source-line-no">160</span><span id="line-160"> * users. Don't close it, it will be closed automatically when the cluster shutdowns</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @return The ZKWatcher instance.</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> public synchronized ZKWatcher getZooKeeperWatcher() throws IOException {</span> |
| <span class="source-line-no">164</span><span id="line-164"> if (zooKeeperWatcher == null) {</span> |
| <span class="source-line-no">165</span><span id="line-165"> zooKeeperWatcher = new ZKWatcher(conf, "testing utility", new Abortable() {</span> |
| <span class="source-line-no">166</span><span id="line-166"> @Override</span> |
| <span class="source-line-no">167</span><span id="line-167"> public void abort(String why, Throwable e) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> throw new RuntimeException("Unexpected abort in HBaseZKTestingUtility:" + why, e);</span> |
| <span class="source-line-no">169</span><span id="line-169"> }</span> |
| <span class="source-line-no">170</span><span id="line-170"></span> |
| <span class="source-line-no">171</span><span id="line-171"> @Override</span> |
| <span class="source-line-no">172</span><span id="line-172"> public boolean isAborted() {</span> |
| <span class="source-line-no">173</span><span id="line-173"> return false;</span> |
| <span class="source-line-no">174</span><span id="line-174"> }</span> |
| <span class="source-line-no">175</span><span id="line-175"> });</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"> return zooKeeperWatcher;</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Gets a ZKWatcher.</span> |
| <span class="source-line-no">182</span><span id="line-182"> */</span> |
| <span class="source-line-no">183</span><span id="line-183"> public static ZKWatcher getZooKeeperWatcher(HBaseZKTestingUtility testUtil) throws IOException {</span> |
| <span class="source-line-no">184</span><span id="line-184"> return new ZKWatcher(testUtil.getConfiguration(), "unittest", new Abortable() {</span> |
| <span class="source-line-no">185</span><span id="line-185"> boolean aborted = false;</span> |
| <span class="source-line-no">186</span><span id="line-186"></span> |
| <span class="source-line-no">187</span><span id="line-187"> @Override</span> |
| <span class="source-line-no">188</span><span id="line-188"> public void abort(String why, Throwable e) {</span> |
| <span class="source-line-no">189</span><span id="line-189"> aborted = true;</span> |
| <span class="source-line-no">190</span><span id="line-190"> throw new RuntimeException("Fatal ZK error, why=" + why, e);</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> @Override</span> |
| <span class="source-line-no">194</span><span id="line-194"> public boolean isAborted() {</span> |
| <span class="source-line-no">195</span><span id="line-195"> return aborted;</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197"> });</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"></span> |
| <span class="source-line-no">200</span><span id="line-200"> /** Returns True if we removed the test dirs */</span> |
| <span class="source-line-no">201</span><span id="line-201"> @Override</span> |
| <span class="source-line-no">202</span><span id="line-202"> public boolean cleanupTestDir() {</span> |
| <span class="source-line-no">203</span><span id="line-203"> boolean ret = super.cleanupTestDir();</span> |
| <span class="source-line-no">204</span><span id="line-204"> if (deleteDir(this.clusterTestDir)) {</span> |
| <span class="source-line-no">205</span><span id="line-205"> this.clusterTestDir = null;</span> |
| <span class="source-line-no">206</span><span id="line-206"> return ret;</span> |
| <span class="source-line-no">207</span><span id="line-207"> }</span> |
| <span class="source-line-no">208</span><span id="line-208"> return false;</span> |
| <span class="source-line-no">209</span><span id="line-209"> }</span> |
| <span class="source-line-no">210</span><span id="line-210">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
