KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use FailureDetectingStepListener class of net.serenitybdd.junit.runners package

Best Serenity JUnit code snippet using net.serenitybdd.junit.runners.FailureDetectingStepListener

Source:SerenityRunner.java

...69     * Special listener that keeps track of test step execution and results.70     */71    private JUnitStepListener stepListener;72    private PageObjectDependencyInjector dependencyInjector;73    private FailureDetectingStepListener failureDetectingStepListener;74    /**75     * Retrieve the runner getConfiguration().from an external source.76     */77    private DriverConfiguration configuration;78    private TagScanner tagScanner;79    private BatchManager batchManager;80    private final Logger logger = LoggerFactory.getLogger(SerenityRunner.class);81    public Pages getPages() {82        return pages;83    }84    /**85     * Creates a new test runner for WebDriver web tests.86     *87     * @param klass the class under test88     * @throws InitializationError if some JUnit-related initialization problem occurred89     */90    public SerenityRunner(final Class<?> klass) throws InitializationError {91        this(klass, Injectors.getInjector(new WebDriverModule()));92    }93    /**94     * Creates a new test runner for WebDriver web tests.95     *96     * @param klass the class under test97     * @param module used to inject a custom Guice module98     * @throws InitializationError if some JUnit-related initialization problem occurred99     */100    public SerenityRunner(Class<?> klass, Module module) throws InitializationError {101        this(klass, Injectors.getInjector(module));102    }103    public SerenityRunner(final Class<?> klass,104                          final Injector injector) throws InitializationError {105        this(klass,106                ThucydidesWebDriverSupport.getWebdriverManager(),107                injector.getInstance(DriverConfiguration.class),108                injector.getInstance(BatchManager.class)109        );110    }111    public SerenityRunner(final Class<?> klass,112                          final WebDriverFactory webDriverFactory) throws InitializationError {113        this(klass, webDriverFactory, WebDriverConfiguredEnvironment.getDriverConfiguration());114    }115    public SerenityRunner(final Class<?> klass,116                          final WebDriverFactory webDriverFactory,117                          final DriverConfiguration configuration) throws InitializationError {118        this(klass,119                webDriverFactory,120                configuration,121                new BatchManagerProvider(configuration).get()122        );123    }124    public SerenityRunner(final Class<?> klass,125                          final WebDriverFactory webDriverFactory,126                          final DriverConfiguration configuration,127                          final BatchManager batchManager) throws InitializationError {128        this(klass,129                ThucydidesWebDriverSupport.getWebdriverManager(webDriverFactory, configuration),130                configuration,131                batchManager132        );133    }134    public SerenityRunner(final Class<?> klass, final BatchManager batchManager) throws InitializationError {135        this(klass,136                ThucydidesWebDriverSupport.getWebdriverManager(),137                WebDriverConfiguredEnvironment.getDriverConfiguration(),138                batchManager);139    }140    public SerenityRunner(final Class<?> klass,141                          final WebdriverManager webDriverManager,142                          final DriverConfiguration configuration,143                          final BatchManager batchManager) throws InitializationError {144        super(klass);145        this.theTest = TestConfiguration.forClass(klass).withSystemConfiguration(configuration);146        this.webdriverManager = webDriverManager;147        this.configuration = configuration;148        this.requestedDriver = getSpecifiedDriver(klass);149        this.tagScanner = new TagScanner(configuration.getEnvironmentVariables());150        this.failureDetectingStepListener = new FailureDetectingStepListener();151        this.failureRerunner = new FailureRerunnerXml(configuration);152        if (TestCaseAnnotations.supportsWebTests(klass)) {153            checkRequestedDriverType();154        }155        this.batchManager = batchManager;156        batchManager.registerTestCase(klass);157    }158    private String getSpecifiedDriver(Class<?> klass) {159        if (ManagedWebDriverAnnotatedField.hasManagedWebdriverField(klass)) {160            return ManagedWebDriverAnnotatedField.findFirstAnnotatedField(klass).getDriver();161        } else {162            return null;163        }164    }...

Source:FailureDetectingStepListener.java

...9import net.thucydides.core.steps.TestFailureCause;10import java.util.ArrayList;11import java.util.List;12import java.util.Map;13public class FailureDetectingStepListener implements StepListener {14    private boolean lastTestFailed = false;15    private List<String> failureMessages = new ArrayList<>();16    private TestFailureCause testFailureCause;17    public void reset() {18        lastTestFailed = false;19        failureMessages.clear();20    }21    public boolean lastTestFailed() {22        return lastTestFailed;23    }24    public void testFailed(TestOutcome testOutcome, Throwable cause) {25        lastTestFailed = true;26        String failingStep = testOutcome.getFailingStep().isPresent() ? testOutcome.getFailingStep().get().getDescription() + ":" : "";27        failureMessages.add(failingStep + testOutcome.getErrorMessage());...

FailureDetectingStepListener

Using AI Code Generation

1import net.serenitybdd.junit.runners.SerenityRunner;2import net.serenitybdd.junit.runners.SerenityRunner.FailureDetectingStepListener;3import net.thucydides.core.steps.StepEventBus;4import org.junit.AfterClass;5import org.junit.BeforeClass;6import org.junit.runner.RunWith;7import org.openqa.selenium.WebDriver;8import org.openqa.selenium.firefox.FirefoxDriver;9@RunWith(SerenityRunner.class)10public class MyTest {11    private static WebDriver driver;12    public static void setup() {13        driver = new FirefoxDriver();14    }15    public static void teardown() {16        driver.quit();17    }18    public void test() {19        StepEventBus.getEventBus().stepFailed("This step failed");20    }21}22import net.serenitybdd.core.steps.StepEventBus;23import net.serenitybdd.junit.runners.SerenityRunner;24import net.thucydides.core.steps.StepListener;25import org.junit.runner.notification.RunNotifier;26import org.junit.runners.model.InitializationError;27public class MySerenityRunner extends SerenityRunner {28    public MySerenityRunner(Class<?> klass) throws InitializationError {29        super(klass);30    }31    public void run(RunNotifier notifier) {32        StepEventBus.getEventBus().registerListener(new FailureDetectingStepListener());33        super.run(notifier);34    }35    public static class FailureDetectingStepListener implements StepListener {36        public void testSuiteStarted(Class<?> storyClass) {}37        public void testSuiteFinished() {}38        public void testStarted(String description) {}39        public void testFinished() {}40        public void stepStarted(String stepDescription) {}41        public void skippedStepStarted(String stepDescription) {}42        public void stepFailed(String stepDescription) {43            System.out.println("Step failed: " + stepDescription);44        }45        public void lastStepFailed() {}46        public void stepIgnored() {}47        public void stepPending() {}48        public void stepPending(String message) {}49        public void stepFinished() {}

FailureDetectingStepListener

Using AI Code Generation

1import net.serenitybdd.junit.runners.FailureDetectingStepListener;2import net.serenitybdd.junit.runners.SerenityRunner;3import org.junit.runner.RunWith;4@RunWith(SerenityRunner.class)5public class TestRunner {6}7import net.serenitybdd.junit.FailureDetectingStepListener;8import org.junit.runner.RunWith;9import org.junit.runners.SerenityRunner;10@RunWith(SerenityRunner.class)11public class TestRunner {12}13import net.serenitybdd.junit5.FailureDetectingStepListener;14import org.junit.jupiter.api.extension.ExtendWith;15@ExtendWith(FailureDetectingStepListener.class)16public class TestRunner {17}18import net.serenitybdd.junit5.listeners.FailureDetectingStepListener;19import org.junit.jupiter.api.extension.ExtendWith;20@ExtendWith(FailureDetectingStepListener.class)21public class TestRunner {22}23import net.serenitybdd.junit.runners.FailureDetectingStepListener;24import net.serenitybdd.junit.runners.SerenityRunner;25import org.junit.runner.RunWith;26@RunWith(SerenityRunner.class)27public class TestRunner {28}29import net.serenitybdd.junit.FailureDetectingStepListener;30import org.junit.runner.RunWith;31import org.junit.runners.SerenityRunner;32@RunWith(SerenityRunner.class)33public class TestRunner {34}35import net.serenitybdd.junit5.FailureDetectingStepListener;36import org.junit.jupiter.api.extension.ExtendWith;37@ExtendWith(FailureDetectingStepListener.class)38public class TestRunner {39}40import net.serenitybdd.junit5.listeners.FailureDetectingStepListener;41import org.junit.jupiter.api.extension.ExtendWith;42@ExtendWith(FailureDetectingStepListener.class)43public class TestRunner {44}

FailureDetectingStepListener

Using AI Code Generation

1@RunWith(SerenityRunner.class)2public class SampleTest {3    private SampleSteps sampleSteps;4    public void test1() {5        sampleSteps.step1();6        sampleSteps.step2();7        sampleSteps.step3();8    }9}10package com.sample;11import net.serenitybdd.core.steps.ScenarioSteps;12import net.thucydides.core.annotations.Step;13public class SampleSteps extends ScenarioSteps {14    public void step1() {15        System.out.println("Step 1");16    }17    public void step2() {18        System.out.println("Step 2");19    }20    public void step3() {21        System.out.println("Step 3");22        throw new RuntimeException("Step 3 failed");23    }24}25package com.sample;26import net.serenitybdd.core.steps.ScenarioSteps;27import net.thucydides.core.annotations.Step;28public class SampleSteps extends ScenarioSteps {29    public void step1() {30        System.out.println("Step 1");31    }32    public void step2() {33        System.out.println("Step 2");34    }35    public void step3() {36        System.out.println("Step 3");37        throw new RuntimeException("Step 3 failed");38    }39}40package com.sample;41import net.serenitybdd.core.steps.ScenarioSteps;42import net.thucydides.core.annotations.Step;43public class SampleSteps extends ScenarioSteps {44    public void step1() {45        System.out.println("Step 1");46    }47    public void step2() {48        System.out.println("Step 2");49    }50    public void step3() {51        System.out.println("Step 3");52        throw new RuntimeException("Step 3 failed");53    }54}55package com.sample;56import net.serenitybdd.core.steps.ScenarioSteps;57import net.thucydides.core.annotations.Step;58public class SampleSteps extends ScenarioSteps {59    public void step1() {60        System.out.println("Step 1");61    }62    public void step2() {63        System.out.println("Step 2");64    }65    public void step3() {66        System.out.println("

FailureDetectingStepListener

Using AI Code Generation

1@Listeners({FailureDetectingStepListener.class})2public class MyTest {}3@RunWith(SerenityRunner.class)4@Listeners({FailureDetectingStepListener.class})5public class MyTest {}6@RunWith(SerenityRunner.class)7@Listeners({FailureDetectingStepListener.class})8public class MyTest extends SerenityRunner {}9@RunWith(SerenityRunner.class)10@Listeners({FailureDetectingStepListener.class})11public class MyTest extends SerenityRunner implements FailureDetectingStepListener {}12@RunWith(SerenityRunner.class)13@Listeners({FailureDetectingStepListener.class})14public class MyTest implements FailureDetectingStepListener {}15@RunWith(SerenityRunner.class)16@Listeners({FailureDetectingStepListener.class})17public class MyTest implements FailureDetectingStepListener extends SerenityRunner {}18@RunWith(SerenityRunner.class)19@Listeners({FailureDetectingStepListener.class})20public class MyTest extends SerenityRunner implements FailureDetectingStepListener extends SerenityRunner {}21@RunWith(SerenityRunner.class)22@Listeners({FailureDetectingStepListener.class})23public class MyTest extends SerenityRunner implements FailureDetectingStepListener extends SerenityRunner implements FailureDetectingStepListener {}24@RunWith(SerenityRunner.class)25@Listeners({FailureDetectingStepListener.class})26public class MyTest extends SerenityRunner implements FailureDetectingStepListener extends SerenityRunner implements FailureDetectingStepListener extends SerenityRunner implements FailureDetectingStepListener {}27@RunWith(SerenityRunner.class)28@Listeners({FailureDetectingStepListener.class})

FailureDetectingStepListener

Using AI Code Generation

1import net.serenitybdd.junit.runners.FailureDetectingStepListener2import net.thucydides.core.steps.StepEventBus3import net.thucydides.core.steps.StepListener4import java.io.File5import java.io.IOException6import java.util.concurrent.TimeUnit7import static net.thucydides.core.ThucydidesSystemProperty.SERENITY_TAKE_SCREENSHOTS8import static net.thucydides.core.ThucydidesSystemProperty.SERENITY_WEBDRIVER_DRIVER9public class SerenityRunner extends SerenityParameterizedRunner {10    private static final String DEFAULT_DRIVER = "chrome";11    private static final String DEFAULT_TAKE_SCREENSHOTS = "FOR_FAILURES";12    public SerenityRunner(Class<?> klass) throws InitializationError {13        super(klass);14    }15    protected List<Runner> getChildren() {16        return super.getChildren();17    }18    protected List<StepListener> stepListeners() {19        List<StepListener> stepListeners = super.stepListeners();20        stepListeners.add(new FailureDetectingStepListener());21        return stepListeners;22    }23    protected void runChild(Runner runner, RunNotifier notifier) {24        super.runChild(runner, notifier);25    }26    protected void runChild(final FrameworkMethod method, RunNotifier notifier) {27        super.runChild(method, notifier);28    }29    protected void runChild(final FrameworkMethod method, RunNotifier notifier, final SerenityReportingRunner childRunner) {30        super.runChild(method, notifier, childRunner);31    }32    protected void runChild(final FrameworkMethod method, RunNotifier notifier, final SerenityReportingRunner childRunner, final SerenityStepFactory stepFactory) {33        super.runChild(method, notifier, childRunner, stepFactory);34    }35    protected void runChild(final FrameworkMethod method, RunNotifier notifier, final SerenityReportingRunner childRunner, final SerenityStepFactory stepFactory, final SerenityTestContext testContext) {36        super.runChild(method, notifier, childRunner, stepFactory, testContext);37    }38    protected void runChild(final FrameworkMethod method, RunNotifier notifier, final SerenityReportingRunner childRunner, final SerenityStepFactory stepFactory, final SerenityTestContext testContext, final SerenityTestOutcomeRecorder testOutcomeRecorder)

FailureDetectingStepListener

Using AI Code Generation

1public class FailureDetectingStepListener implements SerenityStepListener {2    private final Logger log = LoggerFactory.getLogger(this.getClass());3    private final WebDriver driver;4    private final AllureLifecycle lifecycle;5    private final AllureSerenity allureSerenity;6    private final SerenityReporter reporter;7    private final FileOutputFailureScreenshotProcessor screenshotProcessor;8    private final String screenshotDirectory;9    private final String screenshotExtension;10    private final String screenshotContext;11    public FailureDetectingStepListener(12            String screenshotContext) {13        this.driver = driver;14        this.lifecycle = lifecycle;15        this.allureSerenity = allureSerenity;16        this.reporter = reporter;17        this.screenshotProcessor = screenshotProcessor;18        this.screenshotDirectory = screenshotDirectory;19        this.screenshotExtension = screenshotExtension;20        this.screenshotContext = screenshotContext;21    }22    public void stepFinished() {23        if (TestOutcome.forTestInContext().isFailure()) {24            takeScreenshot();25        }26    }27    private void takeScreenshot() {28        try {29            String screenshot = screenshotProcessor.takeScreenshot(driver);30            String screenshotName = screenshotProcessor.getFilename(screenshot);31            String screenshotPath = screenshotProcessor.getRelativePath(screenshot);32            String screenshotUrl = screenshotProcessor.getRelativeUrl(screenshot);33            lifecycle.addAttachment(screenshotName, "image/" + screenshotExtension, screenshotContext, screenshotPath.getBytes());34            reporter.addAttachment(screenshotName, screenshotUrl);35            allureSerenity.addAttachment(screenshotName, screenshotUrl);36        } catch (Exception e) {37            log.warn("Failed to take screenshot", e);38        }39    }40}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.