Remove (duplicate) failed TestNG result via test listener

Question

Similar to the solution posted here TestNG retrying failed tests doesn't output the correct test results, I\'m trying to remove a (duplicate) test result using a test li

Answer 1

I ended up going for a solution that uses a suite listener.

The solution may not fully clean up what TestNG / your tests log to the console, but if you use the TestNG Jenkins plugin, and had a failure first on every test, and then success, the test run ends up to be green, which I guess is the most important thing.

And yes, we run mvn integration-test (not mvn verify) and let the TestNG plugin deal with pass / fail. The solution is quite similar / builds on what was posted here.

import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.testng.ISuite;
import org.testng.ISuiteListener;
import org.testng.ISuiteResult;
import org.testng.ITestContext;

/**
 * {@link ISuiteListener} implementation to clean up duplicate test results caused by retrying tests using the
 * {@link RetryAnalyzer}
 */
public class SuiteResultListener implements ISuiteListener {

    private static final Logger LOG = LogManager.getLogger();

    @Override
    public void onStart(ISuite suite) {
    }

    @Override
    public void onFinish(ISuite suite) {
        LOG.info("Cleaning up duplicate test failures in suite '" + suite.getName() + "' ...");
        final Map results = suite.getResults();
        int removedFailures = 0;
        for (ISuiteResult result : results.values()) {
            final ITestContext testContext = result.getTestContext();

            removedFailures += TestListenerUtil.cleanUpDuplicateFailures(testContext);
        }

        LOG.info("Removed " + removedFailures + " duplicate test failure(s) from suite '" + suite.getName() + "'");
    }
}

And here's the magic that happens in the TestListenerUtil class:

public static int cleanUpDuplicateFailures(ITestContext testContext) {
    final String testContextName = testContext.getName();
    int removedFailures = 0;

    LOG.info("Cleaning up failures in test context '" + testContextName + "' ...");
    final Set failedTests = testContext.getFailedTests().getAllResults();
    if (failedTests.isEmpty()) {
        LOG.info("There are no failures in test context '" + testContextName + "'\n");
    } else {
        // collect all id's from passed test
        final Set passedTestIds = new HashSet<>();
        final Set passedTests = testContext.getPassedTests().getAllResults();
        LOG.info("Analyzing " + passedTests.size() + " passed test(s)");
        for (ITestResult result : passedTests) {
            final int testId = TestListenerUtil.getId(result);
            passedTestIds.add(testId);
            LOG.info("  Passed test " + TestListenerUtil.getName(result) + ": #" + testId + " @ "
                    + getStartTime(result));
        }

        // check which failed test results should be removed
        final List resultsToBeRemoved = new ArrayList<>();
        final Set failedTestIds = new HashSet<>();

        LOG.info("Analyzing " + failedTests.size() + " failed test(s)");
        for (ITestResult result : failedTests) {
            final int testId = TestListenerUtil.getId(result);
            final String name = TestListenerUtil.getName(result);

            // if we saw this test pass or fail before we mark the result for deletion
            if (failedTestIds.contains(testId) || passedTestIds.contains(testId)) {
                LOG.info("  Adding test " + name + " to be removed: #" + testId + " @ " + getStartTime(result));
                resultsToBeRemoved.add(testId);
            } else {
                LOG.info("  Remembering failed test " + name + ": #" + testId + " @ " + getStartTime(result));
                failedTestIds.add(testId);
            }
        }

        // finally delete all duplicate failures (if any)
        final int duplicateFailures = resultsToBeRemoved.size();
        if (duplicateFailures > 0) {
            LOG.info("Cleaning up failed tests (expecting to remove " + resultsToBeRemoved.size()
                    + " result(s)) ...");
            for (ITestResult result : testContext.getFailedTests().getAllResults()) {
                final int testId = TestListenerUtil.getId(result);
                final String info = TestListenerUtil.getName(result) + ": #" + testId + " @ "
                        + getStartTime(result);
                if (resultsToBeRemoved.contains(testId)) {
                    LOG.info("  Removing failed test result " + info);
                    testContext.getFailedTests().removeResult(result);
                    resultsToBeRemoved.remove((Integer) testId);
                    removedFailures++;
                } else {
                    LOG.info("  Not removing failed test result " + info);
                }
            }
        }

        if (removedFailures == duplicateFailures) {
            LOG.info("Removed " + removedFailures + " failed test result(s) in '" + testContextName + "'\n");
        } else {
            LOG.warn("Removed " + removedFailures + " failed test result(s) in '" + testContextName
                    + "' (expected to remove " + duplicateFailures + ")\n");
        }
    }

    return removedFailures;
}

With those two additional utils methods:

public static String getName(ITestResult result) {
    final List parameters = new ArrayList<>();
    if (result.getParameters() != null) {
        for (Object parameter : result.getParameters()) {
            if (parameter instanceof TestResult && ((TestResult) parameter).getStatus() < 0) {
                // TestResult.toString() will explode with status < 0, can't use the toString() method
                parameters.add(parameter.getClass().getName() + "@" + parameter.hashCode());
            } else {
                parameters.add(parameter == null ? "null" : parameter.toString());
            }
        }
    }

    return result.getTestClass().getRealClass().getSimpleName() + "." + result.getMethod().getMethodName() + "("
            + StringUtils.join(parameters, ",") + ")";
}

public static int getId(ITestResult result) {
    final HashCodeBuilder builder = new HashCodeBuilder();
    builder.append(result.getTestClass().getRealClass());
    builder.append(result.getMethod().getMethodName());
    builder.append(result.getParameters());
    return builder.toHashCode();
}

And also, if you're interested how our RetryAnalyzer works, see below.

One thing that is important to understand, is that we're taking the the parameters of the test method into account in both the RetryAnalyzer and the duplicate result clean up. Those are relevant cause we often work with DataProviders.

import java.util.HashMap;
import java.util.Map;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.testng.IRetryAnalyzer;
import org.testng.ITestResult;

public class RetryAnalyzer implements IRetryAnalyzer {

    private static final Logger LOG = LogManager.getLogger();

    private static Integer maxRetries;
    private final Map retryCount = new HashMap<>();

    @Override
    public boolean retry(ITestResult result) {
        // only re-try failures
        if (result.getStatus() == ITestResult.FAILURE) {
            final String testName = TestListenerUtil.getName(result);
            final int count = getRetryCount(result);
            final int maxRetriesAllowed = getMaxRetriesAllowed();
            if (count < maxRetriesAllowed) {
                retryCount.put(TestListenerUtil.getId(result), count + 1);
                LOG.info("Retrying test (attempt " + (count + 1) + "/" + maxRetriesAllowed + "): " + testName);
                return true;
            } else {
                LOG.error("Failing test after " + count + " retries: " + testName);
            }
        }

        return false;
    }

    public boolean canRetry(ITestResult result) {
        return result.getStatus() == ITestResult.FAILURE && getRetryCount(result) < getMaxRetriesAllowed();
    }

    private int getRetryCount(ITestResult result) {
        final int testId = TestListenerUtil.getId(result);
        return retryCount.containsKey(testId) ? retryCount.get(testId) : 0;
    }

    public static int getMaxRetriesAllowed() {
        return maxRetries == null ? Config.MAX_TEST_RETRIES : maxRetries;
    }
}