de.ppi.selenium.assertj.ElementAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webtest Show documentation
Some additional helper for webtesting with selenium
There is a newer version: 0.12
/**
 * 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 de.ppi.selenium.assertj;

import org.assertj.core.api.AbstractAssert;
import org.selophane.elements.base.Element;

import de.ppi.selenium.util.CSSHelper;

/**
 * Asserts for {@link Element}.
 *
 */
public class ElementAssert extends AbstractAssert {

    /**
     *
     * Initiates an object of type ElementAssert.
     *
     * @param actual the current object.
     */
    public ElementAssert(Element actual) {
        super(actual, ElementAssert.class);
    }

    /**
     * Fail if the object is enabled.
     */
    private void failIsEnabled() {
        super.failWithMessage("Object not enabled");
    }

    /**
     * Fail if the object is not enabled.
     */
    private void failIsNotEnabled() {
        super.failWithMessage("Object is enabled");
    }

    /**
     * check if the element is enabled.
     *
     * @return self
     */
    public ElementAssert isEnabled() {
        if (!actual.isEnabled()) {
            failIsEnabled();
        }
        return this;
    }

    /**
     * check if the element is not enabled.
     *
     * @return self
     */
    public ElementAssert isNotEnabled() {
        if (actual.isEnabled()) {
            failIsNotEnabled();
        }
        return this;
    }

    /**
     * check if the element is displayed.
     *
     * @return self.
     */
    public ElementAssert isDisplayed() {
        if (!actual.isDisplayed()) {
            super.failWithMessage("Object is displayed");
        }

        return this;
    }

    /**
     * check if the element is not displayed.
     *
     * @return self
     */
    public ElementAssert isNotDisplayed() {
        if (actual.isDisplayed()) {
            super.failWithMessage("Object not displayed");
        }
        return this;
    }

    /**
     * check if the element is selected.
     *
     * @return self
     */
    public ElementAssert isSelected() {
        if (!actual.isSelected()) {
            super.failWithMessage("Object not selected");
        }
        return this;
    }

    /**
     * check if the element is not selected.
     *
     * @return self
     */
    public ElementAssert isNotSelected() {
        if (actual.isSelected()) {
            super.failWithMessage("Object is selected");
        }
        return this;
    }

    /**
     * check if the element contains the text.
     *
     * @param textToFind the text which should be found.
     *
     * @return self
     */
    public ElementAssert hasText(String textToFind) {
        if (!actual.getText().contains(textToFind)) {
            super.failWithMessage("The element does not contain the text: "
                    + textToFind + " . Actual text found : " + actual.getText());

        }

        return this;
    }

    /**
     * check if the element matches the given regex.
     *
     * @param regexToBeMatched the text which should be found as regeexp.
     * @return self
     */
    public ElementAssert hasTextMatching(String regexToBeMatched) {
        if (!actual.getText().matches(regexToBeMatched)) {
            super.failWithMessage("The element does not match the regex: "
                    + regexToBeMatched + " . Actual text found : "
                    + actual.getText());

        }

        return this;
    }

    /**
     * check if the element does not contain the text.
     *
     * @param textToFind the text which should be found.
     * @return self
     */
    public ElementAssert hasNotText(String textToFind) {
        if (actual.getText().contains(textToFind)) {
            super.failWithMessage("The element contain the text: " + textToFind);
        }

        return this;
    }

    /**
     * check if the element has the given id.
     *
     * @param id to check
     * @return self
     */
    public ElementAssert hasId(String id) {
        if (!actual.getAttribute("id").equals(id)) {
            super.failWithMessage("The element does not have the id: " + id
                    + " . Actual id found : " + actual.getAttribute("id"));
        }
        return this;
    }

    /**
     * check if the element has the not the class.
     *
     * @param classToFind the css-class which should not be found.
     * @return self
     */
    public ElementAssert hasNotClass(String classToFind) {
        if (CSSHelper.getClasses(actual).contains(classToFind)) {
            super.failWithMessage("The element has the class: " + classToFind
                    + " . Actual class found : " + actual.getAttribute("class"));
        }
        return this;
    }

    /**
     * check if the element has the class.
     *
     * @param classToFind the css-class which should be found.
     * @return this
     */
    public ElementAssert hasClass(String classToFind) {
        if (!CSSHelper.getClasses(actual).contains(classToFind)) {
            super.failWithMessage("The element does not have the class: "
                    + classToFind + " . Actual class found : "
                    + actual.getAttribute("class"));
        }
        return this;
    }

}