如何立即重新运行失败的 JUnit 测试？

Question

有没有办法拥有一个 JUnit 规则或类似的规则，让每个失败的测试都有第二次机会，只需尝试再次运行它。

背景：我有一大套用 JUnit 编写的 Selenium2-WebDriver 测试。 由于非常激进的时间安排（点击后只有很短的等待时间），一些测试（100 次中的 1 次，并且总是不同的测试）可能会失败，因为服务器有时会响应较慢。 但是我不能让等待时间太长以至于它绝对足够长，因为那样测试将永远持续。） - 所以我认为这个用例即使需要第二个测试也是绿色的也是可以接受的尝试。

当然，最好有 3 个多数中的 2 个（重复失败的测试 3 次，如果其中两个测试正确，则认为它们是正确的），但这将是未来的改进。

Answer 1

您可以使用TestRule来做到这一点。 这将为您提供所需的灵活性。 TestRule 允许您在测试周围插入逻辑，因此您将实现重试循环：

public class RetryTest {
    public class Retry implements TestRule {
        private int retryCount;

        public Retry(int retryCount) {
            this.retryCount = retryCount;
        }

        public Statement apply(Statement base, Description description) {
            return statement(base, description);
        }

        private Statement statement(final Statement base, final Description description) {
            return new Statement() {
                @Override
                public void evaluate() throws Throwable {
                    Throwable caughtThrowable = null;

                    // implement retry logic here
                    for (int i = 0; i < retryCount; i++) {
                        try {
                            base.evaluate();
                            return;
                        } catch (Throwable t) {
                            caughtThrowable = t;
                            System.err.println(description.getDisplayName() + ": run " + (i+1) + " failed");
                        }
                    }
                    System.err.println(description.getDisplayName() + ": giving up after " + retryCount + " failures");
                    throw caughtThrowable;
                }
            };
        }
    }

    @Rule
    public Retry retry = new Retry(3);

    @Test
    public void test1() {
    }

    @Test
    public void test2() {
        Object o = null;
        o.equals("foo");
    }
}

TestRule是base.evaluate() ，它调用您的测试方法。 所以围绕这个调用，你放置了一个重试循环。 如果在您的测试方法中抛出异常（断言失败实际上是AssertionError ），则测试失败，您将重试。

还有一件事可能有用。 您可能只想将此重试逻辑应用于一组测试，在这种情况下，您可以将测试添加到 Retry 类中，以针对方法上的特定注释进行测试。 Description包含该方法的注释列表。 有关这方面的更多信息，请参阅我对如何在每个 JUnit @Test 方法之前单独运行一些代码，而不使用 @RunWith 或 AOP？ .

使用自定义 TestRunner

这是CKuck的建议，你可以定义自己的Runner。 您需要扩展BlockJUnit4ClassRunner并覆盖 runChild()。 有关更多信息，请参阅我对如何在套件中定义 JUnit 方法规则的回答？ . 这个答案详细说明了如何定义如何为套件中的每个方法运行代码，您必须为此定义自己的 Runner。

Answer 2

现在有一个更好的选择。 如果您使用的是 maven 插件，例如： surfire 或 failefe ，则可以选择添加参数rerunFailingTestsCount SurFire Api 。 这些东西是在以下票证中实现的： Jira Ticket 。 在这种情况下，您不需要编写您的自定义代码和插件自动修改测试结果报告。
我只看到这种方法的一个缺点：如果某些测试在课前/课后阶段测试失败，则不会重新运行。

Answer 3

至于我编写自定义转轮更灵活的解决方案。 上面发布的解决方案（带有代码示例）有两个缺点：

1. 如果在@BeforeClass 阶段失败，它不会重试；
2. 它计算测试的运行方式略有不同（当您重试 3 次时，您将收到 test Runs: 4, success 1 这可能会令人困惑）；

这就是为什么我更喜欢编写自定义跑步者的更多方法。 自定义跑步者的代码可能如下：

import org.junit.Ignore;
import org.junit.internal.AssumptionViolatedException;
import org.junit.internal.runners.model.EachTestNotifier;
import org.junit.runner.Description;
import org.junit.runner.notification.RunNotifier;
import org.junit.runner.notification.StoppedByUserException;
import org.junit.runners.BlockJUnit4ClassRunner;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.Statement;


public class RetryRunner extends BlockJUnit4ClassRunner {

    private final int retryCount = 100;
    private int failedAttempts = 0;

    public RetryRunner(Class<?> klass) throws InitializationError {
        super(klass);
    }    


    @Override
    public void run(final RunNotifier notifier) {
        EachTestNotifier testNotifier = new EachTestNotifier(notifier,
                getDescription());
        Statement statement = classBlock(notifier);
        try {

            statement.evaluate();
        } catch (AssumptionViolatedException e) {
            testNotifier.fireTestIgnored();
        } catch (StoppedByUserException e) {
            throw e;
        } catch (Throwable e) {
            retry(testNotifier, statement, e);
        }
    }

    @Override
    protected void runChild(final FrameworkMethod method, RunNotifier notifier) {
        Description description = describeChild(method);
        if (method.getAnnotation(Ignore.class) != null) {
            notifier.fireTestIgnored(description);
        } else {
            runTestUnit(methodBlock(method), description, notifier);
        }
    }

