Take a screenshot with Cucumber

32,911

Solution 1

Screenshots in general are taken when something unexpected occurs. You may also want to capture a screenshot to report when a test case fails. In this particular case, you should have screenshot capture logic in an @After method that will be executed for every scenario. A Java, selenium version,

@After("@browser")
public void tearDown(Scenario scenario) {
    if (scenario.isFailed()) {
            final byte[] screenshot = ((TakesScreenshot) driver)
                        .getScreenshotAs(OutputType.BYTES);
            scenario.embed(screenshot, "image/png"); //stick it in the report
    }
    driver.close();
}

Solution 2

  1. You can use canned steps (pre-defined) to take screenshot.

    Then take picture
    

There is not need for any step definition. Cucumber also comes with many other pre-defined steps. See other canned steps

  1. If you still need to write step definition.

    Then /^I take a screenshot$/ do
      page.save_screenshot('image_name.png')
    end
    

Solution 3

I am providing the code which will take the snapshot when scenario is failed, I hope you can modify according to your uses, Comment here if you can't do that. This code is in ruby with Ubuntu system

#Create a directory for storing snapshot
dir_path = "/home/vchouhan/vijay_work/snapshot"
unless Dir.exist?(dir_path)
    Dir.mkdir(dir_path,0777)
    puts "=========Directory is created at #{dir_path}"
else
    puts "=========Directory is exist at #{dir_path}"
end

#Run after each scenario
After do |scenario|
  #Check, scenario is failed?
  if(scenario.failed?)
         time = Time.now.strftime('%Y_%m_%d_%Y_%H_%M_%S_')
         name_of_scenario = time + scenario.name.gsub(/\s+/, "_").gsub("/","_")
         puts "Name of snapshot is #{name_of_scenario}"
         file_path = File.expand_path(dir_path)+'/'+name_of_scenario +'.png'
         page.driver.browser.save_screenshot file_path
         puts "Snapshot is taken"
    puts "#===========================================================#"
    puts "Scenario:: #{scenario.name}"
    puts "#===========================================================#"
  end
end
Share:
32,911
Sokhom Ratanak
Author by

Sokhom Ratanak

Updated on September 10, 2020

Comments

  • Sokhom Ratanak
    Sokhom Ratanak over 3 years

    I just learn how to use cucumber. Can you tell me how to complete this code?

    You can implement step definitions for undefined steps with these snippets:

    Then /^I take a screenshot$/ do
        pending # express the regexp above with the code you wish you had
    end