Selenium WebDriver how to name each screenshot taken after a test based on the test name

Question

I am currently using the following method to take screenshots after each test, and it works fine:

@After
public void takeScreenshotAtEndOfTest() throws IOException {
    File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
    String currentDir = System.getProperty("user.dir");
    FileUtils.copyFile(scrFile, new File(currentDir + "\\screenshots\\" + System.currentTimeMillis() + ".png"));

}

My question is, how can I improve this method so that it takes the name of the current test that has been run, and puts that into the filename of the image (instead of System.currentTimeMillis)?

This is one of my tests, if that helps:

@Test
public void pf01_activateQsmart_NoAddon_Cash(){
    guestWebsite.startOfTest("pf01_activateQsmart_NoAddon_Cash");
    doRegularServiceLevelActivation();
    doCashPayment();
    guestWebsite.endOfTest("pf01_activateQsmart_NoAddon_Cash");
}

Answer 1

The answer provided by Sam nearly worked for me, but still had some problems as described above.

Basically I needed to use TestRule instead of MethodRule, and TestWatcher() instead of TestWatchman() - since the former ones have been depreciated.

I also needed to pass in "Description" instead of "FrameworkMethod" to get the name.

Finally I need to surround the copyFile with try / catch to avoid exceptions.

This is the code that worked for me and allowed me to take a screenshot on failure with the method name (and improved timestamp)

@Rule
public TestRule testWatcher = new TestWatcher() {
  @Override
  public void failed(Throwable e, Description test){
      File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
      String currentDir = System.getProperty("user.dir");
      String timeStamp = new SimpleDateFormat("yyyyMMdd_HHmmss").format(Calendar.getInstance().getTime());
      try {
          FileUtils.copyFile(scrFile, new File(currentDir + "\\screenshots\\" + test.getMethodName() + timeStamp + ".png"));
      } catch (IOException e1) {
          e1.printStackTrace();
      }
  }
};

Thanks again for your help

Answer 2

You can use the TestWatchman class which is part of JUnit to get the test case name, as well as the status, so you could take screenshots only on failure. Here's an example that takes a screenshot on failure:

@Rule
MethodRule watchman = new TestWatchman(){

    @Override
    public void failed(Throwable e, FrameworkMethod method){
        File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
        String currentDir = System.getProperty("user.dir");
        FileUtils.copyFile(scrFile, new File(currentDir + "\\screenshots\\" +
        method.getName() + System.currentTimeMillis() + ".png"));
    }

}

JUnit Documentation: https://github.com/junit-team/junit/wiki/Rules#testwatchmantestwatcher-rules

Answer 3

Add this screenshot class to your project:

public class ScreenshotRule implements MethodRule {

    public Statement apply(final Statement statement, final FrameworkMethod frameworkMethod, Object o) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                try {
                    statement.evaluate();
                } catch (Throwable t) {
                    captureScreenshot(frameworkMethod.getName());
                    throw t;
                }
            }
        };
    }

    public void captureScreenshot(String methodName){
        try {
            new File("build/reports/tests/screenshots/").mkdirs(); //this is the default directory for reports generated by gradle
            FileOutputStream outPutFile = new FileOutputStream("build/reports/tests/screenshots/" + methodName + ".jpg");
            outPutFile.write(((TakesScreenshot) driver).getScreenshotAs(OutputType.BYTES));
            out.close();
        } catch (Exception e) {
        }
    }
}

And then add this to your BaseTest or a test file where you want the screenshot to be taken:

@Rule
public ScreenshotRule screenshotRule = new ScreenshotRule();

Also check this post out on saving screenshots and then adding them to reports https://automatedqa.wordpress.com/2016/09/20/html-report-with-screenshots-with-gradle-and-webdriver/