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.apache.hadoop.hbase.quotas.ThrottleQuotaTestUtil.waitMinuteQuota;
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.After;
038import org.junit.Before;
039import org.junit.ClassRule;
040import org.junit.Test;
041import org.junit.experimental.categories.Category;
042
043@Category({ RegionServerTests.class, MediumTests.class })
044public class TestDefaultQuota {
045  @ClassRule
046  public static final HBaseClassTestRule CLASS_RULE =
047    HBaseClassTestRule.forClass(TestDefaultQuota.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 = 5000;
051  private static final byte[] FAMILY = Bytes.toBytes("cf");
052  private static final byte[] QUALIFIER = Bytes.toBytes("q");
053
054  @After
055  public void tearDown() throws Exception {
056    ThrottleQuotaTestUtil.clearQuotaCache(TEST_UTIL);
057    EnvironmentEdgeManager.reset();
058    TEST_UTIL.deleteTable(TABLE_NAME);
059    TEST_UTIL.shutdownMiniCluster();
060  }
061
062  @Before
063  public void setUp() throws Exception {
064    // quotas enabled, using block bytes scanned
065    TEST_UTIL.getConfiguration().setBoolean(QuotaUtil.QUOTA_CONF_KEY, true);
066    TEST_UTIL.getConfiguration().setInt(QuotaCache.REFRESH_CONF_KEY, REFRESH_TIME);
067    TEST_UTIL.getConfiguration().setInt(QuotaUtil.QUOTA_DEFAULT_USER_MACHINE_READ_NUM, 1);
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    TEST_UTIL.createTable(TABLE_NAME, FAMILY);
075    TEST_UTIL.waitTableAvailable(TABLE_NAME);
076
077    try (Admin admin = TEST_UTIL.getAdmin()) {
078      ThrottleQuotaTestUtil.doPuts(1_000, FAMILY, QUALIFIER,
079        admin.getConnection().getTable(TABLE_NAME));
080    }
081    TEST_UTIL.flush(TABLE_NAME);
082  }
083
084  @Test
085  public void testDefaultUserReadNum() throws Exception {
086    // Should have a strict throttle by default
087    TEST_UTIL.waitFor(60_000, () -> runGetsTest(100) < 100);
088
089    // Add big quota and should be effectively unlimited
090    configureLenientThrottle();
091    refreshQuotas();
092    // Should run without error
093    TEST_UTIL.waitFor(60_000, () -> runGetsTest(100) == 100);
094
095    // Remove all the limits, and should revert to strict default
096    unsetQuota();
097    TEST_UTIL.waitFor(60_000, () -> runGetsTest(100) < 100);
098  }
099
100  private void configureLenientThrottle() throws IOException {
101    try (Admin admin = TEST_UTIL.getAdmin()) {
102      admin.setQuota(QuotaSettingsFactory.throttleUser(getUserName(), ThrottleType.READ_NUMBER,
103        100_000, TimeUnit.SECONDS));
104    }
105  }
106
107  private static String getUserName() throws IOException {
108    return User.getCurrent().getShortName();
109  }
110
111  private void refreshQuotas() throws Exception {
112    triggerUserCacheRefresh(TEST_UTIL, false, TABLE_NAME);
113    waitMinuteQuota();
114  }
115
116  private void unsetQuota() throws Exception {
117    try (Admin admin = TEST_UTIL.getAdmin()) {
118      admin.setQuota(QuotaSettingsFactory.unthrottleUser(getUserName()));
119    }
120    refreshQuotas();
121  }
122
123  private long runGetsTest(int attempts) throws Exception {
124    try (Table table = getTable()) {
125      return ThrottleQuotaTestUtil.doGets(attempts, FAMILY, QUALIFIER, table);
126    }
127  }
128
129  private Table getTable() throws IOException {
130    TEST_UTIL.getConfiguration().setInt("hbase.client.pause", 100);
131    TEST_UTIL.getConfiguration().setInt(HConstants.HBASE_CLIENT_RETRIES_NUMBER, 1);
132    return TEST_UTIL.getConnection().getTableBuilder(TABLE_NAME, null).setOperationTimeout(250)
133      .build();
134  }
135
136}