blob: 5d1087ccd50574a587c6bb8bd752407d666beeeb [file] [log] [blame]
<!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.client, class: RegionReplicaTestHelper">
<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.client;</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 static org.junit.Assert.assertEquals;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertNotNull;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.junit.Assert.fail;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.ArrayList;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.List;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Optional;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.HBaseTestingUtil;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HRegionLocation;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.NotServingRegionException;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.RegionLocations;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.Waiter;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.Waiter.ExplainingPredicate;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.regionserver.Region;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.JVMClusterUtil;</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40">public final class RegionReplicaTestHelper {</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 RegionReplicaTestHelper() {</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> // waits for all replicas to have region location</span>
<span class="source-line-no">046</span><span id="line-46"> static void waitUntilAllMetaReplicasAreReady(HBaseTestingUtil util, ConnectionRegistry registry)</span>
<span class="source-line-no">047</span><span id="line-47"> throws IOException {</span>
<span class="source-line-no">048</span><span id="line-48"> Configuration conf = util.getConfiguration();</span>
<span class="source-line-no">049</span><span id="line-49"> int regionReplicaCount =</span>
<span class="source-line-no">050</span><span id="line-50"> util.getAdmin().getDescriptor(TableName.META_TABLE_NAME).getRegionReplication();</span>
<span class="source-line-no">051</span><span id="line-51"> Waiter.waitFor(conf, conf.getLong("hbase.client.sync.wait.timeout.msec", 60000), 200, true,</span>
<span class="source-line-no">052</span><span id="line-52"> new ExplainingPredicate&lt;IOException&gt;() {</span>
<span class="source-line-no">053</span><span id="line-53"> @Override</span>
<span class="source-line-no">054</span><span id="line-54"> public String explainFailure() {</span>
<span class="source-line-no">055</span><span id="line-55"> return "Not all meta replicas get assigned";</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"> @Override</span>
<span class="source-line-no">059</span><span id="line-59"> public boolean evaluate() {</span>
<span class="source-line-no">060</span><span id="line-60"> try {</span>
<span class="source-line-no">061</span><span id="line-61"> RegionLocations locs = registry.getMetaRegionLocations().get();</span>
<span class="source-line-no">062</span><span id="line-62"> if (locs.size() &lt; regionReplicaCount) {</span>
<span class="source-line-no">063</span><span id="line-63"> return false;</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"> for (int i = 0; i &lt; regionReplicaCount; i++) {</span>
<span class="source-line-no">066</span><span id="line-66"> HRegionLocation loc = locs.getRegionLocation(i);</span>
<span class="source-line-no">067</span><span id="line-67"> // Wait until the replica is served by a region server. There could be delay between</span>
<span class="source-line-no">068</span><span id="line-68"> // the replica being available to the connection and region server opening it.</span>
<span class="source-line-no">069</span><span id="line-69"> Optional&lt;ServerName&gt; rsCarryingReplica =</span>
<span class="source-line-no">070</span><span id="line-70"> getRSCarryingReplica(util, loc.getRegion().getTable(), i);</span>
<span class="source-line-no">071</span><span id="line-71"> if (!rsCarryingReplica.isPresent()) {</span>
<span class="source-line-no">072</span><span id="line-72"> return false;</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> return true;</span>
<span class="source-line-no">076</span><span id="line-76"> } catch (Exception e) {</span>
<span class="source-line-no">077</span><span id="line-77"> TestZKConnectionRegistry.LOG.warn("Failed to get meta region locations", e);</span>
<span class="source-line-no">078</span><span id="line-78"> return false;</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"> });</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"> static Optional&lt;ServerName&gt; getRSCarryingReplica(HBaseTestingUtil util, TableName tableName,</span>
<span class="source-line-no">085</span><span id="line-85"> int replicaId) {</span>
<span class="source-line-no">086</span><span id="line-86"> return util.getHBaseCluster().getRegionServerThreads().stream().map(t -&gt; t.getRegionServer())</span>
<span class="source-line-no">087</span><span id="line-87"> .filter(rs -&gt; rs.getRegions(tableName).stream()</span>
<span class="source-line-no">088</span><span id="line-88"> .anyMatch(r -&gt; r.getRegionInfo().getReplicaId() == replicaId))</span>
<span class="source-line-no">089</span><span id="line-89"> .findAny().map(rs -&gt; rs.getServerName());</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"> * Return the new location.</span>
<span class="source-line-no">094</span><span id="line-94"> */</span>
<span class="source-line-no">095</span><span id="line-95"> static ServerName moveRegion(HBaseTestingUtil util, HRegionLocation currentLoc) throws Exception {</span>
<span class="source-line-no">096</span><span id="line-96"> ServerName serverName = currentLoc.getServerName();</span>
<span class="source-line-no">097</span><span id="line-97"> RegionInfo regionInfo = currentLoc.getRegion();</span>
<span class="source-line-no">098</span><span id="line-98"> TableName tableName = regionInfo.getTable();</span>
<span class="source-line-no">099</span><span id="line-99"> int replicaId = regionInfo.getReplicaId();</span>
<span class="source-line-no">100</span><span id="line-100"> ServerName newServerName = util.getHBaseCluster().getRegionServerThreads().stream()</span>
<span class="source-line-no">101</span><span id="line-101"> .map(t -&gt; t.getRegionServer().getServerName()).filter(sn -&gt; !sn.equals(serverName)).findAny()</span>
<span class="source-line-no">102</span><span id="line-102"> .get();</span>
<span class="source-line-no">103</span><span id="line-103"> util.getAdmin().move(regionInfo.getEncodedNameAsBytes(), newServerName);</span>
<span class="source-line-no">104</span><span id="line-104"> util.waitFor(30000, new ExplainingPredicate&lt;Exception&gt;() {</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> @Override</span>
<span class="source-line-no">107</span><span id="line-107"> public boolean evaluate() throws Exception {</span>
<span class="source-line-no">108</span><span id="line-108"> Optional&lt;ServerName&gt; newServerName = getRSCarryingReplica(util, tableName, replicaId);</span>
<span class="source-line-no">109</span><span id="line-109"> return newServerName.isPresent() &amp;&amp; !newServerName.get().equals(serverName);</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> @Override</span>
<span class="source-line-no">113</span><span id="line-113"> public String explainFailure() throws Exception {</span>
<span class="source-line-no">114</span><span id="line-114"> return regionInfo.getRegionNameAsString() + " is still on " + serverName;</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"> });</span>
<span class="source-line-no">117</span><span id="line-117"> return newServerName;</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"> interface Locator {</span>
<span class="source-line-no">121</span><span id="line-121"> RegionLocations getRegionLocations(TableName tableName, int replicaId, boolean reload)</span>
<span class="source-line-no">122</span><span id="line-122"> throws Exception;</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> void updateCachedLocationOnError(HRegionLocation loc, Throwable error) throws Exception;</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"> static void testLocator(HBaseTestingUtil util, TableName tableName, Locator locator)</span>
<span class="source-line-no">128</span><span id="line-128"> throws Exception {</span>
<span class="source-line-no">129</span><span id="line-129"> RegionLocations locs =</span>
<span class="source-line-no">130</span><span id="line-130"> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false);</span>
<span class="source-line-no">131</span><span id="line-131"> assertEquals(3, locs.size());</span>
<span class="source-line-no">132</span><span id="line-132"> for (int i = 0; i &lt; 3; i++) {</span>
<span class="source-line-no">133</span><span id="line-133"> HRegionLocation loc = locs.getRegionLocation(i);</span>
<span class="source-line-no">134</span><span id="line-134"> assertNotNull(loc);</span>
<span class="source-line-no">135</span><span id="line-135"> ServerName serverName = getRSCarryingReplica(util, tableName, i).get();</span>
<span class="source-line-no">136</span><span id="line-136"> assertEquals(serverName, loc.getServerName());</span>
<span class="source-line-no">137</span><span id="line-137"> }</span>
<span class="source-line-no">138</span><span id="line-138"> ServerName newServerName = moveRegion(util, locs.getDefaultRegionLocation());</span>
<span class="source-line-no">139</span><span id="line-139"> // The cached location should not be changed</span>
<span class="source-line-no">140</span><span id="line-140"> assertEquals(locs.getDefaultRegionLocation().getServerName(),</span>
<span class="source-line-no">141</span><span id="line-141"> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false)</span>
<span class="source-line-no">142</span><span id="line-142"> .getDefaultRegionLocation().getServerName());</span>
<span class="source-line-no">143</span><span id="line-143"> // should get the new location when reload = true</span>
<span class="source-line-no">144</span><span id="line-144"> // when meta replica LoadBalance mode is enabled, it may delay a bit.</span>
<span class="source-line-no">145</span><span id="line-145"> util.waitFor(3000, new ExplainingPredicate&lt;Exception&gt;() {</span>
<span class="source-line-no">146</span><span id="line-146"> @Override</span>
<span class="source-line-no">147</span><span id="line-147"> public boolean evaluate() throws Exception {</span>
<span class="source-line-no">148</span><span id="line-148"> ServerName sn =</span>
<span class="source-line-no">149</span><span id="line-149"> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, true)</span>
<span class="source-line-no">150</span><span id="line-150"> .getDefaultRegionLocation().getServerName();</span>
<span class="source-line-no">151</span><span id="line-151"> return newServerName.equals(sn);</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"> @Override</span>
<span class="source-line-no">155</span><span id="line-155"> public String explainFailure() throws Exception {</span>
<span class="source-line-no">156</span><span id="line-156"> return "New location does not show up in meta (replica) region";</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"></span>
<span class="source-line-no">160</span><span id="line-160"> assertEquals(newServerName,</span>
<span class="source-line-no">161</span><span id="line-161"> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, true)</span>
<span class="source-line-no">162</span><span id="line-162"> .getDefaultRegionLocation().getServerName());</span>
<span class="source-line-no">163</span><span id="line-163"> // the cached location should be replaced</span>
<span class="source-line-no">164</span><span id="line-164"> assertEquals(newServerName,</span>
<span class="source-line-no">165</span><span id="line-165"> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false)</span>
<span class="source-line-no">166</span><span id="line-166"> .getDefaultRegionLocation().getServerName());</span>
<span class="source-line-no">167</span><span id="line-167"></span>
<span class="source-line-no">168</span><span id="line-168"> ServerName newServerName1 = moveRegion(util, locs.getRegionLocation(1));</span>
<span class="source-line-no">169</span><span id="line-169"> ServerName newServerName2 = moveRegion(util, locs.getRegionLocation(2));</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> // The cached location should not be change</span>
<span class="source-line-no">172</span><span id="line-172"> assertEquals(locs.getRegionLocation(1).getServerName(),</span>
<span class="source-line-no">173</span><span id="line-173"> locator.getRegionLocations(tableName, 1, false).getRegionLocation(1).getServerName());</span>
<span class="source-line-no">174</span><span id="line-174"> // clear the cached location for replica 1</span>
<span class="source-line-no">175</span><span id="line-175"> locator.updateCachedLocationOnError(locs.getRegionLocation(1), new NotServingRegionException());</span>
<span class="source-line-no">176</span><span id="line-176"> // the cached location for replica 2 should not be changed</span>
<span class="source-line-no">177</span><span id="line-177"> assertEquals(locs.getRegionLocation(2).getServerName(),</span>
<span class="source-line-no">178</span><span id="line-178"> locator.getRegionLocations(tableName, 2, false).getRegionLocation(2).getServerName());</span>
<span class="source-line-no">179</span><span id="line-179"> // should get the new location as we have cleared the old location</span>
<span class="source-line-no">180</span><span id="line-180"> assertEquals(newServerName1,</span>
<span class="source-line-no">181</span><span id="line-181"> locator.getRegionLocations(tableName, 1, false).getRegionLocation(1).getServerName());</span>
<span class="source-line-no">182</span><span id="line-182"> // as we will get the new location for replica 2 at once, we should also get the new location</span>
<span class="source-line-no">183</span><span id="line-183"> // for replica 2</span>
<span class="source-line-no">184</span><span id="line-184"> assertEquals(newServerName2,</span>
<span class="source-line-no">185</span><span id="line-185"> locator.getRegionLocations(tableName, 2, false).getRegionLocation(2).getServerName());</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> public static void assertReplicaDistributed(HBaseTestingUtil util, Table t) throws IOException {</span>
<span class="source-line-no">189</span><span id="line-189"> if (t.getDescriptor().getRegionReplication() &lt;= 1) {</span>
<span class="source-line-no">190</span><span id="line-190"> return;</span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"> List&lt;RegionInfo&gt; regionInfos = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">193</span><span id="line-193"> for (JVMClusterUtil.RegionServerThread rs : util.getMiniHBaseCluster()</span>
<span class="source-line-no">194</span><span id="line-194"> .getRegionServerThreads()) {</span>
<span class="source-line-no">195</span><span id="line-195"> regionInfos.clear();</span>
<span class="source-line-no">196</span><span id="line-196"> for (Region r : rs.getRegionServer().getRegions(t.getName())) {</span>
<span class="source-line-no">197</span><span id="line-197"> if (contains(regionInfos, r.getRegionInfo())) {</span>
<span class="source-line-no">198</span><span id="line-198"> fail("Replica regions should be assigned to different region servers");</span>
<span class="source-line-no">199</span><span id="line-199"> } else {</span>
<span class="source-line-no">200</span><span id="line-200"> regionInfos.add(r.getRegionInfo());</span>
<span class="source-line-no">201</span><span id="line-201"> }</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> }</span>
<span class="source-line-no">204</span><span id="line-204"> }</span>
<span class="source-line-no">205</span><span id="line-205"></span>
<span class="source-line-no">206</span><span id="line-206"> private static boolean contains(List&lt;RegionInfo&gt; regionInfos, RegionInfo regionInfo) {</span>
<span class="source-line-no">207</span><span id="line-207"> for (RegionInfo info : regionInfos) {</span>
<span class="source-line-no">208</span><span id="line-208"> if (RegionReplicaUtil.isReplicasForSameRegion(info, regionInfo)) {</span>
<span class="source-line-no">209</span><span id="line-209"> return true;</span>
<span class="source-line-no">210</span><span id="line-210"> }</span>
<span class="source-line-no">211</span><span id="line-211"> }</span>
<span class="source-line-no">212</span><span id="line-212"> return false;</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214">}</span>
</pre>
</div>
</main>
</body>
</html>