blob: a7af08a5c26005873d1f1430cda96cda248319c0 [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: TestAsyncQuotaAdminApi">
<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.apache.hadoop.hbase.client.AsyncConnectionConfiguration.START_LOG_ERRORS_AFTER_COUNT_KEY;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.junit.Assert.assertEquals;</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.util.Objects;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HBaseClassTestRule;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.quotas.QuotaCache;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.quotas.QuotaFilter;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.quotas.QuotaSettings;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.quotas.QuotaSettingsFactory;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.quotas.QuotaTableUtil;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.quotas.QuotaUtil;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.quotas.ThrottleType;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.testclassification.ClientTests;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.testclassification.MediumTests;</span>
<span class="source-line-no">040</span><span id="line-40">import org.junit.BeforeClass;</span>
<span class="source-line-no">041</span><span id="line-41">import org.junit.ClassRule;</span>
<span class="source-line-no">042</span><span id="line-42">import org.junit.Test;</span>
<span class="source-line-no">043</span><span id="line-43">import org.junit.experimental.categories.Category;</span>
<span class="source-line-no">044</span><span id="line-44">import org.junit.runner.RunWith;</span>
<span class="source-line-no">045</span><span id="line-45">import org.junit.runners.Parameterized;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">@RunWith(Parameterized.class)</span>
<span class="source-line-no">048</span><span id="line-48">@Category({ ClientTests.class, MediumTests.class })</span>
<span class="source-line-no">049</span><span id="line-49">public class TestAsyncQuotaAdminApi extends TestAsyncAdminBase {</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> @ClassRule</span>
<span class="source-line-no">052</span><span id="line-52"> public static final HBaseClassTestRule CLASS_RULE =</span>
<span class="source-line-no">053</span><span id="line-53"> HBaseClassTestRule.forClass(TestAsyncQuotaAdminApi.class);</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> @BeforeClass</span>
<span class="source-line-no">056</span><span id="line-56"> public static void setUpBeforeClass() throws Exception {</span>
<span class="source-line-no">057</span><span id="line-57"> TEST_UTIL.getConfiguration().setBoolean(QuotaUtil.QUOTA_CONF_KEY, true);</span>
<span class="source-line-no">058</span><span id="line-58"> TEST_UTIL.getConfiguration().setInt(QuotaCache.REFRESH_CONF_KEY, 2000);</span>
<span class="source-line-no">059</span><span id="line-59"> TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_RPC_TIMEOUT_KEY, 60000);</span>
<span class="source-line-no">060</span><span id="line-60"> TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_OPERATION_TIMEOUT, 120000);</span>
<span class="source-line-no">061</span><span id="line-61"> TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 2);</span>
<span class="source-line-no">062</span><span id="line-62"> TEST_UTIL.getConfiguration().setInt(START_LOG_ERRORS_AFTER_COUNT_KEY, 0);</span>
<span class="source-line-no">063</span><span id="line-63"> TEST_UTIL.startMiniCluster(1);</span>
<span class="source-line-no">064</span><span id="line-64"> TEST_UTIL.waitTableAvailable(QuotaTableUtil.QUOTA_TABLE_NAME);</span>
<span class="source-line-no">065</span><span id="line-65"> ASYNC_CONN = ConnectionFactory.createAsyncConnection(TEST_UTIL.getConfiguration()).get();</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"> @Test</span>
<span class="source-line-no">069</span><span id="line-69"> public void testThrottleType() throws Exception {</span>
<span class="source-line-no">070</span><span id="line-70"> String userName = User.getCurrent().getShortName();</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> admin</span>
<span class="source-line-no">073</span><span id="line-73"> .setQuota(</span>
<span class="source-line-no">074</span><span id="line-74"> QuotaSettingsFactory.throttleUser(userName, ThrottleType.READ_NUMBER, 6, TimeUnit.MINUTES))</span>
<span class="source-line-no">075</span><span id="line-75"> .get();</span>
<span class="source-line-no">076</span><span id="line-76"> admin.setQuota(</span>
<span class="source-line-no">077</span><span id="line-77"> QuotaSettingsFactory.throttleUser(userName, ThrottleType.WRITE_NUMBER, 12, TimeUnit.MINUTES))</span>
<span class="source-line-no">078</span><span id="line-78"> .get();</span>
<span class="source-line-no">079</span><span id="line-79"> admin.setQuota(QuotaSettingsFactory.bypassGlobals(userName, true)).get();</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> int countThrottle = 0;</span>
<span class="source-line-no">082</span><span id="line-82"> int countGlobalBypass = 0;</span>
<span class="source-line-no">083</span><span id="line-83"> for (QuotaSettings settings : admin.getQuota(null).get()) {</span>
<span class="source-line-no">084</span><span id="line-84"> switch (settings.getQuotaType()) {</span>
<span class="source-line-no">085</span><span id="line-85"> case THROTTLE:</span>
<span class="source-line-no">086</span><span id="line-86"> countThrottle++;</span>
<span class="source-line-no">087</span><span id="line-87"> break;</span>
<span class="source-line-no">088</span><span id="line-88"> case GLOBAL_BYPASS:</span>
<span class="source-line-no">089</span><span id="line-89"> countGlobalBypass++;</span>
<span class="source-line-no">090</span><span id="line-90"> break;</span>
<span class="source-line-no">091</span><span id="line-91"> default:</span>
<span class="source-line-no">092</span><span id="line-92"> fail("unexpected settings type: " + settings.getQuotaType());</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"> assertEquals(2, countThrottle);</span>
<span class="source-line-no">096</span><span id="line-96"> assertEquals(1, countGlobalBypass);</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> admin.setQuota(QuotaSettingsFactory.unthrottleUser(userName)).get();</span>
<span class="source-line-no">099</span><span id="line-99"> assertNumResults(1, null);</span>
<span class="source-line-no">100</span><span id="line-100"> admin.setQuota(QuotaSettingsFactory.bypassGlobals(userName, false)).get();</span>
<span class="source-line-no">101</span><span id="line-101"> assertNumResults(0, null);</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> @Test</span>
<span class="source-line-no">105</span><span id="line-105"> public void testQuotaRetrieverFilter() throws Exception {</span>
<span class="source-line-no">106</span><span id="line-106"> TableName[] tables = new TableName[] { TableName.valueOf("T0"), TableName.valueOf("T01"),</span>
<span class="source-line-no">107</span><span id="line-107"> TableName.valueOf("NS0:T2"), };</span>
<span class="source-line-no">108</span><span id="line-108"> String[] namespaces = new String[] { "NS0", "NS01", "NS2" };</span>
<span class="source-line-no">109</span><span id="line-109"> String[] users = new String[] { "User0", "User01", "User2" };</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> for (String user : users) {</span>
<span class="source-line-no">112</span><span id="line-112"> admin</span>
<span class="source-line-no">113</span><span id="line-113"> .setQuota(</span>
<span class="source-line-no">114</span><span id="line-114"> QuotaSettingsFactory.throttleUser(user, ThrottleType.REQUEST_NUMBER, 1, TimeUnit.MINUTES))</span>
<span class="source-line-no">115</span><span id="line-115"> .get();</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> for (TableName table : tables) {</span>
<span class="source-line-no">118</span><span id="line-118"> admin.setQuota(QuotaSettingsFactory.throttleUser(user, table, ThrottleType.REQUEST_NUMBER,</span>
<span class="source-line-no">119</span><span id="line-119"> 2, TimeUnit.MINUTES)).get();</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> for (String ns : namespaces) {</span>
<span class="source-line-no">123</span><span id="line-123"> admin.setQuota(QuotaSettingsFactory.throttleUser(user, ns, ThrottleType.REQUEST_NUMBER, 3,</span>
<span class="source-line-no">124</span><span id="line-124"> TimeUnit.MINUTES)).get();</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"> assertNumResults(21, null);</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> for (TableName table : tables) {</span>
<span class="source-line-no">130</span><span id="line-130"> admin.setQuota(</span>
<span class="source-line-no">131</span><span id="line-131"> QuotaSettingsFactory.throttleTable(table, ThrottleType.REQUEST_NUMBER, 4, TimeUnit.MINUTES))</span>
<span class="source-line-no">132</span><span id="line-132"> .get();</span>
<span class="source-line-no">133</span><span id="line-133"> }</span>
<span class="source-line-no">134</span><span id="line-134"> assertNumResults(24, null);</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> for (String ns : namespaces) {</span>
<span class="source-line-no">137</span><span id="line-137"> admin.setQuota(QuotaSettingsFactory.throttleNamespace(ns, ThrottleType.REQUEST_NUMBER, 5,</span>
<span class="source-line-no">138</span><span id="line-138"> TimeUnit.MINUTES)).get();</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> assertNumResults(27, null);</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> assertNumResults(7, new QuotaFilter().setUserFilter("User0"));</span>
<span class="source-line-no">143</span><span id="line-143"> assertNumResults(0, new QuotaFilter().setUserFilter("User"));</span>
<span class="source-line-no">144</span><span id="line-144"> assertNumResults(21, new QuotaFilter().setUserFilter("User.*"));</span>
<span class="source-line-no">145</span><span id="line-145"> assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setTableFilter("T0"));</span>
<span class="source-line-no">146</span><span id="line-146"> assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setTableFilter("NS.*"));</span>
<span class="source-line-no">147</span><span id="line-147"> assertNumResults(0, new QuotaFilter().setUserFilter("User.*").setTableFilter("T"));</span>
<span class="source-line-no">148</span><span id="line-148"> assertNumResults(6, new QuotaFilter().setUserFilter("User.*").setTableFilter("T.*"));</span>
<span class="source-line-no">149</span><span id="line-149"> assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS0"));</span>
<span class="source-line-no">150</span><span id="line-150"> assertNumResults(0, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS"));</span>
<span class="source-line-no">151</span><span id="line-151"> assertNumResults(9, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS.*"));</span>
<span class="source-line-no">152</span><span id="line-152"> assertNumResults(6,</span>
<span class="source-line-no">153</span><span id="line-153"> new QuotaFilter().setUserFilter("User.*").setTableFilter("T0").setNamespaceFilter("NS0"));</span>
<span class="source-line-no">154</span><span id="line-154"> assertNumResults(1, new QuotaFilter().setTableFilter("T0"));</span>
<span class="source-line-no">155</span><span id="line-155"> assertNumResults(0, new QuotaFilter().setTableFilter("T"));</span>
<span class="source-line-no">156</span><span id="line-156"> assertNumResults(2, new QuotaFilter().setTableFilter("T.*"));</span>
<span class="source-line-no">157</span><span id="line-157"> assertNumResults(3, new QuotaFilter().setTableFilter(".*T.*"));</span>
<span class="source-line-no">158</span><span id="line-158"> assertNumResults(1, new QuotaFilter().setNamespaceFilter("NS0"));</span>
<span class="source-line-no">159</span><span id="line-159"> assertNumResults(0, new QuotaFilter().setNamespaceFilter("NS"));</span>
<span class="source-line-no">160</span><span id="line-160"> assertNumResults(3, new QuotaFilter().setNamespaceFilter("NS.*"));</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> for (String user : users) {</span>
<span class="source-line-no">163</span><span id="line-163"> admin.setQuota(QuotaSettingsFactory.unthrottleUser(user)).get();</span>
<span class="source-line-no">164</span><span id="line-164"> for (TableName table : tables) {</span>
<span class="source-line-no">165</span><span id="line-165"> admin.setQuota(QuotaSettingsFactory.unthrottleUser(user, table)).get();</span>
<span class="source-line-no">166</span><span id="line-166"> }</span>
<span class="source-line-no">167</span><span id="line-167"> for (String ns : namespaces) {</span>
<span class="source-line-no">168</span><span id="line-168"> admin.setQuota(QuotaSettingsFactory.unthrottleUser(user, ns)).get();</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"> assertNumResults(6, null);</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> for (TableName table : tables) {</span>
<span class="source-line-no">174</span><span id="line-174"> admin.setQuota(QuotaSettingsFactory.unthrottleTable(table)).get();</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"> assertNumResults(3, null);</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> for (String ns : namespaces) {</span>
<span class="source-line-no">179</span><span id="line-179"> admin.setQuota(QuotaSettingsFactory.unthrottleNamespace(ns)).get();</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> assertNumResults(0, null);</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"></span>
<span class="source-line-no">184</span><span id="line-184"> @Test</span>
<span class="source-line-no">185</span><span id="line-185"> public void testSwitchRpcThrottle() throws Exception {</span>
<span class="source-line-no">186</span><span id="line-186"> CompletableFuture&lt;Boolean&gt; future1 = ASYNC_CONN.getAdmin().switchRpcThrottle(true);</span>
<span class="source-line-no">187</span><span id="line-187"> assertEquals(true, future1.get().booleanValue());</span>
<span class="source-line-no">188</span><span id="line-188"> CompletableFuture&lt;Boolean&gt; future2 = ASYNC_CONN.getAdmin().isRpcThrottleEnabled();</span>
<span class="source-line-no">189</span><span id="line-189"> assertEquals(true, future2.get().booleanValue());</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"></span>
<span class="source-line-no">192</span><span id="line-192"> @Test</span>
<span class="source-line-no">193</span><span id="line-193"> public void testSwitchExceedThrottleQuota() throws Exception {</span>
<span class="source-line-no">194</span><span id="line-194"> AsyncAdmin admin = ASYNC_CONN.getAdmin();</span>
<span class="source-line-no">195</span><span id="line-195"> assertEquals(false, admin.exceedThrottleQuotaSwitch(false).get().booleanValue());</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"> private void assertNumResults(int expected, final QuotaFilter filter) throws Exception {</span>
<span class="source-line-no">199</span><span id="line-199"> assertEquals(expected, countResults(filter));</span>
<span class="source-line-no">200</span><span id="line-200"> }</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 int countResults(final QuotaFilter filter) throws Exception {</span>
<span class="source-line-no">203</span><span id="line-203"> int count = 0;</span>
<span class="source-line-no">204</span><span id="line-204"> for (QuotaSettings settings : admin.getQuota(filter).get()) {</span>
<span class="source-line-no">205</span><span id="line-205"> LOG.debug(Objects.toString(settings));</span>
<span class="source-line-no">206</span><span id="line-206"> count++;</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 count;</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>