Include retries tests for JUnit and TestNG

Author: bonigarcia

junit-vs-testng/src/test/java/io/github/bonigarcia/junit/selenium/RandomCalculatorJUnitTest.java

@@ -0,0 +1,44 @@
+/*
+ * (C) Copyright 2025 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.junit.selenium;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.openqa.selenium.By;
+
+@ExtendWith(RetryExtension.class)
+class RandomCalculatorJUnitTest extends BrowserParent {
+
+    @Test
+    @Retry(4)
+    void testRandomCalculator() {
+        driver.get(
+                "https://bonigarcia.dev/selenium-webdriver-java/random-calculator.html");
+        // 1 + 3
+        driver.findElement(By.xpath("//span[text()='1']")).click();
+        driver.findElement(By.xpath("//span[text()='+']")).click();
+        driver.findElement(By.xpath("//span[text()='3']")).click();
+        driver.findElement(By.xpath("//span[text()='=']")).click();
+
+        // ... should be 4
+        String result = driver.findElement(By.className("screen")).getText();
+        assertThat(result).isEqualTo("4");
+    }
+
+}

junit-vs-testng/src/test/java/io/github/bonigarcia/junit/selenium/Retry.java

@@ -0,0 +1,25 @@
+/*
+ * (C) Copyright 2025 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.junit.selenium;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Retry {
+    int value() default 3;
+}

junit-vs-testng/src/test/java/io/github/bonigarcia/junit/selenium/RetryExtension.java

@@ -0,0 +1,62 @@
+/*
+ * (C) Copyright 2025 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.junit.selenium;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestExecutionExceptionHandler;
+
+public class RetryExtension implements TestExecutionExceptionHandler {
+
+    static final int DEFAULT_MAX_RETRIES = 3;
+
+    final AtomicInteger retryCount = new AtomicInteger(1);
+
+    @Override
+    public void handleTestExecutionException(ExtensionContext extensionContext,
+            Throwable throwable) throws Throwable {
+        logError(throwable);
+
+        extensionContext.getTestMethod().ifPresent(method -> {
+            int maxRetries = method.getAnnotation(Retry.class) != null
+                    ? method.getAnnotation(Retry.class).value()
+                    : DEFAULT_MAX_RETRIES;
+
+            while (retryCount.incrementAndGet() <= maxRetries) {
+                try {
+                    extensionContext.getExecutableInvoker().invoke(method,
+                            extensionContext.getRequiredTestInstance());
+                    return;
+                } catch (Throwable t) {
+                    logError(t);
+
+                    if (retryCount.get() >= maxRetries) {
+                        throw t;
+                    }
+                }
+            }
+        });
+    }
+
+    private void logError(Throwable e) {
+        System.err.println("Attempt test execution #" + retryCount.get()
+                + " failed (" + e.getClass().getName() + "thrown):  "
+                + e.getMessage());
+    }
+
+}

junit-vs-testng/src/test/java/io/github/bonigarcia/testng/selenium/RandomCalculatorNGTest.java

@@ -0,0 +1,42 @@
+/*
+ * (C) Copyright 2025 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.testng.selenium;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.openqa.selenium.By;
+import org.testng.annotations.Test;
+
+public class RandomCalculatorNGTest extends BrowserParent {
+
+    @Test(retryAnalyzer = RetryAnalyzer.class)
+    @Retry(5)
+    public void testRandomCalculator() {
+        driver.get(
+                "https://bonigarcia.dev/selenium-webdriver-java/random-calculator.html");
+        // 1 + 3
+        driver.findElement(By.xpath("//span[text()='1']")).click();
+        driver.findElement(By.xpath("//span[text()='+']")).click();
+        driver.findElement(By.xpath("//span[text()='3']")).click();
+        driver.findElement(By.xpath("//span[text()='=']")).click();
+
+        // ... should be 4
+        String result = driver.findElement(By.className("screen")).getText();
+        assertThat(result).isEqualTo("4");
+    }
+
+}

junit-vs-testng/src/test/java/io/github/bonigarcia/testng/selenium/Retry.java

@@ -0,0 +1,25 @@
+/*
+ * (C) Copyright 2025 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.testng.selenium;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Retry {
+    int value() default 3;
+}

junit-vs-testng/src/test/java/io/github/bonigarcia/testng/selenium/RetryAnalyzer.java

@@ -0,0 +1,53 @@
+/*
+ * (C) Copyright 2021 Boni Garcia (https://bonigarcia.github.io/)
+ *
+ * Licensed 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 io.github.bonigarcia.testng.selenium;
+
+import java.lang.reflect.Method;
+import java.util.concurrent.atomic.AtomicInteger;
+
+import org.testng.IRetryAnalyzer;
+import org.testng.ITestResult;
+
+public class RetryAnalyzer implements IRetryAnalyzer {
+
+    static final int DEFAULT_MAX_RETRIES = 3;
+
+    final AtomicInteger retryCount = new AtomicInteger(1);
+
+    @Override
+    public boolean retry(ITestResult result) {
+        Method method = result.getMethod().getConstructorOrMethod().getMethod();
+        int maxRetries = DEFAULT_MAX_RETRIES;
+        if (method.isAnnotationPresent(Retry.class)) {
+            Retry retry = method.getAnnotation(Retry.class);
+            maxRetries = retry.value();
+        }
+        if (retryCount.get() <= maxRetries) {
+            logError(result.getThrowable());
+            retryCount.incrementAndGet();
+            return true;
+        }
+        return false;
+    }
+
+    private void logError(Throwable e) {
+        System.err.println("Attempt test execution #" + retryCount.get()
+                + " failed (" + e.getClass().getName() + "thrown):  "
+                + e.getMessage());
+    }
+
+}