Package com.codeborne.selenide.impl

Class ScreenShotLaboratory

java.lang.Object

com.codeborne.selenide.impl.ScreenShotLaboratory

public class ScreenShotLaboratory
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Screenshot>	allScreenshots
protected final Clock	clock
protected final ThreadLocal<String>	currentContext
protected final ThreadLocal<@Nullable List<Screenshot>>	currentContextScreenshots
protected AtomicLong	screenshotCounter
protected final ThreadLocal<List<Screenshot>>	threadScreenshots

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScreenShotLaboratory()
protected	ScreenShotLaboratory(Photographer photographer, PageSourceExtractor extractor, AttachmentHandler attachmentHandler, Clock clock)

Method Summary

Modifier and Type	Method	Description
protected void	addToHistory(Screenshot screenshot)
List<Screenshot>	contextScreenshots()
List<Screenshot>	finishContext()
protected String	generateScreenshotFileName()
List<@Nullable File>	getContextScreenshots()
Optional<File>	getLastContextScreenshot()
@Nullable File	getLastScreenshot()
Optional<File>	getLastThreadScreenshot()
protected String	getScreenshotFileName(String className, String methodName)
List<File>	getScreenshots()
List<@Nullable File>	getThreadScreenshots()
Optional<Screenshot>	lastContextScreenshot()
@Nullable Screenshot	lastScreenshot()
Optional<Screenshot>	lastThreadScreenshot()
protected @Nullable File	savePageImageToFile(Config config, String fileName, Driver driver)
protected File	savePageSourceToFile(Config config, String fileName, Driver driver)
List<Screenshot>	screenshots()
void	startContext(String context)
void	startContext(String className, String methodName)
Screenshot	takeScreenshot(Driver driver, boolean saveScreenshot, boolean savePageSource)
Screenshot	takeScreenshot(Driver driver, String fileName, boolean saveScreenshot, boolean savePageSource)	Takes screenshot of current browser window.
File	takeScreenshot(Driver driver, org.openqa.selenium.WebElement element)
@Nullable File	takeScreenshot(Driver driver, org.openqa.selenium.WebElement iframe, SelenideElement element)
Screenshot	takeScreenShot(Driver driver, String className, String methodName)
<T> @Nullable T	takeScreenShot(Driver driver, org.openqa.selenium.OutputType<T> outputType)
@Nullable File	takeScreenShotAsFile(Driver driver)
BufferedImage	takeScreenshotAsImage(Driver driver, org.openqa.selenium.WebElement element)
@Nullable BufferedImage	takeScreenshotAsImage(Driver driver, org.openqa.selenium.WebElement iframe, SelenideElement element)
List<Screenshot>	threadScreenshots()

Methods inherited from class java.lang.Object

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

Field Details

clock

protected final Clock clock

allScreenshots

protected final List<Screenshot> allScreenshots

screenshotCounter

protected AtomicLong screenshotCounter

currentContext

protected final ThreadLocal<String> currentContext

currentContextScreenshots

protected final ThreadLocal<@Nullable List<Screenshot>> currentContextScreenshots

threadScreenshots

protected final ThreadLocal<List<Screenshot>> threadScreenshots

Constructor Details

ScreenShotLaboratory

protected ScreenShotLaboratory()

ScreenShotLaboratory

protected ScreenShotLaboratory(Photographer photographer,
 PageSourceExtractor extractor,
 AttachmentHandler attachmentHandler,
 Clock clock)

Method Details

takeScreenShot

public Screenshot takeScreenShot(Driver driver,
 String className,
 String methodName)

getScreenshotFileName

protected String getScreenshotFileName(String className,
 String methodName)

takeScreenshot

public Screenshot takeScreenshot(Driver driver,
 String fileName,
 boolean saveScreenshot,
 boolean savePageSource)

Takes screenshot of current browser window. Stores 2 files: 1. html of the page (if "savePageSource" parameter is true), and 2. screenshot of the page in PNG format (if "saveScreenshot" parameter is true)

Either file may be null if webdriver has failed to save it.

Parameters:

fileName - name of file (without extension) to store screenshot to.

Returns:

instance of Screenshot containing both files

takeScreenShot

public <T> @Nullable T takeScreenShot(Driver driver,
 org.openqa.selenium.OutputType<T> outputType)

takeScreenshot

public File takeScreenshot(Driver driver,
 org.openqa.selenium.WebElement element)

takeScreenshotAsImage

public BufferedImage takeScreenshotAsImage(Driver driver,
 org.openqa.selenium.WebElement element)

generateScreenshotFileName

protected String generateScreenshotFileName()

takeScreenshot

public @Nullable File takeScreenshot(Driver driver,
 org.openqa.selenium.WebElement iframe,
 SelenideElement element)

takeScreenshotAsImage

public @Nullable BufferedImage takeScreenshotAsImage(Driver driver,
 org.openqa.selenium.WebElement iframe,
 SelenideElement element)

takeScreenShotAsFile

public @Nullable File takeScreenShotAsFile(Driver driver)

addToHistory

protected void addToHistory(Screenshot screenshot)

savePageImageToFile

protected @Nullable File savePageImageToFile(Config config,
 String fileName,
 Driver driver)

savePageSourceToFile

protected File savePageSourceToFile(Config config,
 String fileName,
 Driver driver)

startContext

public void startContext(String className,
 String methodName)

startContext

public void startContext(String context)

finishContext

@CanIgnoreReturnValue
public List<Screenshot> finishContext()

getScreenshots

public List<File> getScreenshots()

screenshots

public List<Screenshot> screenshots()

getThreadScreenshots

public List<@Nullable File> getThreadScreenshots()

threadScreenshots

public List<Screenshot> threadScreenshots()

getContextScreenshots

public List<@Nullable File> getContextScreenshots()

contextScreenshots

public List<Screenshot> contextScreenshots()

getLastScreenshot

public @Nullable File getLastScreenshot()

lastScreenshot

public @Nullable Screenshot lastScreenshot()

getLastThreadScreenshot

public Optional<File> getLastThreadScreenshot()

lastThreadScreenshot

public Optional<Screenshot> lastThreadScreenshot()

getLastContextScreenshot

public Optional<File> getLastContextScreenshot()

lastContextScreenshot

public Optional<Screenshot> lastContextScreenshot()

takeScreenshot

@CanIgnoreReturnValue
public Screenshot takeScreenshot(Driver driver,
 boolean saveScreenshot,
 boolean savePageSource)