001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.quotas;
019
020import static org.apache.hadoop.hbase.quotas.ThrottleQuotaTestUtil.triggerUserCacheRefresh;
021import static org.junit.Assert.assertTrue;
022
023import java.io.IOException;
024import java.util.UUID;
025import java.util.concurrent.TimeUnit;
026import org.apache.hadoop.hbase.HBaseClassTestRule;
027import org.apache.hadoop.hbase.HBaseTestingUtil;
028import org.apache.hadoop.hbase.HConstants;
029import org.apache.hadoop.hbase.TableName;
030import org.apache.hadoop.hbase.client.Admin;
031import org.apache.hadoop.hbase.client.Table;
032import org.apache.hadoop.hbase.security.User;
033import org.apache.hadoop.hbase.testclassification.MediumTests;
034import org.apache.hadoop.hbase.testclassification.RegionServerTests;
035import org.apache.hadoop.hbase.util.Bytes;
036import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
037import org.junit.AfterClass;
038import org.junit.BeforeClass;
039import org.junit.ClassRule;
040import org.junit.Test;
041import org.junit.experimental.categories.Category;
042
043@Category({ RegionServerTests.class, MediumTests.class })
044public class TestThreadHandlerUsageQuota {
045  @ClassRule
046  public static final HBaseClassTestRule CLASS_RULE =
047    HBaseClassTestRule.forClass(TestThreadHandlerUsageQuota.class);
048  private static final HBaseTestingUtil TEST_UTIL = new HBaseTestingUtil();
049  private static final TableName TABLE_NAME = TableName.valueOf(UUID.randomUUID().toString());
050  private static final int REFRESH_TIME = 5;
051  private static final byte[] FAMILY = Bytes.toBytes("cf");
052  private static final byte[] QUALIFIER = Bytes.toBytes("q");
053  private static final int MAX_OPS = 1000;
054
055  @AfterClass
056  public static void tearDown() throws Exception {
057    ThrottleQuotaTestUtil.clearQuotaCache(TEST_UTIL);
058    EnvironmentEdgeManager.reset();
059    TEST_UTIL.deleteTable(TABLE_NAME);
060    TEST_UTIL.shutdownMiniCluster();
061  }
062
063  @BeforeClass
064  public static void setUpBeforeClass() throws Exception {
065    // Enable quotas
066    TEST_UTIL.getConfiguration().setBoolean(QuotaUtil.QUOTA_CONF_KEY, true);
067    TEST_UTIL.getConfiguration().setInt(QuotaCache.REFRESH_CONF_KEY, REFRESH_TIME);
068
069    // Don't cache blocks to make IO predictable
070    TEST_UTIL.getConfiguration().setFloat(HConstants.HFILE_BLOCK_CACHE_SIZE_KEY, 0.0f);
071
072    TEST_UTIL.startMiniCluster(1);
073    TEST_UTIL.waitTableAvailable(QuotaTableUtil.QUOTA_TABLE_NAME);
074
075    TEST_UTIL.createTable(TABLE_NAME, FAMILY);
076
077    TEST_UTIL.waitTableAvailable(TABLE_NAME);
078    TEST_UTIL.flush(TABLE_NAME);
079  }
080
081  @Test
082  public void testHandlerUsageThrottleForReads() throws Exception {
083    try (Table table = getTable()) {
084      unthrottleUser();
085      long unthrottledAttempts = ThrottleQuotaTestUtil.doGets(MAX_OPS, FAMILY, QUALIFIER, table);
086
087      configureThrottle();
088      long throttledAttempts = ThrottleQuotaTestUtil.doGets(MAX_OPS, FAMILY, QUALIFIER, table);
089      assertTrue("Throttled attempts should be less than unthrottled attempts",
090        throttledAttempts < unthrottledAttempts);
091    }
092  }
093
094  @Test
095  public void testHandlerUsageThrottleForWrites() throws Exception {
096    try (Table table = getTable()) {
097      unthrottleUser();
098      long unthrottledAttempts = ThrottleQuotaTestUtil.doPuts(MAX_OPS, FAMILY, QUALIFIER, table);
099
100      configureThrottle();
101      long throttledAttempts = ThrottleQuotaTestUtil.doPuts(MAX_OPS, FAMILY, QUALIFIER, table);
102      assertTrue("Throttled attempts should be less than unthrottled attempts",
103        throttledAttempts < unthrottledAttempts);
104    }
105  }
106
107  private void configureThrottle() throws Exception {
108    try (Admin admin = TEST_UTIL.getAdmin()) {
109      admin.setQuota(QuotaSettingsFactory.throttleUser(getUserName(),
110        ThrottleType.REQUEST_HANDLER_USAGE_MS, 1, TimeUnit.SECONDS));
111    }
112    triggerUserCacheRefresh(TEST_UTIL, false, TABLE_NAME);
113  }
114
115  private void unthrottleUser() throws Exception {
116    try (Admin admin = TEST_UTIL.getAdmin()) {
117      admin.setQuota(QuotaSettingsFactory.unthrottleUserByThrottleType(getUserName(),
118        ThrottleType.REQUEST_HANDLER_USAGE_MS));
119    }
120    triggerUserCacheRefresh(TEST_UTIL, true, TABLE_NAME);
121  }
122
123  private static String getUserName() throws IOException {
124    return User.getCurrent().getShortName();
125  }
126
127  private Table getTable() throws IOException {
128    TEST_UTIL.getConfiguration().setInt("hbase.client.pause", 100);
129    TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 1);
130    return TEST_UTIL.getConnection().getTableBuilder(TABLE_NAME, null).setOperationTimeout(250)
131      .build();
132  }
133}