View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional information regarding
4    * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with the License. You may obtain a
6    * copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable
7    * law or agreed to in writing, software distributed under the License is distributed on an "AS IS"
8    * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
9    * for the specific language governing permissions and limitations under the License.
10   */
11  
12  package org.apache.hadoop.hbase.quotas;
13  
14  import static org.junit.Assert.assertEquals;
15  import static org.junit.Assert.fail;
16  
17  import java.util.concurrent.TimeUnit;
18  
19  import org.apache.commons.logging.Log;
20  import org.apache.commons.logging.LogFactory;
21  import org.apache.hadoop.hbase.HBaseTestingUtility;
22  import org.apache.hadoop.hbase.HConstants;
23  import org.apache.hadoop.hbase.TableName;
24  import org.apache.hadoop.hbase.client.Admin;
25  import org.apache.hadoop.hbase.security.User;
26  import org.apache.hadoop.hbase.testclassification.MediumTests;
27  import org.junit.AfterClass;
28  import org.junit.BeforeClass;
29  import org.junit.Test;
30  import org.junit.experimental.categories.Category;
31  
32  /**
33   * minicluster tests that validate that quota entries are properly set in the quota table
34   */
35  @Category({ MediumTests.class })
36  public class TestQuotaAdmin {
37    final Log LOG = LogFactory.getLog(getClass());
38  
39    private final static HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();
40  
41    @BeforeClass
42    public static void setUpBeforeClass() throws Exception {
43      TEST_UTIL.getConfiguration().setBoolean(QuotaUtil.QUOTA_CONF_KEY, true);
44      TEST_UTIL.getConfiguration().setInt(QuotaCache.REFRESH_CONF_KEY, 2000);
45      TEST_UTIL.getConfiguration().setInt("hbase.hstore.compactionThreshold", 10);
46      TEST_UTIL.getConfiguration().setInt("hbase.regionserver.msginterval", 100);
47      TEST_UTIL.getConfiguration().setInt("hbase.client.pause", 250);
48      TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 6);
49      TEST_UTIL.getConfiguration().setBoolean("hbase.master.enabletable.roundrobin", true);
50      TEST_UTIL.startMiniCluster(1);
51      TEST_UTIL.waitTableAvailable(QuotaTableUtil.QUOTA_TABLE_NAME);
52    }
53  
54    @AfterClass
55    public static void tearDownAfterClass() throws Exception {
56      TEST_UTIL.shutdownMiniCluster();
57    }
58  
59    @Test
60    public void testSimpleScan() throws Exception {
61      Admin admin = TEST_UTIL.getHBaseAdmin();
62      String userName = User.getCurrent().getShortName();
63  
64      admin.setQuota(QuotaSettingsFactory.throttleUser(userName, ThrottleType.REQUEST_NUMBER, 6,
65        TimeUnit.MINUTES));
66      admin.setQuota(QuotaSettingsFactory.bypassGlobals(userName, true));
67  
68      QuotaRetriever scanner = QuotaRetriever.open(TEST_UTIL.getConfiguration());
69      try {
70        int countThrottle = 0;
71        int countGlobalBypass = 0;
72        for (QuotaSettings settings : scanner) {
73          LOG.debug(settings);
74          switch (settings.getQuotaType()) {
75          case THROTTLE:
76            ThrottleSettings throttle = (ThrottleSettings) settings;
77            assertEquals(userName, throttle.getUserName());
78            assertEquals(null, throttle.getTableName());
79            assertEquals(null, throttle.getNamespace());
80            assertEquals(6, throttle.getSoftLimit());
81            assertEquals(TimeUnit.MINUTES, throttle.getTimeUnit());
82            countThrottle++;
83            break;
84          case GLOBAL_BYPASS:
85            countGlobalBypass++;
86            break;
87          default:
88            fail("unexpected settings type: " + settings.getQuotaType());
89          }
90        }
91        assertEquals(1, countThrottle);
92        assertEquals(1, countGlobalBypass);
93      } finally {
94        scanner.close();
95      }
96  
97      admin.setQuota(QuotaSettingsFactory.unthrottleUser(userName));
98      assertNumResults(1, null);
99      admin.setQuota(QuotaSettingsFactory.bypassGlobals(userName, false));
100     assertNumResults(0, null);
101   }
102 
103   @Test
104   public void testQuotaRetrieverFilter() throws Exception {
105     Admin admin = TEST_UTIL.getHBaseAdmin();
106     TableName[] tables =
107         new TableName[] { TableName.valueOf("T0"), TableName.valueOf("T01"),
108             TableName.valueOf("NS0:T2"), };
109     String[] namespaces = new String[] { "NS0", "NS01", "NS2" };
110     String[] users = new String[] { "User0", "User01", "User2" };
111 
112     for (String user : users) {
113       admin.setQuota(QuotaSettingsFactory.throttleUser(user, ThrottleType.REQUEST_NUMBER, 1,
114         TimeUnit.MINUTES));
115 
116       for (TableName table : tables) {
117         admin.setQuota(QuotaSettingsFactory.throttleUser(user, table, ThrottleType.REQUEST_NUMBER,
118           2, TimeUnit.MINUTES));
119       }
120 
121       for (String ns : namespaces) {
122         admin.setQuota(QuotaSettingsFactory.throttleUser(user, ns, ThrottleType.REQUEST_NUMBER, 3,
123           TimeUnit.MINUTES));
124       }
125     }
126     assertNumResults(21, null);
127 
128     for (TableName table : tables) {
129       admin.setQuota(QuotaSettingsFactory.throttleTable(table, ThrottleType.REQUEST_NUMBER, 4,
130         TimeUnit.MINUTES));
131     }
132     assertNumResults(24, null);
133 
134     for (String ns : namespaces) {
135       admin.setQuota(QuotaSettingsFactory.throttleNamespace(ns, ThrottleType.REQUEST_NUMBER, 5,
136         TimeUnit.MINUTES));
137     }
138     assertNumResults(27, null);
139 
140     assertNumResults(7, new QuotaFilter().setUserFilter("User0"));
141     assertNumResults(0, new QuotaFilter().setUserFilter("User"));
142     assertNumResults(21, new QuotaFilter().setUserFilter("User.*"));
143     assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setTableFilter("T0"));
144     assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setTableFilter("NS.*"));
145     assertNumResults(0, new QuotaFilter().setUserFilter("User.*").setTableFilter("T"));
146     assertNumResults(6, new QuotaFilter().setUserFilter("User.*").setTableFilter("T.*"));
147     assertNumResults(3, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS0"));
148     assertNumResults(0, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS"));
149     assertNumResults(9, new QuotaFilter().setUserFilter("User.*").setNamespaceFilter("NS.*"));
150     assertNumResults(6, new QuotaFilter().setUserFilter("User.*").setTableFilter("T0")
151         .setNamespaceFilter("NS0"));
152     assertNumResults(1, new QuotaFilter().setTableFilter("T0"));
153     assertNumResults(0, new QuotaFilter().setTableFilter("T"));
154     assertNumResults(2, new QuotaFilter().setTableFilter("T.*"));
155     assertNumResults(3, new QuotaFilter().setTableFilter(".*T.*"));
156     assertNumResults(1, new QuotaFilter().setNamespaceFilter("NS0"));
157     assertNumResults(0, new QuotaFilter().setNamespaceFilter("NS"));
158     assertNumResults(3, new QuotaFilter().setNamespaceFilter("NS.*"));
159 
160     for (String user : users) {
161       admin.setQuota(QuotaSettingsFactory.unthrottleUser(user));
162       for (TableName table : tables) {
163         admin.setQuota(QuotaSettingsFactory.unthrottleUser(user, table));
164       }
165       for (String ns : namespaces) {
166         admin.setQuota(QuotaSettingsFactory.unthrottleUser(user, ns));
167       }
168     }
169     assertNumResults(6, null);
170 
171     for (TableName table : tables) {
172       admin.setQuota(QuotaSettingsFactory.unthrottleTable(table));
173     }
174     assertNumResults(3, null);
175 
176     for (String ns : namespaces) {
177       admin.setQuota(QuotaSettingsFactory.unthrottleNamespace(ns));
178     }
179     assertNumResults(0, null);
180   }
181 
182   private void assertNumResults(int expected, final QuotaFilter filter) throws Exception {
183     assertEquals(expected, countResults(filter));
184   }
185 
186   private int countResults(final QuotaFilter filter) throws Exception {
187     QuotaRetriever scanner = QuotaRetriever.open(TEST_UTIL.getConfiguration(), filter);
188     try {
189       int count = 0;
190       for (QuotaSettings settings : scanner) {
191         LOG.debug(settings);
192         count++;
193       }
194       return count;
195     } finally {
196       scanner.close();
197     }
198   }
199 }