se.claremont.taf.websupport.webdrivergluecode.WebInteractionMethods Maven / Gradle / Ivy
The newest version!
package se.claremont.taf.websupport.webdrivergluecode;
import org.apache.pdfbox.cos.COSDocument;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.text.PDFTextStripper;
import org.openqa.selenium.Dimension;
import org.openqa.selenium.Point;
import org.openqa.selenium.*;
import org.openqa.selenium.logging.LogEntries;
import org.openqa.selenium.logging.LogEntry;
import org.openqa.selenium.support.ui.Select;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import se.claremont.taf.core.guidriverpluginstructure.GuiElement;
import se.claremont.taf.core.logging.LogFolder;
import se.claremont.taf.core.logging.LogLevel;
import se.claremont.taf.core.support.StringManagement;
import se.claremont.taf.core.support.SupportMethods;
import se.claremont.taf.core.support.tableverification.CellMatchingType;
import se.claremont.taf.core.support.tableverification.TableData;
import se.claremont.taf.core.testcase.TestCase;
import se.claremont.taf.core.testrun.TestRun;
import se.claremont.taf.javasupport.interaction.GenericInteractionMethods;
import se.claremont.taf.javasupport.interaction.MethodInvoker;
import se.claremont.taf.websupport.ActionResult;
import se.claremont.taf.websupport.DomElement;
import se.claremont.taf.websupport.W3CHtmlValidatorService;
import se.claremont.taf.websupport.brokenlinkcheck.BrokenLinkReporter;
import se.claremont.taf.websupport.brokenlinkcheck.LinkCheck;
import se.claremont.taf.websupport.elementidentification.WebElementIdentifier;
import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.event.InputEvent;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.*;
import java.util.logging.Level;
/**
* Methods for interaction with web elements in a web page DOM. Utilizes Selenium WebDriver components.
*
* Created by jordam on 2016-08-17.
*/
@SuppressWarnings({"SameParameterValue", "WeakerAccess", "unused"})
public class WebInteractionMethods {
private final static Logger logger = LoggerFactory.getLogger( WebInteractionMethods.class );
@SuppressWarnings("WeakerAccess")
public WebDriver driver;
private final TestCase testCase;
@SuppressWarnings("CanBeFinal")
private int standardTimeoutInSeconds = 30;
public int getStandardTimeout() {
return standardTimeoutInSeconds;
}
private class NavigationError extends Exception{}
private class TextEnteringError extends Exception{}
private class BrowserClosingError extends Exception{}
/**
* Setting up the possibility to interact with web components
*
* @param testCase the test case to write testCaseLog messages to
*/
public WebInteractionMethods(TestCase testCase){
WebDriverManager.WebBrowserType webBrowser = WebDriverManager.WebBrowserType.CHROME;
this.testCase = testCase;
try{
WebDriverManager webDriverManager = new WebDriverManager(testCase);
driver = webDriverManager.initializeWebDriver(webBrowser);
driver.manage().window().maximize();
if(driver.getWindowHandles() == null || driver.getWindowHandles().size() == 0){
log(LogLevel.EXECUTION_PROBLEM, "Could not initializeIfNotInitialized driver.");
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Could not initializeIfNotInitialized driver. Error: " + e.getMessage());
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}
/**
* Attempts to create a WebDriver instance to use for the specified browser type
*
* @param testCase The test case to log to
* @param browserType The type of browser to try to create driver instance for
*/
public WebInteractionMethods(TestCase testCase, WebDriverManager.WebBrowserType browserType){
this.testCase = testCase;
if(browserType == WebDriverManager.WebBrowserType.NONE) {
driver = null;
return;
}
try{
WebDriverManager webDriverManager = new WebDriverManager(testCase);
driver = webDriverManager.initializeWebDriver(browserType);
driver.manage().window().maximize();
if(driver.getWindowHandles() == null || driver.getWindowHandles().size() == 0){
log(LogLevel.EXECUTION_PROBLEM, "Could not initializeIfNotInitialized driver.");
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not initialize if not driver is initialized. Error: " + e.toString());
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}
public WebInteractionMethods(TestCase testCase, WebDriver driver){
this.testCase = testCase;
try{
this.driver = driver;
driver.manage().window().maximize();
if(driver.getWindowHandles() == null || driver.getWindowHandles().size() == 0){
log(LogLevel.FRAMEWORK_ERROR, "Could not initializeIfNotInitialized driver.");
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Could not initializeIfNotInitialized driver. Error: " + e.getMessage());
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}
/*
* Remote WebDriver enabled constructor. Example of usages: BrowserStack.
*
* @param testCase The test case to log errors to.
* @param url URL to remote web driver
* @param desiredCapabilities The desired capabilities of the browser driver to use.
*/
/*
public WebInteractionMethods(TestCase testCase, URL url, DesiredCapabilities desiredCapabilities){
this.testCase = testCase;
try{
driver = new RemoteWebDriver(url, desiredCapabilities);
driver.manage().window().maximize();
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Could not initializeIfNotInitialized driver. Error: " + e.getMessage());
saveScreenshot(null);
saveDesktopScreenshot();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
}
*/
/**
* Returns the test case.
*
* @return TestCase
*/
public TestCase getTestCase(){
return testCase;
}
/**
* Pauses execution for a number of milliseconds.
*
* @param milliseconds The number of milliseconds to wait.
*/
public synchronized void wait(int milliseconds){
try {
Thread.sleep(milliseconds);
log(LogLevel.DEBUG, "Waiting for " + milliseconds + " milliseconds.");
} catch (InterruptedException e) {
log(LogLevel.EXECUTION_PROBLEM, "Could not wait the expected " + milliseconds + " milliseconds.");
}
}
/**
* Browser back button
* @return Return action result
*/
public ActionResult goBack(){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
try{
driver.navigate().back();
log(LogLevel.EXECUTED, "Navigating back in browser.");
return new ActionResult(true, null, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not navigate back in browser." + e.toString());
return new ActionResult(false, null, this);
}
}
public BrowserVerificationMethods verify(){
return new BrowserVerificationMethods(this);
}
/**
* Writes a testCaseLog post to the testCaseLog
*
* @param logLevel The testCaseLog level of the testCaseLog post
* @param message The testCaseLog message string
*/
@SuppressWarnings("WeakerAccess")
public void log(LogLevel logLevel, String message){
testCase.log(logLevel, message);
}
/**
* Navigates to specified URL
*
* @param url The string formed URL to navigate to
* @return Action result
*/
public ActionResult navigate(String url){
try {
goToUrl(url);
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTED, "Navigation performed to URL '" + url + "'.", "Navigation performed to URL '" + url + "'." );
return new ActionResult(true, null, this);
}catch (NavigationError e){
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTION_PROBLEM, "Could not navigate to URL '" + url + "'.", "Could not navigate to URL '" + url + "'.");
return new ActionResult(false, null, this);
}
}
/**
* Maps the element of the current page to a page element file.
* @param outputFilePath The path to the output file
* @param quickAndSloppyMode The quickAndSloppyMode does not perform the time
* consuming recursive check if elements can be uniquely identified with a sub-element
* search from any parent.
* @return Action result
*/
public ActionResult mapCurrentPageWithBy(String outputFilePath, boolean quickAndSloppyMode){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
WebPageCodeConstructorWithBy constructor = new WebPageCodeConstructorWithBy(this);
constructor.createPageObjectFromCurrentPage(outputFilePath, quickAndSloppyMode);
return new ActionResult(true, null, this);
}
/**
* Creates the DomElements that are easily identified on current path to draft code in output file.
* There is also a more thorough, thus more time consuming, method of doing this;
* the {@link #mapCurrentPageThorough(String) mapCurrentPageThorough() } method.
*
* @param outputFilePath File path to output file
* @return Action result
*/
public ActionResult mapCurrentPage(String outputFilePath){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
Date startTime = new Date();
log(LogLevel.DEBUG, "Starting mapping elements of the current page (" + driver.getCurrentUrl() + ").");
WebPageCodeConstructor.ConstructWebPageCode(driver, outputFilePath);
log(LogLevel.EXECUTED, "Mapped the element of the current page ('" + driver.getCurrentUrl() + "') and saved it to the file '" + outputFilePath + "'. Mapping took " + StringManagement.timeDurationAsString(startTime, new Date()) + ".");
return new ActionResult(true, null, this);
}
/**
* Creates draft page object class content by traversing the DOM of the current page, identifying elements
* on the page. This method is far more time consuming than the regular {@link #mapCurrentPage(String) mapCurrentPage } method.
*
* @deprecated Still evolving. Still unstable.
*
* @param outputFilePath The file to save craft class text to.
* @return Action result
*/
@SuppressWarnings("DeprecatedIsStillUsed")
@Deprecated()
public ActionResult mapCurrentPageThorough(String outputFilePath){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
Date startTime = new Date();
log(LogLevel.DEBUG, "Starting mapping elements of the current page (" + driver.getCurrentUrl() + ").");
WebPageCodeConstructor.ConstructWebPageCodeThorough(driver, outputFilePath);
log(LogLevel.EXECUTED, "Mapped the element of the current page ('" + driver.getCurrentUrl() + "') and saved it to the file '" + outputFilePath + "'. Mapping took " + StringManagement.timeDurationAsString(startTime, new Date()) + ".");
return new ActionResult(true, null, this);
}
/**
* Checks page for broken links
* @return Action result
*/
public ActionResult reportBrokenLinksOnCurrentPage(){
BrokenLinkReporter brokenLinkReporter = new BrokenLinkReporter(testCase, driver);
brokenLinkReporter.reportBrokenLinks(true);
return new ActionResult(true, null, this);
}
/**
* Checks page for broken links (even hidden ones)
* @return Action result
*/
public ActionResult reportBrokenLinksOnCurrentPage_IncludeAllLinksAlsoNonDisplayedLinks(){
BrokenLinkReporter brokenLinkReporter = new BrokenLinkReporter(testCase, driver);
brokenLinkReporter.reportBrokenLinks(false);
return new ActionResult(true, null, this);
}
/**
* Waits for the given element to appear. If it hasn't appeared within the standard timeout execution continues.
*
* @param guiElement The element to wait for.
* @return Returns true if element successfully appears within the timeout.
*/
public ActionResult waitForElementToAppear(GuiElement guiElement){
return new ActionResult(waitForElementToAppear(guiElement, standardTimeoutInSeconds).wasSuccess, guiElement, this);
}
/**
* Pauses execution until given element is displayed.
*
* @param guiElement The element to wait for
* @param timeoutInSeconds Number of seconds to wait for object being displayed
* @return Returns true if element appears within timeout.
*/
public ActionResult waitForElementToAppear(GuiElement guiElement, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
WebElement element;
boolean elementHasAppeared = false;
while (!elementHasAppeared && (System.currentTimeMillis() - startTime) <= timeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
if(element != null && element.isDisplayed()){
elementHasAppeared = true;
}else{
wait(50);
}
}
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " for element " + domElement.LogIdentification() + " to appear. " +
"It " + Boolean.toString(elementHasAppeared).toLowerCase().replace("true", "did.").replace("false", "never did."));
return new ActionResult(elementHasAppeared, guiElement, this);
}
/**
* Pauses execution until given element is displayed.
*
* @param timeoutInSeconds The number of seconds to wait for the element to become enabled.
* @param guiElement The element to wait for
* @return Returns true if element appears within timeout.
*/
public WebElement waitForElementToBeEnabled(GuiElement guiElement, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
WebElement element = null;
boolean elementIsEnabled = false;
while ((System.currentTimeMillis() - startTime) <= timeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
try{
if(element != null && element.isEnabled()){
elementIsEnabled = true;
if(element.isDisplayed()){
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " milliseconds for element " + domElement.LogIdentification() + " to become displayed and enabled.");
} else {
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " milliseconds for element " + domElement.LogIdentification() + " to become enabled. Element is not visible.");
}
return element;
}else{
wait(50);
}
}catch (Exception ignored){
//Stale element exception
}
}
if(element == null){
log(LogLevel.DEBUG, "Could not identify element " + domElement.LogIdentification() + ". Tried for " + (System.currentTimeMillis() - startTime) + " milliseconds.");
} else {
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " milliseconds for element " + domElement.LogIdentification() + " to become displayed and enabled. " +
"It " + Boolean.toString(elementIsEnabled).toLowerCase().replace("true", "did").replace("false", "never did") + " become enabled.");
}
return null;
}
/**
* Waiting for element to disappear. If element is still there after standard timeout execution continues.
* @param guiElement The element to wait for disappearance of.
* @return Return true if element successfully has disappeared within the timeout.
*/
public ActionResult waitForElementToDisappear(GuiElement guiElement){
return new ActionResult(waitForElementToDisappear(guiElement, standardTimeoutInSeconds).wasSuccess, guiElement, this);
}
/**
* Pausing execution until the given element has disappeared.
*
* @param guiElement The element to wait for.
* @param timeoutInSeconds Timeout period to wait for element to disappear.
* @return Returns true if element disappears within timeout.
*/
public ActionResult waitForElementToDisappear(GuiElement guiElement, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
WebElement element;
boolean elementIsDisplayed = true;
while (elementIsDisplayed && (System.currentTimeMillis() - startTime) <= timeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
try{
if(element == null || !element.isDisplayed()){
elementIsDisplayed = false;
}else{
wait(50);
}
}catch (Exception ignored){ //element disappeared while performing
elementIsDisplayed = false;
}
}
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " for element " + domElement.LogIdentification() + " to disappear. " +
"It " + Boolean.toString(elementIsDisplayed).toLowerCase().replace("true", "never did.").replace("false", "did."));
return new ActionResult(!waitForElementToDisappear(guiElement, standardTimeoutInSeconds).wasSuccess, guiElement, this);
}
/**
* Checks current page for broken links and reports results to log as verifications.
* @return Action result
*/
public ActionResult reportBrokenLinksRecursive(){
String currentDomain = currentDomain();
List links = driver.findElements(By.xpath("//a"));
List linkCheckingThreads = new ArrayList<>();
for(WebElement link : links){
String href = link.getAttribute("href");
if(SupportMethods.isRegexMatch(href, "http.*" + currentDomain + ".*") || SupportMethods.isRegexMatch(href, "./.*")){
Thread linkCheck = new Thread(new LinkCheck(testCase, link.getAttribute("href")));
linkCheckingThreads.add(linkCheck);
linkCheck.start();
}
}
//Code below for waiting for all threads to finish due to log timing issues
//noinspection ForLoopReplaceableByForEach
for(int i = 0; i < linkCheckingThreads.size(); i++)
try {
linkCheckingThreads.get(i).join();
} catch (InterruptedException e) {
log(LogLevel.FRAMEWORK_ERROR, e.getMessage());
}
return new ActionResult(true,null, this);
}
private String currentDomain(){
String domain = driver.getCurrentUrl();
int startPosition = domain.indexOf("://") + 3;
domain = domain.substring(startPosition);
if(domain.contains("/"))
domain = domain.substring(0, domain.indexOf("/"));
return domain;
}
/**
* Reads the text from an element
*
* @param guiElement The element to read the current text from
* @return the current text in the element
*/
public String getText(GuiElement guiElement){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
String text = null;
WebElement element = null;
boolean elementIdentified = false;
while (text == null && (System.currentTimeMillis() - startTime) <= standardTimeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
if(element != null){
elementIdentified = true;
try {
text = element.getText();
if (text == null || text.length() == 0)
text = element.getAttribute("value");
}catch (Exception ignored){
text = (String) MethodInvoker.invokeTheFirstEncounteredMethod(testCase, element, new String[] {"getValue()", "getOptions()", "value()", "option()", "text()", "getLabel()", "label()"});
}
}
wait(50);
}
if(text == null && !elementIdentified){
log(LogLevel.EXECUTION_PROBLEM, "Could not retrieve text from element " + domElement.LogIdentification() + " since it could not be identified at runtime.");
//noinspection ConstantConditions
saveScreenshot(element);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else if (text == null){
log(LogLevel.EXECUTION_PROBLEM, "The element " + domElement.LogIdentification() + " could be identified, but the text of the element could not be read.");
saveScreenshot(element);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else {
log(LogLevel.DEBUG, "Identified the text '" + text + "' from element " + domElement.LogIdentification() + ".");
}
return text;
}
/**
* Reads the text from an element
*
* @param guiElement The element to read the current text from
* @return the current text in the element
*/
public String getTextWithoutLogging(GuiElement guiElement){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
String text = null;
WebElement element;
while (text == null && (System.currentTimeMillis() - startTime) <= standardTimeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
if(element != null){
try {
text = element.getText();
}catch (Exception ignored){}
} else {
wait(50);
}
}
return text;
}
/**
* Checks for existence of given element. Actually waits for existence of the element during the standard timeout time
*
* @param element The element to check existence of
* @return Return true if element is found within timeout period
*/
public boolean exists(GuiElement element){
DomElement domElement = (DomElement) element;
return getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds) != null;
}
/**
* Sending accept to popup
* @return Action result
*/
public ActionResult acceptAlert() {
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
try {
Alert alert = driver.switchTo().alert();
alert.accept();
log(LogLevel.EXECUTED, "Accepted alert dialogue.");
return new ActionResult(true, null, this);
} catch (Exception ignored) {
log(LogLevel.EXECUTION_PROBLEM, "Could not accept alert dialogue.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, null, this);
}
}
/**
* Re-scaling the browser window to a new size.
*
* @param width The new width of the browser window
* @param height The new height of the browser window
* @return Action result
*/
public ActionResult setBrowserWindowSize(int width, int height) {
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
log(LogLevel.DEBUG, "Re-sizing the browser window from (width/height) " + driver.manage().window().getSize().width + "/" + driver.manage().window().getSize().height + " pixels to " + width + "/" + height + " pixels.");
try{
driver.manage().window().setSize(new Dimension(width, height));
log(LogLevel.EXECUTED, "Re-sized browser window to width " + width + " pixels and height " + height + " pixels.");
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not re-size browser window to height " + height + " and width " + width + " pixels");
return new ActionResult(false, null, this);
}
return new ActionResult(true, null, this);
}
/**
* Checks a pdf file for specific string patterns
* @param strURL
* @param reqTextInPDF
* @return Action result
*/
public boolean verifyPDFContent(String strURL, String reqTextInPDF) {
PDFTextStripper pdfStripper = null;
PDDocument pdDoc = null;
COSDocument cosDoc = null;
String parsedText = null;
String pdfText;
try {
String script = "" +
"window.file_contents = null; " +
"var xhr = new XMLHttpRequest(); " +
"xhr.responseType = 'blob'; " +
"xhr.onload = function() { " +
" var reader = new FileReader(); " +
" reader.onloadend = function() { " +
" window.file_contents = reader.result;" +
" };" +
" reader.readAsDataURL(xhr.response);" +
"};" +
"xhr.open('GET', '" + strURL + "');" +
"xhr.send();";
executeJavascript(script);
String theFile = null;
long startTime = System.currentTimeMillis();
while (theFile == null && System.currentTimeMillis() - startTime < 10000){
theFile = (String)executeJavascript("return (window.file_contents !== null ? window.file_contents.split(',')[1] : null);");
}
pdDoc = PDDocument.load(Base64.getDecoder().decode(theFile));
pdfText = new PDFTextStripper().getText(pdDoc);
pdDoc.close();
if (!reqTextInPDF.contains(pdfText.replaceAll(" ", "")))
log(LogLevel.VERIFICATION_FAILED, "The total salary value is not present in the pdf document expected total Salary = "
+ reqTextInPDF);
else
log(LogLevel.VERIFICATION_PASSED, "Total salary in pdf document is correct");
} catch (IOException e) {
System.err.println("Unable to open PDF Parser. " + e.getMessage());
try {
if (cosDoc != null)
cosDoc.close();
if (pdDoc != null)
pdDoc.close();
} catch (Exception e1) {
e1.printStackTrace();
}
}
if(SupportMethods.isRegexMatch(parsedText, reqTextInPDF)) return true;
return false;
}
/**
* Checks current value of given attribute for the element. For example the href value of a link, the src value of an image and so forth.
*
* @param linkElement The element to check attribute of
* @param attributeName The name of the attribute to check the value of
* @param expectedAttributeValue The expected attribute of the element
* @deprecated Use attribute() method under {@link #verifiyElement(DomElement)} instead.
* @return Action result
*/
@Deprecated
public ActionResult verifyElementAttribute(GuiElement linkElement, String attributeName, String expectedAttributeValue){
DomElement domElement = (DomElement) linkElement;
try{
WebElement element = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(element.getAttribute("href").equals(expectedAttributeValue)){
log(LogLevel.VERIFICATION_PASSED, "Element " + domElement.LogIdentification() + " was found to have the expected attribute value of '" + expectedAttributeValue + "' for attribute '" + attributeName + "'.");
return new ActionResult(true, linkElement, this);
} else {
log(LogLevel.VERIFICATION_FAILED, "Element " + domElement.LogIdentification() + " was expected to have the value '" + expectedAttributeValue + "' for attribute '" + attributeName + "' but actually had the value of '" + element.getAttribute(attributeName) + "'.");
return new ActionResult(false, linkElement, this);
}
} catch (Exception e){
log(LogLevel.VERIFICATION_PROBLEM, "Could not check the attribute '" + attributeName + "' of element " + domElement.LogIdentification() + " (was expected to have the value '" + expectedAttributeValue + "'." + SupportMethods.LF + e.toString() );
return new ActionResult(false, linkElement, this);
}
}
/**
* Checks current value of given attribute for the element towards a regular expression pattern. For example the href value of a link, the src value of an image and so forth.
*
* @param linkElement The element to check attribute of
* @param attributeName The name of the attribute to check the value of
* @param expectedAttributevalueAsRegex The expected attribute of the element, as regular expression pattern
* @deprecated Use attribute() method under {@link #verifiyElement(DomElement)} instead.
* @return Action result
*/
@Deprecated
public ActionResult verifyElementAttributeRegex(GuiElement linkElement, String attributeName, String expectedAttributevalueAsRegex){
DomElement domElement = (DomElement) linkElement;
try{
WebElement element = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(SupportMethods.isRegexMatch(element.getAttribute("href"),expectedAttributevalueAsRegex)){
log(LogLevel.VERIFICATION_PASSED, "Element " + domElement.LogIdentification() + " was found to have the expected attribute value of '" + expectedAttributevalueAsRegex + "' for attribute '" + attributeName + "'.");
return new ActionResult(true, linkElement, this);
} else {
log(LogLevel.VERIFICATION_FAILED, "Element " + domElement.LogIdentification() + " was expected to have the value '" + expectedAttributevalueAsRegex + "' for attribute '" + attributeName + "' but actually had the value of '" + element.getAttribute(attributeName) + "'.");
return new ActionResult(false, linkElement, this);
}
} catch (Exception e){
log(LogLevel.VERIFICATION_PROBLEM, "Could not check the attribute '" + attributeName + "' of element " + domElement.LogIdentification() + " (was expected to have the value '" + expectedAttributevalueAsRegex + "'." + SupportMethods.LF + e.toString() );
return new ActionResult(false, linkElement, this);
}
}
/**
* When a test case object is created a snapshot of running processes is created. This method makes a comparison
* of what processes that differs at the time of method execution compared to test case start.
* @return Action result
*/
public ActionResult writeRunningProcessListDeviationsSinceTestCaseStart(){
testCase.writeProcessListDeviationsFromSystemStartToLog();
return new ActionResult(true, null, this);
}
/**
* Writes text to the given element.
*
* @param guiElement The element to write to
* @param textToWrite The text to write
* @return Action result
*/
public ActionResult write(GuiElement guiElement, String textToWrite){
DomElement domElement = (DomElement) guiElement;
long startTime = System.currentTimeMillis();
WebElement element = null;
boolean success = false;
while (!success && System.currentTimeMillis() - startTime < standardTimeoutInSeconds * 1000){
element = getRuntimeElementWithoutLogging(domElement);
if(element == null){
wait(50);
continue;
}
try {
enterText(element, textToWrite, false);
success = true;
}catch (Exception ignored){}
}
if(success){
log(LogLevel.EXECUTED, "Wrote '" + textToWrite + "' to " + domElement.LogIdentification() + ".");
return new ActionResult(true, guiElement, this);
} else {
String text = null;
String errorMessage = null;
boolean exist = false;
try {
element = getRuntimeElementWithoutLogging(domElement);
if(element != null) {
exist = true;
text = element.getText();
}
}catch (Exception e){
errorMessage = e.getMessage();
}
log(LogLevel.EXECUTION_PROBLEM, "Could not enter the text '" + textToWrite + "' to element " + domElement.LogIdentification() + ". Element " + Boolean.toString(exist).toLowerCase().replace("false", "could not be identified").replace("true", "was identified") + ".");
if(text != null) {
log(LogLevel.DEVIATION_EXTRA_INFO, "Current text of " + domElement.LogIdentification() + " = '" + text + "'.");
} else if(exist){
log(LogLevel.DEVIATION_EXTRA_INFO, "Could not retrieve the current text of the element " + domElement.LogIdentification() + ". Are you sure it is the correct element?");
}
if(errorMessage != null) log(LogLevel.DEVIATION_EXTRA_INFO, "Error message: " + errorMessage);
saveScreenshot(element);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
return new ActionResult(false, guiElement, this);
}
/**
* Writes text to the given element after the element value has been cleared.
*
* @param guiElement The element to write to
* @param textToWrite The text to write
* @return Action result
*/
public ActionResult writeAfterClear(GuiElement guiElement, String textToWrite){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
try {
enterText(webElement, textToWrite, true);
return new ActionResult(true, guiElement, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not enter the text '" + textToWrite + "' to element " + domElement.LogIdentification() + ". ");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
return new ActionResult(false, guiElement, this);
}
/**
* Writes text and triggers a submit of it to an element
*
* @param guiElement the element
* @param text the text to send
* @return Action result
*/
public ActionResult submitText(GuiElement guiElement, String text){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = null;
try {
webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
enterText(webElement, text, false);
try{
webElement.submit();
log(LogLevel.EXECUTED, "Submitted text '" + text + "' to " + domElement.LogIdentification() + ".");
return new ActionResult(true, guiElement, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not submit the text entered to " + domElement.LogIdentification() + ".");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
} catch (TextEnteringError textEnteringError) {
log(LogLevel.EXECUTION_PROBLEM, "Could not enter '" + text + "' in " + domElement.LogIdentification() + ".");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
return new ActionResult(false, guiElement, this);
}
/**
* Saves a screenshot of the web browser content to the testCaseLog folder and writes a testCaseLog post about it.
* Used for provide debugging information when execution or verification problems (or errors) occur.
* @param relevantWebElementToMarkWithBorder relevantWebElementToMarkWithBorder
* @return Action result
*/
@SuppressWarnings("WeakerAccess")
public ActionResult saveScreenshot(WebElement relevantWebElementToMarkWithBorder){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
JavascriptExecutor js = null;
try {
js = (JavascriptExecutor) driver;
if (relevantWebElementToMarkWithBorder != null && driver instanceof JavascriptExecutor) {
js.executeScript("arguments[0].setAttribute('style', arguments[1]);", relevantWebElementToMarkWithBorder, "border: 5px solid yellow;");
}
} catch (Exception e){
log(LogLevel.DEBUG, "Could not highlight any element before screenshot. Error: " + e.getMessage());
}
String fileName = testCase.testName + TestRun.getFileCounter() + ".png";
String filePath = LogFolder.testRunLogFolder + fileName;
logger.debug( "Saving screenshot of web browser content to '" + filePath + "'." );
TestRun.increaseFileCounter();
byte[] fileImage;
try{
fileImage = ((TakesScreenshot)driver).getScreenshotAs(OutputType.BYTES);
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Could not take screenshot. Is driver ok? " + e.toString());
try{
if(relevantWebElementToMarkWithBorder != null && driver instanceof JavascriptExecutor && js != null) js.executeScript("arguments[0].setAttribute('style', arguments[1]);", relevantWebElementToMarkWithBorder, "");
}catch (Exception jsProblem){
log(LogLevel.DEBUG, "Could not reset element highlight frame. Error: " + jsProblem.getMessage());
}
return new ActionResult(false, null, this);
}
/*
try {
Path file = Paths.get(filePath);
File fileFolder = new File(filePath);
//noinspection ResultOfMethodCallIgnored
fileFolder.getParentFile().mkdirs();
if(fileImage != null){
Files.write(file, fileImage);
log(LogLevel.DEVIATION_EXTRA_INFO, "Saved screenshot as '" + filePath + "'.");
}
} catch (IOException e) {
log(LogLevel.EXECUTION_PROBLEM, "Could not save screenshot to '" + filePath + "'. " + e.toString());
//e.printStackTrace();
}
*/
if(fileImage != null){
SupportMethods.saveToFile(fileImage, filePath);
String htmlFilePath = fileName;
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.INFO, "Saved browser screenshot as '" + filePath + "'.",
"Saved browser screenshot as " + System.lineSeparator() +
" " + System.lineSeparator() +
" " + filePath + "" + System.lineSeparator() +
" " + System.lineSeparator() +
"
" + System.lineSeparator() +
" " + System.lineSeparator() +
" ![\"browser](\"")
" + System.lineSeparator() +
" ");
} else {
log(LogLevel.DEBUG, "Could not save screenshot to '" + filePath + "' since the image data was empty.");
return new ActionResult(false, null, this);
}
return new ActionResult(true, null, this);
}
/**
* Saving desktop of full desktop rather than just the web browser
* @return Action result
*/
public ActionResult saveDesktopScreenshot(){
try {
GenericInteractionMethods robotSwingInteractionMethods = new GenericInteractionMethods(testCase);
robotSwingInteractionMethods.takeScreenshot();
return new ActionResult(true, null, this);
} catch (Exception e){
testCase.log(LogLevel.DEBUG, "Could not take desktop screenshot: " + e.toString());
return new ActionResult(false, null, this);
}
}
/**
* Capture image of specific element to disk. Works by cropping a full screenshot to element.
*
* @param domElement The element to capture an image of.
* @param filePath The file name of the file to write the image to.
* @return Action result
*/
public ActionResult saveDomElementScreenshot(DomElement domElement, String filePath){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement == null){
log(LogLevel.EXECUTION_PROBLEM, "Could not identify " + domElement.LogIdentification() + " when trying to capture an image of it.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, domElement, this);
}
File screen = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
int ImageWidth = webElement.getSize().getWidth();
int ImageHeight = webElement.getSize().getHeight();
Point point = webElement.getLocation();
int xCoordinate = point.getX();
int yCoordinate = point.getY();
BufferedImage img;
try {
img = ImageIO.read(screen);
} catch (IOException e) {
log(LogLevel.EXECUTION_PROBLEM, "Could not read screenshot of full screenshot when trying to capture an image of " + domElement.LogIdentification() + ".");
return new ActionResult(false, domElement, this);
}
//cut Image using height, width and x y coordinates parameters.
BufferedImage destination = img.getSubimage(xCoordinate, yCoordinate, ImageWidth, ImageHeight);
try {
ImageIO.write(destination, "png", new File(filePath));
} catch (IOException e) {
log(LogLevel.EXECUTION_PROBLEM, "Could not write image of " + domElement.LogIdentification() + " to file '" + filePath + "'.");
return new ActionResult(false, domElement, this);
}
return new ActionResult(true, domElement, this);
}
/**
* Checks for existence of given element. Actually waits for existence of the element during the timeout time
*
* @param guiElement The element to check existence of
* @param timeOutInSeconds The time to wait for object to exist.
* @return Return true if element is found within timeout period
*/
public boolean existsWithTimeout(GuiElement guiElement, int timeOutInSeconds){
DomElement domElement = (DomElement) guiElement;
return getRuntimeElementWithTimeout(domElement, timeOutInSeconds) != null;
}
/**
* Checks for existence of given element.
*
* @param domElement The element to check existence of
* @return Return true if element is found
*/
public boolean exists(DomElement domElement){
return getRuntimeElementWithoutLogging(domElement) != null;
}
/**
* Changing the standard timeout value for waiting for objects in the GUI for most methods.
*
* @param standardTimeoutInSeconds The new value for standard timeout, in seconds.
* @return Action result
*/
public ActionResult setStandardTimeout(int standardTimeoutInSeconds){
log(LogLevel.DEBUG, "Resetting standard timeout from " + this.standardTimeoutInSeconds + " seconds to " + standardTimeoutInSeconds + " seconds.");
this.standardTimeoutInSeconds = standardTimeoutInSeconds;
return new ActionResult(true, null, this);
}
/**
* In some cases you might want to click on an element with a visible text without declaring the element itself. Then use this method.
*
* @param visibleText The visible text of the element to find
* @return Action result
*/
public ActionResult clickOnElementWithTheVisibleText(String visibleText){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
List potentialClickObjects = driver.findElements(By.xpath("//*[.='" + visibleText + "']"));
if(potentialClickObjects.size() == 0){
log(LogLevel.DEBUG, "No exact match for string '" + visibleText + "' found. Trying to find elements containing the text instead.");
potentialClickObjects = driver.findElements(By.xpath("//*[contains(text(), '" + visibleText + "')]"));
}
if(potentialClickObjects.size() == 1){
if(!potentialClickObjects.get(0).isDisplayed())
errorManagementProcedures("Attempting to click the element with the visible text '" + visibleText + "'. It exists but it is hidden from view.", potentialClickObjects.get(0));
if(!potentialClickObjects.get(0).isEnabled())
errorManagementProcedures("Attempting to click the element with the visible text '" + visibleText + "'. It exists but it is disabled.", potentialClickObjects.get(0));
try {
potentialClickObjects.get(0).click();
log(LogLevel.EXECUTED, "Clicked the element with visible text '" + visibleText + "'.");
return new ActionResult(true, new DomElement(potentialClickObjects.get(0)), this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not click the element with the visible text '" + visibleText + "'. Error message: " + e.getMessage());
return new ActionResult(false, new DomElement(potentialClickObjects.get(0)), this);
}
}else{
List trulyClickableElements = new ArrayList<>();
for(WebElement potentialClickObject : potentialClickObjects){
if(potentialClickObject.isEnabled()){
trulyClickableElements.add(potentialClickObject);
}
}
log(LogLevel.DEBUG, "Found " + potentialClickObjects.size() + " elements with the text '" + visibleText + "'. Out of those " + trulyClickableElements.size() + " was enabled and not hidden.");
if(trulyClickableElements.size() == 1){
try{
trulyClickableElements.get(0).click();
log(LogLevel.EXECUTED, "Clicked the element with the visible text '" + visibleText + "'.");
return new ActionResult(true, new DomElement(trulyClickableElements.get(0)), this);
}catch (Exception e){
errorManagementProcedures("Could not click element with visible text '" + visibleText + "'. Error message: " + e.getMessage(), trulyClickableElements.get(0));
return new ActionResult(false, new DomElement(trulyClickableElements.get(0)), this);
}
}else{
boolean clicked = false;
for(WebElement webElement : trulyClickableElements){
if(webElement.isDisplayed()){
clicked = true;
webElement.click();
log(LogLevel.EXECUTED, "Clicked the element with the visible text '" + visibleText + "'.");
return new ActionResult(true, new DomElement(webElement), this);
}
}
if(!clicked){
errorManagementProcedures("Attempted to click element with visible text '" + visibleText + "', but several elements was found with that text.", null);
}
}
}
return new ActionResult(false, null, this); //Should not be reachable
}
private class Waiter{
private final TestCase testCase;
private final LogLevel logLevel;
private final long startTime;
private int totalTimeInWaiting;
public Waiter(TestCase testCase, LogLevel logLevel){
this.logLevel = logLevel;
this.testCase = testCase;
this.startTime = System.currentTimeMillis();
}
public void wait(int milliseconds){
try {
Thread.sleep(milliseconds);
totalTimeInWaiting += milliseconds;
} catch (InterruptedException e) {
e.printStackTrace();
}
}
public void report(){
testCase.log(logLevel, "Waited a total of " + (System.currentTimeMillis() - startTime) + " milliseconds, with " + totalTimeInWaiting + " of those in the waiting mechanism.");
}
public int totalTimeSpentSoFar(){
return (int) (System.currentTimeMillis() - startTime);
}
}
/**
* Performing a click event on an element. Method keeps trying the given number of seconds.
*
* @param guiElement the GUI element to click
* @param timeoutInSeconds The number of seconds to wait and try to click
* @return Action result
*/
public ActionResult clickEvenIfDisabled(GuiElement guiElement, int timeoutInSeconds){
waitForElementToAppear(guiElement);
WebElement webElement = getRuntimeElementWithLogging((DomElement)guiElement);
if(webElement == null){
testCase.log(LogLevel.EXECUTION_PROBLEM, "Could not identify element " + ((DomElement)guiElement).LogIdentification() + " to click blindly at.");
return new ActionResult(false, guiElement, this);
}
Point topLeft = webElement.getLocation();
Point clickPoint = new Point (topLeft.getX() + webElement.getSize().width/2, topLeft.getY() + webElement.getSize().height/2);
Robot r;
try {
r = new Robot();
r.mouseMove(clickPoint.getX(),clickPoint.getY());
r.mousePress( InputEvent.BUTTON1_MASK );
r.mouseRelease( InputEvent.BUTTON1_MASK );
testCase.log(LogLevel.EXECUTED, "Clicked blindly at element position for element " + ((DomElement)guiElement).LogIdentification() + " (at point '" + clickPoint.x + "x" + clickPoint.y + "').");
return new ActionResult(true, guiElement, this);
} catch (AWTException e) {
testCase.log(LogLevel.EXECUTION_PROBLEM, "Could not click blindly at element " + ((DomElement)guiElement).LogIdentification() + " at point '" + clickPoint.x + "x" + clickPoint.y + "'. Error: " + e.toString());
return new ActionResult(false, guiElement, this);
}
}
/**
* Performing a click event on an element. Method keeps trying the set standard timeout number of seconds.
*
* @param guiElement the GUI element to click
* @return Action result
*/
public ActionResult click(GuiElement guiElement){
return new ActionResult(click(guiElement, standardTimeoutInSeconds).wasSuccess, guiElement, this);
}
/**
* Performing a click event on an element. Method keeps trying the given number of seconds.
*
* @param guiElement the GUI element to click
* @param timeoutInSeconds The number of seconds to wait and try to click
* @return Action result
*/
public ActionResult click(GuiElement guiElement, int timeoutInSeconds){
Set errorMessages = new HashSet<>();
DomElement element = (DomElement) guiElement;
long startTime = System.currentTimeMillis();
boolean hasBeenEnabled = false;
boolean hasBeenDisplayed = false;
boolean hasBeenIdentified = false;
boolean clicked = false;
WebElement webElement = null;
log(LogLevel.DEBUG, "Attempting to click on " + element.LogIdentification() + ".");
while (!clicked && (System.currentTimeMillis() - startTime) <= timeoutInSeconds *1000){
webElement = getRuntimeElementWithoutLogging(element);
if(webElement == null || !webElement.isEnabled() || !webElement.isDisplayed()){
try { Thread.sleep(50); } catch (InterruptedException ignored) { }
continue;
}
webElement = getRuntimeElementWithLogging(element);
if(webElement == null) break;
if(webElement.isEnabled())
hasBeenEnabled = true;
if(webElement.isDisplayed())
hasBeenDisplayed = true;
try{
//noinspection ConstantConditions
webElement.click();
clicked = true;
} catch (Exception e){
errorMessages.add(e.getMessage());
try { Thread.sleep(50); } catch (InterruptedException e2) { errorMessages.add(e2.getMessage()); }
}
}
if(clicked){
log(LogLevel.EXECUTED, "Clicked the " + element.LogIdentification() + " element after " + String.valueOf(System.currentTimeMillis() - startTime) + " milliseconds.");
return new ActionResult(true, guiElement, this);
} else if(errorMessages.size() > 0){
for(String errorMessage : errorMessages){
if(errorMessages.contains("Other element would receive the click")) {
log(LogLevel.EXECUTION_PROBLEM, "It seems something is blocking the possibility to click on " + element.LogIdentification() + ". It could for example be a popup overlaying the element?");
errorManagementProcedures("Could not click element " + element.LogIdentification() + ".", webElement);
return new ActionResult(false, guiElement, this);
}
}
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.FRAMEWORK_ERROR,
"Could not click on element " + element.LogIdentification() +
". Error(s):" + System.lineSeparator() + String.join(System.lineSeparator(), errorMessages),
"Could not click och element " + element.LogIdentification() + ".
Error:
" +
String.join("
* ", errorMessages));
errorManagementProcedures("Could not click element " + element.LogIdentification() + ".", webElement);
} else {
if(webElement == null){
errorManagementProcedures("Could not identify element " + element.LogIdentification() + " in the GUI.", null);
}
//noinspection ConstantConditions
if(!hasBeenEnabled || !hasBeenDisplayed){
errorManagementProcedures("Element " + element.LogIdentification() + " was identified. " +
"It is" + String.valueOf(hasBeenEnabled).toLowerCase().replace("true", "").replace("false", " not") + " enabled. " +
"It is" + String.valueOf(hasBeenDisplayed).toLowerCase().replace("true", "").replace("false", " not") + " displayed. " +
"Seems unnatural to click it. If you still want this element to be clicked the clickEvenIfDisabled() method instead.", webElement);
}
errorManagementProcedures("Could not successfully click on the " + element.LogIdentification() + " element.", webElement);
}
return new ActionResult(false, guiElement, this);
}
private boolean elementBecomeDisplayedWithinTimeout(WebElement webelement){
if(!webelement.isDisplayed()){
Waiter wait = new Waiter(testCase, LogLevel.DEBUG);
while (!webelement.isDisplayed() && wait.totalTimeSpentSoFar() < standardTimeoutInSeconds *1000){
wait.wait(50);
}
wait.report();
}
return webelement.isDisplayed();
}
private boolean elementBecomeEnabledWithinTimeout(WebElement webelement){
if(!webelement.isEnabled()){
Waiter wait = new Waiter(testCase, LogLevel.DEBUG);
while (!webelement.isEnabled() && wait.totalTimeSpentSoFar() < standardTimeoutInSeconds *1000){
wait.wait(50);
}
wait.report();
}
return webelement.isEnabled();
}
/**
* Closes the web browser.
* @return Action result
*/
public ActionResult closeBrowser(){
try{
closeBrowserDriver();
log(LogLevel.INFO, "Closing browser.");
return new ActionResult(true, null, this);
}catch (BrowserClosingError browserClosingError) {
log(LogLevel.EXECUTION_PROBLEM, "Could not close the browser.");
return new ActionResult(false, null, this);
}
}
/**
* Makes sure the driver is closed
* @return Action result
*/
public ActionResult makeSureDriverIsClosed(){
try{
closeBrowserDriver();
return new ActionResult(true, null, this);
}catch (Exception e) {
log(LogLevel.DEBUG, "Could not close browser. Was probably already closed.");
return new ActionResult(false, null, this);
}
}
/**
* Checks if the given object exist in the HTML. Compare with verifyObjectIsDisplayed, that also checks if the element is visible in the GUI.
*
* @param guiElement The GUI element to find
* @deprecated Use exists() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementExistence(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
if(getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds) == null){
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was expected to be present but could not be identified.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else {
log(LogLevel.VERIFICATION_PASSED, "Existence of object " + domElement.LogIdentification() + " verified.");
}
}
/**
* Checks if the given object exist in the HTML. Compare with verifyObjectIsDisplayed, that also checks if the element is visible in the GUI.
*
* @param guiElement The GUI element to find
* @deprecated Use exists() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
@SuppressWarnings("All")
public void verifyObjectExistence(GuiElement guiElement){
verifyElementExistence(guiElement);
}
/**
* Checks if the given object is not displayed in the HTML. Compare with verifyObjectDoesNotExist, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @deprecated Use isNotDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyObjectIsNotDisplayed(GuiElement guiElement){
verifyElementIsNotDisplayed(guiElement);
}
/**
* Checks if the given object is not displayed in the HTML. Compare with verifyObjectDoesNotExist, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @deprecated Use isNotDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementIsNotDisplayed(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
long startTime = System.currentTimeMillis();
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
boolean disappeared = (webElement == null);
while (!disappeared && System.currentTimeMillis() - startTime < standardTimeoutInSeconds * 1000){
wait(100);
webElement = getRuntimeElementWithoutLogging(domElement);
disappeared = (webElement == null || !webElement.isDisplayed());
}
if(webElement == null){
log(LogLevel.DEBUG, "Object " + domElement.LogIdentification() + " could not be identified in the html.");
log(LogLevel.VERIFICATION_PASSED, "Object " + domElement.LogIdentification() + " verified to not be present.");
} else if(!webElement.isDisplayed()) {
log(LogLevel.DEBUG, "Object " + domElement.LogIdentification() + " could be identified in the html, but it is suppressed from being displayed in the GUI.");
log(LogLevel.VERIFICATION_PASSED, "Object " + domElement.LogIdentification() + " verified to not displayed.");
}else {
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was identified as displayed although expected to not be displayed.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks if the given object is not displayed in the HTML. Compare with verifyObjectDoesNotExist, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @param timeoutInSeconds The time to wait for object disappearance.
* @deprecated Use isNotDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyObjectIsNotDisplayedWithTimeout(GuiElement guiElement, int timeoutInSeconds){
verifyElementIsNotDisplayedWithTimeout(guiElement, timeoutInSeconds);
}
/**
* Checks if the given object is not displayed in the HTML. Compare with verifyObjectDoesNotExist, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @param timeoutInSeconds The time to wait for object disappearance.
* @deprecated Use isNotDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementIsNotDisplayedWithTimeout(GuiElement guiElement, int timeoutInSeconds){
DomElement domElement = (DomElement) guiElement;
long startTime = System.currentTimeMillis();
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
boolean disappeared = (webElement == null);
while (!disappeared && System.currentTimeMillis() - startTime < timeoutInSeconds * 1000){
wait(100);
webElement = getRuntimeElementWithoutLogging(domElement);
disappeared = (webElement == null || !webElement.isDisplayed());
}
if(webElement == null){
log(LogLevel.DEBUG, "Object " + domElement.LogIdentification() + " could not be identified in the html.");
log(LogLevel.VERIFICATION_PASSED, "Object " + domElement.LogIdentification() + " verified to not be present.");
} else if(!webElement.isDisplayed()) {
log(LogLevel.DEBUG, "Object " + domElement.LogIdentification() + " could be identified in the html, but it is suppressed from being displayed in the GUI.");
log(LogLevel.VERIFICATION_PASSED, "Object " + domElement.LogIdentification() + " verified to not displayed.");
}else {
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was identified as displayed although expected to not be displayed.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks if the given element is displayed in the GUI.
*
* @param guiElement The element to check for
* @return Return true if the element is displayed
*/
public boolean isDisplayed(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
boolean displayed = (webElement == null || !webElement.isDisplayed());
log(LogLevel.DEBUG, "Checking if " + domElement.LogIdentification() + " is displayed. Returning " + displayed + ".");
return displayed;
}
/**
* Checks if the given element is displayed in the GUI. Check performed only once, but wait for element to appear.
*
* @param guiElement The element to check for
* @return Return true if the element is not displayed
*/
public boolean isNotDisplayed(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
boolean notDisplayed = (webElement == null || !webElement.isDisplayed());
log(LogLevel.DEBUG, "Checking if " + domElement.LogIdentification() + " is not displayed. Returning " + notDisplayed + ".");
return notDisplayed;
}
/**
* Checks if the given element is displayed in the GUI. Checks only once, but right away. If element is not present directly it continues.
*
* @param guiElement The element to check for
* @return Return true if the element is not displayed
*/
public boolean isNotDisplayedExactlyNow(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
boolean notDisplayed = (webElement == null || !webElement.isDisplayed());
log(LogLevel.DEBUG, "Checking if " + domElement.LogIdentification() + " is not displayed. Returning " + notDisplayed + ".");
return notDisplayed;
}
/**
* Checks if the given element is displayed in the GUI. Checks repeatedly for element to disappear from the GUI of the system under test the whole length of the timeout.
*
* @param guiElement The element to check for
* @param timeoutInSeconds Seconds to wait for element being disappeared
* @return Return true if the element is not displayed
*/
public boolean isNotDisplayedWithinTimeout(GuiElement guiElement, int timeoutInSeconds) {
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
if (webElement == null) return true;
while ((webElement != null && webElement.isDisplayed()) && (System.currentTimeMillis() - startTime) < timeoutInSeconds * 1000) {
webElement = getRuntimeElementWithoutLogging(domElement);
}
return webElement == null || !webElement.isDisplayed();
}
/**
* Checks if the given object is displayed in the HTML. Compare with verifyObjectExistence, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @deprecated Use isDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyObjectIsDisplayed(GuiElement guiElement){
verifyElementIsDisplayed(guiElement);
}
/**
* Checks if the given object is displayed in the HTML. Compare with {@link #verifyObjectExistence(GuiElement)}, that checks if the element exist in the html.
*
* @param guiElement The GUI element to find
* @deprecated Use isDisplayed() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementIsDisplayed(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement == null){
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was expected to be displayed but could not be identified at all.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else if(!webElement.isDisplayed()) {
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " is present, but the display of the object is suppressed.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}else {
log(LogLevel.VERIFICATION_PASSED, "Existence of object " + domElement.LogIdentification() + " verified.");
}
}
/**
* Checks if the given object exist in the GUI
*
* @param guiElement The GUI element to find
* @deprecated Use doesNotExist() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyObjectDoesNotExist(GuiElement guiElement){
verifyElementDoesNotExist(guiElement);
}
/**
* Checks if the given object exist in the GUI
*
* @param guiElement The GUI element to find
* @deprecated Use doesNotExist() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementDoesNotExist(GuiElement guiElement){
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement != null){
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was expected to not be present but was able to be identified.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else {
log(LogLevel.VERIFICATION_PASSED, "Verified that the object " + domElement.LogIdentification() + " was not present.");
}
}
/**
* Checks if the given object exist in the GUI, within a timeout.
*
* @param guiElement The GUI element to find.
* @param timeoutInSeconds The timeout to wait for object disappearance.
* @deprecated Use doesNotExist() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyObjectDoesNotExistWithTimeout(GuiElement guiElement, int timeoutInSeconds){
verifyElementDoesNotExistWithTimeout(guiElement, timeoutInSeconds);
}
/**
* Checks if the given object exist in the GUI, within a timeout.
*
* @param guiElement The GUI element to find.
* @param timeoutInSeconds The timeout to wait for object disappearance.
* @deprecated Use method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementDoesNotExistWithTimeout(GuiElement guiElement, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, timeoutInSeconds);
if(webElement != null){
log(LogLevel.VERIFICATION_FAILED, "Object " + domElement.LogIdentification() + " was expected to not be present but was able to be identified.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else {
log(LogLevel.VERIFICATION_PASSED, "Verified that the object " + domElement.LogIdentification() + " was not present.");
}
}
/**
* Checks if an element exist in the browser within a given timeout
*
* @param guiElement The element to verify
* @param timeoutInSeconds The number of seconds to keep retrying before calling it a failure
* @deprecated Use method exists() under {@link #verifiyElement(DomElement)} instead (and set the timeout).
*/
@Deprecated
public void verifyObjectExistenceWithTimeout(GuiElement guiElement, int timeoutInSeconds){
verifyElementExistenceWithTimeout(guiElement, timeoutInSeconds);
}
/**
* Checks if an element exist in the browser within a given timeout
*
* @param guiElement The element to verify
* @param timeoutInSeconds The number of seconds to keep retrying before calling it a failure
* @deprecated Use exists() method under {@link #verifiyElement(DomElement)} instead.
*/
@Deprecated
public void verifyElementExistenceWithTimeout(GuiElement guiElement, int timeoutInSeconds){
DomElement domElement = (DomElement) guiElement;
if(getRuntimeElementWithTimeout(domElement, timeoutInSeconds) == null){
log(LogLevel.VERIFICATION_PROBLEM, "Object " + domElement.LogIdentification() + " was expected to be present but was not identified.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
} else {
log(LogLevel.VERIFICATION_PASSED, "Existence of object " + domElement.LogIdentification() + " verified.");
}
}
/**
* Checks if the element is displayed directly.
*
* @param guiElement The element to check for
* @return Return true if the element can be found and is displayed.
*/
public boolean isDisplayedWithoutTimeout(GuiElement guiElement){
DomElement domElement = (DomElement)guiElement;
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
return webElement != null && webElement.isDisplayed();
}
/**
* Checks if specified text exist in the browser page
*
* @param text test string to find
* @deprecated Use method under {@link #verify()} instead.
*/
@Deprecated
public void verifyTextExistOnCurrentPage(String text){
DomElement domElement = new DomElement("//*[contains(text(),'" + text + "')]", DomElement.IdentificationType.BY_X_PATH);
//List list = driver.findElements(By.xpath("//*[contains(text(),'" + text + "')]"));
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement != null){
log(LogLevel.VERIFICATION_PASSED, "The text '" + text + "' could be found on the current page.");
}else {
log(LogLevel.VERIFICATION_FAILED, "The text '" + text + "' could not be found on the current page.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks if specified text exist in the current driver page source
*
* @param text test string to find
* @param timeoutInSeconds The time to wait
* @return Returns true if the text can be identified within the time given.
* @deprecated Use method under {@link #verify()} instead.
*/
@Deprecated
public boolean textExistInPageSourceOfCurrentPageWithinTimeout(String text, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
while (System.currentTimeMillis() - startTime <= timeoutInSeconds * 1000){
if(driver.getPageSource().contains(text)){
log(LogLevel.DEBUG, "Checked for text '" + text + "' to exist in current page source within "+ timeoutInSeconds + " seconds, and it was identified after " + (System.currentTimeMillis() - startTime) + " milliseconds.");
return true;
}
wait(50);
}
log(LogLevel.DEBUG, "Checked for text '" + text + "' to exist in page source within "+ timeoutInSeconds + " seconds. It could not be identified.");
return false;
}
/**
* Checks if specified text exist (maybe not displayed) on the current browser page
*
* @param text test string to find
* @param timeoutInSeconds The time to wait
* @return Returns true if the text can be identified within the given timeout
*/
public boolean textExistOnCurrentPageWithinTimeout(String text, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = new DomElement("//*[contains(text(),'" + text + "')]", DomElement.IdentificationType.BY_X_PATH);
while (System.currentTimeMillis() - startTime <= timeoutInSeconds * 1000){
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
if(webElement != null){
log(LogLevel.DEBUG, "Checked for text '" + text + "' to exist on current page within "+ timeoutInSeconds + " seconds, and it was identified after " + (System.currentTimeMillis() - startTime) + " milliseconds. No check for if the element is displayed. There are other methods for that.");
return true;
}
wait(50);
}
log(LogLevel.DEBUG, "Checked for text '" + text + "' to exist on page within "+ timeoutInSeconds + " seconds. It could not be identified.");
return false;
}
/**
* Checks if specified text is displayed on the current browser page
*
* @param text test string to find
* @param timeoutInSeconds The time to wait
* @return Returns true if the text can be identified within the given time.
*/
public boolean textIsDisplayedOnCurrentPageWithinTimeout(String text, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
DomElement domElement = new DomElement("//*[contains(text(),'" + text + "')]", DomElement.IdentificationType.BY_X_PATH);
while (System.currentTimeMillis() - startTime <= timeoutInSeconds * 1000){
WebElement webElement = getRuntimeElementWithoutLogging(domElement);
if(webElement != null && webElement.isDisplayed()){
log(LogLevel.DEBUG, "Checked for text '" + text + "' to become displayed on current page within "+ timeoutInSeconds + " seconds, and it was identified after " + (System.currentTimeMillis() - startTime) + " milliseconds.");
return true;
}
wait(50);
}
log(LogLevel.DEBUG, "Checked for text '" + text + "' to become displayed on page within "+ timeoutInSeconds + " seconds. It could not be identified.");
return false;
}
/**
* Checks if specified regular expression text pattern exist in the browser page source code
*
* @param textAsRegexPattern test string to find
* @deprecated Use method under {@link #verify()} instead
*/
@Deprecated
public void verifyTextAsRegexPatternExistInPageSource(String textAsRegexPattern){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String pageSource = driver.getPageSource();
if(SupportMethods.isRegexMatch(pageSource, textAsRegexPattern)){
log(LogLevel.VERIFICATION_PASSED, "The regular expression pattern '" + textAsRegexPattern + "' could be found on the current page.");
}else {
log(LogLevel.VERIFICATION_FAILED, "The regular expression pattern '" + textAsRegexPattern + "' could not be found on the current page.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks the web browser page title against expected result, written as a regular expression
*
* @param expectedTitleAsRegexPattern Expected regular expression pattern to match the current title of the web page
* @deprecated Use {@link #verify()}.title() instead.
*/
@SuppressWarnings("unused")
@Deprecated
public void verifyPageTitleAsRegex(String expectedTitleAsRegexPattern){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTitle = driver.getTitle();
if(SupportMethods.isRegexMatch(currentTitle, expectedTitleAsRegexPattern)){
log(LogLevel.VERIFICATION_PASSED, "The current page title was '" + currentTitle + "', and that title matches the given regex pattern '" + expectedTitleAsRegexPattern + "'.");
}else {
log(LogLevel.VERIFICATION_FAILED, "The current page title was expected to match the regex pattern '" + expectedTitleAsRegexPattern+ "' but was '" + currentTitle + "'.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks the web browser page title against expected result
*
* @param expectedTitle Expected current title of the web page
* @deprecated Use {@link #verify()}.title() instead.
*/
@SuppressWarnings("unused")
@Deprecated
public void verifyPageTitle(String expectedTitle){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTitle = driver.getTitle();
if(currentTitle.equals(expectedTitle)){
log(LogLevel.VERIFICATION_PASSED, "The current page title was '" + expectedTitle + "' as expected.");
}else {
log(LogLevel.VERIFICATION_FAILED, "The current page title was expected to be '" + expectedTitle + "' but was '" + currentTitle + "'.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks that the web browser page title matches the expected title pattern within specified timeout
*
* @param expectedTitleAsRegexPattern Expected title pattern in a regular expression format, for the web page
* @deprecated Use {@link #verify()}.title() instead.
* @param timeoutInSeconds Timeout in seconds
*/
@SuppressWarnings("SameParameterValue")
@Deprecated
public void verifyPageTitleAsRegexWithTimeout(String expectedTitleAsRegexPattern, int timeoutInSeconds){
double startTime = System.currentTimeMillis();
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTitle = driver.getTitle();
long retryPeriodInMS = 50;
while(!SupportMethods.isRegexMatch(currentTitle, expectedTitleAsRegexPattern) && System.currentTimeMillis() - startTime < timeoutInSeconds *1000){
try {
Thread.sleep(retryPeriodInMS);
} catch (InterruptedException e) {
log(LogLevel.FRAMEWORK_ERROR, "Could not put thread to sleep.");
e.printStackTrace();
}
currentTitle = driver.getTitle();
}
if(SupportMethods.isRegexMatch(currentTitle, expectedTitleAsRegexPattern)){
log(LogLevel.VERIFICATION_PASSED, "The current page title was '" + currentTitle + "' and that title is found to be a match for given regular expression pattern '" + expectedTitleAsRegexPattern + "' (found after " + (System.currentTimeMillis() - startTime) + " milliseconds).");
}else {
log(LogLevel.VERIFICATION_FAILED, "The current page title was expected to match the regular expression pattern '" + expectedTitleAsRegexPattern + "' but was '" + currentTitle + "' even after " + timeoutInSeconds + " milliseconds.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks that the web browser page title is (or become) the expected title within specified timeout
*
* @param expectedTitle Expected title of the web page
* @deprecated Use {@link #verify()}.title() instead.
* @param timeoutInSeconds Timeout in seconds
*/
@SuppressWarnings("SameParameterValue")
@Deprecated
public void verifyPageTitleWithTimeout(String expectedTitle, int timeoutInSeconds){
double startTime = System.currentTimeMillis();
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTitle = driver.getTitle();
long retryPeriodInMS = 50;
while(!currentTitle.equals(expectedTitle) && System.currentTimeMillis() - startTime < timeoutInSeconds *1000){
try {
Thread.sleep(retryPeriodInMS);
} catch (InterruptedException e) {
log(LogLevel.FRAMEWORK_ERROR, "Could not put thread to sleep.");
e.printStackTrace();
}
currentTitle = driver.getTitle();
}
if(currentTitle.equals(expectedTitle)){
log(LogLevel.VERIFICATION_PASSED, "The current page title was '" + expectedTitle + "' as expected (found after " + (System.currentTimeMillis() - startTime) + " milliseconds).");
}else {
log(LogLevel.VERIFICATION_FAILED, "The current page title was expected to be '" + expectedTitle + "' but was '" + currentTitle + "' even after " + (System.currentTimeMillis() - startTime) + " milliseconds.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Verifies that the current text of the given element correspond to the expected text.
*
* @param guiElement The element to check the text of
* @param expectedText The expected text to find
* @deprecated Use method under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyElementText(GuiElement guiElement, String expectedText){
boolean verifiedOk = false;
String currentText = "";
long startTime = System.currentTimeMillis();
while(!verifiedOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
currentText = getTextWithoutLogging(guiElement);
if(currentText != null && currentText.equals(expectedText)){
verifiedOk = true;
}
}
if(verifiedOk){
log(LogLevel.VERIFICATION_PASSED, "Element " + ((DomElement)guiElement).LogIdentification() + " found to have the text '" + expectedText + "' as expected.");
} else {
if(exists(guiElement)){
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to have the text '" + expectedText + "', but it actually was '" + currentText + "'.");
} else {
DomElement domElement = (DomElement) guiElement;
log(LogLevel.VERIFICATION_PROBLEM, "Could not find element " + domElement.LogIdentification() + " when attempting to verify the text '" + expectedText + "'.");
}
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Verifies that the current text of the given element correspond to the expected text.
*
* @param guiElement The element to check the text of
* @param expectedText The expected text to find
* @deprecated Use method textContains() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyElementTextContainsText(GuiElement guiElement, String expectedText){
boolean verifiedOk = false;
String currentText = "";
long startTime = System.currentTimeMillis();
while(!verifiedOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
currentText = getTextWithoutLogging(guiElement);
if(currentText != null && currentText.contains(expectedText)){
verifiedOk = true;
}
}
if(verifiedOk){
log(LogLevel.VERIFICATION_PASSED, "Element " + ((DomElement)guiElement).LogIdentification() + " found to have the text '" + expectedText + "' as expected.");
} else {
if(exists(guiElement)){
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to have the text '" + expectedText + "', but it actually was '" + currentText + "'.");
} else {
DomElement domElement = (DomElement) guiElement;
log(LogLevel.VERIFICATION_PROBLEM, "Could not find element " + domElement.LogIdentification() + " when attempting to verify the text '" + expectedText + "'.");
}
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Verifies that the current text of the given element correspond to the expected text.
*
* @param guiElement The element to check the text of
* @param expectedTextAsRegexPattern The expected text to find
* @deprecated Use method text() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyElementTextWithRegexPattern(GuiElement guiElement, String expectedTextAsRegexPattern){
String currentText = "";
long startTime = System.currentTimeMillis();
boolean verifiedOk = false;
while (!verifiedOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
currentText = getTextWithoutLogging(guiElement);
if(SupportMethods.isRegexMatch(currentText, expectedTextAsRegexPattern)){
verifiedOk = true;
}
}
if(SupportMethods.isRegexMatch(currentText, expectedTextAsRegexPattern)){
log(LogLevel.VERIFICATION_PASSED, "Element " + ((DomElement)guiElement).LogIdentification() + " found to be '" + currentText + ". It is a match with the regular expression pattern '" + expectedTextAsRegexPattern + "'.");
} else {
if(exists(guiElement)){
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to have match the regular expression pattern '" + expectedTextAsRegexPattern+ "', but it actually was '" + currentText + "'. Not a match.");
} else {
DomElement domElement = (DomElement) guiElement;
log(LogLevel.VERIFICATION_PROBLEM, "Could not find element " + domElement.LogIdentification() + " when attempting to verify the text from regular expression pattern '" + expectedTextAsRegexPattern + "'.");
}
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Clicks the row matching the given strings in a table
*
* @param guiTableElement The table element in the gui
* @param textsToFindOnRow the text strings to find
* @return Action result
*/
public ActionResult pickTableRow(GuiElement guiTableElement, String[] textsToFindOnRow){
boolean doneOk = false;
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement)guiTableElement;
WebElement webElement = null;
try{
while (!doneOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds *1000){
webElement = getRuntimeElementWithoutLogging(domElement);
List partialMatches = new ArrayList<>();
boolean allValuesFoundInRow = false;
List rows = webElement.findElements(By.xpath(".//tr"));
for (WebElement row : rows)
{
ArrayList rowStrings = new ArrayList<>();
boolean someValueFoundInRow = false;
boolean valueMissingOnRow = false;
List cells = row.findElements(By.xpath("(.//td | .//th)"));
for(String textToFindOnRow : textsToFindOnRow)
{
boolean thisValueFoundOnRow = false;
for(WebElement cell : cells)
{
rowStrings.add(cell.getText());
if (cell.getText().contains(textToFindOnRow))
{
thisValueFoundOnRow = true;
someValueFoundInRow = true;
}
}
if (!thisValueFoundOnRow)
{
valueMissingOnRow = true;
break;
}
}
//log(LogLevel.DEBUG, String.join(", ", rowStrings) + " > Match: " + String.valueOf(!valueMissingOnRow));
if (!valueMissingOnRow)
{
allValuesFoundInRow = true;
row.click();
break;
} else if (someValueFoundInRow){
partialMatches.add("'" + String.join("', '", rowStrings) + "'");
}
}
if(!allValuesFoundInRow){
log(LogLevel.EXECUTION_PROBLEM, "Could not find row matching '" + String.join("', '", textsToFindOnRow) + "' in " + domElement.LogIdentification() + ".");
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.DEVIATION_EXTRA_INFO,
"Rows with partial matches for '" + String.join("', '", textsToFindOnRow) + "':" + System.lineSeparator() + "[" + String.join("]" + System.lineSeparator() + "[", partialMatches) + "]",
"Rows with partial matches for '" + String.join("', '", textsToFindOnRow) + "':
" + String.join(" ", partialMatches) + "
");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
haltFurtherExecution();
} else {
doneOk = true;
log(LogLevel.EXECUTED, "Clicked the row with values '" + String.join("', '", textsToFindOnRow) + "' in table " + domElement.LogIdentification() + ".");
}
}
} catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not pick table row. Error: " + e.toString());
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
haltFurtherExecution();
}
return new ActionResult(true, guiTableElement, this);
}
/**
* Executes the provided javascript on page
* @param script Script to run
* @return Returns anything returned by the script, un-casted.
*/
public Object executeJavascript(String script){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
Object returnObject = null;
if (driver instanceof JavascriptExecutor) {
try {
JavascriptExecutor javascriptExecutor = ((JavascriptExecutor)driver);
returnObject = javascriptExecutor.executeScript(script);
String returnObjectAsString = null;
if(returnObject != null){
try{
returnObjectAsString = returnObject.toString();
}catch (Exception ignored){}
}
String logMessageText = "Executed the javascript '" + script + "'.";
String logMessageHtml = "Executed the javascript:" + StringManagement.htmlContentToDisplayableHtmlCode(script);
if(returnObjectAsString != null){
logMessageText += " Returned '" + returnObjectAsString + "'.";
logMessageHtml += "
Returned:
" + StringManagement.htmlContentToDisplayableHtmlCode(returnObjectAsString);
}
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTED, logMessageText, logMessageHtml);
}catch (Exception e){
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTION_PROBLEM,
"Errors while trying to run the javascript:" + SupportMethods.LF + script + SupportMethods.LF + "Error:" + SupportMethods.LF + e.toString(),
"Errors while trying to run the javascript:" + SupportMethods.LF + StringManagement.htmlContentToDisplayableHtmlCode(script) + SupportMethods.LF + "Error:" + SupportMethods.LF + e.toString());
saveHtmlContentOfCurrentPage();
}
} else {
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTION_PROBLEM,
"Attempted executing javascript, but browser type driver does not seem to be compatible. Javascript that did not run below:" + SupportMethods.LF + script,
"Attempted executing javascript, but browser type driver does not seem to be compatible. Javascript that did not run below:" + SupportMethods.LF + StringManagement.htmlContentToDisplayableHtmlCode(script));
saveHtmlContentOfCurrentPage();
}
return returnObject;
}
/**
* Check the page source for current page with the W3C Validator API for HTML consistency.
*
* @param verbose If set to true warning messages will be logged, as well as extra debugging information from the W3C validation service. If set to false only errors will be logged.
* @deprecated Use method under {@link #verify()} instead
* @return Action result
*/
@Deprecated
public ActionResult verifyCurrentPageSourceWithW3validator(boolean verbose){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
W3CHtmlValidatorService w3CHtmlValidatorService = new W3CHtmlValidatorService(testCase, driver.getPageSource(), verbose);
w3CHtmlValidatorService.verifyPageSourceWithW3validator();
if(w3CHtmlValidatorService.failed()) saveHtmlContentOfCurrentPage();
return new ActionResult(!w3CHtmlValidatorService.failed(), null, this);
}
/**
* Verifies that an element is enabled for interaction (displayed and enabled).
*
* @param guiElement The element to assess.
* @deprecated Use method isEnabled() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyIsEnabled(GuiElement guiElement){
if(isEnabled(guiElement)){
log(LogLevel.VERIFICATION_PASSED, "Element " + ((DomElement)guiElement).LogIdentification() + " found to be enabled as expected.");
}else {
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement) guiElement;
boolean enabled = false;
WebElement webElement = null;
while (!enabled && System.currentTimeMillis() - startTime < standardTimeoutInSeconds * 1000){
webElement = getRuntimeElementWithoutLogging(domElement);
if(webElement.isEnabled()) enabled = true;
}
if(webElement == null) {
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to be enabled, but could not be identified.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return;
}
if(!webElement.isDisplayed() && !enabled){
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to be enabled, but it's neither displayed, nor enabled.");
}else if(!enabled){
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to be enabled. It seem to be enabled, but not displayed.");
}else{
log(LogLevel.VERIFICATION_FAILED, "Element " + ((DomElement)guiElement).LogIdentification() + " was expected to be enabled. It's enabled, but not displayed and cannot be used for interaction.");
}
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Changes what browser tab is currently activated.
*
* @param tabNameAsRegexForTabToSwitchTo The name of the tab to switch to.
* @return Action result
*/
public ActionResult switchBrowserTabWithTabNameGivenAsRegexPattern(String tabNameAsRegexForTabToSwitchTo){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTabId;
String initialTitle;
try
{
initialTitle = driver.getTitle();
currentTabId = driver.getWindowHandle();
log(LogLevel.DEBUG, "Switching browser tabs, trying to switch to a tab with title matching the regular expression pattern '" + tabNameAsRegexForTabToSwitchTo + "'. Initial browser tab title = '" + initialTitle + "' (tab id='" + currentTabId + "').");
}
catch (Exception e)
{
log(LogLevel.EXECUTION_PROBLEM, "Could not switch browser tab. Browser seem to be closed.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, null, this);
}
for (String tabId : driver.getWindowHandles())
{
if ( !currentTabId.equals(tabId) )
{
driver.switchTo().window(tabId);
String tabName = driver.getTitle();
log(LogLevel.DEBUG, "Identified browser tab with tab title = '" + tabName + " (id='" + tabId + "').");
if(SupportMethods.isRegexMatch(driver.getTitle(), tabNameAsRegexForTabToSwitchTo) ){
return new ActionResult(true, null, this);
}
}
}
log(LogLevel.EXECUTED, "Switched browser tab from tab '" + initialTitle + "' to tab with title '" + driver.getTitle() + "'. Matched with regular expression pattern '" + tabNameAsRegexForTabToSwitchTo + "'.");
return new ActionResult(true, null, this);
}
/**
* Changes what browser tab is currently activated.
*
* @param tabNameForTabToSwitchTo The name of the tab to switch to.
* @return Action result
*/
public ActionResult switchBrowserTab(String tabNameForTabToSwitchTo){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String currentTabId;
String initialTitle;
try
{
initialTitle = driver.getTitle();
currentTabId = driver.getWindowHandle();
log(LogLevel.DEBUG, "Switching browser tabs, trying to switch to tab with title '" + tabNameForTabToSwitchTo + "'. Initial browser tab title = '" + initialTitle + "' (tab id='" + currentTabId + "').");
}
catch (Exception e)
{
log(LogLevel.EXECUTION_PROBLEM, "Could not switch browser tab. Browser seem to be closed.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, null, this);
}
List actualTabs = new ArrayList<>();
actualTabs.add(initialTitle);
for (String tabId : driver.getWindowHandles())
{
if ( currentTabId.equals(tabId) ) continue;
driver.switchTo().window(tabId);
String tabName = driver.getTitle();
log(LogLevel.DEBUG, "Identified browser tab with tab title = '" + tabName + " (id='" + tabId + "').");
String currentTitle = driver.getTitle();
actualTabs.add(currentTitle);
if(currentTitle != null && currentTitle.equals(tabNameForTabToSwitchTo) ){
log(LogLevel.EXECUTED, "Switched browser tab from tab '" + initialTitle + "' to tab with title '" + driver.getTitle() + "'.");
return new ActionResult(true, null, this);
}
}
log(LogLevel.EXECUTION_PROBLEM, "Could not switch browser tab from tab '" + initialTitle + "' to tab with title '" + tabNameForTabToSwitchTo + "'. Existing titles: '" + String.join("', '", actualTabs) + "'.");
return new ActionResult(false, null, this);
}
/**
* Closes the current browser tab. If it's the last one the browser is closed.
* @return Action result
*/
public ActionResult closeCurrentBrowserTab(){
log(LogLevel.FRAMEWORK_ERROR, "Close current browser tab is not yet implemented.");
return new ActionResult(false, null, this);
}
/**
* Holds mouse cursor over given element
*
* @param guiElement Element to hover
* @return Action result
*/
public ActionResult hover(GuiElement guiElement){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String javaScript = "var evObj = document.createEvent('MouseEvents');" +
"evObj.initMouseEvent(\"mouseover\",true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);" +
"arguments[0].dispatchEvent(evObj);";
try{
((JavascriptExecutor)driver).executeScript(javaScript, getRuntimeElementWithTimeout(((DomElement)guiElement), standardTimeoutInSeconds));
log(LogLevel.EXECUTED, "Hover over " + ((DomElement)guiElement).LogIdentification() + ".");
return new ActionResult(true, guiElement, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not hover over " + ((DomElement)guiElement).LogIdentification() + ".");
saveScreenshot(getRuntimeElementWithoutLogging((DomElement)guiElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, guiElement, this);
}
}
/**
* Returns methods to verify the provided element
* @param domElement Element to verify
* @return Returns methods to use for verifications of the element
*/
public ElementVerificationMethods verifiyElement(DomElement domElement){
return new ElementVerificationMethods(domElement, this);
}
/**
* Returns if the element is able to interact with (actually if it is displayed and enabled)
*
* @param guiElement The element to check
* @return Return true if the element is displayed and enabled.
*/
@SuppressWarnings("WeakerAccess")
public boolean isEnabled(GuiElement guiElement){
DomElement domElement = (DomElement)guiElement;
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement == null) return false;
boolean interactionable = (webElement.isEnabled() && webElement.isDisplayed());
log(LogLevel.DEBUG, "Checking if " + ((DomElement)guiElement).LogIdentification() + " is interactionable and " + String.valueOf(interactionable).toLowerCase().replace("true", "it seems to be both displayed and enabled.").replace("false", " it is not."));
return interactionable;
}
/**
* Selecting multiple choices in a dropdown element (deselects what's in it to begin with.
*
* @param dropdownElement The element to interact with
* @param selectedOptions The list of options to select, based on visible text
* @return Action result
*/
public ActionResult selectInMultipleChoiceDropdown(GuiElement dropdownElement, ArrayList selectedOptions){
return new ActionResult(selectInDropdownManager(dropdownElement, selectedOptions).wasSuccess, dropdownElement, this);
}
/**
* Selecting an option in a dropdown element by visible text
*
* @param guiElement The element to interact with
* @param selection The visible text of the option to choose
* @return Action result
*/
public ActionResult selectInDropdown(GuiElement guiElement, String selection){
ArrayList selectionsList = new ArrayList<>();
selectionsList.add(selection);
return new ActionResult(selectInDropdownManager(guiElement, selectionsList).wasSuccess, guiElement, this);
}
/**
* Chooses a selection in a radio button set
*
* @param radioButtonContainer The element to interact with
* @param text The visible text of the element to choose
* @return Action result
*/
public ActionResult chooseRadioButton(GuiElement radioButtonContainer, String text){
DomElement domElement = (DomElement) radioButtonContainer;
if(text == null) {
log(LogLevel.DEBUG, "Did not choose anything in " + domElement.LogIdentification() + " since there was no input to select.");
return new ActionResult(false, radioButtonContainer, this);
}
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement == null){
log(LogLevel.EXECUTION_PROBLEM, "Could not identify radio button element " + domElement.LogIdentification() + " where '" + text + "' was supposed to be selected. Continuing test case execution nevertheless.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, domElement, this);
}
if(!webElement.getTagName().toLowerCase().equals("form")){
if(webElement.getTagName().toLowerCase().equals("input") && (webElement.getText().contains(text) || webElement.getAttribute("value").contains(text))){
webElement.click();
log(LogLevel.EXECUTED, "Clicked the '" + webElement.getAttribute("value") + "' radiobutton element.");
return new ActionResult(true, domElement, this);
}
log(LogLevel.EXECUTION_PROBLEM, "Trying to select '" + text + "' in radio button set " + domElement.LogIdentification() + ". However the tag of the element is not 'form', but '" + webElement.getTagName() + "'.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, domElement, this);
}
List optionStrings = new ArrayList<>();
try {
List optionButtons = webElement.findElements(By.xpath("//*[@type='radio']"));
log(LogLevel.DEBUG, "Found " + optionButtons.size() + " options for radiobutton.");
if(optionButtons.size()==0){
log(LogLevel.FRAMEWORK_ERROR, "Could not identify any radiobuttons within " + domElement.LogIdentification() + ". Does it contain elements of type 'radio'?");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return new ActionResult(false, domElement, this);
}
for(WebElement optionButton : optionButtons){
if(optionButton.isSelected()){
log(LogLevel.DEBUG, "Initial selected value in " + domElement.LogIdentification() + " was '" + optionButton.getText() + "'.");
if(optionButton.getText().equals(text)){
log(LogLevel.EXECUTED, "Made sure the radiobutton " + domElement.LogIdentification() + " had the value '" + text + "' checked, and it already did.");
return new ActionResult(true, domElement, this);
}
}
if(optionButton.isDisplayed()){
optionStrings.add(optionButton.getText() + " (value='" + optionButton.getAttribute("value") + "')" + String.valueOf(optionButton.isEnabled()).toLowerCase().replace("false", " (not enabled)").replace("true", ""));
}else {
optionStrings.add(optionButton.getText() + " (hidden field)" + String.valueOf(optionButton.isEnabled()).toLowerCase().replace("false", " (not enabled)").replace("true", ""));
}
}
for (WebElement optionButton : optionButtons){
if(optionButton.getText().equals(text)){
optionButton.click();
log(LogLevel.EXECUTED, "Clicked the '" + text + "' radiobutton of " + domElement.LogIdentification() + ".");
return new ActionResult(true, domElement, this);
}
}
for (WebElement optionButton : optionButtons){
if(optionButton.getAttribute("value").equals(text)){
optionButton.click();
log(LogLevel.EXECUTED, "Clicked the '" + text + "' radiobutton of " + domElement.LogIdentification() + ".");
return new ActionResult(true, domElement, this);
}
}
errorManagementProcedures("Could not click the '" + text + "' radiobutton of " + domElement.LogIdentification() + ". Available options are '" + String.join("', '", optionStrings) + "'.", webElement);
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Method 'chooseRadioButton()' crashed with error." + e.getMessage());
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
return new ActionResult(false, domElement, this);
}
/**
* Ticking or un-ticking checkboxes. Common code to reduce duplicated code.
*
* @param checkboxElement The element to interact with
* @param expectedToBeTicked True if expected to be ticked after procedure, false if expected to be un-ticked after procedure. If null is provided, execution will proceed without interaction.
* @return Action result
*/
public ActionResult manageCheckbox(GuiElement checkboxElement, Boolean expectedToBeTicked){
long startTime = System.currentTimeMillis();
DomElement domElement = (DomElement)checkboxElement;
if (expectedToBeTicked == null){
log(LogLevel.DEBUG, "Leaving checkbox " + domElement.LogIdentification() + " without interaction since input was null.");
return new ActionResult(true, checkboxElement, this);
}
WebElement webElement = null;
boolean success = false;
while (!success && (System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000)){
webElement = getRuntimeElementWithoutLogging(domElement);
if(webElement == null){
wait(50);
continue;
}
if(!webElement.getTagName().toLowerCase().equals("input") || !webElement.getAttribute("type").toLowerCase().equals("checkbox")){
List subElements = webElement.findElements(By.xpath("//input"));
if(subElements.size() == 1){
if(!subElements.get(0).isSelected() == expectedToBeTicked){
subElements.get(0).click();
log(LogLevel.EXECUTED, "Clicked the " + domElement.LogIdentification() + " to make it " + String.valueOf(expectedToBeTicked).toLowerCase().replace("true", "ticked").replace("false", "unticked") + ".");
success = true;
continue;
} else {
log(LogLevel.EXECUTED, "Made sure that " + domElement.LogIdentification() + " was " + String.valueOf(expectedToBeTicked).toLowerCase().replace("true", "ticked").replace("false", "un-ticked") + ". And it already was.");
success = true;
continue;
}
}
log(LogLevel.EXECUTION_PROBLEM, "Element " + domElement.LogIdentification() + " was expected to be a 'input' tag with the type 'checkbox', but it seem to be a '" + webElement.getTagName() + "' tag with type '" + webElement.getAttribute("type") + "'.");
webElement = null;
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
} else {
try {
if(webElement.isSelected() == expectedToBeTicked){
log(LogLevel.EXECUTED, "Made sure the " + domElement.LogIdentification() + " was " + String.valueOf(expectedToBeTicked).toLowerCase().replace("true", "ticked").replace("false", "unticked") + ", and it already was.");
success = true;
} else {
webElement.click();
log(LogLevel.EXECUTED, "Clicked on the " + domElement.LogIdentification() + " checkbox since it was expected to be " + String.valueOf(expectedToBeTicked).toLowerCase().replace("true", "ticked").replace("false", "unticked") + " but it was not.");
success = true;
}
return new ActionResult(true, checkboxElement, this);
} catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Something went wrong while interacting with the " + domElement.LogIdentification() + " checkbox. " + e.getMessage());
errorManagementProcedures("This should not happen.", webElement);
}
}
}
if(webElement == null){
errorManagementProcedures("Could not identify the checkbox " + domElement.LogIdentification() + ". Was supposed to " + String.valueOf(expectedToBeTicked).toLowerCase().replace("true", "tick").replace("false", "untick") + " it.", null);
}
return new ActionResult(false, checkboxElement, this);
}
/**
* Returns the currently selected value from a dropdown
* @param guiElement Dropdown element
* @return Returns the value as a string
*/
public String getSelectedValueFromDropdown(GuiElement guiElement){
List selectedStrings = new ArrayList<>();
DomElement domElement = (DomElement) guiElement;
WebElement webElement = waitForElementToBeEnabled(guiElement, standardTimeoutInSeconds);
if(webElement == null) {
log(LogLevel.DEBUG, "Could not identify the element " + domElement.LogIdentification() + " to get current selection from.");
return null;
}
Select dropdown;
try{
dropdown = new Select(webElement);
}catch (Exception e){
log(LogLevel.DEBUG, "Could not cast WebElement to type Select (=DropDown). " + e.getMessage());
return null;
}
List selections = dropdown.getAllSelectedOptions();
for(WebElement selection : selections){
try{
selectedStrings.add(selection.getText());
}catch (Exception e){
log(LogLevel.DEBUG, "Could not get text value for selected element when attempting to get selections for " + domElement.LogIdentification() + ". " + e.getMessage());
}
}
return "['" + String.join("','", selectedStrings) + "']";
}
/**
* Verifies that an image looks as expected
*
* @param guiElement The image to check
* @param pathToOracleImage The oracle image to compare with
* @deprecated Need new implementation
*/
@Deprecated
public void verifyImage(GuiElement guiElement, String pathToOracleImage){
log(LogLevel.FRAMEWORK_ERROR, "Method 'verifyImage()' is not yet implemented.");
saveScreenshot(getRuntimeElementWithoutLogging((DomElement)guiElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
/**
* Picks a value in a selector dropdown
*
* @param dropdownElement The element to interact with
* @param selections The value(s) to choose
* @return Action result
*/
private ActionResult selectInDropdownManager(GuiElement dropdownElement, List selections){
DomElement domElement = (DomElement) dropdownElement;
if(selections == null ||selections.size() == 0) {
log(LogLevel.DEBUG, "Did not choose anything in " + domElement.LogIdentification() + " since there was no input to select.");
return new ActionResult(true, dropdownElement, this);
}
WebElement webElement = waitForElementToBeEnabled(domElement, standardTimeoutInSeconds);
if(webElement == null) {
errorManagementProcedures("Could not identify element " + domElement.LogIdentification() + " where '" + String.join("', '", selections) + "' was supposed to be selected. Continuing test case execution nevertheless.", null);
return new ActionResult(false, dropdownElement, this);
}
if(!webElement.getTagName().toLowerCase().equals("select"))
errorManagementProcedures("Trying to select '" + String.join("', '", selections) + "' in dropdown " + domElement.LogIdentification() + ". However the tag of the element is not 'select', but '" + webElement.getTagName() + "'.", webElement);
//Create Select element and log originally selected values
boolean allSelectionsOkSoFar = true;
List nonSelectedStrings = new ArrayList<>();
List optionStrings = new ArrayList<>();
try{
Select select = new Select(webElement);
List selectedOptions = new ArrayList<>();
for(WebElement selectedOption : select.getAllSelectedOptions()){
selectedOptions.add(selectedOption.getText());
}
log(LogLevel.DEBUG, "Initial selected value(s) in " + domElement.LogIdentification() + ": '" + String.join("', '", selectedOptions) + "'.");
//Save logging info - what options actually was enabled
List options = select.getOptions();
for(WebElement option : options){
if(option.isDisplayed()){
optionStrings.add(option.getText() + String.valueOf(option.isEnabled()).toLowerCase().replace("false", " (not enabled)").replace("true", ""));
}else {
optionStrings.add(option.getText() + " (hidden field)" + String.valueOf(option.isEnabled()).toLowerCase().replace("false", " (not enabled)").replace("true", ""));
}
}
//Select options
if(select.isMultiple()){
select.deselectAll();
}
for(String selection : selections){
boolean thisSelectionPerformed = false;
for(WebElement option : options){
if(!option.isDisplayed() || !option.isEnabled()) continue;
if(option.getText().equals(selection)){
select.selectByVisibleText(selection);
thisSelectionPerformed = true;
break;
}
}
if(!thisSelectionPerformed){
nonSelectedStrings.add(selection);
allSelectionsOkSoFar = false;
}
}
}catch (Exception e){
log(LogLevel.FRAMEWORK_ERROR, "Something went terribly bad while trying to select '" + String.join("', '", selections) + "' in " + domElement.LogIdentification() + ". " + e.getMessage());
errorManagementProcedures("This should not happen.", webElement);
}
//Log results
if(allSelectionsOkSoFar){
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.DEBUG, "Found available options in " + domElement.LogIdentification() + ": '" + String.join("', '", optionStrings) + "'.",
"Found available options in " + domElement.LogIdentification() + ": '" + String.join("', '", optionStrings) + "'.");
log(LogLevel.EXECUTED, "Selected '" + String.join("', '", selections) + "' in dropdown " + domElement.LogIdentification());
return new ActionResult(true, domElement, this);
} else {
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.EXECUTION_PROBLEM,
"Could not select '" + String.join("', '", nonSelectedStrings) + "' in element " + domElement.LogIdentification() + " when attempting to select '" + String.join("', '", selections) + "'. Available options are :'" + String.join("', '", optionStrings) + "'.",
"Could not select:- '" + String.join("'
- '", nonSelectedStrings) + "'
in element " + domElement.LogIdentification() + " when attempting to select: - '" + String.join("'
- '", selections) + "'
. Available options are:- '" + String.join("'
- '", optionStrings) + "'
.");
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
return new ActionResult(false, domElement, this);
}
/**
* Verifies if html table data holds expected data. Top row expected to hold headlines.
*
* @param guiElement The table to search
* @param headlineColonValueSemicolonSeparatedString The data to find, in the pattern example of 'Headline1:ExpectedCorrespondingCellValue1;Headline2:ExpectedCorrespondingCellValue2'. If all values can be matched on the same row the test is passed.
* @param cellMatchingType Type of matching performed.
* @deprecated Use method tableRows() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyTableRows(GuiElement guiElement, String[] headlineColonValueSemicolonSeparatedString, CellMatchingType cellMatchingType){
boolean doneOk = false;
long startTime = System.currentTimeMillis();
while (!doneOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
TableData tableData = tableDataFromGuiElement(guiElement, false);
if(tableData == null ){
DomElement table = (DomElement) guiElement;
testCase.log(LogLevel.VERIFICATION_PROBLEM, "Table data for " + table.LogIdentification() + " is null.");
saveScreenshot(getRuntimeElementWithoutLogging(table));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return;
}
boolean nonErroneous = true;
for(String searchPattern : headlineColonValueSemicolonSeparatedString){
if(!tableData.rowExist(searchPattern, cellMatchingType)){
nonErroneous = false;
}
}
if(nonErroneous) doneOk = true;
}
TableData tableData = tableDataFromGuiElement(guiElement, true);
if(tableData == null) return;
tableData.verifyRows(headlineColonValueSemicolonSeparatedString, cellMatchingType);
}
/**
* Verifies existence of a row matching the stated values corresponding to the stated headlines.
*
* @param tableElement The table element.
* @param headlineColonValueSemicolonSeparatedString The data to find, in the pattern example of 'Headline1:ExpectedCorrespondingCellValue1;Headline2:ExpectedCorrespondingCellValue2'. If all values can be matched on the same row the test is passed.
* @param cellMatchingType Type of matching performed.
* @deprecated Use method tableRow() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyTableRow(GuiElement tableElement, String headlineColonValueSemicolonSeparatedString, CellMatchingType cellMatchingType){
DomElement domElement = (DomElement)tableElement;
long startTime = System.currentTimeMillis();
boolean found = waitForElementToAppear(tableElement).wasSuccess;
if(!found) {
log(LogLevel.VERIFICATION_PROBLEM, "Could not identify " + domElement.LogIdentification() + " within timeout. Could not verify row data '" + headlineColonValueSemicolonSeparatedString + "'.");
return;
}
boolean doneOk = false;
TableData tableData;
while (!doneOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
try{
tableData = tableDataFromGuiElement(tableElement, false);
}catch (Exception ignored){
tableData = null;
}
if(tableData == null) {
wait(50);
continue;
}
doneOk = tableData.rowExist(headlineColonValueSemicolonSeparatedString, cellMatchingType);
}
tableData = tableDataFromGuiElement(tableElement, true);
if(tableData == null){
testCase.log(LogLevel.VERIFICATION_PROBLEM, "Could not retrieve data from " + domElement.LogIdentification() + ".");
saveScreenshot(getRuntimeElementWithoutLogging(domElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return;
}
if(!tableData.verifyRowExist(headlineColonValueSemicolonSeparatedString, cellMatchingType)){
saveScreenshot(getRuntimeElementWithoutLogging(domElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Reloads the page. Similar as pressing F5 in the browser to refresh the page.
* @return Action result
*/
public ActionResult reloadPage(){
try{
driver.navigate().refresh();
return new ActionResult(true, null, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not reload page. Error: " + e);
return new ActionResult(false, null, this);
}
}
/**
* Verifies that the headline exists in the table.
*
* @param tableElement Table element
* @param expectedHeadline Headline name, as seen in the table
* @deprecated Use method tableHeadlines() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyTableHeadline(GuiElement tableElement, String expectedHeadline){
TableData tableData = tableDataFromGuiElement(tableElement, true);
if(tableData == null) return;
if(!tableData.verifyHeadingExist(expectedHeadline)){
saveScreenshot(getRuntimeElementWithoutLogging((DomElement)tableElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
*
* @param guiElement The HTML table element
* @param logErrors Set to true to log errors
* @return Returns the HTML table data as a TableData element.
*/
@SuppressWarnings("ConstantConditions")
public TableData tableDataFromGuiElement(GuiElement guiElement, boolean logErrors){
DomElement domElement = (DomElement)guiElement;
boolean found = waitForElementToAppear(guiElement).wasSuccess;
if(!found) {
testCase.log(LogLevel.DEBUG, "Could not find " + domElement.LogIdentification() + " within timeout.");
return null;
}
StringBuilder tableContent = new StringBuilder();
WebElement tableElement = getRuntimeElementWithoutLogging(domElement);
if(!tableElement.getTagName().toLowerCase().equals("table")){
try {
tableElement = tableElement.findElement(By.xpath(".//table"));
}catch (Exception ignored){
testCase.log(LogLevel.DEBUG, "The " + domElement.LogIdentification() + " is not of 'table' tag, and it does not seem to have any child element of type 'table' either.");
}
}
if(tableElement == null) {
if(logErrors) testCase.log(LogLevel.VERIFICATION_PROBLEM, "Could not create TableData from " + domElement.LogIdentification() + ". Check debug for more info.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return null;
}
List rows;
try {
rows = tableElement.findElements(By.xpath("./tr"));
}catch (Exception e){
if(logErrors) testCase.log(LogLevel.DEBUG, "Cannot get hold of table rows directly under the TABLE element for HTML table " + domElement.LogIdentification() + ".");
rows = new ArrayList<>(); }
if(rows.size() == 0){
try {
rows = tableElement.findElements(By.xpath("./*/tr")); //Row definitions under // tags
}catch (Exception e){
if(logErrors) testCase.log(LogLevel.DEBUG, "Cannot get hold of table rows one step below the TABLE element for HTML table " + domElement.LogIdentification() + ".");
rows = new ArrayList<>();
}
}
if(rows.size() == 0){
try {
rows = tableElement.findElements(By.xpath(".//tr"));
}catch (Exception e){
if(logErrors) testCase.log(LogLevel.VERIFICATION_PROBLEM, "Cannot get hold of any table rows for HTML table " + domElement.LogIdentification() + ".");
saveScreenshot(tableElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return null;
}
}
for(WebElement row : rows){
List cells = new ArrayList<>();
try{
cells = row.findElements(By.xpath("(./td|./th)"));
} catch (Exception e){
if(logErrors) {
testCase.log(LogLevel.DEBUG, "Cannot find any table cells directly under the ROW element for table " + domElement.LogIdentification() + " for row '" + row.toString() + "'.");
cells = new ArrayList<>();
}
}
if(cells.size() == 0) {
try{
cells = row.findElements(By.xpath("(./*/td|./*/th)"));
} catch (Exception e){
if(logErrors) {
testCase.log(LogLevel.DEBUG, "Cannot find any table cells one step below the ROW element for table " + domElement.LogIdentification() + " for row '" + row.toString() + "'.");
cells = new ArrayList<>();
}
}
}
if(cells.size() == 0){
try{
cells = row.findElements(By.xpath("(.//td|.//th)"));
} catch (Exception e){
if(logErrors) {
testCase.log(LogLevel.DEBUG, "Cannot find any table cells for row '" + row.toString() + "' in table " + domElement.LogIdentification() + ".");
saveScreenshot(tableElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
}
if(cells.size() == 0){
tableContent.append(";");
tableContent.append(SupportMethods.LF);
continue;
}
for(WebElement cell : cells){
Integer colSpan;
try{
colSpan = Integer.parseInt(cell.getAttribute("colspan"));
}catch(Exception ignored){
colSpan = 1;
}
if(colSpan == null) colSpan = 1;
for (int i = 0; i < colSpan ; i++){
try{
tableContent.append(cell.getText().replace(";", " ").replace(System.lineSeparator(), " ")).append(";");
} catch (Exception e) {
testCase.log(LogLevel.DEBUG, "Could not read text from table cell. Replacing with ''.");
tableContent.append(";");
}
}
}
tableContent.append(SupportMethods.LF);
}
return new TableData(testCase, domElement.LogIdentification(), tableContent.toString());
}
/**
* Checks if a certain row exist in table.
*
* @param tableElement The table element
* @param headlineColonValueSemicolonSeparatedString The pattern to find ('Headline1:CorrespondingDataValueOnRow;Headline2:CorrespondingDataValueForThisHeadline').
* @param regex True if data value pattern is states as a regular expressions. Otherwise a check for cells containing the data value is performed.
* @return Returns true if rows matching is found.
*/
public boolean tableRowExists(GuiElement tableElement, String headlineColonValueSemicolonSeparatedString, boolean regex){
if(regex){
return tableRowExists(tableElement, headlineColonValueSemicolonSeparatedString, CellMatchingType.REGEX_MATCH);
} else {
return tableRowExists(tableElement, headlineColonValueSemicolonSeparatedString, CellMatchingType.CONTAINS_MATCH);
}
}
/**
* Checks if a certain row exist in table.
*
* @param tableElement The table element
* @param headlineColonValueSemicolonSeparatedString The pattern to find ('Headline1:CorrespondingDataValueOnRow;Headline2:CorrespondingDataValueForThisHeadline').
* @param cellMatchingType Type of matching performed.
* @return Returns true if rows matching is found.
*/
public boolean tableRowExists(GuiElement tableElement, String headlineColonValueSemicolonSeparatedString, CellMatchingType cellMatchingType) {
getRuntimeElementWithTimeout((DomElement)tableElement, standardTimeoutInSeconds);
TableData tableData = tableDataFromGuiElement(tableElement, false);
return tableData != null && tableData.rowExist(headlineColonValueSemicolonSeparatedString, cellMatchingType);
}
/**
* Checks if a certain row exist in table. Gives the GUI table time to load
*
* @param tableElement The table element
* @param headlineColonValueSemicolonSeparatedString The pattern to find ('Headline1:CorrespondingDataValueOnRow;Headline2:CorrespondingDataValueForThisHeadline').
* @param cellMatchingType Type of matching performed.
* @return Returns true if rows matching is found.
*/
public boolean tableRowExistsWithTimeout(GuiElement tableElement, String headlineColonValueSemicolonSeparatedString, CellMatchingType cellMatchingType) {
boolean doneOk = false;
long startTime = System.currentTimeMillis();
while (!doneOk && System.currentTimeMillis() - startTime <= standardTimeoutInSeconds * 1000){
TableData tableData = tableDataFromGuiElement(tableElement, false);
if(tableData == null ) continue;
doneOk = tableData.rowExist(headlineColonValueSemicolonSeparatedString, cellMatchingType);
}
return doneOk;
}
/**
* Checks that the expected headlines exist in table
*
* @param tableElement The table element
* @param expectedHeadlines The list of expected headlines
* @deprecated Use method tableHeadlines() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyTableHeadlines(GuiElement tableElement, List expectedHeadlines){
DomElement table = (DomElement) tableElement;
boolean found = waitForElementToAppear(tableElement).wasSuccess;
if(!found){
log(LogLevel.VERIFICATION_PROBLEM, "Could not find " + table.LogIdentification() + " to verify headlines '" + String.join("', '", expectedHeadlines) + "' in." );
return;
}
TableData tableData = tableDataFromGuiElement(tableElement, false);
if(tableData == null) {
testCase.log(LogLevel.FRAMEWORK_ERROR, "Could not construct TableData for HTML table " + ((DomElement)tableElement).LogIdentification() + " when trying to verify headlines '" + String.join("', '", expectedHeadlines) + "'.");
saveScreenshot(getRuntimeElementWithoutLogging((DomElement)tableElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return;
}
if(!tableData.verifyHeadingsExist(expectedHeadlines)){
saveScreenshot(getRuntimeElementWithoutLogging(table));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
}
}
/**
* Checks if table data rows are empty/doesn't exist. Headlines does not count as data.
*
* @param tableElement The table element.
* @return Return true if table is empty.
*/
public boolean tableIsEmpty(GuiElement tableElement) {
getRuntimeElementWithTimeout((DomElement)tableElement, standardTimeoutInSeconds);
TableData tableData = tableDataFromGuiElement(tableElement, true);
return tableData != null && tableData.tableIsEmpty();
}
/**
* Navigates to specified URL
*
* @param url String formed URL
* @throws NavigationError Error thrown if Navigation cannot be performed
* @return Action result
*/
private ActionResult goToUrl(String url) throws NavigationError{
try{
driver.navigate().to(url);
return new ActionResult(true, null, this);
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not go to URL '" + url + "'. Error: " + e);
return new ActionResult(false, null, this);
}
}
/**
* Writes the input string to specified DOM element
*
* @param element Selenium WebElement to interact with
* @param text Text to enter
* @param clearElement clears the existing element value
* @throws TextEnteringError Error thrown when text cannot be entered by sendKeys method
*/
private void enterText(WebElement element, String text, boolean clearElement) throws TextEnteringError{
if(element != null){
try {
if( clearElement ) {
element.clear();
log(LogLevel.DEBUG, "Clearing existing text " + element.getText());
}
element.sendKeys(text);
log(LogLevel.DEBUG, "Sending keys '" + text + "'.");
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not send keys '" + text + "'.");
saveScreenshot(element);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
throw new TextEnteringError();
}
}else {
log(LogLevel.EXECUTION_PROBLEM, "Could not send keys '" + text + "' since the webElement was null.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
throw new TextEnteringError();
}
}
/**
* Saves the current HTML of the page interacted with to the testCaseLog folder for debugging purposes and write a testCaseLog post about it
* Used for provide debugging information when execution or verification problems (or errors) occur.
* @return Action result
*/
public ActionResult saveHtmlContentOfCurrentPage(){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
String LF = SupportMethods.LF;
String htmlStyle = " pre { font-family: Consolas, Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace, serif;" + LF +
" margin-bottom: 10px;" + LF +
" overflow: auto;" + LF +
" width: auto;" + LF +
" padding: 5px;" + LF +
" background-color: #eee;" + LF +
" width: 100%;" + LF +
" padding-bottom: 20px!ie7;" + LF +
" max - height: 600px;" + LF +
" }" + LF;
String html =
"" + LF + "" + LF + LF +
" " + LF +
" Source code of page " + LF +
" " + LF +
" " + LF +
" " + LF +
" " + StringManagement.htmlContentToDisplayableHtmlCode(driver.getPageSource()) + LF + LF +
" " + LF +
"" + LF;
String filePath = LogFolder.testRunLogFolder + testCase.testName + TestRun.getFileCounter() + ".html";
TestRun.increaseFileCounter();
SupportMethods.saveToFile(html, filePath);
logPageSourceSaving(filePath);
return new ActionResult(true, null, this);
}
private void logPageSourceSaving(String filePath){
String htmlFilePath = filePath.replace("\\", "/");
String[] parts = htmlFilePath.split("/");
htmlFilePath = parts[parts.length -1];
testCase.logDifferentlyToTextLogAndHtmlLog(LogLevel.INFO, "Page source saved as '" + filePath + "'.",
"Page source saved as " +
"" + filePath + "");
}
/**
* Halts further execution of the test case when further execution is considered non-valuable
*/
public void haltFurtherExecution(){
log(LogLevel.INFO, "Halting further execution due to perceived problems.");
makeSureDriverIsClosed();
testCase.report();
}
/**
* Gets a runtime element from the WebDriver driver to be able to interact with it
*
* @param element Declared DomElement to interact with
* @return WebElement for WebDriver interaction
*/
public WebElement getRuntimeElementWithoutLogging(DomElement element){
if(element == null) return null;
List relevantWebElements = gatherRelevantElements(element, false);
return mostRelevantElement(relevantWebElements, element, false);
}
/**
* Gets a runtime element from the WebDriver driver to be able to interact with it
*
* @param parent The DomElement limiting search scope. Only the descendants of this element will be searched.
* @param descendantToReturn The DomElement being sought after.
* @return WebElement for WebDriver interaction
*/
public WebElement getRuntimeElementWithoutLogging(DomElement parent, DomElement descendantToReturn){
if(parent == null || descendantToReturn == null) return null;
List relevantWebElements = gatherRelevantElements(parent, descendantToReturn, false);
return mostRelevantElement(relevantWebElements, descendantToReturn, false);
}
/**
* Gathers a list of relevant elements when trying to get hold of the WebElement corresponding to a DomElement.
*
* @param element The DomElement to find
* @return Returns a list of relevant matches for DomElement
*/
private List gatherRelevantElements(DomElement element, boolean performLogging){
if(driver == null){
if(performLogging)
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
List webElements = new ArrayList<>();
if(element == null) {
if(performLogging)
log(LogLevel.DEBUG, "Trying to get relevant WebElements for DomElement that is null.");
return webElements;
}
if(element.by != null){
WebElement returnElement = WebElementIdentifier.getWebElement(testCase, driver, element, true);
if(returnElement != null){
webElements.add(returnElement);
return webElements;
}
}
try {
if(element.recognitionStrings == null) return webElements;
for(String recognitionString : element.recognitionStrings){
if (element.identificationType == DomElement.IdentificationType.BY_LINK_TEXT) {
webElements.addAll(driver.findElements(By.linkText(recognitionString)));
} else if (element.identificationType == DomElement.IdentificationType.BY_ID) {
webElements.addAll(driver.findElements(By.id(recognitionString)));
} else if(element.identificationType == DomElement.IdentificationType.BY_X_PATH) {
webElements.addAll(driver.findElements(By.xpath(recognitionString)));
} else if(element.identificationType == DomElement.IdentificationType.BY_NAME) {
webElements.addAll(driver.findElements(By.name(recognitionString)));
} else if (element.identificationType == DomElement.IdentificationType.BY_CSS){
webElements.addAll(driver.findElements(By.cssSelector(recognitionString)));
} else if (element.identificationType == DomElement.IdentificationType.BY_CLASS){
webElements.addAll(driver.findElements(By.className(recognitionString)));
} else if (element.identificationType == DomElement.IdentificationType.BY_VISIBLE_TEXT){
webElements.addAll(driver.findElements(By.xpath("//*[.='" + recognitionString + "']")));
if(webElements.size() == 0){
webElements.addAll(driver.findElements(By.xpath("//*[contains(text(), '" + recognitionString + "')]")));
}
} else if(element.identificationType == DomElement.IdentificationType.BY_ATTRIBUTE_VALUE){
if(!recognitionString.contains("=")){
if(performLogging)
log(LogLevel.EXECUTION_PROBLEM, "Identifying elements by attribute value needs attribute value stated as 'attribute_name=attribute_value', " +
"for example 'href=http://myserver.com/mylink' or possibly 'href=\"http://myserver.com/mylink\"'." + System.lineSeparator() +
"For element " + element.name + " the recognition string was '" + recognitionString + ".");
continue;
}
String attributeName = recognitionString.split("=")[0];
String attributeValue = recognitionString.substring(recognitionString.indexOf("=") + 1);
if(attributeValue.startsWith("\"") && attributeValue.endsWith("\"")){
attributeValue = attributeValue.substring(1, attributeValue.length()-1);
} else if (attributeValue.startsWith("'") && attributeValue.endsWith("'")){
attributeValue = attributeValue.substring(1, attributeValue.length()-1);
}
webElements.addAll(driver.findElements(By.xpath("//*[@" + attributeName + "='" + attributeValue +"']")));
} else {
if(performLogging)
log(LogLevel.FRAMEWORK_ERROR, "Tried to identify " + element.LogIdentification() + ", but the IdentificationType '" + element.identificationType.toString() + "' was not supported in getRuntimeElementWithoutLogging() method.");
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
}
}
}catch (Exception e){
if(performLogging)
log(LogLevel.DEBUG, "Tried to identify " + element.LogIdentification() + ", but something went wrong. " + e.getMessage());
}
return webElements;
}
/**
* Gathers a list of relevant elements when trying to get hold of the WebElement corresponding to a DomElement.
*
* @param parentDomElement The root element. Search is limited to descendants of this element.
* @param descendantToFind The DomElement to find amoing the descendants of parentDomElement.
* @return Returns a list of relevant matches for DomElement
*/
private List gatherRelevantElements(DomElement parentDomElement, DomElement descendantToFind, boolean performLogging){
if(driver == null){
if(performLogging)
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
if(parentDomElement == null) return null;
WebElement parent = getRuntimeElementWithoutLogging(parentDomElement);
if(parent == null){
if(performLogging)
log(LogLevel.EXECUTION_PROBLEM, "Cannot find parent element " + parentDomElement.LogIdentification() + " so cannot find the DomElement " + descendantToFind.LogIdentification() + " among its descendants.");
return null;
}
List webElements = new ArrayList<>();
if(descendantToFind == null) {
if(performLogging)
log(LogLevel.DEBUG, "Trying to get relevant WebElements for DomElement that is null.");
return webElements;
}
try {
for(String recognitionString : descendantToFind.recognitionStrings){
if (descendantToFind.identificationType == DomElement.IdentificationType.BY_LINK_TEXT) {
webElements.addAll(parent.findElements(By.linkText(recognitionString)));
} else if (descendantToFind.identificationType == DomElement.IdentificationType.BY_ID) {
webElements.addAll(parent.findElements(By.id(recognitionString)));
} else if(descendantToFind.identificationType == DomElement.IdentificationType.BY_X_PATH) {
webElements.addAll(parent.findElements(By.xpath(recognitionString)));
} else if(descendantToFind.identificationType == DomElement.IdentificationType.BY_NAME) {
webElements.addAll(parent.findElements(By.name(recognitionString)));
} else if (descendantToFind.identificationType == DomElement.IdentificationType.BY_CSS){
webElements.addAll(parent.findElements(By.cssSelector(recognitionString)));
} else if (descendantToFind.identificationType == DomElement.IdentificationType.BY_CLASS){
webElements.addAll(parent.findElements(By.className(recognitionString)));
} else if (descendantToFind.identificationType == DomElement.IdentificationType.BY_VISIBLE_TEXT){
webElements.addAll(parent.findElements(By.xpath(".//*[text()='" + recognitionString + "']")));
if(webElements.size() == 0){
webElements.addAll(parent.findElements(By.xpath(".//*[contains(text(), '" + recognitionString + "')]")));
}
} else if(descendantToFind.identificationType == DomElement.IdentificationType.BY_ATTRIBUTE_VALUE){
if(!recognitionString.contains("=")){
if(performLogging)
log(LogLevel.EXECUTION_PROBLEM, "Identifying elements by attribute value needs attribute value stated as 'attribute_name=attribute_value', " +
"for example 'href=http://myserver.com/mylink' or possibly 'href=\"http://myserver.com/mylink\"'." + System.lineSeparator() +
"For element " + descendantToFind.name + " the recognition string was '" + recognitionString + ".");
continue;
}
String attributeName = recognitionString.split("=")[0];
String attributeValue = recognitionString.substring(recognitionString.indexOf("=") + 1);
if(attributeValue.startsWith("\"") && attributeValue.endsWith("\"")){
attributeValue = attributeValue.substring(1, attributeValue.length()-1);
} else if (attributeValue.startsWith("'") && attributeValue.endsWith("'")){
attributeValue = attributeValue.substring(1, attributeValue.length()-1);
}
webElements.addAll(driver.findElements(By.xpath("//*[@" + attributeName + "='" + attributeValue +"']")));
} else {
if(performLogging)
log(LogLevel.FRAMEWORK_ERROR, "Tried to identify " + descendantToFind.LogIdentification() + ", but the IdentificationType '" + descendantToFind.identificationType.toString() + "' was not supported in getRuntimeElementWithoutLogging() method.");
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
}
}
}catch (Exception e){
if(performLogging)
log(LogLevel.DEBUG, "Tried to identify " + descendantToFind.LogIdentification() + ", but something went wrong. " + e.getMessage());
}
return webElements;
}
/**
* If several elements are found, the displayed one is returned. If several still are displayed, returning the enabled one.
* @param webElements List of elements
* @param element The element (only for logging purposes)
* @return Returns a webElement, or null if none are found.
*/
private WebElement mostRelevantElement(List webElements, DomElement element, boolean performLogging){
if (webElements.size() == 0) return null;
//More than one match - trying to find best, most relevant match
String debugString = "Found " + webElements.size() + " elements when trying to identify " + element.LogIdentification() + ". ";
if(element.ordinalNumber != null){
if(webElements.size() <= element.ordinalNumber){
if(performLogging)
log(LogLevel.DEBUG, debugString + "Using WebElement #" + element.ordinalNumber + ", given by the DomElement object. ");
return webElements.get(element.ordinalNumber + 1);
} else {
if(performLogging)
log(LogLevel.DEBUG, debugString + "The ordinal number given by the DomElement object was supposed to be " +
element.ordinalNumber + ", so it could not be matched.");
return null;
}
}
if (webElements.size() == 1) return webElements.get(0);
List visibleElementsList = new ArrayList<>();
for(WebElement webElement : webElements){
if(webElement.isDisplayed())
visibleElementsList.add(webElement);
}
if(visibleElementsList.size() == 0){
log(LogLevel.DEBUG, debugString + "None of these elements were visible. Returning first match and holding thumbs this is the best match.");
return webElements.get(0);
}
if(visibleElementsList.size() == 1){
log(LogLevel.DEBUG, debugString + "Only one of these was visible. Returning that element, assuming that was the element meant.");
return visibleElementsList.get(0);
}
List enabledElements = new ArrayList<>();
for(WebElement visibleElement : visibleElementsList){
if(visibleElement.isEnabled()) enabledElements.add(visibleElement);
}
debugString += visibleElementsList.size() + " of these elements were visible, and out of these " + enabledElements.size() + " were enabled. ";
if(enabledElements.size() == 0){
log(LogLevel.DEBUG, debugString + "Using first visible match. No element was enabled, so no element seemed more likely than another.");
return visibleElementsList.get(0);
}
if(enabledElements.size() == 1){
log(LogLevel.DEBUG, debugString + "Assuming the only enabled element is the element to interact with.");
return enabledElements.get(0);
}
log(LogLevel.DEBUG, debugString + visibleElementsList.size() + " of these was visible. Returning the first match in hope of successful execution.");
return visibleElementsList.get(0);
}
/**
* Gets a runtime element from the WebDriver driver to be able to interact with it
*
* @param element Declared DomElement to interact with
* @param timeoutInSeconds Number of seconds to wait for element before giving up on it
* @return WebElement for WebDriver interaction
*/
public WebElement getRuntimeElementWithTimeout(DomElement element, int timeoutInSeconds){
double startTickCount = System.currentTimeMillis();
WebElement returnElement = getRuntimeElementWithoutLogging(element);
long sleepTime = 50;
while(returnElement == null && System.currentTimeMillis()- startTickCount < timeoutInSeconds *1000){
try {
Thread.sleep(sleepTime);
} catch (InterruptedException e) {
e.printStackTrace();
}
returnElement = getRuntimeElementWithoutLogging(element);
}
if(returnElement == null){
log(LogLevel.DEBUG, "Could not identify element " + element.LogIdentification() + " within the " + timeoutInSeconds + " second timeout.");
} else {
log(LogLevel.DEBUG, "Identified element " + element.LogIdentification() + " after " + (System.currentTimeMillis() - startTickCount) + " ms.");
}
return returnElement;
}
/**
* Returns the runtime element and performs logging while identifying it.
* @param element The element definition to use
* @return Returns the WebElement identified to correspond to the provided DomElement
*/
WebElement getRuntimeElementWithLogging(DomElement element){
if(element == null) return null;
List relevantWebElements = gatherRelevantElements(element, true);
return mostRelevantElement(relevantWebElements, element, true);
}
/**
* Performing driver shutdown procedures
*
* @throws BrowserClosingError Error thrown when driver cannot close browser
*/
private void closeBrowserDriver() throws BrowserClosingError{
try {
driver.close();
driver.quit();
}catch (Exception e){
throw new BrowserClosingError();
}
}
/**
* Saves debug information and halts further execution.
*
* @param errorMessage The error message to write to the test case log as a EXECUTION_PROBLEM log post.
*/
private void errorManagementProcedures(String errorMessage, WebElement webElement){
log(LogLevel.EXECUTION_PROBLEM, errorMessage);
saveScreenshot(webElement);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
haltFurtherExecution();
}
/**
* Checks for a page title existence
* @param expectedPageTitle Title
* @param timeoutInSeconds Timeout
* @return Returns true if identified within the timeout
*/
public boolean pageTitleExistWithTimeout(String expectedPageTitle, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
while (System.currentTimeMillis() - startTime < timeoutInSeconds * 1000 && !driver.getTitle().equals(expectedPageTitle)){
wait(100);
}
boolean success = driver.getTitle().equals(expectedPageTitle);
long timeSpent = System.currentTimeMillis() - startTime;
if(timeSpent > timeoutInSeconds * 1000){
timeSpent = timeoutInSeconds * 1000;
}
if(success){
testCase.log(LogLevel.DEBUG, "Waited for page title to become '" + expectedPageTitle + "', and that was identified after " + timeSpent + " milliseconds. ");
} else {
testCase.log(LogLevel.DEBUG, "Waited for page title to become '" + expectedPageTitle + "', but that did not happen within the " + timeoutInSeconds + " second timeout. Page title is '" + driver.getTitle() + "'.");
}
return success;
}
/**
* Checks for a page title match the provided regular expression pattern within the timeout provided.
* @param expectedPageTitleRegEx Regular expression pattern to use to match page title
* @param timeoutInSeconds Timeout in full seconds.
* @return Returns true if matching title is found within the timeout
*/
public boolean pageTitleMatchRegexWithTimeout(String expectedPageTitleRegEx, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
while (System.currentTimeMillis() - startTime < timeoutInSeconds * 1000 && !SupportMethods.isRegexMatch(driver.getTitle(), expectedPageTitleRegEx)){
wait(100);
}
boolean success = SupportMethods.isRegexMatch(driver.getTitle(), expectedPageTitleRegEx);
long timeSpent = System.currentTimeMillis() - startTime;
if(timeSpent > timeoutInSeconds * 1000){
timeSpent = timeoutInSeconds * 1000;
}
if(success){
testCase.log(LogLevel.DEBUG, "Waited for page title to match regular expression pattern '" + expectedPageTitleRegEx + "', and that was identified after " + timeSpent + " milliseconds. ");
} else {
testCase.log(LogLevel.DEBUG, "Waited for page title to match regular expression pattern '" + expectedPageTitleRegEx+ "', but that did not happen within the " + timeoutInSeconds + " second timeout. Page title is '" + driver.getTitle() + "'.");
}
return success;
}
/**
* Logs severe entries in browser console, client log, and driver log to test case log. Clears browser console in the process.
* @deprecated Use method under {@link #verify()}} instead
*/
@Deprecated
public void verifyBrowserConsoleHasNoErrors_AlsoClearsBrowserConsole(){
List logEntries = getLogEntriesFromBrowser(Level.SEVERE);
List logEntriesAsStrings = new ArrayList<>();
for(LogEntry logEntry : logEntries){
logEntriesAsStrings.add(logEntry.toString());
}
if(logEntries.size() > 0){
log(LogLevel.VERIFICATION_FAILED, "Browser has the following log posts of at least log level 'severe' in console:" + System.lineSeparator() + String.join(System.lineSeparator(), logEntriesAsStrings));
} else {
log(LogLevel.VERIFICATION_PASSED, "Browser had no severe log posts in console.");
}
}
/**
* Logs entries in browser console to test case log. Clears browser console in the process.
*/
public void logOutputFromBrowserConsole_AlsoClearsBrowserConsole(){
List logEntries = getLogEntriesFromBrowser(null);
List logEntriesAsStrings = new ArrayList<>();
for(LogEntry logEntry : logEntries){
logEntriesAsStrings.add(logEntry.toString());
}
if(logEntriesAsStrings.size() > 0){
log(LogLevel.INFO, "Browser had the following log posts in console:" + System.lineSeparator() + String.join(System.lineSeparator(), logEntriesAsStrings));
} else {
log(LogLevel.INFO, "Browser had an empty console output.");
}
}
/**
* Fetches the log entries from the browser console
* @param lowestLogLevel Filter for log levels to fetch
* @return Returns a list of the log entries
*/
public List getLogEntriesFromBrowser(java.util.logging.Level lowestLogLevel){
List logPosts = new ArrayList<>();
Set logTypes = driver.manage().logs().getAvailableLogTypes();
for(String logType : logTypes){
LogEntries logEntries = driver.manage().logs().get(logType);
List logEntryList = logEntries.getAll();
for(LogEntry logEntry : logEntryList){
if(lowestLogLevel == null || logEntry.getLevel().intValue() >= lowestLogLevel.intValue()){
logPosts.add(logEntry);
}
}
}
return logPosts;
}
/**
* Waits for the element image to stop changing.
* If change does not stop after timeout is reached a log message will be produced.
* Waiting for standard timeout.
*
* @param guiElement The element to wait for
* @return Returns true if animation of element stops within the timeout.
*/
public boolean waitForElementToFinishAnimation(GuiElement guiElement){
DomElement domElement;
try{
domElement = (DomElement)guiElement;
}catch (Exception e){
log(LogLevel.EXECUTION_PROBLEM, "Could not convert GuiElement to DomElement.");
return false;
}
return waitForElementToFinishAnimation(domElement, standardTimeoutInSeconds);
}
/**
* Waits for the element image to stop changing. If change does not stop after timeout is reached a log message will be produced.
*
* @param domElement The element to wait for
* @param timeoutInSeconds How long to wait for the element to stop animate
* @return Returns true if animation of element stops within the timeout.
*/
public boolean waitForElementToFinishAnimation(DomElement domElement, int timeoutInSeconds){
long startTime = System.currentTimeMillis();
waitForElementToAppear(domElement, timeoutInSeconds);
BufferedImage bufferedImage1 = grabElementImage(domElement);
wait(50);
BufferedImage bufferedImage2 = grabElementImage(domElement);
boolean animationDetected = !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
while(animationDetected && (System.currentTimeMillis() - startTime) < timeoutInSeconds * 1000){
bufferedImage1 = grabElementImage(domElement);
wait(50);
bufferedImage2 = grabElementImage(domElement);
animationDetected = !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
}
if(animationDetected){
log(LogLevel.EXECUTION_PROBLEM, "Waited " + timeoutInSeconds + " for element " + domElement.LogIdentification() + " to stop animation, but it didn't.");
} else {
log(LogLevel.DEBUG, "Waited " + (System.currentTimeMillis() - startTime) + " milliseconds until animation of element " + domElement.LogIdentification() + " had stopped.");
}
return !animationDetected;
}
/**
*
* @param domElement
* @param timeoutInSeconds
* @deprecated Use isAnimated() under {@link #verifiyElement(DomElement)}} instead
*/
@Deprecated
public void verifyElementIsAnimated(DomElement domElement, int timeoutInSeconds) {
long startTime = System.currentTimeMillis();
waitForElementToAppear(domElement, timeoutInSeconds);
BufferedImage bufferedImage1 = grabElementImage(domElement);
BufferedImage bufferedImage2 = grabElementImage(domElement);
boolean elementHasFinishedRendering= !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
while(!elementHasFinishedRendering && (System.currentTimeMillis() - startTime) < timeoutInSeconds * 1000){
wait(50);
bufferedImage2 = grabElementImage(domElement);
elementHasFinishedRendering = !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
//Initial change detection to make sure element is fully rendered and animation is started
}
wait(50);
bufferedImage1 = grabElementImage(domElement);
boolean animationHasStarted = !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
while(!animationHasStarted && (System.currentTimeMillis() - startTime) < timeoutInSeconds * 1000){
wait(50);
bufferedImage1 = grabElementImage(domElement);
animationHasStarted = !bufferedImagesAreEqual(bufferedImage1, bufferedImage2);
//Second change detection to make sure element actually changes
}
if(animationHasStarted){
log(LogLevel.VERIFICATION_PASSED, "Element " + domElement.LogIdentification() + " is detected to be animated.");
} else {
log(LogLevel.VERIFICATION_FAILED, "Element " + domElement.LogIdentification() + " could not be detected to be animated within the timeout of " + timeoutInSeconds + " seconds.");
saveScreenshot(getRuntimeElementWithoutLogging(domElement));
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
}
}
@SuppressWarnings("BooleanMethodIsAlwaysInverted")
protected boolean bufferedImagesAreEqual(BufferedImage img1, BufferedImage img2) {
if (img1.getWidth() == img2.getWidth() && img1.getHeight() == img2.getHeight()) {
for (int x = 0; x < img1.getWidth(); x++) {
for (int y = 0; y < img1.getHeight(); y++) {
if (img1.getRGB(x, y) != img2.getRGB(x, y))
return false;
}
}
} else {
return false;
}
return true;
}
protected BufferedImage grabElementImage(DomElement domElement){
if(driver == null){
log(LogLevel.EXECUTION_PROBLEM, "Driver is null.");
haltFurtherExecution();
}
WebElement webElement = getRuntimeElementWithTimeout(domElement, standardTimeoutInSeconds);
if(webElement == null){
log(LogLevel.EXECUTION_PROBLEM, "Could not identify " + domElement.LogIdentification() + " when trying to capture an image of it.");
saveScreenshot(null);
saveDesktopScreenshot();
saveHtmlContentOfCurrentPage();
writeRunningProcessListDeviationsSinceTestCaseStart();
return null;
}
File screen = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
int ImageWidth = webElement.getSize().getWidth();
int ImageHeight = webElement.getSize().getHeight();
Point point = webElement.getLocation();
int xCoordinate = point.getX();
int yCoordinate = point.getY();
BufferedImage img = null;
try {
img = ImageIO.read(screen);
} catch (IOException e) {
log(LogLevel.EXECUTION_PROBLEM, "Could not read screenshot of full screenshot when trying to capture an image of " + domElement.LogIdentification() + ".");
return null;
}
//cut Image using height, width and x y coordinates parameters.
return img.getSubimage(xCoordinate, yCoordinate, ImageWidth, ImageHeight);
}
/**
* Returns the number of matching element for the identification description of the provided DomElement.
* @param domElement The DomElement to use to identify WebElements
* @return Returns match count.
*/
public Integer getRuntimeElementMatchCount(DomElement domElement) {
if(domElement == null) return null;
List relevantWebElements = gatherRelevantElements(domElement, false);
return relevantWebElements.size();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy