ca.nrc.cadc.search.integration.AbstractSearchFormPage.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.search.integration.AbstractSearchFormPage.java

Source

/*
 ************************************************************************
 *******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
 **************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
 *
 *  (c) 2016.                            (c) 2016.
 *  Government of Canada                 Gouvernement du Canada
 *  National Research Council            Conseil national de recherches
 *  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
 *  All rights reserved                  Tous droits rservs
 *
 *  NRC disclaims any warranties,        Le CNRC dnie toute garantie
 *  expressed, implied, or               nonce, implicite ou lgale,
 *  statutory, of any kind with          de quelque nature que ce
 *  respect to the software,             soit, concernant le logiciel,
 *  including without limitation         y compris sans restriction
 *  any warranty of merchantability      toute garantie de valeur
 *  or fitness for a particular          marchande ou de pertinence
 *  purpose. NRC shall not be            pour un usage particulier.
 *  liable in any event for any          Le CNRC ne pourra en aucun cas
 *  damages, whether direct or           tre tenu responsable de tout
 *  indirect, special or general,        dommage, direct ou indirect,
 *  consequential or incidental,         particulier ou gnral,
 *  arising from the use of the          accessoire ou fortuit, rsultant
 *  software.  Neither the name          de l'utilisation du logiciel. Ni
 *  of the National Research             le nom du Conseil National de
 *  Council of Canada nor the            Recherches du Canada ni les noms
 *  names of its contributors may        de ses  participants ne peuvent
 *  be used to endorse or promote        tre utiliss pour approuver ou
 *  products derived from this           promouvoir les produits drivs
 *  software without specific prior      de ce logiciel sans autorisation
 *  written permission.                  pralable et particulire
 *                                       par crit.
 *
 *  This file is part of the             Ce fichier fait partie du projet
 *  OpenCADC project.                    OpenCADC.
 *
 *  OpenCADC is free software:           OpenCADC est un logiciel libre ;
 *  you can redistribute it and/or       vous pouvez le redistribuer ou le
 *  modify it under the terms of         modifier suivant les termes de
 *  the GNU Affero General Public        la GNU Affero General Public
 *  License as published by the          License? telle que publie
 *  Free Software Foundation,            par la Free Software Foundation
 *  either version 3 of the              : soit la version 3 de cette
 *  License, or (at your option)         licence, soit ( votre gr)
 *  any later version.                   toute version ultrieure.
 *
 *  OpenCADC is distributed in the       OpenCADC est distribu
 *  hope that it will be useful,         dans lespoir quil vous
 *  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
 *  without even the implied             GARANTIE : sans mme la garantie
 *  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILIT
 *  or FITNESS FOR A PARTICULAR          ni dADQUATION  UN OBJECTIF
 *  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
 *  General Public License for           Gnrale Publique GNU Affero
 *  more details.                        pour plus de dtails.
 *
 *  You should have received             Vous devriez avoir reu une
 *  a copy of the GNU Affero             copie de la Licence Gnrale
 *  General Public License along         Publique GNU Affero avec
 *  with OpenCADC.  If not, see          OpenCADC ; si ce nest
 *  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
 *                                       <http://www.gnu.org/licenses/>.
 *
 *
 ************************************************************************
 */

package ca.nrc.cadc.search.integration;

import ca.nrc.cadc.web.selenium.AbstractTestWebPage;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;
import org.openqa.selenium.support.PageFactory;

import java.util.Objects;

abstract class AbstractSearchFormPage extends AbstractTestWebPage {
    private static final String CONTENT_LOCATOR_XPATH = "//*[@id='%s']/summary/label/span";
    private static final By TOP_RESET_BUTTON_BY = By.xpath("//*[@id=\"queryForm\"]/div[1]/button[@type=\"reset\"]");

    @FindBy(xpath = "//*[@id=\"queryForm\"]/div[1]/button[@type=\"submit\"]")
    WebElement topSubmitButton;

    AbstractSearchFormPage(final WebDriver driver) throws Exception {
        super(driver);

        waitForElementPresent(TOP_RESET_BUTTON_BY);
        waitForElementVisible(TOP_RESET_BUTTON_BY);
        PageFactory.initElements(driver, this);
    }

