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