com.seleniumtests.uipage.BasePage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-selenium4 Show documentation
The newest version!
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 * 				Copyright 2017-2019 B.Hecquet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.seleniumtests.uipage;

import java.time.Duration;
import java.util.Set;

import org.apache.logging.log4j.Logger;
import org.openqa.selenium.Alert;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebDriverException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.ExpectedCondition;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;
import org.testng.Assert;

import com.seleniumtests.core.SeleniumTestsContextManager;
import com.seleniumtests.customexception.ScenarioException;
import com.seleniumtests.driver.CustomEventFiringWebDriver;
import com.seleniumtests.driver.TestType;
import com.seleniumtests.uipage.htmlelements.HtmlElement;
import com.seleniumtests.util.logging.ScenarioLogger;
import com.seleniumtests.util.logging.SeleniumRobotLogger;

/**
 * Base html page abstraction. Used by PageObject and WebPageSection
 */
public abstract class BasePage {

    protected WebDriver driver;
    private int explictWaitTimeout = SeleniumTestsContextManager.getThreadContext().getExplicitWaitTimeout();

	protected static final ScenarioLogger logger = ScenarioLogger.getScenarioLogger(BasePage.class);  // with this logger, information will be added in test step + logs
	protected static final Logger internalLogger = SeleniumRobotLogger.getLogger(BasePage.class);
    
    public Alert getAlert() {
    	new WebDriverWait(driver, Duration.ofSeconds(2)).until(ExpectedConditions.alertIsPresent());
        return driver.switchTo().alert();
    }

    public String getAlertText() {
    	Alert alert = getAlert();
        return alert.getText();
    }
 
    protected void assertCurrentPage(final boolean log) { }
    protected void assertCurrentPage(boolean log, HtmlElement pageIdentifierElement) { }

    public WebDriver getDriver() {
        return driver;
    }
    
    /**
     * For unit tests because in test scenarios, driver is already created on page initialization
     * @param driver
     */
	public void setDriver(WebDriver driver) {
		this.driver = driver;
	}

    public boolean isTextPresent(final String text) {
    	if (SeleniumTestsContextManager.isWebTest()) {
	        Assert.assertNotNull(text, "isTextPresent: text should not be null!");
	        
	        WebElement body;
	        try {
	        	body = driver.findElement(By.tagName("body"));
	        } catch (WebDriverException e) {
	        	return false;
	        }
	
	        return body.getText().contains(text);
    	}
        return false;
    }    

    /**
     * If current window is closed then use driver.switchTo.window(handle).
     *
     * @param   windowName
     */
    public final void selectWindow(final String windowName) {
    	
    	// app test are not compatible with window
        TestType testType = SeleniumTestsContextManager.getThreadContext().getTestType();
        if (testType.family() == TestType.APP && testType.isMobile()) {
            throw new ScenarioException("Mobile application are not compatible with Windows");
        }
    	
        if (windowName == null) {
        	driver.switchTo().defaultContent();
        } else {
        	driver.switchTo().window(windowName);
        }
    }

    /**
     * Wait for a condition
     * @param condition		condition available using ExpectedConditions
     * 						e.g: ExpectedConditions.presenceOfElementLocated(by)
     */
    public void waitForCondition(final ExpectedCondition condition) {
    	
    	WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(explictWaitTimeout));
    	wait.until(condition);
    }

	public Set getCurrentHandles() {
		return ((CustomEventFiringWebDriver)driver).getCurrentHandles();
	}
	



}