Merge branch 'apache:master' into RATIS-2251

Author: slfan1989

.github/workflows/ci.yaml

@@ -83,6 +83,7 @@ jobs:
           - grpc
           - server
           - misc
+          - flaky
       fail-fast: false
     uses: ./.github/workflows/check.yaml
     with:

dev-support/checks/unit.sh

@@ -36,6 +36,10 @@ mkdir -p "$REPORT_DIR"
 export MAVEN_OPTS="-Xmx4096m"
 MAVEN_OPTIONS='-V -B'
 
+if [[ "$@" =~ "-Pflaky-tests" ]]; then
+  MAVEN_OPTIONS="${MAVEN_OPTIONS} -Dsurefire.rerunFailingTestsCount=5 -Dsurefire.timeout=1200"
+fi
+
 if [[ "${FAIL_FAST}" == "true" ]]; then
   MAVEN_OPTIONS="${MAVEN_OPTIONS} --fail-fast -Dsurefire.skipAfterFailureCount=1"
 else

pom.xml

@@ -222,6 +222,7 @@
     <slf4j.version>2.0.7</slf4j.version>
     <junit-bom.version>5.11.2</junit-bom.version>
     <jacoco.version>0.8.12</jacoco.version>
+    <flaky-test-groups>flaky | org.apache.ratis.test.tag.FlakyTest</flaky-test-groups>
   </properties>
 
   <dependencyManagement>
@@ -654,12 +655,6 @@
               <exclude>**/Test*$*.java</exclude>
               <exclude>${test.exclude.pattern}</exclude>
             </excludes>
-            <properties>
-              <property>
-                <name>listener</name>
-                <value>org.apache.ratis.JUnitRunListener</value>
-              </property>
-            </properties>
           </configuration>
         </plugin>
         <plugin>
@@ -1124,6 +1119,7 @@
               <includes>
                 <include>org.apache.ratis.grpc.**</include>
               </includes>
+              <excludedGroups>${flaky-test-groups}</excludedGroups>
             </configuration>
           </plugin>
         </plugins>
@@ -1141,6 +1137,7 @@
                 <include>org.apache.ratis.datastream.**</include>
                 <include>org.apache.ratis.server.**</include>
               </includes>
+              <excludedGroups>${flaky-test-groups}</excludedGroups>
             </configuration>
           </plugin>
         </plugins>
@@ -1159,6 +1156,21 @@
                 <exclude>org.apache.ratis.grpc.**</exclude>
                 <exclude>org.apache.ratis.server.**</exclude>
               </excludes>
+              <excludedGroups>${flaky-test-groups}</excludedGroups>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <id>flaky-tests</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <groups>${flaky-test-groups}</groups>
             </configuration>
           </plugin>
         </plugins>

ratis-assembly/pom.xml

@@ -33,6 +33,8 @@
     <test.cache.data>${project.build.directory}/test-classes</test.cache.data>
     <test.build.classes>${project.build.directory}/test-classes</test.build.classes>
     <license.bundles.dependencies>true</license.bundles.dependencies>
+    <!-- no testable code in this module -->
+    <skipTests>true</skipTests>
   </properties>
 
   <build>

ratis-client/pom.xml

@@ -23,6 +23,11 @@
   <artifactId>ratis-client</artifactId>
   <name>Apache Ratis Client</name>
 
+  <properties>
+    <!-- no tests in this module so far -->
+    <skipTests>true</skipTests>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>org.apache.ratis</groupId>

ratis-common/src/main/java/org/apache/ratis/conf/ConfUtils.java

@@ -18,7 +18,6 @@
 package org.apache.ratis.conf;
 
 import org.apache.ratis.security.TlsConf;
-import org.apache.ratis.thirdparty.com.google.common.base.Objects;
 import org.apache.ratis.util.NetUtils;
 import org.apache.ratis.util.SizeInBytes;
 import org.apache.ratis.util.TimeDuration;
@@ -33,6 +32,7 @@
 import java.net.InetSocketAddress;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.function.BiConsumer;
@@ -60,7 +60,7 @@ private static <T> boolean isNew(String key, T value) {
   static <T> void logGet(String key, T value, T defaultValue, Consumer<String> logger) {
     if (logger != null && Utils.isNew(key, value)) {
       logger.accept(String.format("%s = %s (%s)", key, value,
-          Objects.equal(value, defaultValue)? "default": "custom"));
+          Objects.equals(value, defaultValue)? "default": "custom"));
     }
   }
 

ratis-common/src/test/java/org/apache/ratis/BaseTest.java

@@ -18,7 +18,6 @@
 package org.apache.ratis;
 
 import org.apache.ratis.conf.ConfUtils;
