How can I take a screenshot with Selenium WebDriver?

Question

Is it possible to take a screenshot using Selenium WebDriver?

user_1280424 · Answer

Java (Robot Framework)

I used this method for taking a screenshot.

void takeScreenShotMethod(){
    try{
        Thread.sleep(10000)
        BufferedImage image = new Robot().createScreenCapture(new Rectangle(Toolkit.getDefaultToolkit().getScreenSize()));
        ImageIO.write(image, "jpg", new File("./target/surefire-reports/screenshot.jpg"));
    }
    catch(Exception e){
        e.printStackTrace();
    }
}

You may use this method wherever required.

user_7429447 · Answer

There are multiple methods through Selenium's Java and Python client to take a screenshot using Selenium WebDriver.

Java Methods

The following are the different Java methods to take a screenshot:

Using getScreenshotAs() from the TakesScreenshot interface:

Code block:

     package screenShot;

     import java.io.File;
     import java.io.IOException;

     import org.apache.commons.io.FileUtils;
     import org.openqa.selenium.OutputType;
     import org.openqa.selenium.TakesScreenshot;
     import org.openqa.selenium.WebDriver;
     import org.openqa.selenium.firefox.FirefoxDriver;
     import org.openqa.selenium.support.ui.ExpectedConditions;
     import org.openqa.selenium.support.ui.WebDriverWait;

     public class Firefox_takesScreenshot {

         public static void main(String[] args) throws IOException {

             System.setProperty("webdriver.gecko.driver", "C:\Utility\BrowserDrivers\geckodriver.exe");
             WebDriver driver =  new FirefoxDriver();
             driver.get("https://login.bws.birst.com/login.html/");
             new WebDriverWait(driver, 20).until(ExpectedConditions.titleContains("Birst"));
             File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
             FileUtils.copyFile(scrFile, new File(".\Screenshots\Mads_Cruz_screenshot.png"));
             driver.quit();
         }
     }

Screenshot:
If the webpage is jQuery enabled, you can use ashot from the pazone/ashot library:

Code block:

     package screenShot;

     import java.io.File;
     import javax.imageio.ImageIO;
     import org.openqa.selenium.WebDriver;
     import org.openqa.selenium.firefox.FirefoxDriver;
     import org.openqa.selenium.support.ui.ExpectedConditions;
     import org.openqa.selenium.support.ui.WebDriverWait;

     import ru.yandex.qatools.ashot.AShot;
     import ru.yandex.qatools.ashot.Screenshot;
     import ru.yandex.qatools.ashot.shooting.ShootingStrategies;

     public class ashot_CompletePage_Firefox {

         public static void main(String[] args) throws Exception {

             System.setProperty("webdriver.gecko.driver", "C:\Utility\BrowserDrivers\geckodriver.exe");
             WebDriver driver =  new FirefoxDriver();
             driver.get("https://jquery.com/");
             new WebDriverWait(driver, 20).until(ExpectedConditions.titleContains("jQuery"));
             Screenshot myScreenshot = new AShot().shootingStrategy(ShootingStrategies.viewportPasting(100)).takeScreenshot(driver);
             ImageIO.write(myScreenshot.getImage(),"PNG",new File("./Screenshots/firefoxScreenshot.png"));
             driver.quit();
         }
     }

Screenshot:
Using selenium-shutterbug from assertthat/selenium-shutterbug library:

Code block:

     package screenShot;

     import org.openqa.selenium.WebDriver;
     import org.openqa.selenium.firefox.FirefoxDriver;
     import com.assertthat.selenium_shutterbug.core.Shutterbug;
     import com.assertthat.selenium_shutterbug.utils.web.ScrollStrategy;

     public class selenium_shutterbug_fullpage_firefox {

         public static void main(String[] args) {

             System.setProperty("webdriver.gecko.driver", "C:\Utility\BrowserDrivers\geckodriver.exe");
             WebDriver driver =  new FirefoxDriver();
             driver.get("https://www.google.co.in");
             Shutterbug.shootPage(driver, ScrollStrategy.BOTH_DIRECTIONS).save("./Screenshots/");
             driver.quit();
         }
     }

Screenshot:

Python Methods

The following are the different Python methods to take a screenshot:

Using save_screenshot() method:

Code block:

     from selenium import webdriver

     driver = webdriver.Chrome(r'C:\Utility\BrowserDrivers\chromedriver.exe')
     driver.get("http://google.com")
     driver.save_screenshot('./Screenshots/save_screenshot_method.png')
     driver.quit()

Screenshot:
Using the get_screenshot_as_file() method:

Code block:

     from selenium import webdriver

     driver = webdriver.Chrome(r'C:\Utility\BrowserDrivers\chromedriver.exe')
     driver.get("http://google.com")
     driver.get_screenshot_as_file('./Screenshots/get_screenshot_as_file_method.png')
     driver.quit()

Screenshot:
Using get_screenshot_as_png() method:

Code block:

     from selenium import webdriver

     driver = webdriver.Chrome(r'C:\Utility\BrowserDrivers\chromedriver.exe')
     driver.get("http://google.com")
     screenPnG = driver.get_screenshot_as_png()

     # Crop it back to the window size (it may be taller)
     box = (0, 0, 1366, 728)
     im = Image.open(BytesIO(screenPnG))
     region = im.crop(box)
     region.save('./Screenshots/get_screenshot_as_png_method.png', 'PNG', optimize=True, quality=95)
     driver.quit()

Screenshot:

user_5615171 · Answer

Python

webdriver.get_screenshot_as_file(filepath)

The above method will take a screenshot and also store it as a file in the location provided as a parameter.

user_3600553 · Answer

