io.tapack.satisfy.pages.BaseWebPage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of satisfy-web-steps Show documentation
There is a newer version: 0.6.6
/*
 * Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Tapack Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Tapack Software is supplied to you by Tapack in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Tapack Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Tapack Software.
 *
 * Neither the name, trademarks, service marks or logos of Tapack may be used
 * to endorse or promote products derived from the Tapack Software without
 * specific prior written permission from Tapack.
 *
 * The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK
 * MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.tapack.io/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Tapack and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Tapack and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Tapack or visit www.tapack.io if you need additional
 * information or have any questions.
 */

package io.tapack.satisfy.pages;

import io.tapack.satisfy.props.WebProperty;
import io.tapack.satisfy.steps.spi.WebPage;
import net.thucydides.core.pages.PageObject;
import net.thucydides.core.webdriver.ThucydidesWebDriverSupport;
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.support.ui.ExpectedCondition;
import org.openqa.selenium.support.ui.ExpectedConditions;
import org.openqa.selenium.support.ui.WebDriverWait;

import static io.tapack.satisfy.props.SatisfyWebProperties
        .getSatisfyWebProperties;

public class BaseWebPage extends PageObject implements WebPage {

    public static final boolean AJAX_LOADER_ID_IS_DEFINED =
            getSatisfyWebProperties().isDefined(WebProperty.AJAX_LOADER_ID);
    public static final String AJAX_LOADER_ID = getSatisfyWebProperties()
            .getProperty(WebProperty.AJAX_LOADER_ID);
    public static final int TIME_OUT_IN_SECONDS = getSatisfyWebProperties()
            .getSatisfyWait();
    private static final long WAIT_FOR_ELEMENT_PAUSE_LENGTH = 50;

    public BaseWebPage() {
        super(ThucydidesWebDriverSupport.getDriver());
    }

    @Override
    public void waitAjaxIsFinished() {
        if (AJAX_LOADER_ID_IS_DEFINED) {
            doWait().until(ExpectedConditions.invisibilityOfElementLocated(By
                    .id(AJAX_LOADER_ID)));
        }
    }

    @Override
    public boolean accept() {
        return false;
    }

    /**
     * ID tokens must begin with a letter ([A-Za-z])
     * and may be followed by any number of letters,
     * digits ([0-9]), hyphens ("-"), underscores ("_"),
     * colons (":"), and periods (".").
     * As a purely practical matter, you may want to avoid certain characters.
     * Periods, colons and '#' have special meaning in CSS selectors.
     */
    @Override
    public By convertToSelector(String identity) {
        waitAjaxIsFinished();
        By selector = new By.ByCssSelector(identity);
        if (identity.matches("^[a-zA-Z][\\w_-]*$")) {
            selector = new By.ById(identity);
        } else if (identity.startsWith("/") || identity.startsWith("./")) {
            selector = new By.ByXPath(identity);
        }
        return selector;
    }

    @Override
    public Object evaluateJavascript(String script) {
        return ((JavascriptExecutor) getDriver()).executeScript(script);
    }

    @Override
    public void shouldBeVisible(By by) {
        doWait().until(ExpectedConditions.visibilityOfElementLocated(by));
    }

    @Override
    public void shouldNotBeVisible(By by) {
        doWait().until(ExpectedConditions.invisibilityOfElementLocated(by));
    }

    @Override
    public PageObject waitFor(ExpectedCondition expectedCondition) {
        doWait().until(expectedCondition);
        return this;
    }

    private WebDriverWait doWait() {
        return new WebDriverWait(getDriver(), TIME_OUT_IN_SECONDS,
                WAIT_FOR_ELEMENT_PAUSE_LENGTH);
    }

}