HBASE-19840 Flakey TestMetaWithReplicas; ADDENDUM to fix Checksyte

hbase-common/src/test/java/org/apache/hadoop/hbase/HBaseClassTestRule.java

@@ -0,0 +1,88 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase;
+
+import java.util.concurrent.TimeUnit;
+import org.apache.hadoop.hbase.testclassification.LargeTests;
+import org.apache.hadoop.hbase.testclassification.MediumTests;
+import org.apache.hadoop.hbase.testclassification.SmallTests;
+import org.apache.yetus.audience.InterfaceAudience;
+import org.junit.experimental.categories.Category;
+import org.junit.rules.TestRule;
+import org.junit.rules.Timeout;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+/**
+ * The class level TestRule for all the tests. Every test class should have a {@code ClassRule} with
+ * it.
+ * <p>
+ * For now it only sets a test method timeout based off the test categories small, medium, large.
+ * Based on junit Timeout TestRule; see https://github.com/junit-team/junit/wiki/Rules
+ */
+@InterfaceAudience.Private
+public final class HBaseClassTestRule implements TestRule {
+
+  private final Class<?> clazz;
+
+  private final Timeout timeout;
+
+  private HBaseClassTestRule(Class<?> clazz, Timeout timeout) {
+    this.clazz = clazz;
+    this.timeout = timeout;
+  }
+
+  /**
+   * Mainly used for {@link HBaseClassTestRuleChecker} to confirm that we use the correct
+   * class to generate timeout ClassRule.
+   */
+  public Class<?> getClazz() {
+    return clazz;
+  }
+
+  private static long getTimeoutInSeconds(Class<?> clazz) {
+    Category[] categories = clazz.getAnnotationsByType(Category.class);
+    if (categories.length == 0) {
+      throw new IllegalArgumentException(clazz.getName() + " is not annotated with @Category");
+    }
+    for (Class<?> c : categories[0].value()) {
+      if (c == SmallTests.class) {
+        // See SmallTests. Supposed to run 15 seconds.
+        return 30;
+      } else if (c == MediumTests.class) {
+        // See MediumTests. Supposed to run 50 seconds.
+        return 180;
+      } else if (c == LargeTests.class) {
+        // Let large tests have a ten minute timeout.
+        return TimeUnit.MINUTES.toSeconds(10);
+      }
+    }
+    throw new IllegalArgumentException(
+        clazz.getName() + " does not have SmallTests/MediumTests/LargeTests in @Category");
+  }
+
+  public static HBaseClassTestRule forClass(Class<?> clazz) {
+    return new HBaseClassTestRule(clazz, Timeout.builder().withLookingForStuckThread(true)
+        .withTimeout(getTimeoutInSeconds(clazz), TimeUnit.SECONDS).build());
+  }
+
+  @Override
+  public Statement apply(Statement base, Description description) {
+    return timeout.apply(base, description);
+  }
+}

hbase-common/src/test/java/org/apache/hadoop/hbase/HBaseClassTestRuleChecker.java

@@ -0,0 +1,53 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.hbase;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import org.apache.yetus.audience.InterfaceAudience;
+import org.junit.ClassRule;
+import org.junit.runner.Description;
+import org.junit.runner.notification.RunListener;
+import org.junit.runner.notification.RunListener.ThreadSafe;
+
+/**
+ * A RunListener to confirm that we have a {@link CategoryBasedTimeout} class rule for every test.
+ */
+@InterfaceAudience.Private
+@ThreadSafe
+public class HBaseClassTestRuleChecker extends RunListener {
+
+  @Override
+  public void testStarted(Description description) throws Exception {
+    for (Field field : description.getTestClass().getFields()) {
+      if (Modifier.isStatic(field.getModifiers()) && field.getType() == HBaseClassTestRule.class &&
+        field.isAnnotationPresent(ClassRule.class)) {
+        HBaseClassTestRule timeout = (HBaseClassTestRule) field.get(null);
+        assertEquals(
+          "The HBaseClassTestRule ClassRule in " + description.getTestClass().getName() +
+            " is for " + timeout.getClazz().getName(),
+          description.getTestClass(), timeout.getClazz());
+        return;
+      }
+    }
+    fail("No HBaseClassTestRule ClassRule for " + description.getTestClass().getName());
+  }
+}