[LI-CHERRY-PICK] [987f0ee] KAFKA-8164: Add support for retrying failed (

apache#259)
wyuka · Jan 27, 2022 · 77737fb · 77737fb
1 parent 9bd81c1
commit 77737fb
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 4 deletions.
diff --git a/.github/workflows/build-and-upload-archives-upon-creating-tags.yml b/.github/workflows/build-and-upload-archives-upon-creating-tags.yml
@@ -100,7 +100,7 @@ jobs:
       - name: Run tests
         env:
           SCALA_VERSION: ${{ matrix.scalaVersion }}
-        run: ./gradlew -PscalaVersion="$SCALA_VERSION" cleanTest clients:integrationTest --no-daemon -PtestLoggingEvents=started,passed,skipped,failed
+        run: ./gradlew -PmaxTestRetries=3 -PscalaVersion="$SCALA_VERSION" cleanTest clients:integrationTest --no-daemon -PtestLoggingEvents=started,passed,skipped,failed
   int-test-core:
     # Name the Job
     name: core:integrationTest_${{ matrix.scalaVersion }} (${{ matrix.prefix }})
@@ -139,7 +139,7 @@ jobs:
         # Use set -f to disable shell expansion on *
         run: >
           set -f
-          && ./gradlew -PscalaVersion="$SCALA_VERSION" -PtestLoggingEvents=started,passed,skipped,failed --no-daemon cleanTest core:integrationTest `for i in $PREFIX; do printf ' --tests %s*' $i; done`
+          && ./gradlew -PmaxTestRetries=3 -PscalaVersion="$SCALA_VERSION" -PtestLoggingEvents=started,passed,skipped,failed --no-daemon cleanTest core:integrationTest `for i in $PREFIX; do printf ' --tests %s*' $i; done`
           && set +f
 
 

diff --git a/.github/workflows/int-test.yml b/.github/workflows/int-test.yml
@@ -50,7 +50,7 @@ jobs:
       - name: Run tests
         env:
           SCALA_VERSION: ${{ matrix.scalaVersion }}
-        run: ./gradlew -Pversion=${{ env.RELEASE_VERSION }} cleanTest clients:integrationTest --no-daemon -PtestLoggingEvents=started,passed,skipped,failed
+        run: ./gradlew -PmaxTestRetries=3 -Pversion=${{ env.RELEASE_VERSION }} cleanTest clients:integrationTest --no-daemon -PtestLoggingEvents=started,passed,skipped,failed
   core:
     # Name the Job
     name: core_${{ matrix.scalaVersion }} (${{ matrix.prefix }})
@@ -89,6 +89,6 @@ jobs:
         # Use set -f to disable shell expansion on *
         run: >
           set -f
-          && ./gradlew -PscalaVersion="$SCALA_VERSION" -PtestLoggingEvents=started,passed,skipped,failed --no-daemon cleanTest core:integrationTest `for i in $PREFIX; do printf ' --tests %s*' $i; done`
+          && ./gradlew -PmaxTestRetries=3 -PscalaVersion="$SCALA_VERSION" -PtestLoggingEvents=started,passed,skipped,failed --no-daemon cleanTest core:integrationTest `for i in $PREFIX; do printf ' --tests %s*' $i; done`
           && set +f
 
diff --git a/README.md b/README.md
@@ -97,6 +97,13 @@ Change the log4j setting in either `clients/src/test/resources/log4j.properties`
 
     ./gradlew clients:test --tests RequestResponseTest
 
+### Specifying test retries ###
+By default, each failed test is retried once up to a maximum of five retries per test run. Tests are retried at the end of the test task. Adjust these parameters in the following way:
+
+    ./gradlew test -PmaxTestRetries=1 -PmaxTestRetryFailures=5
+
+See [Test Retry Gradle Plugin](https://github.com/gradle/test-retry-gradle-plugin) for more details.
+
 ### Generating test coverage reports ###
 Generate coverage reports for the whole project:
 

diff --git a/build.gradle b/build.gradle
@@ -38,6 +38,7 @@ buildscript {
     classpath "org.owasp:dependency-check-gradle:$versions.owaspDepCheckPlugin"
     classpath "com.diffplug.spotless:spotless-plugin-gradle:$versions.spotlessPlugin"
     classpath "gradle.plugin.com.github.spotbugs:spotbugs-gradle-plugin:$versions.spotbugsPlugin"
+    classpath "org.gradle:test-retry-gradle-plugin:$versions.testRetryPlugin"
     classpath libs.jaxbApi
   }
 }
@@ -99,6 +100,9 @@ ext {
 
   userMaxForks = project.hasProperty('maxParallelForks') ? maxParallelForks.toInteger() : null
 
+  userMaxTestRetries = project.hasProperty('maxTestRetries') ? maxTestRetries.toInteger() : 0
+  userMaxTestRetryFailures = project.hasProperty('maxTestRetryFailures') ? maxTestRetryFailures.toInteger() : 0
+
   skipSigning = project.hasProperty('skipSigning') && skipSigning.toBoolean()
   shouldSign = !skipSigning && !version.endsWith("SNAPSHOT") && project.gradle.startParameter.taskNames.any { it.contains("upload") }
 
@@ -168,6 +172,7 @@ subprojects {
   apply plugin: 'signing'
   apply plugin: 'checkstyle'
   apply plugin: "com.github.spotbugs"
+  apply plugin: 'org.gradle.test-retry'
 
   sourceCompatibility = minJavaVersion
   targetCompatibility = minJavaVersion
@@ -300,6 +305,11 @@ subprojects {
       exceptionFormat = testExceptionFormat
     }
     logTestStdout.rehydrate(delegate, owner, this)()
+
+    retry {
+      maxRetries = userMaxTestRetries
+      maxFailures = userMaxTestRetryFailures
+    }
   }
 
   task integrationTest(type: Test, dependsOn: compileJava) {

diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -116,6 +116,7 @@ versions += [
   spotbugs: "3.1.12",
   spotbugsPlugin: "1.6.9",
   spotlessPlugin: "3.23.1",
+  testRetryPlugin: "1.3.1",
   zookeeper: "3.5.8",
   zstd: "1.4.3-1",
   conscrypt: "2.1.0",