com.github.markusbernhardt.seleniumlibrary.keywords.Screenshot Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of robotframework-seleniumlibrary Show documentation
Java port of the Python based SeleniumLibrary for Robot Framework
There is a newer version: 4.0.0-alpha-2.0
Show newest version
package com.github.markusbernhardt.seleniumlibrary.keywords;

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

import org.apache.commons.lang3.exception.ExceptionUtils;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.robotframework.javalib.annotation.ArgumentNames;
import org.robotframework.javalib.annotation.Autowired;
import org.robotframework.javalib.annotation.RobotKeyword;
import org.robotframework.javalib.annotation.RobotKeywordOverload;
import org.robotframework.javalib.annotation.RobotKeywords;

import com.github.markusbernhardt.seleniumlibrary.RunOnFailureKeywordsAdapter;
import com.github.markusbernhardt.seleniumlibrary.utils.Robotframework;

@RobotKeywords
public class Screenshot extends RunOnFailureKeywordsAdapter {

	/**
	 * Instantiated BrowserManagement keyword bean
	 */
	@Autowired
	protected BrowserManagement browserManagement;

	/**
	 * Instantiated Logging keyword bean
	 */
	@Autowired
	protected Logging logging;

	// ##############################
	// Keywords
	// ##############################
	@RobotKeywordOverload
	public void capturePageScreenshot() {
		capturePageScreenshot(null);
	}

	/**
	 * Take a screenshot of the current page and embed it into the log.

	 * 

	 * The filename argument specifies the name of the file to write the
	 * screenshot into. If no filename is given, the screenshot is saved into
	 * file selenium-screenshot-<counter>.png under the directory where
	 * the Robot Framework log file is written into. The filename is also
	 * considered relative to the same directory, if it is not given in absolute
	 * format.

	 * 

	 * A CSS can be used to modify how the screenshot is taken. By default the
	 * background color is changed to avoid possible problems with background
	 * leaking when the page layout is somehow broken.

	 * 
	 * @param filename
	 *            Default=NONE. Name of the file to write.
	 */
	@RobotKeyword
	@ArgumentNames({ "filename=NONE" })
	public void capturePageScreenshot(String filename) {
		File logdir = logging.getLogDir();
		File path = new File(logdir, normalizeFilename(filename));
		String link = Robotframework.getLinkPath(path, logdir);
		WebDriver currentWebDriver = browserManagement.getCurrentWebDriver();

		if (currentWebDriver.getClass().toString().contains("HtmlUnit")) {
		    logging.warn("HTMLunit is not supporting screenshots.");
		    return;
		} else {
    		TakesScreenshot takesScreenshot = ((TakesScreenshot) currentWebDriver);
    		if (takesScreenshot == null) {
    			logging.warn("Can't take screenshot. No open browser found");
    			return;
    		}
    
    		byte[] png = takesScreenshot.getScreenshotAs(OutputType.BYTES);
    		writeScreenshot(path, png);
    
    		logging.html(String.format(
    				"", link, link));
		}
	}

	// ##############################
	// Internal Methods
	// ##############################

	protected int screenshotIndex = 0;

	protected void writeScreenshot(File path, byte[] png) {
		FileOutputStream fos = null;
		try {
		    path.getParentFile().mkdirs();
			fos = new FileOutputStream(path);
			fos.write(png);
			fos.flush();
		} catch (IOException e) {
			logging.warn(String.format("Can't write screenshot '%s'", path.getAbsolutePath()));
			logging.debug(ExceptionUtils.getStackTrace(e));
		} finally {
			if (fos != null) {
				try {
					fos.close();
				} catch (IOException e) {
					logging.warn("Can't even close stream");
				}
			}
		}
	}

	protected String normalizeFilename(String filename) {
		if (filename == null) {
			screenshotIndex++;
			filename = String.format("selenium-screenshot-%d.png", screenshotIndex);
		} else {
			filename = filename.replace('/', File.separatorChar);
		}
		return filename;
	}

}