com.github.arachnidium.model.common.FunctionalPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arachnidium-app-model Show documentation
There is a newer version: 0.9.9.9-BETA
Show newest version
/**
 *
 */
package com.github.arachnidium.model.common;

import io.appium.java_client.pagefactory.AppiumFieldDecorator;

import java.awt.Color;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;

import com.github.arachnidium.util.logging.Log;
import com.github.arachnidium.util.logging.eLogColors;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.PageFactory;
import org.openqa.selenium.support.pagefactory.ElementLocatorFactory;
import org.openqa.selenium.support.pagefactory.FieldDecorator;

import com.github.arachnidium.core.BrowserWindow;
import com.github.arachnidium.core.Handle;
import com.github.arachnidium.core.HowToGetBrowserWindow;
import com.github.arachnidium.core.HowToGetMobileScreen;
import com.github.arachnidium.core.MobileScreen;
import com.github.arachnidium.core.components.common.Ime;
import com.github.arachnidium.core.components.common.ScriptExecutor;
import com.github.arachnidium.core.components.common.TimeOut;
import com.github.arachnidium.core.fluenthandle.IHowToGetHandle;
import com.github.arachnidium.core.highlighting.IWebElementHighlighter;
import com.github.arachnidium.core.highlighting.WebElementHighLighter;
import com.github.arachnidium.core.interfaces.ISwitchesToItself;
import com.github.arachnidium.core.interfaces.ITakesPictureOfItSelf;
import com.github.arachnidium.model.abstractions.ModelObject;
import com.github.arachnidium.model.interfaces.IDecomposable;
import com.github.arachnidium.model.support.HowToGetByFrames;

/**
 *This class is for description of browser or mobile UI or the fragment 
 *of this UI. It is assumed that this description can be reusable.
 *
 *Interaction and behavior should describe subclasses of this. 
 *
 */
public abstract class FunctionalPart extends ModelObject implements ITakesPictureOfItSelf, ISwitchesToItself {

	/**
	 * This is used when general time out is not suitable
	 * for method that performs interaction. Defined time
	 * out will be applied before method is invoked.
	 * 
	 * This annotation is ignored when {@link InteractiveMethod} is
	 * not present.
	 */
	@Target(value = ElementType.METHOD)
	@Retention(value = RetentionPolicy.RUNTIME)	
	protected static @interface WithImplicitlyWait {
		/**
		 * @return customized value of timeout
		 */
		long timeOut();
		/**
		 * @return customized time unit
		 */
		TimeUnit timeUnit() default TimeUnit.SECONDS;
	}

	/**
	 *This annotation is useful 
	 *when there is need to interact with more
	 *than one browser window/mobile context
	 *at the same time. Also it is convenient
	 *when described UI is inside frame
	 *
	 *The presence of this annotation means
	 *that {@link WebDriver} will be switched
	 *to window/context and to frame automatically 
	 */
	@Target(value = ElementType.METHOD)
	@Retention(value = RetentionPolicy.RUNTIME)
	protected static @interface InteractiveMethod {

	}

	FunctionalPart parent; // parent test object
	// parent application
	protected Application application;
	protected final Ime ime;
	private final HowToGetByFrames pathStrategy;
	private final AppiumFieldDecorator defaultFieldDecorator;
	private final TimeOut timeOut;
	protected final ScriptExecutor scriptExecutor; //executes given javaScript

	/**
	 * This constructor should present 
	 * when an instance of the class is going to
	 * be got from another.

	 * 

	 * This instantiation means that described specific UI or the fragment is 
	 * on the same window/mobile context and inside the same frame (it is
     * actual for browser and mobile hybrid apps) as the more generalized "parent".
	 * 
	 *@example
	 *someUIDescriptionInstance.getPart(someUIDescription.class)

	 *

	 *someUIDescription.class should have this constructor 
	 * 
	 *@param parent is considered as a more general UI or the part of client UI
	 *
	 *@see IDecomposable#getPart(Class)
	 */
	@SuppressWarnings("unchecked")
	protected FunctionalPart(FunctionalPart parent) {
		this((S) parent.handle, new HowToGetByFrames());
	}
	