-import org.apache.ratis.protocol.RaftPeer;
 import org.apache.ratis.util.ExitUtils;
 import org.apache.ratis.util.FileUtils;
 import org.apache.ratis.util.JavaUtils;
@@ -28,6 +27,7 @@
 import org.apache.ratis.util.TimeDuration;
 import org.apache.ratis.util.function.CheckedRunnable;
 import org.junit.After;
+import org.junit.Before;
 import org.junit.Rule;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
@@ -42,8 +42,7 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.List;
+import java.lang.reflect.Method;
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Future;
@@ -75,33 +74,30 @@ public void setFirstException(Throwable e) {
     }
   }
 
-  public List<RaftPeer> getPeersWithPriority(List<RaftPeer> peers, RaftPeer suggestedLeader) {
-    List<RaftPeer> peersWithPriority = new ArrayList<>();
-    for (int i = 0; i < peers.size(); i++) {
-      RaftPeer peer = peers.get(i);
-      final int priority = peer.equals(suggestedLeader)? 2: 1;
-      peersWithPriority.add(
-          RaftPeer.newBuilder(peer).setPriority(priority).build());
-    }
-    return peersWithPriority;
-  }
-
-
-  /*
-   * Junit 4 reference will be removed and the code will be refactored once
-   * all the unit tests are migrated to Junit 5.
-   */
+  // TODO: Junit 4 reference should be removed once all the unit tests are migrated to Junit 5.
 
   private String testCaseName;
 
   @BeforeEach
   public void setup(TestInfo testInfo) {
-    testCaseName = testInfo.getTestMethod()
-        .orElseThrow(() -> new RuntimeException("Exception while getting test name."))
-        .getName();
+    checkAssumptions();
 
+    final Method method = testInfo.getTestMethod().orElse(null);
+    testCaseName = testInfo.getTestClass().orElse(getClass()).getSimpleName()
+        + "." + (method == null? null : method.getName());
+  }
+
+  // @Before annotation is retained to support junit 4 tests.
+  @Before
+  public void checkAssumptions() {
     final int leaks = ReferenceCountedLeakDetector.getLeakDetector().getLeakCount();
     Assumptions.assumeFalse(0 < leaks, () -> "numLeaks " + leaks + " > 0");
+
+    final Throwable first = firstException.get();
+    Assumptions.assumeTrue(first == null, () -> "Already failed with " + first);
+
+    final Throwable exited = ExitUtils.getFirstExitException();
+    Assumptions.assumeTrue(exited == null, () -> "Already exited with " + exited);
   }
 
   // @After annotation is retained to support junit 4 tests.
@@ -116,19 +112,10 @@ public void assertNoFailures() {
     ExitUtils.assertNotTerminated();
   }
 
-  // Retained to support junit 4 tests.
-  @Rule
-  public final org.junit.rules.Timeout globalTimeout = new org.junit.rules.Timeout(
-      getGlobalTimeoutSeconds(), TimeUnit.SECONDS );
-
   // Retained to support junit 4 tests.
   @Rule
   public final TestName testName = new TestName();
 
-  public int getGlobalTimeoutSeconds() {
-    return 100;
-  }
-
   private static final Supplier<File> ROOT_TEST_DIR = JavaUtils.memoize(
       () -> JavaUtils.callAsUnchecked(() -> {
         final File dir = new File(System.getProperty("test.build.data", "target/test/data"),

ratis-common/src/test/java/org/apache/ratis/JUnit5TestExecutionListener.java

@@ -0,0 +1,51 @@
+/*
+ * 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.ratis;
+
+import org.apache.ratis.util.JavaUtils;
+import org.junit.platform.engine.TestExecutionResult;
+import org.junit.platform.launcher.TestExecutionListener;
+import org.junit.platform.launcher.TestIdentifier;
+
+import java.io.PrintStream;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * A {@link TestExecutionListener} to dump all threads after a test timeout failure.
+ */
+public class JUnit5TestExecutionListener implements TestExecutionListener {
+  private final PrintStream out = System.out;
+
+  @Override
+  public void executionFinished(TestIdentifier id, TestExecutionResult result) {
+    final Throwable timeoutException = getTimeoutException(result);
+    if (timeoutException != null) {
+      out.format("%n%s %s failed%n", JavaUtils.date(), id.getDisplayName());
+      timeoutException.printStackTrace(out);
+      JavaUtils.dumpAllThreads(out::println);
+    }
+  }
+
+  private static Throwable getTimeoutException(TestExecutionResult result) {
+    if (result == null) {
+      return null;
+    }
+    final Throwable throwable = result.getThrowable().orElse(null);
+    return throwable instanceof TimeoutException? throwable : null;
+  }
+}