co.verisoft.fw.pages.BasePage Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 co.verisoft.fw.pages;


import co.verisoft.fw.objectrepository.ObjectReporsitoryFactory;
import co.verisoft.fw.objectrepository.ObjectRepository;
import co.verisoft.fw.selenium.drivers.VerisoftMobileDriver;
import co.verisoft.fw.utils.Property;
import co.verisoft.fw.utils.Waits;
import io.appium.java_client.android.AndroidDriver;
import io.appium.java_client.ios.IOSDriver;
import io.appium.java_client.pagefactory.AppiumFieldDecorator;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.openqa.selenium.By;
import org.openqa.selenium.Platform;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.PageFactory;


import java.util.Arrays;
import java.util.Properties;


/**
 * Represent base page for WebDriver interface (Web, mobile, client - server)
 * This class contains the basic common functionality shared by all pages
 *
 * @author David Yehezkel
 * 30 Mar 2020
 */
@ToString
@Slf4j
public abstract class BasePage {

    protected WebDriver driver;
    protected final int timeOut;
    protected final int pollingInterval;
    protected ObjectRepository repository;


    /**
     * C-tor. Initializes generic properties such as timeOut and pollingInterval
     *
     * @param driver a WebDriver object to store and use
     */
    public BasePage(WebDriver driver) {
        Property prop = new Property();
        timeOut = prop.getIntProperty("selenium.wait.timeout");
        pollingInterval = prop.getIntProperty("polling.interval");
        this.driver = driver;
        initElementsPageFactory(driver);
        ObjectReporsitoryFactory.initObjects(driver, this, getRepositoryPath());
    }

    /**
     * C-tor. Initializes generic properties such as timeOut and pollingInterval
     *
     * @param driver a WebDriver object to store and use
     * @param objectRepositoryFilePath a custom path to the object repository file
     */
    public BasePage(WebDriver driver, String objectRepositoryFilePath) {
        Property prop = new Property();
        timeOut = prop.getIntProperty("selenium.wait.timeout");
        pollingInterval = prop.getIntProperty("polling.interval");
        this.driver = driver;
        initElementsPageFactory(driver);
        ObjectReporsitoryFactory.initObjects(driver, this, objectRepositoryFilePath);
    }

    /**
     * A method that reads the object repository path from the projects "root.config.properties" file
     * If the property is not found, it reads the object repository from the default property file "defaults.config.properties" from inside the package.
     * @return String objectRepositoryPath.
     */
    private String getRepositoryPath() {
        Property root_prop = new Property();
        String objectRepositoryPath = root_prop.getProperty("object.repository.path");

        if (null == objectRepositoryPath) {
            Properties default_prop = new Properties();
            try {
                default_prop.load(Property.class.getClassLoader().getResourceAsStream("default.config.properties"));
                objectRepositoryPath = default_prop.getProperty("object.repository.path");
            } catch (Throwable e) {
                throw new RuntimeException("Could not initialize property file. " + e);
            }
        }
        return objectRepositoryPath;
    }

    private void initElementsPageFactory(WebDriver driver) {
        if (driver instanceof VerisoftMobileDriver) {
            if (((VerisoftMobileDriver) driver).getCapabilities().getPlatformName().equals(Platform.ANDROID)) {
                AndroidDriver androidDriver = ((VerisoftMobileDriver) driver).getAndroidDriver();
                PageFactory.initElements(new AppiumFieldDecorator(androidDriver), this);
            } else if (((VerisoftMobileDriver) driver).getCapabilities().getPlatformName().equals(Platform.IOS)) {
                IOSDriver iosDriver = ((VerisoftMobileDriver) driver).getIOSDriver();
                PageFactory.initElements(new AppiumFieldDecorator(iosDriver), this);
            }
        } else {
            PageFactory.initElements(driver, this);
        }
    }


    /**
     * This is a default implementation of isOnPage.
     * It receives one or more WebElements and checks if they are present
     *
     * @param elements One or more WebElements to check for presence
     * @return true- all elements specified were present, false - otherwise
     */
    public boolean isOnPage(WebElement... elements) {
        try {
            Waits.visibilityOfAllElements(driver, timeOut, elements);
            log.info("elements " + Arrays.toString(elements) + "was present on page");
            return true;
        } catch (Exception e) {
            log.info("elements " + Arrays.toString(elements) + "wasn't present on page");
            return false;
        }
    }

    /**
     * This is a another implementation of isOnPage.
     * It receives a locator and checks if all the WebElements located by this locator are present
     *
     * @param locator By parameter to check for presence
     * @return true- all elements specified were present, false - otherwise
     */
    public boolean isOnPage(By locator) {
        try {
            Waits.visibilityOfAllElementsLocatedBy(driver, timeOut, locator);
            log.info("elements " + locator + " was present on page");
            return true;
        } catch (Exception e) {
            log.info("elements " + locator + " wasn't present on page");
            return false;
        }
    }


    /**
     * check if the main page url contains the text
     *
     * @param fraction part of url to be search for
     * @return true if text contains false otherwise
     */
    public boolean urlContains(String fraction) {
        try {
            Waits.urlContains(driver, timeOut / 10, fraction);
            return true;
        } catch (Exception e) {
            log.debug("url: " + driver.getCurrentUrl() + " not contains " + fraction);
            return false;
        }
    }


    /**
     * Checks if driver is on page
     *
     * @return true- all elements specified were present, false - otherwise
     */
    public abstract boolean isOnPage();

}