	/**
	 * This constructor should present 
	 * when an instance of the class is going to
	 * be got from another.

	 * 

	 * This instantiation means that described specific UI or the fragment is 
	 * on the same window/mobile context and inside the same frame (it is
     * actual for browser and mobile hybrid apps) as the more generalized "parent".
	 * 

	 * 

     *The described piece of UI is inside frame (it is
     * actual for browser and mobile hybrid apps).
	 *Path to desired frame is specified by {@link HowToGetByFrames}
	 *instance. 

	 *
	 *@example
	 *someUIDescriptionInstance.getPart(someUIDescription.class, howToGetByFrameInstance);

	 *

	 *someUIDescription.class should have this constructor 
	 * 
	 *@param parent is considered as a more general UI or the part of client UI
	 *@param path is a path to frame which is specified by {@link HowToGetByFrames}
	 *
	 *@see IDecomposable#getPart(Class, HowToGetByFrames)
	 *
	 *@see HowToGetByFrames
	 */	
	@SuppressWarnings("unchecked")
	protected FunctionalPart(FunctionalPart parent, HowToGetByFrames path) {
		this((S) parent.handle, path);
		parent.addChild(this);
	}

	/**
	 * This constructor should present 
	 * when an instance of the class is going to
	 * be got from the given {@link Handle} e.g. browser window
	 * or mobile context. 
	 *
	 *It is expected that this is the
	 *most frequently used case. 
	 *
	 *@param handle is the given browser window
	 *or mobile context
	 *
	 *@example
	 *applicationInstance.getPart(someUIDescription.class);

	 *applicationInstance.getPart(someUIDescription.class, windowOrContextIndex);

	 *applicationInstance.getPart(someUIDescription.class, howToGetBrowserWindowInstance);

	 *and so on
	 *

	 *someUIDescription.class should have this constructor 
	 *
	 *@see Application
	 *@see IHowToGetHandle
	 *@see HowToGetBrowserWindow
	 *@see HowToGetMobileScreen
	 *@see Handle
	 *@see BrowserWindow
	 *@see MobileScreen
	 */
	protected FunctionalPart(S handle) {
		this(handle, new HowToGetByFrames());
	}

	/**
     * This constructor should present 
	 * when an instance of the class is going to
	 * be got from the given browser window
	 * or mobile context.
 
	 *
 
     *The described piece of UI is inside frame (it is
     * actual for browser and mobile hybrid apps).
	 *Path to desired frame is specified by {@link HowToGetByFrames}
	 *instance. 

	 *
	 *@param handle is the given browser window
	 *or mobile context
	 *
	 *@param path is a path to frame which is specified by {@link HowToGetByFrames}
	 *
	 *@see HowToGetByFrames	
	*/
	protected FunctionalPart(S handle, HowToGetByFrames path) {
		super(handle);
		timeOut = getWebDriverEncapsulation().getTimeOut();
		defaultFieldDecorator = new AppiumFieldDecorator(getWrappedDriver(), 
				timeOut.getImplicitlyWaitTimeOut(), timeOut.getImplicitlyWaitTimeUnit());
		this.pathStrategy = path;
		ime =            getComponent(Ime.class);
		scriptExecutor = getComponent(ScriptExecutor.class);
	}

	/**
	 *@see com.github.arachnidium.model.abstractions.ModelObject#addChild(com.github.arachnidium.model.abstractions.ModelObject)
	 */
	@Override
	protected final void addChild(ModelObject child) {
		super.addChild(child);
		FunctionalPart childPart = (FunctionalPart) child;
		childPart.parent = this;
		childPart.application = this.application;
	}

	/**
	 *this method 
	 *starts destruction of related
	 *information
	 */
	@Override
	public void destroy() {
		if (!handle.exists())
			handle.destroy();
		super.destroy();
		return;
	}