Yes, it is possible to take screenshots via Selenium WebDriver. I currently use Chrome Driver for snapping images of websites. Please refer the following method captureScreenshot().

You can also add restriction towards web driver, such as

use headless version of web browser
disable notification when page loads
start full screen, etc.

If a website is equipped with Alert Box, your web driver will not be able to capture screenshot since exception will be thrown. In that scenario you need to close the alert box and then get the screenshot. Following code fragment does the closing of alert box.

    public void captureScreenshot() throws InterruptedException, IOException {

        System.out.println("Creating Chrome Driver");

        // Set Chrome Driver
        System.setProperty("webdriver.chrome.driver", "D:\chromedriver.exe");

        // Add arguments to Chrome Options
        ChromeOptions chromeOptions = new ChromeOptions();
        chromeOptions.addArguments("--headless");
        chromeOptions.addArguments("start-maximized");
        chromeOptions.addArguments("--disable-gpu");
        chromeOptions.addArguments("--start-fullscreen");
        chromeOptions.addArguments("--disable-extensions");
        chromeOptions.addArguments("--disable-popup-blocking");
        chromeOptions.addArguments("--disable-notifications");
        chromeOptions.addArguments("--window-size=1920,1080");
        chromeOptions.addArguments("--no-sandbox");
        chromeOptions.addArguments("--dns-prefetch-disable");
        chromeOptions.addArguments("enable-automation");
        chromeOptions.addArguments("disable-features=NetworkService");

        WebDriver driver = new ChromeDriver(chromeOptions);
        driver.get("https://www.google.com");
        System.out.println("Wait a bit for the page to render");
        TimeUnit.SECONDS.sleep(5);
        System.out.println("Taking Screenshot");
        File outputFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
        String imageDetails = "D:\Images";
        File screenShot = new File(imageDetails).getAbsoluteFile();
        FileUtils.copyFile(outputFile, screenShot);
        System.out.println("Screenshot saved: {}" + imageDetails);
    }
}

In order to accept Alert Box and Get Screenshot:

String alertText = alert.getText();
System.out.println("ERROR: (ALERT BOX DETECTED) - ALERT MSG : " + alertText);
alert.accept();
File outputFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
String imageDetails = "D://Images"
File screenShot = new File(imageDetails).getAbsoluteFile();
FileUtils.copyFile(outputFile, screenShot);
System.out.println("Screenshot saved: {}" + imageDetails);
driver.close();

user_4291793 · Answer

Java

For newer version of Java, the FileUtils function doesn't work. Here the following function worked perfectly for screenshot copying.

import java.io.File;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.io.FileHandler;

File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
File destfile = new File(destination folder /filename.extension);
FileHandler.copy(scrfile, destfile);

user_8767345 · Answer

/**
 * Take a screenshot and move to the given folder location.
 *
 * @param driver
 * @param folderLocation
 * @return screenShotFilePath
 */
public static String captureScreenshot(WebDriver driver, String folderLocation) {

    // Variable to store screenshot's file path.
    String screenShotFilePath = null;

    // Generate unique id for screen shot name.
    String uniqueId = UUID.randomUUID().toString().substring(31);

    if (driver != null) {

        // Generate screenshot as a file
        File scrFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);

        // New screenshot file path with having file name
        screenShotFilePath = folderLocation + File.separator + uniqueId + ".png";

        // Move file to the destination location.
        FileUtils.moveFile(scrFile, new File(screenShotFilePath));
    }

    return screenShotFilePath;
}

user_13692427 · Answer

Using C# and MSTestframework, Here I have created a static method. Taken a path where I can store the images as jpeg format. to make more clear I am naming those screen shots with current Executing Testcases and date and time of the failure.

          /// 
            /// This method is used to screen shot where test method failed 
            /// 
            /// TestCaseName
            public static void Capture(string testCase)
            {
                try
                {
                    StringBuilder path = new StringBuilder("C:/Logs/Screenshot/");
                    Constant.screenshot = ((ITakesScreenshot)Constant.browser).GetScreenshot();
                    string fileName = path.Append(string.Format(testCase + "-at-{0:yyyy-MM dd_hh-mm-ss}.jpeg", DateTime.Now)).ToString();
                    Constant.screenshot.SaveAsFile(fileName, ScreenshotImageFormat.Jpeg);
                }
                catch (Exception e)
                {
                    File.AppendAllText("C:/Logs/FailedTestCasesLogs.txt", "
COULD NOT CAPTURE THE SCREENSHOT!
");
                    Log(e);
                }
    
            }

user_944190 · Answer

You can take screenshot of webpage visible portion in browser as:

First import:

import java.io.File;
import com.google.common.io.Files;

Then

File src=((TakesScreenshot)driver).getScreenShotAs(OutputType.FILE);
Files.copy(src,new File("new path/pic.jpeg"));

Plus after Selenium4 you can also take screenshot of webelement as:

WebElement element=driver.findElement(By.xpath("xpath 
 here"));
File src=element.getScreenShotAs(OutputType.FILE);
File.copy(src,new File("new path/pic.jpeg"));

user_17894902 · Answer

JAVA

Hi, you can take screenshot in selenium and here is the code given below with the help of which you can create screenshot in any selenium project and we can also generate screenshots for the failed scenario's in aws too.

    public boolean takeScreenshot(final String name) {
    String screenshotDirectory = System.getenv("WORKING_DIRECTORY");
    File screenshot = 
    ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
    return screenshot.renameTo(new File(screenshotDirectory, 
    String.format("%s.png", name)));
    }

How can I take a screenshot with Selenium WebDriver?

47 Answers

Java (Robot Framework)

Java Methods

Python Methods

Java