com.epam.jdi.uitests.mobile.appium.elements.BaseElement.java Source code

Introduction

Here is the source code for com.epam.jdi.uitests.mobile.appium.elements.BaseElement.java

Source

package com.epam.jdi.uitests.mobile.appium.elements;
/*
 * Copyright 2004-2016 EPAM Systems
 *
 * This file is part of JDI project.
 *
 * JDI is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JDI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with JDI. If not, see <http://www.gnu.org/licenses/>.
 */

import com.epam.commons.Timer;
import com.epam.jdi.uitests.core.annotations.functions.Functions;
import com.epam.jdi.uitests.core.interfaces.base.IAvatar;
import com.epam.jdi.uitests.core.interfaces.base.IBaseElement;
import com.epam.jdi.uitests.core.logger.LogLevels;
import com.epam.jdi.uitests.mobile.appium.elements.actions.ActionInvoker;
import com.epam.jdi.uitests.mobile.appium.elements.actions.ActionScenrios;
import com.epam.jdi.uitests.mobile.appium.elements.actions.ElementsActions;
import com.epam.jdi.uitests.mobile.appium.elements.apiInteract.GetElementModule;
import com.epam.jdi.uitests.mobile.appium.elements.pageobjects.annotations.AppiumAnnotationsUtil;
import com.epam.jdi.uitests.mobile.appium.elements.pageobjects.annotations.GetElement;
import org.openqa.selenium.By;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;

import java.lang.reflect.Field;
import java.text.MessageFormat;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import static com.epam.commons.ReflectionUtils.isClass;
import static com.epam.jdi.uitests.core.logger.LogLevels.INFO;
import static com.epam.jdi.uitests.core.settings.JDISettings.*;
import static com.epam.jdi.uitests.mobile.appium.driver.WebDriverByUtils.getByLocator;
import static java.lang.String.format;
import static java.util.concurrent.TimeUnit.MILLISECONDS;

/**
 * Created by Roman_Iovlev on 6/10/2015.
 */
public abstract class BaseElement implements IBaseElement {

    public static ActionScenrios actionScenrios = new ActionScenrios();
    public static BiConsumer<String, Consumer<String>> doActionRule = (text, action) -> {
        if (text == null)
            return;
        action.accept(text);
    };
    public static BiConsumer<String, Consumer<String>> setValueEmptyAction = (text, action) -> {
        if (text == null || text.equals(""))
            return;
        action.accept(text.equals("#CLEAR#") ? "" : text);
    };
    public Functions function = Functions.NONE;

    public void setFunction(Functions function) {
        this.function = function;
    }

    public GetElementModule avatar;
    public ActionInvoker invoker = new ActionInvoker(this);
    protected GetElement getElementClass = new GetElement(this);
    protected ElementsActions actions = new ElementsActions(this);
    private String name;
    private String varName;
    private String typeName;
    private Object parent;

    public BaseElement() {
        this(By.id("EMPTY"));
    }

    public BaseElement(By byLocator) {
        avatar = new GetElementModule(
                byLocator == null || getByLocator(byLocator).equals("EMPTY") ? null : byLocator, this);
    }

    public static void setActionScenarios(ActionScenrios actionScenrios) {
        BaseElement.actionScenrios = actionScenrios;
    }

    public static void setValueRule(String text, Consumer<String> action) {
        doActionRule.accept(text, action);
    }

    /**
     * @return Get Elements name
     */
    public String getName() {
        return name != null ? name : getTypeName();
    }

    public void setName(Field field) {
        this.name = AppiumAnnotationsUtil.getElementName(field);
        this.varName = field.getName();
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVarName() {
        return varName != null ? varName : getName();
    }

    protected Timer timer() {
        return avatar.timer();
    }

    protected JavascriptExecutor jsExecutor() {
        return (JavascriptExecutor) getDriver();
    }

    public boolean hasLocator() {
        return avatar.hasLocator();
    }

    /**
     * @return Get WebDriver associated with Element
     */
    public WebDriver getDriver() {
        return avatar.getDriver();
    }

    /**
     * @return Get Elements locator
     */
    public By getLocator() {
        return avatar.getLocator();
    }

    public GetElementModule getAvatar() {
        return avatar;
    }

    public BaseElement setAvatar(IAvatar avatar) {
        this.avatar = (GetElementModule) avatar.copy();
        return this;
    }

    public BaseElement setAvatar(By byLocator) {
        this.avatar = this.avatar.copy(byLocator);
        return this;
    }

    public BaseElement setAvatar(By byLocator, GetElementModule avatar) {
        this.avatar = avatar.copy(byLocator);
        return this;
    }

    public void setWaitTimeout(long mSeconds) {
        logger.debug("Set wait timeout to " + mSeconds);
        getDriver().manage().timeouts().implicitlyWait(mSeconds, MILLISECONDS);
        timeouts.setCurrentTimeoutSec((int) (mSeconds / 1000));
    }

    public void restoreWaitTimeout() {
        setWaitTimeout(timeouts.getDefaultTimeoutSec());
    }

    protected String getTypeName() {
        return (typeName != null) ? typeName : getClass().getSimpleName();
    }

    public void setTypeName(String typeName) {
        this.typeName = typeName;
    }

    protected String getParentName() {
        return parent == null ? "" : parent.getClass().getSimpleName();
    }

    public Object getParent() {
        return parent;
    }

    public String printContext() {
        By locator;
        BaseElement parent;
        String parentContext;
        return getParent() == null || !isClass(getParent().getClass(), BaseElement.class)
                || (locator = (parent = (BaseElement) getParent()).getLocator()) == null ? ""
                        : ((parentContext = parent.printContext()).equals("")) ? locator.toString()
                                : locator + "; " + parentContext;
    }

    public void setParent(Object parent) {
        this.parent = parent;
    }

    public void logAction(String actionName, LogLevels level) {
        toLog(format(shortLogMessagesFormat ? "%s for %s" : "Perform action '%s' with Element (%s)", actionName,
                this.toString()), level);
    }

    public void logAction(String actionName) {
        logAction(actionName, INFO);
    }

    @Override
    public String toString() {
        return MessageFormat.format(
                shortLogMessagesFormat ? "{1} ''{0}'' ({2}.{3}; {4})"
                        : "Name: ''{0}'', Type: ''{1}'' In: ''{2}'', {4}",
                getName(), getTypeName(), getParentName(), getVarName(), avatar);
    }
}