    /**
     *This method returns another UI description (child).
     *It is assumed that current UI is more generalized and the
     *child is more specific. 
     *
     *It means, that required UI or fragment of UI 
     *is on the same browser window/mobile screen as the
     *current. Also "child" is inside the same frame as the
     *current (it is actual for browser and mobile hybrid apps). 
     *
     *@see com.github.arachnidium.model.abstractions.ModelObject#getPart(java.lang.Class)
     *
     *@see IDecomposable#getPart(Class)
     */
	@Override
	public  T getPart(Class partClass) {
		Object[] values = new Object[] { this };
		return DefaultApplicationFactory.get(partClass, values);
	}

	/**
     *This method returns another UI description (child).
     *It is assumed that current UI is more generalized and the
     *child is more specific. 
     *
     *It means, that required UI or fragment of UI 
     *is on the same browser window/mobile screen as the
     *current. Also "child" is inside the same frame as the
     *current (it is actual for browser and mobile hybrid apps). 

     *

     *The child is in enclosed frame. 
     *Frames are actual for browser and mobile hybrid apps.
	 *
	 *@see com.github.arachnidium.model.abstractions.ModelObject#getPart(Class, HowToGetByFrames)
	 *
	 *@see IDecomposable#getPart(Class, HowToGetByFrames)
	 *
	 *@see HowToGetByFrames
	 */
	@Override
	public  T getPart(Class partClass,
			HowToGetByFrames pathStrategy) {
		Object[] values = new Object[] { this, pathStrategy };
		return DefaultApplicationFactory.get(partClass, values);
	}

