Fix: Ensure DataProvider parameters are refreshed on retry when cacheDataForTestRetries=false (#3250)

* Fix: Ensure DataProvider is re-executed when cacheDataForTestRetries=false

During test retries, if cacheDataForTestRetries was set to false, the DataProvider was re-executed but the new parameters were ignored. This change ensures that the new parameters are correctly used.

* Test: Add reproduction test from PR #3237

This test confirms that when cacheDataForTestRetries=false, the test method receives the fresh data generated by the DataProvider, rather than cached stale data.

* Refactor reproduction tests to align with project style

Split tests into runners extending SimpleBaseTest and sample test cases, ensuring proper isolation and style consistency.

* Cleanup: Remove duplicate reproduction test (issue 3236), keeping the one from PR #3237

* Update CHANGES.txt

* Apply formatting

* Update testng-core/src/main/java/org/testng/internal/invokers/TestInvoker.java

Co-authored-by: Julien Herr <[email protected]>

* Revert "Update testng-core/src/main/java/org/testng/internal/invokers/TestInvoker.java"

This reverts commit 1b37b67.

* Apply change suggestion

* Update Gradle wrapper validation action to v5

Bumps the Gradle wrapper validation GitHub Action from v3 to v5 for improved security and compatibility.

---------

Co-authored-by: Bartek Florczak <[email protected]>
Co-authored-by: Julien Herr <[email protected]>

Author: 3 people

.github/workflows/gradle-wrapper-validation.yml

@@ -7,4 +7,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: gradle/actions/wrapper-validation@v3
+      - uses: gradle/actions/wrapper-validation@v5

CHANGES.txt

@@ -1,4 +1,5 @@
 Current (7.12.0)
+Fixed: GITHUB-3236: DataProvider parameters are not refreshed on retry when cacheDataForTestRetries=false (Bartek Florczak)
 Fixed: GITHUB-3227: assertEqualsNoOrder false positive when collection has same size and actual Collection is subset of expected collection (Krishnan Mahadevan)
 Fixed: GITHUB-3177: Method org.testng.xml.XmlSuite#toXml do not save new properties like "share-thread-pool-for-data-providers" (Krishnan Mahadevan)
 Fixed: GITHUB-3179: ClassCastException when use shouldUseGlobalThreadPool(true) property (Krishnan Mahadevan)

testng-core/src/main/java/org/testng/internal/invokers/TestInvoker.java

@@ -243,7 +243,8 @@ public FailureContext retryFailed(
       boolean cacheData =
           Optional.ofNullable(arguments.getTestMethod().getDataProviderMethod())
               .map(IDataProviderMethod::cacheDataForTestRetries)
-              .orElse(false);
+              .orElse(true);
+      Object[] parameterValues = arguments.getParameterValues();
       if (!cacheData) {
         Map<String, String> allParameters = Maps.newHashMap();
         int verbose = testContext.getCurrentXmlTest().getVerbose();
@@ -257,8 +258,18 @@ public FailureContext retryFailed(
         if (bag.hasErrors()) {
           continue;
         }
+        if (bag.parameterHolder != null) {
+          Iterator<Object[]> it = bag.parameterHolder.parameters;
+          int targetIndex = arguments.getParametersIndex();
+          for (int i = 0; it.hasNext(); i++) {
+            Object[] current = it.next();
+            if (i == targetIndex) {
+              parameterValues = current;
+              break;
+            }
+          }
+        }
       }
-      Object[] parameterValues = arguments.getParameterValues();
       TestMethodArguments tma =
           new TestMethodArguments.Builder()
               .usingArguments(arguments)

testng-core/src/test/java/test/dataprovider/issue3237/CacheTest.java

@@ -0,0 +1,23 @@
+package test.dataprovider.issue3237;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.testng.TestListenerAdapter;
+import org.testng.TestNG;
+import org.testng.annotations.Test;
+import test.SimpleBaseTest;
+
+public class CacheTest extends SimpleBaseTest {
+
+  @Test
+  public void verifyFreshDataOnRetry() {
+    TestNG tng = create(SampleCacheTestCase.class);
+    TestListenerAdapter tla = new TestListenerAdapter();
+    tng.addListener(tla);
+    tng.run();
+
+    assertThat(tla.getFailedTests()).isEmpty();
+    assertThat(tla.getPassedTests()).hasSize(1);
+    assertThat(tla.getSkippedTests()).hasSize(1);
+  }
+}

testng-core/src/test/java/test/dataprovider/issue3237/SampleCacheTestCase.java

@@ -0,0 +1,41 @@
+package test.dataprovider.issue3237;
+
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicInteger;
+import org.testng.Assert;
+import org.testng.IRetryAnalyzer;
+import org.testng.ITestResult;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+public class SampleCacheTestCase {
+
+  private final AtomicInteger invocationCount = new AtomicInteger(0);
+  private String currentUuid;
+
+  @Test(dataProvider = "dp", retryAnalyzer = MyRetry.class)
+  public void testMethod(String uuid) {
+    // Verify that fresh UUID is generated on each retry (no caching)
+    Assert.assertEquals(uuid, currentUuid, "Received stale data from DataProvider!");
+
+    // Fail on first invocation to trigger retry, pass on second
+    if (invocationCount.getAndIncrement() < 1) {
+      throw new RuntimeException("Failed for " + uuid);
+    }
+  }
+
+  @DataProvider(name = "dp", cacheDataForTestRetries = false)
+  public Object[][] getData() {
+    currentUuid = UUID.randomUUID().toString();
+    return new Object[][] {{currentUuid}};
+  }
+
+  public static class MyRetry implements IRetryAnalyzer {
+    private int count = 0;
+
+    @Override
+    public boolean retry(ITestResult result) {
+      return count++ < 1;
+    }
+  }
+}

testng-core/src/test/resources/testng.xml

@@ -606,6 +606,7 @@
       <class name="test.dataprovider.IndicesTest" />
       <class name="test.dataprovider.DataProviderTest"/>
       <class name="test.dataprovider.InterceptorTest"/>
+      <class name="test.dataprovider.issue3237.CacheTest"/>
     </classes>
   </test>