    /**
     * Runs a {@link Statement} that represents a leaf (aka atomic) test.
     */
    protected final void runTestUnit(Statement statement, Description description,
            RunNotifier notifier) {
        EachTestNotifier eachNotifier = new EachTestNotifier(notifier, description);
        eachNotifier.fireTestStarted();
        try {
            statement.evaluate();
        } catch (AssumptionViolatedException e) {
            eachNotifier.addFailedAssumption(e);
        } catch (Throwable e) {
            retry(eachNotifier, statement, e);
        } finally {
            eachNotifier.fireTestFinished();
        }
    }

    public void retry(EachTestNotifier notifier, Statement statement, Throwable currentThrowable) {
        Throwable caughtThrowable = currentThrowable;
        while (retryCount > failedAttempts) {
            try {
                statement.evaluate();
                return;
            } catch (Throwable t) {
                failedAttempts++;
                caughtThrowable = t;
            }
        }
        notifier.addFailure(caughtThrowable);
    }
}

Answer 4

建议的评论是根据这篇文章写的，并添加了一些内容。

在这里，如果您的 jUnit 项目中的某个测试用例得到“失败”或“错误”结果，则该测试用例将再重新运行一次。 在这里我们总共设置了 3 次获得成功结果的机会。

因此，我们需要创建规则类并将“@Rule”通知添加到您的测试类。

如果您不想为每个测试类编写相同的“@Rule”通知，您可以将其添加到您的抽象 SetProperty 类（如果有）并从中扩展。

规则类：

import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;

public class RetryRule implements TestRule {
    private int retryCount;

    public RetryRule (int retryCount) {
        this.retryCount = retryCount;
    }

    public Statement apply(Statement base, Description description) {
        return statement(base, description);
    }

    private Statement statement(final Statement base, final Description description) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                Throwable caughtThrowable = null;

                // implement retry logic here
                for (int i = 0; i < retryCount; i++) {
                    try {
                        base.evaluate();
                        return;
                    } catch (Throwable t) {
                        caughtThrowable = t;
                        //  System.out.println(": run " + (i+1) + " failed");
                        System.err.println(description.getDisplayName() + ": run " + (i + 1) + " failed.");
                    }
                }
                System.err.println(description.getDisplayName() + ": giving up after " + retryCount + " failures.");
                throw caughtThrowable;
            }
        };
    }
}

测试类：

import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.firefox.FirefoxDriver;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;

/**
 * Created by ONUR BASKIRT on 27.03.2016.
 */
public class RetryRuleTest {

    static WebDriver driver;
    final private String URL = "http://www.swtestacademy.com";

    @BeforeClass
    public static void setupTest(){
        driver = new FirefoxDriver();
    }

    //Add this notification to your Test Class 
    @Rule
    public RetryRule retryRule = new RetryRule(3);

    @Test
    public void getURLExample() {
        //Go to www.swtestacademy.com
        driver.get(URL);

        //Check title is correct
        assertThat(driver.getTitle(), is("WRONG TITLE"));
    }
}

Answer 5

您必须编写自己的org.junit.runner.Runner并使用@RunWith(YourRunner.class)注释您的测试。

Answer 6

这个答案是建立在这个答案的基础上的。

如果您需要在每次运行之前重新创建ActivityScenario （和您的 Activity），您可以使用 try-with-resources 启动它。 ActivityScenario将在每次尝试后自动关闭。

public final class RetryRule<A extends Activity> implements TestRule {
    private final int retryCount;
    private final Class<A> activityClazz;
    private ActivityScenario<A> scenario;

    /**
     * @param retryCount the number of retries. retryCount = 1 means 1 (normal) try and then
     * 1 retry, i.e. 2 tries overall
     */
    public RetryRule(int retryCount, @NonNull Class<A> clazz) {
        this.retryCount = retryCount;
        this.activityClazz = clazz;
    }

    public Statement apply(Statement base, Description description) {
        return statement(base, description);
    }

    private Statement statement(final Statement base, final Description description) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                Throwable caughtThrowable = null;

                // implement retry logic here
                for (int i = 0; i <= retryCount; i++) {
                    try(ActivityScenario<A> scenario = ActivityScenario.launch(activityClazz)){
                        RetryRule.this.scenario = scenario;
                        base.evaluate();
                        return;
                    } catch (Throwable t) {
                        caughtThrowable = t;
                        Log.e(LOGTAG,
                                description.getDisplayName() + ": run " + (i + 1) + " failed: ", t);
                    }
                }
                Log.e(LOGTAG,
                        description.getDisplayName() + ": giving up after " + (retryCount + 1) +
                                " failures");
                throw Objects.requireNonNull(caughtThrowable);
            }
        };
    }

    public ActivityScenario<A> getScenario() {
        return scenario;
    }
}

然后，您可以使用getScenario()方法在测试中访问您的场景。

Answer 7

至于Junit5 ，junit-pioneer 扩展https://junit-pioneer.org/docs/retrying-test/提供了一个很酷的功能@RetryingTest，简单示例：

public class RetryTest {
    private int counter = 0;


    @RetryingTest(5)
    void retryCounter() {
        if (counter++ < 2) fail();
    }

}

这将失败两次，并在第三次执行时显示绿色。