Google Git
Sign in
apache / hbase-site / 2a28054bde0a6b5d8782506cf60e4c280820d61b / . / testdevapidocs / src-html / org / apache / hadoop / hbase / client / RegionReplicaTestHelper.html
blob: 4c7b85f64ca63b44ee76b70746935b84e7433a51 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import static org.junit.Assert.assertEquals;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import static org.junit.Assert.assertNotNull;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import static org.junit.Assert.fail;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.IOException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Optional;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.conf.Configuration;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseTestingUtil;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HRegionLocation;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.NotServingRegionException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.RegionLocations;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.ServerName;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.TableName;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.Waiter;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.Waiter.ExplainingPredicate;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.regionserver.Region;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.util.JVMClusterUtil;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>public final class RegionReplicaTestHelper {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private RegionReplicaTestHelper() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> }<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> // waits for all replicas to have region location<a name="line.45"></a>
<span class="sourceLineNo">046</span> static void waitUntilAllMetaReplicasAreReady(HBaseTestingUtil util, ConnectionRegistry registry)<a name="line.46"></a>
<span class="sourceLineNo">047</span> throws IOException {<a name="line.47"></a>
<span class="sourceLineNo">048</span> Configuration conf = util.getConfiguration();<a name="line.48"></a>
<span class="sourceLineNo">049</span> int regionReplicaCount =<a name="line.49"></a>
<span class="sourceLineNo">050</span> util.getAdmin().getDescriptor(TableName.META_TABLE_NAME).getRegionReplication();<a name="line.50"></a>
<span class="sourceLineNo">051</span> Waiter.waitFor(conf, conf.getLong("hbase.client.sync.wait.timeout.msec", 60000), 200, true,<a name="line.51"></a>
<span class="sourceLineNo">052</span> new ExplainingPredicate&lt;IOException&gt;() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> @Override<a name="line.53"></a>
<span class="sourceLineNo">054</span> public String explainFailure() {<a name="line.54"></a>
<span class="sourceLineNo">055</span> return "Not all meta replicas get assigned";<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public boolean evaluate() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> try {<a name="line.60"></a>
<span class="sourceLineNo">061</span> RegionLocations locs = registry.getMetaRegionLocations().get();<a name="line.61"></a>
<span class="sourceLineNo">062</span> if (locs.size() &lt; regionReplicaCount) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> return false;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span> for (int i = 0; i &lt; regionReplicaCount; i++) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> HRegionLocation loc = locs.getRegionLocation(i);<a name="line.66"></a>
<span class="sourceLineNo">067</span> // Wait until the replica is served by a region server. There could be delay between<a name="line.67"></a>
<span class="sourceLineNo">068</span> // the replica being available to the connection and region server opening it.<a name="line.68"></a>
<span class="sourceLineNo">069</span> Optional&lt;ServerName&gt; rsCarryingReplica =<a name="line.69"></a>
<span class="sourceLineNo">070</span> getRSCarryingReplica(util, loc.getRegion().getTable(), i);<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (!rsCarryingReplica.isPresent()) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return false;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> return true;<a name="line.75"></a>
<span class="sourceLineNo">076</span> } catch (Exception e) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> TestZKConnectionRegistry.LOG.warn("Failed to get meta region locations", e);<a name="line.77"></a>
<span class="sourceLineNo">078</span> return false;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> });<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> static Optional&lt;ServerName&gt; getRSCarryingReplica(HBaseTestingUtil util, TableName tableName,<a name="line.84"></a>
<span class="sourceLineNo">085</span> int replicaId) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return util.getHBaseCluster().getRegionServerThreads().stream().map(t -&gt; t.getRegionServer())<a name="line.86"></a>
<span class="sourceLineNo">087</span> .filter(rs -&gt; rs.getRegions(tableName).stream()<a name="line.87"></a>
<span class="sourceLineNo">088</span> .anyMatch(r -&gt; r.getRegionInfo().getReplicaId() == replicaId))<a name="line.88"></a>
<span class="sourceLineNo">089</span> .findAny().map(rs -&gt; rs.getServerName());<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Return the new location.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> static ServerName moveRegion(HBaseTestingUtil util, HRegionLocation currentLoc) throws Exception {<a name="line.95"></a>
<span class="sourceLineNo">096</span> ServerName serverName = currentLoc.getServerName();<a name="line.96"></a>
<span class="sourceLineNo">097</span> RegionInfo regionInfo = currentLoc.getRegion();<a name="line.97"></a>
<span class="sourceLineNo">098</span> TableName tableName = regionInfo.getTable();<a name="line.98"></a>
<span class="sourceLineNo">099</span> int replicaId = regionInfo.getReplicaId();<a name="line.99"></a>
<span class="sourceLineNo">100</span> ServerName newServerName = util.getHBaseCluster().getRegionServerThreads().stream()<a name="line.100"></a>
<span class="sourceLineNo">101</span> .map(t -&gt; t.getRegionServer().getServerName()).filter(sn -&gt; !sn.equals(serverName)).findAny()<a name="line.101"></a>
<span class="sourceLineNo">102</span> .get();<a name="line.102"></a>
<span class="sourceLineNo">103</span> util.getAdmin().move(regionInfo.getEncodedNameAsBytes(), newServerName);<a name="line.103"></a>
<span class="sourceLineNo">104</span> util.waitFor(30000, new ExplainingPredicate&lt;Exception&gt;() {<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public boolean evaluate() throws Exception {<a name="line.107"></a>
<span class="sourceLineNo">108</span> Optional&lt;ServerName&gt; newServerName = getRSCarryingReplica(util, tableName, replicaId);<a name="line.108"></a>
<span class="sourceLineNo">109</span> return newServerName.isPresent() &amp;&amp; !newServerName.get().equals(serverName);<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> @Override<a name="line.112"></a>
<span class="sourceLineNo">113</span> public String explainFailure() throws Exception {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return regionInfo.getRegionNameAsString() + " is still on " + serverName;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> });<a name="line.116"></a>
<span class="sourceLineNo">117</span> return newServerName;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> interface Locator {<a name="line.120"></a>
<span class="sourceLineNo">121</span> RegionLocations getRegionLocations(TableName tableName, int replicaId, boolean reload)<a name="line.121"></a>
<span class="sourceLineNo">122</span> throws Exception;<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> void updateCachedLocationOnError(HRegionLocation loc, Throwable error) throws Exception;<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> static void testLocator(HBaseTestingUtil util, TableName tableName, Locator locator)<a name="line.127"></a>
<span class="sourceLineNo">128</span> throws Exception {<a name="line.128"></a>
<span class="sourceLineNo">129</span> RegionLocations locs =<a name="line.129"></a>
<span class="sourceLineNo">130</span> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false);<a name="line.130"></a>
<span class="sourceLineNo">131</span> assertEquals(3, locs.size());<a name="line.131"></a>
<span class="sourceLineNo">132</span> for (int i = 0; i &lt; 3; i++) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> HRegionLocation loc = locs.getRegionLocation(i);<a name="line.133"></a>
<span class="sourceLineNo">134</span> assertNotNull(loc);<a name="line.134"></a>
<span class="sourceLineNo">135</span> ServerName serverName = getRSCarryingReplica(util, tableName, i).get();<a name="line.135"></a>
<span class="sourceLineNo">136</span> assertEquals(serverName, loc.getServerName());<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> ServerName newServerName = moveRegion(util, locs.getDefaultRegionLocation());<a name="line.138"></a>
<span class="sourceLineNo">139</span> // The cached location should not be changed<a name="line.139"></a>
<span class="sourceLineNo">140</span> assertEquals(locs.getDefaultRegionLocation().getServerName(),<a name="line.140"></a>
<span class="sourceLineNo">141</span> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false)<a name="line.141"></a>
<span class="sourceLineNo">142</span> .getDefaultRegionLocation().getServerName());<a name="line.142"></a>
<span class="sourceLineNo">143</span> // should get the new location when reload = true<a name="line.143"></a>
<span class="sourceLineNo">144</span> // when meta replica LoadBalance mode is enabled, it may delay a bit.<a name="line.144"></a>
<span class="sourceLineNo">145</span> util.waitFor(3000, new ExplainingPredicate&lt;Exception&gt;() {<a name="line.145"></a>
<span class="sourceLineNo">146</span> @Override<a name="line.146"></a>
<span class="sourceLineNo">147</span> public boolean evaluate() throws Exception {<a name="line.147"></a>
<span class="sourceLineNo">148</span> ServerName sn =<a name="line.148"></a>
<span class="sourceLineNo">149</span> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, true)<a name="line.149"></a>
<span class="sourceLineNo">150</span> .getDefaultRegionLocation().getServerName();<a name="line.150"></a>
<span class="sourceLineNo">151</span> return newServerName.equals(sn);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> @Override<a name="line.154"></a>
<span class="sourceLineNo">155</span> public String explainFailure() throws Exception {<a name="line.155"></a>
<span class="sourceLineNo">156</span> return "New location does not show up in meta (replica) region";<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> });<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> assertEquals(newServerName,<a name="line.160"></a>
<span class="sourceLineNo">161</span> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, true)<a name="line.161"></a>
<span class="sourceLineNo">162</span> .getDefaultRegionLocation().getServerName());<a name="line.162"></a>
<span class="sourceLineNo">163</span> // the cached location should be replaced<a name="line.163"></a>
<span class="sourceLineNo">164</span> assertEquals(newServerName,<a name="line.164"></a>
<span class="sourceLineNo">165</span> locator.getRegionLocations(tableName, RegionReplicaUtil.DEFAULT_REPLICA_ID, false)<a name="line.165"></a>
<span class="sourceLineNo">166</span> .getDefaultRegionLocation().getServerName());<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> ServerName newServerName1 = moveRegion(util, locs.getRegionLocation(1));<a name="line.168"></a>
<span class="sourceLineNo">169</span> ServerName newServerName2 = moveRegion(util, locs.getRegionLocation(2));<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> // The cached location should not be change<a name="line.171"></a>
<span class="sourceLineNo">172</span> assertEquals(locs.getRegionLocation(1).getServerName(),<a name="line.172"></a>
<span class="sourceLineNo">173</span> locator.getRegionLocations(tableName, 1, false).getRegionLocation(1).getServerName());<a name="line.173"></a>
<span class="sourceLineNo">174</span> // clear the cached location for replica 1<a name="line.174"></a>
<span class="sourceLineNo">175</span> locator.updateCachedLocationOnError(locs.getRegionLocation(1), new NotServingRegionException());<a name="line.175"></a>
<span class="sourceLineNo">176</span> // the cached location for replica 2 should not be changed<a name="line.176"></a>
<span class="sourceLineNo">177</span> assertEquals(locs.getRegionLocation(2).getServerName(),<a name="line.177"></a>
<span class="sourceLineNo">178</span> locator.getRegionLocations(tableName, 2, false).getRegionLocation(2).getServerName());<a name="line.178"></a>
<span class="sourceLineNo">179</span> // should get the new location as we have cleared the old location<a name="line.179"></a>
<span class="sourceLineNo">180</span> assertEquals(newServerName1,<a name="line.180"></a>
<span class="sourceLineNo">181</span> locator.getRegionLocations(tableName, 1, false).getRegionLocation(1).getServerName());<a name="line.181"></a>
<span class="sourceLineNo">182</span> // as we will get the new location for replica 2 at once, we should also get the new location<a name="line.182"></a>
<span class="sourceLineNo">183</span> // for replica 2<a name="line.183"></a>
<span class="sourceLineNo">184</span> assertEquals(newServerName2,<a name="line.184"></a>
<span class="sourceLineNo">185</span> locator.getRegionLocations(tableName, 2, false).getRegionLocation(2).getServerName());<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> public static void assertReplicaDistributed(HBaseTestingUtil util, Table t) throws IOException {<a name="line.188"></a>
<span class="sourceLineNo">189</span> if (t.getDescriptor().getRegionReplication() &lt;= 1) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> return;<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> List&lt;RegionInfo&gt; regionInfos = new ArrayList&lt;&gt;();<a name="line.192"></a>
<span class="sourceLineNo">193</span> for (JVMClusterUtil.RegionServerThread rs : util.getMiniHBaseCluster()<a name="line.193"></a>
<span class="sourceLineNo">194</span> .getRegionServerThreads()) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> regionInfos.clear();<a name="line.195"></a>
<span class="sourceLineNo">196</span> for (Region r : rs.getRegionServer().getRegions(t.getName())) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (contains(regionInfos, r.getRegionInfo())) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> fail("Replica regions should be assigned to different region servers");<a name="line.198"></a>
<span class="sourceLineNo">199</span> } else {<a name="line.199"></a>
<span class="sourceLineNo">200</span> regionInfos.add(r.getRegionInfo());<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> private static boolean contains(List&lt;RegionInfo&gt; regionInfos, RegionInfo regionInfo) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> for (RegionInfo info : regionInfos) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> if (RegionReplicaUtil.isReplicasForSameRegion(info, regionInfo)) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> return true;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span> return false;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span>}<a name="line.214"></a>
</pre>
</div>
</body>
</html>