com.leonarduk.web.BaseSeleniumPage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webscraper-core Show documentation
Infrastructure classes
The newest version!
/**
 * All rights reserved. @Leonard UK Ltd.
 */
package com.leonarduk.web;

import org.apache.log4j.Logger;
import org.openqa.selenium.Alert;
import org.openqa.selenium.By;
import org.openqa.selenium.NoAlertPresentException;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.LoadableComponent;

/**
 * The Class BaseSeleniumPage.
 *
 * @author stephen
 * @version $Author: $: Author of last commit
 * @version $Rev: $: Revision of last commit
 * @version $Date$: Date of last commit
 * @since 18 Feb 2015
 */
public abstract class BaseSeleniumPage extends LoadableComponent implements AutoCloseable {

	/** The Constant LOGGER. */
	private static final Logger LOGGER = Logger.getLogger(BaseSeleniumPage.class);

	/** The web driver. */
	private final WebDriver webdriver;

	private final String expectedUrl;

	private boolean acceptNextAlert = true;

	public static void waitForPageToLoad(final WebDriver webDriver2) {
		try {
			final int halfASecond = 500;
			Thread.sleep(10 * halfASecond);
			if (!SeleniumUtils.isInternetAvailable()) {
				BaseSeleniumPage.LOGGER.warn("no internet - can't load " + webDriver2.getCurrentUrl());
				BaseSeleniumPage.waitForPageToLoad(webDriver2);
				webDriver2.get(webDriver2.getCurrentUrl());
			}
		} catch (final InterruptedException e) {
			BaseSeleniumPage.LOGGER.info("Interrupted", e);
		}
	}

	/**
	 * Instantiates a new base selenium page.
	 *
	 * @param webDriver   the web driver
	 * @param expectedUrl the expected url
	 */
	public BaseSeleniumPage(final WebDriver webDriver, final String expectedUrl) {
		super();
		this.expectedUrl = expectedUrl;
		this.webdriver = webDriver;
	}

	/**
	 * Click field.
	 *
	 * @param xpath the xpath
	 */
	protected final void clickField(final String xpath) {
		this.findElementByXpath(xpath).click();
	}

	@Override
	public void close() throws Exception {
		this.webdriver.close();
	}

	public String closeAlertAndGetItsText() {
		try {
			final Alert alert = this.webdriver.switchTo().alert();
			final String alertText = alert.getText();
			if (this.acceptNextAlert) {
				alert.accept();
			} else {
				alert.dismiss();
			}
			return alertText;
		} finally {
			this.acceptNextAlert = true;
		}
	}

	/**
	 * Enter value into field.
	 *
	 * @param answer the answer
	 * @param xpath  the xpath
	 * @return the web element
	 */
	protected final WebElement enterValueIntoField(final String answer, final String xpath) {
		final WebElement element = this.findElementByXpath(xpath);
		element.clear();
		element.sendKeys(answer);
		return element;

	}

	/**
	 * Find element by xpath.
	 *
	 * @param xpath the xpath
	 * @return the web element
	 */
	protected final WebElement findElementByXpath(final String xpath) {
		final WebElement findElement = this.webdriver.findElement(By.xpath(xpath));
		if (null == findElement) {
			throw new NoSuchElementException("Could not find xpath " + xpath);
		}
		return findElement;

	}

	/**
	 * Gets the expected url.
	 *
	 * @return the expected url
	 */
	public final String getExpectedUrl() {
		return this.expectedUrl;
	}

	/**
	 * Gets the web driver.
	 *
	 * @return the web driver
	 */
	public final WebDriver getWebDriver() {
		return this.webdriver;
	}

	public final BrowserController getBrowserController() {
		return new SeleniumBrowserController(this.webdriver);
	}

	public boolean isAlertPresent() {
		try {
			this.webdriver.switchTo().alert();
			return true;
		} catch (@SuppressWarnings("unused") final NoAlertPresentException e) {
			return false;
		}
	}

	public boolean isElementPresent(final By by) {
		try {
			this.webdriver.findElement(by);
			return true;
		} catch (@SuppressWarnings("unused") final NoSuchElementException e) {
			return false;
		}
	}

	@Override
	protected final void isLoaded() {
		if (!this.webdriver.getCurrentUrl().equals(this.expectedUrl)) {
			this.load();
		}
		final String url = this.webdriver.getCurrentUrl();
		if (!url.startsWith(this.expectedUrl)) {
			throw new SeleniumException(this.expectedUrl + " is  not loaded. Instead is " + url);
		}

	}

	/**
	 * Keep number only.
	 *
	 * @param password2 the password2
	 * @return the string
	 */
	protected final int keepNumberOnly(final String password2) {
		return Integer.valueOf(password2.replaceAll("\\D+", "")).intValue();
	}

	/**
	 * Wait for page to load.
	 */
	public final void waitForPageToLoad() {
		BaseSeleniumPage.waitForPageToLoad(this.webdriver);
	}
}