Contact us
Create app
com.vaadin.testbench.
Package com.vaadin.testbench

Class ScreenshotOnFailureRule

java.lang.Object
org.junit.rules.TestWatcher
com.vaadin.testbench.ScreenshotOnFailureRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class ScreenshotOnFailureRule extends org.junit.rules.TestWatcher

This JUnit Rule grabs a screenshot when a test fails. Usage: 

 
 public class MyTestCase extends TestBenchTestCase {

      \@Rule public ScreenshotOnFailureRule screenshotOnFailure = new ScreenshotOnFailureRule(this, true);

      \@Test public void myTest() throws Exception {
          ...
      }
 }

NOTE! Do NOT call driver.quit() in your tearDown() method (annotated with After). The tear down method will be run before this rule is run and if the driver is closed it is no longer possible to grab a screen shot of the situation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScreenshotOnFailureRule(HasDriver driverHolder)

    Creates a new ScreenshotOnFailureRule in the provided test case.

    ScreenshotOnFailureRule(HasDriver driverHolder, boolean quitDriverOnFinish)

    Creates a new ScreenshotOnFailureRule in the provided test case.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    failed(Throwable throwable, org.junit.runner.Description description)
     
    protected void
    finished(org.junit.runner.Description description)
     
    protected File
    getErrorScreenshotFile(org.junit.runner.Description description)
     
    void
    setQuitDriverOnFinish(boolean quitDriverOnFinish)

    Tells the rule whether to quit the driver when the test has finished executing or to allow the user to specify this.

    Methods inherited from class org.junit.rules.TestWatcher

    apply, skipped, skipped, starting, succeeded

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ScreenshotOnFailureRule

      public ScreenshotOnFailureRule(HasDriver driverHolder)

      Creates a new ScreenshotOnFailureRule in the provided test case.

      Parameters:

      driverHolder - The HasDriver instance that holds the active WebDriver instance. Commonly this is the TestBenchTestCase.

    • ScreenshotOnFailureRule

      public ScreenshotOnFailureRule(HasDriver driverHolder, boolean quitDriverOnFinish)

      Creates a new ScreenshotOnFailureRule in the provided test case.

      Parameters:

      driverHolder - The HasDriver instance that holds the active WebDriver instance. Commonly this is the TestBenchTestCase.

      quitDriverOnFinish - Tells the rule whether to quit the driver when a single test has finished or not.

  • Method Details

    • setQuitDriverOnFinish

      public void setQuitDriverOnFinish(boolean quitDriverOnFinish)

      Tells the rule whether to quit the driver when the test has finished executing or to allow the user to specify this.

      Parameters:

      quitDriverOnFinish - true if the driver should be quit when a test has finished running.

    • failed

      protected void failed(Throwable throwable, org.junit.runner.Description description)

      Overrides:

      failed in class org.junit.rules.TestWatcher

    • finished

      protected void finished(org.junit.runner.Description description)

      Overrides:

      finished in class org.junit.rules.TestWatcher

    • getErrorScreenshotFile

      protected File getErrorScreenshotFile(org.junit.runner.Description description)

      Parameters:

      description - test Description

      Returns:

      Failure screenshot file.

Copyright © 2025. All rights reserved.