| <!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: HBaseCommonTestingUtil, class: PortAllocator"> |
| <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 java.net.ServerSocket;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Arrays;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.HashSet;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.List;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Random;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Set;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.UUID;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.ThreadLocalRandom;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.commons.io.FileUtils;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.Waiter.Predicate;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.io.compress.Compression;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.slf4j.Logger;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40">/**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * Common helpers for testing HBase that do not depend on specific server/etc. things.</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.PHOENIX)</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">045</span><span id="line-45">public class HBaseCommonTestingUtil {</span> |
| <span class="source-line-no">046</span><span id="line-46"> protected static final Logger LOG = LoggerFactory.getLogger(HBaseCommonTestingUtil.class);</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> /**</span> |
| <span class="source-line-no">049</span><span id="line-49"> * Compression algorithms to use in parameterized JUnit 4 tests</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> public static final List<Object[]> COMPRESSION_ALGORITHMS_PARAMETERIZED =</span> |
| <span class="source-line-no">052</span><span id="line-52"> Arrays.asList(new Object[][] { { Compression.Algorithm.NONE }, { Compression.Algorithm.GZ } });</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * This is for unit tests parameterized with a two booleans.</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57"> public static final List<Object[]> BOOLEAN_PARAMETERIZED =</span> |
| <span class="source-line-no">058</span><span id="line-58"> Arrays.asList(new Object[][] { { false }, { true } });</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> /**</span> |
| <span class="source-line-no">061</span><span id="line-61"> * Compression algorithms to use in testing</span> |
| <span class="source-line-no">062</span><span id="line-62"> */</span> |
| <span class="source-line-no">063</span><span id="line-63"> public static final Compression.Algorithm[] COMPRESSION_ALGORITHMS =</span> |
| <span class="source-line-no">064</span><span id="line-64"> { Compression.Algorithm.NONE, Compression.Algorithm.GZ };</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> protected final Configuration conf;</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 HBaseCommonTestingUtil() {</span> |
| <span class="source-line-no">069</span><span id="line-69"> this(null);</span> |
| <span class="source-line-no">070</span><span id="line-70"> }</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> public HBaseCommonTestingUtil(Configuration conf) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> this.conf = (conf == null ? HBaseConfiguration.create() : conf);</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"> /**</span> |
| <span class="source-line-no">077</span><span id="line-77"> * Returns this classes's instance of {@link Configuration}.</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @return Instance of Configuration.</span> |
| <span class="source-line-no">079</span><span id="line-79"> */</span> |
| <span class="source-line-no">080</span><span id="line-80"> public Configuration getConfiguration() {</span> |
| <span class="source-line-no">081</span><span id="line-81"> return this.conf;</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</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"> * System property key to get base test directory value</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> public static final String BASE_TEST_DIRECTORY_KEY = "test.build.data.basedirectory";</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> /**</span> |
| <span class="source-line-no">090</span><span id="line-90"> * Default base directory for test output.</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> public static final String DEFAULT_BASE_TEST_DIRECTORY = "target/test-data";</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /**</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Directory where we put the data for this instance of HBaseTestingUtility</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> private File dataTestDir = null;</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /**</span> |
| <span class="source-line-no">100</span><span id="line-100"> * Returns Where to write test data on local filesystem, specific to the test. Useful for tests</span> |
| <span class="source-line-no">101</span><span id="line-101"> * that do not use a cluster. Creates it if it does not exist already.</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> public Path getDataTestDir() {</span> |
| <span class="source-line-no">104</span><span id="line-104"> if (this.dataTestDir == null) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> setupDataTestDir();</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"> return new Path(this.dataTestDir.getAbsolutePath());</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> /**</span> |
| <span class="source-line-no">111</span><span id="line-111"> * Returns the path to a subdirectory or file named {code subdirName} under</span> |
| <span class="source-line-no">112</span><span id="line-112"> * {@link #getDataTestDir()}. Does *NOT* create the directory or file if it does not exist.</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @param name the name of a subdirectory or file in the test data directory</span> |
| <span class="source-line-no">114</span><span id="line-114"> */</span> |
| <span class="source-line-no">115</span><span id="line-115"> public Path getDataTestDir(final String name) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> return new Path(getDataTestDir(), name);</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> /**</span> |
| <span class="source-line-no">120</span><span id="line-120"> * Sets up a directory for a test to use.</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @return New directory path, if created.</span> |
| <span class="source-line-no">122</span><span id="line-122"> */</span> |
| <span class="source-line-no">123</span><span id="line-123"> protected Path setupDataTestDir() {</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (this.dataTestDir != null) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> LOG.warn("Data test dir already setup in " + dataTestDir.getAbsolutePath());</span> |
| <span class="source-line-no">126</span><span id="line-126"> return null;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"> Path testPath = getRandomDir();</span> |
| <span class="source-line-no">129</span><span id="line-129"> this.dataTestDir = new File(testPath.toString()).getAbsoluteFile();</span> |
| <span class="source-line-no">130</span><span id="line-130"> // Set this property so if mapreduce jobs run, they will use this as their home dir.</span> |
| <span class="source-line-no">131</span><span id="line-131"> System.setProperty("test.build.dir", this.dataTestDir.toString());</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> if (deleteOnExit()) {</span> |
| <span class="source-line-no">134</span><span id="line-134"> this.dataTestDir.deleteOnExit();</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"> createSubDir("hbase.local.dir", testPath, "hbase-local-dir");</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> return testPath;</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</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"> * Returns a dir with a random (uuid) name under the test dir</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @see #getBaseTestDir()</span> |
| <span class="source-line-no">145</span><span id="line-145"> */</span> |
| <span class="source-line-no">146</span><span id="line-146"> public Path getRandomDir() {</span> |
| <span class="source-line-no">147</span><span id="line-147"> return new Path(getBaseTestDir(), getRandomUUID().toString());</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> public static UUID getRandomUUID() {</span> |
| <span class="source-line-no">151</span><span id="line-151"> return new UUID(ThreadLocalRandom.current().nextLong(), ThreadLocalRandom.current().nextLong());</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> protected void createSubDir(String propertyName, Path parent, String subDirName) {</span> |
| <span class="source-line-no">155</span><span id="line-155"> Path newPath = new Path(parent, subDirName);</span> |
| <span class="source-line-no">156</span><span id="line-156"> File newDir = new File(newPath.toString()).getAbsoluteFile();</span> |
| <span class="source-line-no">157</span><span id="line-157"></span> |
| <span class="source-line-no">158</span><span id="line-158"> if (deleteOnExit()) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> newDir.deleteOnExit();</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> conf.set(propertyName, newDir.getAbsolutePath());</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"></span> |
| <span class="source-line-no">165</span><span id="line-165"> /**</span> |
| <span class="source-line-no">166</span><span id="line-166"> * Returns true if we should delete testing dirs on exit.</span> |
| <span class="source-line-no">167</span><span id="line-167"> */</span> |
| <span class="source-line-no">168</span><span id="line-168"> boolean deleteOnExit() {</span> |
| <span class="source-line-no">169</span><span id="line-169"> String v = System.getProperty("hbase.testing.preserve.testdir");</span> |
| <span class="source-line-no">170</span><span id="line-170"> // Let default be true, to delete on exit.</span> |
| <span class="source-line-no">171</span><span id="line-171"> return v == null ? true : !Boolean.parseBoolean(v);</span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"></span> |
| <span class="source-line-no">174</span><span id="line-174"> /**</span> |
| <span class="source-line-no">175</span><span id="line-175"> * Returns true if we removed the test dirs</span> |
| <span class="source-line-no">176</span><span id="line-176"> */</span> |
| <span class="source-line-no">177</span><span id="line-177"> public boolean cleanupTestDir() {</span> |
| <span class="source-line-no">178</span><span id="line-178"> if (deleteDir(this.dataTestDir)) {</span> |
| <span class="source-line-no">179</span><span id="line-179"> this.dataTestDir = null;</span> |
| <span class="source-line-no">180</span><span id="line-180"> return true;</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"> return false;</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> /**</span> |
| <span class="source-line-no">186</span><span id="line-186"> * Returns true if we removed the test dir</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @param subdir Test subdir name.</span> |
| <span class="source-line-no">188</span><span id="line-188"> */</span> |
| <span class="source-line-no">189</span><span id="line-189"> public boolean cleanupTestDir(final String subdir) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> if (this.dataTestDir == null) {</span> |
| <span class="source-line-no">191</span><span id="line-191"> return false;</span> |
| <span class="source-line-no">192</span><span id="line-192"> }</span> |
| <span class="source-line-no">193</span><span id="line-193"> return deleteDir(new File(this.dataTestDir, subdir));</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> /**</span> |
| <span class="source-line-no">197</span><span id="line-197"> * Returns Where to write test data on local filesystem; usually</span> |
| <span class="source-line-no">198</span><span id="line-198"> * {@link #DEFAULT_BASE_TEST_DIRECTORY} Should not be used by the unit tests, hence its's private.</span> |
| <span class="source-line-no">199</span><span id="line-199"> * Unit test will use a subdirectory of this directory.</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @see #setupDataTestDir()</span> |
| <span class="source-line-no">201</span><span id="line-201"> */</span> |
| <span class="source-line-no">202</span><span id="line-202"> private Path getBaseTestDir() {</span> |
| <span class="source-line-no">203</span><span id="line-203"> String PathName = System.getProperty(BASE_TEST_DIRECTORY_KEY, DEFAULT_BASE_TEST_DIRECTORY);</span> |
| <span class="source-line-no">204</span><span id="line-204"></span> |
| <span class="source-line-no">205</span><span id="line-205"> return new Path(PathName);</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> /**</span> |
| <span class="source-line-no">209</span><span id="line-209"> * Returns true if we deleted it.</span> |
| <span class="source-line-no">210</span><span id="line-210"> * @param dir Directory to delete</span> |
| <span class="source-line-no">211</span><span id="line-211"> */</span> |
| <span class="source-line-no">212</span><span id="line-212"> boolean deleteDir(final File dir) {</span> |
| <span class="source-line-no">213</span><span id="line-213"> if (dir == null || !dir.exists()) {</span> |
| <span class="source-line-no">214</span><span id="line-214"> return true;</span> |
| <span class="source-line-no">215</span><span id="line-215"> }</span> |
| <span class="source-line-no">216</span><span id="line-216"> int ntries = 0;</span> |
| <span class="source-line-no">217</span><span id="line-217"> do {</span> |
| <span class="source-line-no">218</span><span id="line-218"> ntries += 1;</span> |
| <span class="source-line-no">219</span><span id="line-219"> try {</span> |
| <span class="source-line-no">220</span><span id="line-220"> if (deleteOnExit()) {</span> |
| <span class="source-line-no">221</span><span id="line-221"> FileUtils.deleteDirectory(dir);</span> |
| <span class="source-line-no">222</span><span id="line-222"> }</span> |
| <span class="source-line-no">223</span><span id="line-223"></span> |
| <span class="source-line-no">224</span><span id="line-224"> return true;</span> |
| <span class="source-line-no">225</span><span id="line-225"> } catch (IOException ex) {</span> |
| <span class="source-line-no">226</span><span id="line-226"> LOG.warn("Failed to delete " + dir.getAbsolutePath());</span> |
| <span class="source-line-no">227</span><span id="line-227"> } catch (IllegalArgumentException ex) {</span> |
| <span class="source-line-no">228</span><span id="line-228"> LOG.warn("Failed to delete " + dir.getAbsolutePath(), ex);</span> |
| <span class="source-line-no">229</span><span id="line-229"> }</span> |
| <span class="source-line-no">230</span><span id="line-230"> } while (ntries < 30);</span> |
| <span class="source-line-no">231</span><span id="line-231"></span> |
| <span class="source-line-no">232</span><span id="line-232"> return false;</span> |
| <span class="source-line-no">233</span><span id="line-233"> }</span> |
| <span class="source-line-no">234</span><span id="line-234"></span> |
| <span class="source-line-no">235</span><span id="line-235"> /**</span> |
| <span class="source-line-no">236</span><span id="line-236"> * Wrapper method for {@link Waiter#waitFor(Configuration, long, Predicate)}.</span> |
| <span class="source-line-no">237</span><span id="line-237"> */</span> |
| <span class="source-line-no">238</span><span id="line-238"> public <E extends Exception> long waitFor(long timeout, Predicate<E> predicate) throws E {</span> |
| <span class="source-line-no">239</span><span id="line-239"> return Waiter.waitFor(this.conf, timeout, predicate);</span> |
| <span class="source-line-no">240</span><span id="line-240"> }</span> |
| <span class="source-line-no">241</span><span id="line-241"></span> |
| <span class="source-line-no">242</span><span id="line-242"> /**</span> |
| <span class="source-line-no">243</span><span id="line-243"> * Wrapper method for {@link Waiter#waitFor(Configuration, long, long, Predicate)}.</span> |
| <span class="source-line-no">244</span><span id="line-244"> */</span> |
| <span class="source-line-no">245</span><span id="line-245"> public <E extends Exception> long waitFor(long timeout, long interval, Predicate<E> predicate)</span> |
| <span class="source-line-no">246</span><span id="line-246"> throws E {</span> |
| <span class="source-line-no">247</span><span id="line-247"> return Waiter.waitFor(this.conf, timeout, interval, predicate);</span> |
| <span class="source-line-no">248</span><span id="line-248"> }</span> |
| <span class="source-line-no">249</span><span id="line-249"></span> |
| <span class="source-line-no">250</span><span id="line-250"> /**</span> |
| <span class="source-line-no">251</span><span id="line-251"> * Wrapper method for {@link Waiter#waitFor(Configuration, long, long, boolean, Predicate)}.</span> |
| <span class="source-line-no">252</span><span id="line-252"> */</span> |
| <span class="source-line-no">253</span><span id="line-253"> public <E extends Exception> long waitFor(long timeout, long interval, boolean failIfTimeout,</span> |
| <span class="source-line-no">254</span><span id="line-254"> Predicate<E> predicate) throws E {</span> |
| <span class="source-line-no">255</span><span id="line-255"> return Waiter.waitFor(this.conf, timeout, interval, failIfTimeout, predicate);</span> |
| <span class="source-line-no">256</span><span id="line-256"> }</span> |
| <span class="source-line-no">257</span><span id="line-257"></span> |
| <span class="source-line-no">258</span><span id="line-258"> private static final PortAllocator portAllocator = new PortAllocator();</span> |
| <span class="source-line-no">259</span><span id="line-259"></span> |
| <span class="source-line-no">260</span><span id="line-260"> public static int randomFreePort() {</span> |
| <span class="source-line-no">261</span><span id="line-261"> return portAllocator.randomFreePort();</span> |
| <span class="source-line-no">262</span><span id="line-262"> }</span> |
| <span class="source-line-no">263</span><span id="line-263"></span> |
| <span class="source-line-no">264</span><span id="line-264"> static class PortAllocator {</span> |
| <span class="source-line-no">265</span><span id="line-265"> private static final int MIN_RANDOM_PORT = 0xc000;</span> |
| <span class="source-line-no">266</span><span id="line-266"> private static final int MAX_RANDOM_PORT = 0xfffe;</span> |
| <span class="source-line-no">267</span><span id="line-267"></span> |
| <span class="source-line-no">268</span><span id="line-268"> /** A set of ports that have been claimed using {@link #randomFreePort()}. */</span> |
| <span class="source-line-no">269</span><span id="line-269"> private final Set<Integer> takenRandomPorts = new HashSet<>();</span> |
| <span class="source-line-no">270</span><span id="line-270"> private final Random random;</span> |
| <span class="source-line-no">271</span><span id="line-271"> private final AvailablePortChecker portChecker;</span> |
| <span class="source-line-no">272</span><span id="line-272"></span> |
| <span class="source-line-no">273</span><span id="line-273"> public PortAllocator() {</span> |
| <span class="source-line-no">274</span><span id="line-274"> this.random = new Random();</span> |
| <span class="source-line-no">275</span><span id="line-275"> this.portChecker = new AvailablePortChecker() {</span> |
| <span class="source-line-no">276</span><span id="line-276"> @Override</span> |
| <span class="source-line-no">277</span><span id="line-277"> public boolean available(int port) {</span> |
| <span class="source-line-no">278</span><span id="line-278"> try {</span> |
| <span class="source-line-no">279</span><span id="line-279"> ServerSocket sock = new ServerSocket(port);</span> |
| <span class="source-line-no">280</span><span id="line-280"> sock.close();</span> |
| <span class="source-line-no">281</span><span id="line-281"> return true;</span> |
| <span class="source-line-no">282</span><span id="line-282"> } catch (IOException ex) {</span> |
| <span class="source-line-no">283</span><span id="line-283"> return false;</span> |
| <span class="source-line-no">284</span><span id="line-284"> }</span> |
| <span class="source-line-no">285</span><span id="line-285"> }</span> |
| <span class="source-line-no">286</span><span id="line-286"> };</span> |
| <span class="source-line-no">287</span><span id="line-287"> }</span> |
| <span class="source-line-no">288</span><span id="line-288"></span> |
| <span class="source-line-no">289</span><span id="line-289"> public PortAllocator(Random random, AvailablePortChecker portChecker) {</span> |
| <span class="source-line-no">290</span><span id="line-290"> this.random = random;</span> |
| <span class="source-line-no">291</span><span id="line-291"> this.portChecker = portChecker;</span> |
| <span class="source-line-no">292</span><span id="line-292"> }</span> |
| <span class="source-line-no">293</span><span id="line-293"></span> |
| <span class="source-line-no">294</span><span id="line-294"> public PortAllocator(AvailablePortChecker portChecker) {</span> |
| <span class="source-line-no">295</span><span id="line-295"> this(new Random(), portChecker);</span> |
| <span class="source-line-no">296</span><span id="line-296"> }</span> |
| <span class="source-line-no">297</span><span id="line-297"></span> |
| <span class="source-line-no">298</span><span id="line-298"> /**</span> |
| <span class="source-line-no">299</span><span id="line-299"> * Returns a random free port and marks that port as taken. Not thread-safe. Expected to be</span> |
| <span class="source-line-no">300</span><span id="line-300"> * called from single-threaded test setup code/</span> |
| <span class="source-line-no">301</span><span id="line-301"> */</span> |
| <span class="source-line-no">302</span><span id="line-302"> public int randomFreePort() {</span> |
| <span class="source-line-no">303</span><span id="line-303"> int port = 0;</span> |
| <span class="source-line-no">304</span><span id="line-304"> do {</span> |
| <span class="source-line-no">305</span><span id="line-305"> port = randomPort();</span> |
| <span class="source-line-no">306</span><span id="line-306"> if (takenRandomPorts.contains(port)) {</span> |
| <span class="source-line-no">307</span><span id="line-307"> port = 0;</span> |
| <span class="source-line-no">308</span><span id="line-308"> continue;</span> |
| <span class="source-line-no">309</span><span id="line-309"> }</span> |
| <span class="source-line-no">310</span><span id="line-310"> takenRandomPorts.add(port);</span> |
| <span class="source-line-no">311</span><span id="line-311"></span> |
| <span class="source-line-no">312</span><span id="line-312"> if (!portChecker.available(port)) {</span> |
| <span class="source-line-no">313</span><span id="line-313"> port = 0;</span> |
| <span class="source-line-no">314</span><span id="line-314"> }</span> |
| <span class="source-line-no">315</span><span id="line-315"> } while (port == 0);</span> |
| <span class="source-line-no">316</span><span id="line-316"> return port;</span> |
| <span class="source-line-no">317</span><span id="line-317"> }</span> |
| <span class="source-line-no">318</span><span id="line-318"></span> |
| <span class="source-line-no">319</span><span id="line-319"> /**</span> |
| <span class="source-line-no">320</span><span id="line-320"> * Returns a random port. These ports cannot be registered with IANA and are intended for</span> |
| <span class="source-line-no">321</span><span id="line-321"> * dynamic allocation (see http://bit.ly/dynports).</span> |
| <span class="source-line-no">322</span><span id="line-322"> */</span> |
| <span class="source-line-no">323</span><span id="line-323"> private int randomPort() {</span> |
| <span class="source-line-no">324</span><span id="line-324"> return MIN_RANDOM_PORT + random.nextInt(MAX_RANDOM_PORT - MIN_RANDOM_PORT);</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326"></span> |
| <span class="source-line-no">327</span><span id="line-327"> interface AvailablePortChecker {</span> |
| <span class="source-line-no">328</span><span id="line-328"> boolean available(int port);</span> |
| <span class="source-line-no">329</span><span id="line-329"> }</span> |
| <span class="source-line-no">330</span><span id="line-330"> }</span> |
| <span class="source-line-no">331</span><span id="line-331">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