	private IWebElementHighlighter getHighlighter(){
		WebElementHighLighter highLighter = new WebElementHighLighter();
		highLighter.resetAccordingTo(getWebDriverEncapsulation().
				getWrappedConfiguration());
		return highLighter;
	}
	
	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#FINE} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *@param element to be highlighted
	 *@param highlight is an used color
	 *@param comment is a narrative message text
	 */
	@InteractiveMethod
	public void highlightAsFine(WebElement element, Color highlight,
			String comment) {
		getHighlighter().highlightAsFine(getWrappedDriver(),
				element, highlight, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#FINE} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *{@link eLogColors#DEBUGCOLOR} is used.
	 *
	 *@param element to be highlighted
	 *@param comment is a narrative message text
	 */	
	@InteractiveMethod
	public void highlightAsFine(WebElement element, String comment) {
		getHighlighter().highlightAsFine(getWrappedDriver(),
				element, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#INFO} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *@param element to be highlighted
	 *@param highlight is an used color
	 *@param comment is a narrative message text
	 */	
	@InteractiveMethod
	public void highlightAsInfo(WebElement element, Color highlight,
			String comment) {
		getHighlighter().highlightAsInfo(getWrappedDriver(),
				element, highlight, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#INFO} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *{@link eLogColors#CORRECTSTATECOLOR} is used.
	 *
	 *@param element to be highlighted
	 *@param comment is a narrative message text
	 */		
	@InteractiveMethod
	public void highlightAsInfo(WebElement element, String comment) {
		getHighlighter().highlightAsInfo(getWrappedDriver(),
				element, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#SEVERE} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *@param element to be highlighted
	 *@param highlight is an used color
	 *@param comment is a narrative message text
	 */		
	@InteractiveMethod
	public void highlightAsSevere(WebElement element, Color highlight,
			String comment) {
		getHighlighter().highlightAsSevere(getWrappedDriver(),
				element, highlight, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#SEVERE} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *{@link eLogColors#SEVERESTATECOLOR} is used.
	 *
	 *@param element to be highlighted
	 *@param comment is a narrative message text
	 */		
	@InteractiveMethod
	public void highlightAsSevere(WebElement element, String comment) {
		getHighlighter().highlightAsSevere(getWrappedDriver(),
				element, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#WARNING} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *@param element to be highlighted
	 *@param highlight is an used color
	 *@param comment is a narrative message text
	 */		
	@InteractiveMethod
	public void highlightAsWarning(WebElement element, Color highlight,
			String comment) {
		getHighlighter().highlightAsWarning(getWrappedDriver(),
				element, highlight, comment);
	}

	/**
	 *Highlights HTML element by given color, creates 
	 *{@link Log} message with {@link Level#WARNING} and narrative
	 *text, optionally takes a screen shot and attaches to {@link Log} 
	 *
	 *{@link eLogColors#WARNSTATECOLOR} is used.
	 *
	 *@param element to be highlighted
	 *@param comment is a narrative message text
	 */		
	@InteractiveMethod
	public void highlightAsWarning(WebElement element, String comment) {
		getHighlighter().highlightAsWarning(getWrappedDriver(),
				element, comment);
	}

	/**
	 *Instantiates declared {@link WebElement} fields
	 *using {@link PageFactory} and {@link AppiumFieldDecorator}
	 */
	protected void load() {
		PageFactory.initElements(defaultFieldDecorator, this);
	}

	/**
	 *Instantiates declared {@link WebElement} fields
	 *using {@link PageFactory} and customized 
	 *{@link FieldDecorator}
	 *
	 *@param decorator is an instance of the customized
	 *{@link FieldDecorator}
	 */
	protected void load(FieldDecorator decorator) {
		PageFactory.initElements(decorator, this);
	}

	/**
	 * Instantiates declared {@link WebElement} fields
	 *using {@link PageFactory} and customized 
	 *{@link ElementLocatorFactory}
	 *
	 *@param factoryis an instance of the customized
	 *{@link ElementLocatorFactory}
	 */
	protected void load(ElementLocatorFactory factory) {
		PageFactory.initElements(factory, this);
	}

	/**
	 *Performs focus on the described UI.
	 *
	 *First of all it performs the switching to the window/mobile 
	 *context where UI is existing now.
	 *If described UI is inside frame this method
	 *performs switching from one frame to another
	 */
	@Override
	public synchronized void switchToMe() {
		// firstly we should switch parent browser window on
		if (parent != null)
			parent.switchToMe();
		else
			handle.switchToMe();
		pathStrategy.switchTo(getWrappedDriver());
		return;
	}

	/**
	 *takes screenshots and attaches it to
	 *log messages. {@link Level#FINE}
	 *
	 *@see com.github.arachnidium.core.interfaces.ITakesPictureOfItSelf#takeAPictureOfAFine(java.lang.String)
	 */
	@Override
	public void takeAPictureOfAFine(String comment) {
		handle.takeAPictureOfAFine(comment);
	}

	/**
	 *takes screenshots and attache it to
	 *log messages. {@link Level#INFO}
	 *
	 *@see com.github.arachnidium.core.interfaces.ITakesPictureOfItSelf#takeAPictureOfAnInfo(java.lang.String)
	 */
	@Override
	public void takeAPictureOfAnInfo(String comment) {
		handle.takeAPictureOfAnInfo(comment);
	}

	/**
	 *takes screenshots and attache it to
	 *log messages. {@link Level#SEVERE}
	 *
	 *@see com.github.arachnidium.core.interfaces.ITakesPictureOfItSelf#takeAPictureOfAnInfo(java.lang.String)
	 */
	@Override
	public void takeAPictureOfASevere(String comment) {
		handle.takeAPictureOfASevere(comment);
	}

	/**
	 *takes screenshots and attache it to
	 *log messages. {@link Level#WARNING}
	 *
	 *@see com.github.arachnidium.core.interfaces.ITakesPictureOfItSelf#takeAPictureOfAnInfo(java.lang.String)
	 */
	@Override
	public void takeAPictureOfAWarning(String comment) {
		handle.takeAPictureOfAWarning(comment);
	}
	
	/**
	 *@return An instance of the current {@link Application} 
	 */
	public Application getApplication(){
		return application;
	}
	
	TimeOut getTimeOut() {
		if (timeOut == null) {
			return getWebDriverEncapsulation().getTimeOut();
		}
		return timeOut;
	}

	AppiumFieldDecorator getDefaultFieldDecorator() {
		if (defaultFieldDecorator == null) {
			return new AppiumFieldDecorator(getWebDriverEncapsulation()
					.getWrappedDriver());
		}
		return defaultFieldDecorator;
	}
}