    AbstractSearchFormPage(WebDriver driver, int timeoutInSeconds) throws Exception {
        super(driver, timeoutInSeconds);

        waitForElementPresent(TOP_RESET_BUTTON_BY);
        waitForElementVisible(TOP_RESET_BUTTON_BY);
        PageFactory.initElements(driver, this);
    }

    void enterInputValue(final WebElement inputElement, final String value) throws Exception {
        final String inputID = inputElement.getAttribute("id");

        summonTooltip(inputID);
        showInputField(inputID);
        waitForElementVisible(inputElement);

        for (int i = 0; i < value.length(); i++) {
            inputElement.sendKeys(Character.toString(value.charAt(i)));
            waitFor(150L);
        }

        closeTooltip();
    }

    void clearInputValue(final String inputID) throws Exception {
        final WebElement inputElement = find(By.id(inputID));

        if (inputElement.isDisplayed()) {
            sendKeys(inputElement, "");
            hideInputField(inputID);
        } else {
            throw new IllegalStateException("Input element " + inputID + " is not displayed.");
        }
    }

    void verifyFormInputError(final String inputID) throws Exception {
        waitForElementPresent(
                By.xpath("//div[@id='" + inputID + "_input_decorate'][contains(@class,'has-error')]"));
    }

    void verifyFormInputMessage(final String inputID, final boolean errorExpected, final String expectedMessage)
            throws Exception {
        if (errorExpected) {
            verifyFormInputError(inputID);
        }

        final By contents = By.xpath(String.format(CONTENT_LOCATOR_XPATH, (inputID + "_details")));

        if (!Objects.equals(expectedMessage, "")) {
            waitForTextPresent(contents, expectedMessage);
        } else {
            WebElement contentEl = find(contents);
            if (!contentEl.getText().equals("")) {
                throw new Exception();
            }
        }
    }

    void verifyFormInputMessageMatches(final String inputID, final boolean errorExpected, final String messageRegex)
            throws Exception {
        if (errorExpected) {
            verifyFormInputError(inputID);
        }

        verifyTextMatches(By.xpath(String.format(CONTENT_LOCATOR_XPATH, (inputID + "_details"))), messageRegex);
    }

    void hideInputBox(final String inputID) throws Exception {
        click(By.xpath(String.format(CONTENT_LOCATOR_XPATH, (inputID + "_details"))));
        waitForElementInvisible(By.id(inputID));
    }

    void summonTooltip(final String baseID) throws Exception {
        final By tooltipIconTriggerBy = By.xpath("//div[@id='" + baseID + "_formgroup']/div");

        waitForElementPresent(tooltipIconTriggerBy);
        waitForElementVisible(tooltipIconTriggerBy);

        click(tooltipIconTriggerBy);

        waitForElementPresent(By.xpath("//div[@id='" + baseID + "_formgroup']/div[2]"));
        waitForElementVisible(By.xpath("//div[@id='" + baseID + "_formgroup']/div[2]"));
    }

    void closeTooltip() throws Exception {
        final By tooltipCloseLink = By.xpath("//*[contains(@class, 'glyphicon-remove-circle')]");
        waitForElementPresent(tooltipCloseLink);
        final WebElement tooltipClose = find(tooltipCloseLink);
        click(tooltipClose);
    }

    /**
     * Ensure the field is open.
     *
     * @param inputID The String ID locator.
     * @throws Exception Any error.
     */
    void showInputField(final String inputID) throws Exception {
        final WebElement element = find(By.id(inputID + "_details"));

        if (!find(By.id(inputID)).isDisplayed()) {
            // show the input box
            click(element);
        }
    }

    /**
     * Ensure the field is open.
     *
     * @param inputID The String ID locator.
     * @throws Exception Any error.
     */
    void hideInputField(final String inputID) throws Exception {
        final WebElement element = find(By.id(inputID + "_details"));

        if (find(By.id(inputID)).isDisplayed()) {
            // show the input box
            click(element);
        }
    }

    SearchResultsPage submitSuccess() throws Exception {
        click(topSubmitButton);

        return new SearchResultsPage(driver);
    }

    void reset() throws Exception {
        click(TOP_RESET_BUTTON_BY);
        waitForMAQToggleReset();
    }

    abstract void waitForMAQToggleReset() throws Exception;
}