com.ats.element.FoundElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ats-automated-testing Show documentation
Code generator library to create and execute GUI automated tests
The newest version!
/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you 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 com.ats.element;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import org.openqa.selenium.OutputType;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.openqa.selenium.remote.RemoteWebElement;

import com.ats.data.Rectangle;
import com.ats.element.api.AtsApiElement;
import com.ats.element.test.TestElement;
import com.ats.element.test.TestElementRecord;
import com.ats.executor.TestBound;
import com.ats.executor.channels.Channel;
import com.ats.executor.drivers.desktop.DesktopElement;
import com.ats.executor.drivers.desktop.DesktopWindow;
import com.ats.executor.drivers.engines.WebDriverEngine;
import com.ats.generator.variables.CalculatedProperty;
import com.fasterxml.jackson.databind.JsonNode;

public class FoundElement{

	private String id;

	private Double x = 0.0;
	private Double y = 0.0;

	private Double screenX = 0.0;
	private Double screenY = 0.0;

	private Double innerX = 0.0;
	private Double innerY = 0.0;

	private Double boundX = 0.0;
	private Double boundY = 0.0;

	private Double width = 0.0;
	private Double height = 0.0;

	private int centerWidth = 0;
	private int centerHeight = 0;

	private String tag = "*";
	private boolean shadowRoot = false;

	private String type = Channel.HTML;

	private RemoteWebElement value;
	private FoundElement parent;
	private boolean visible = true;
	private boolean numeric = false;
	private boolean password = false;
	private boolean clickable = true;
	private ArrayList children;

	private boolean active = true;

	private ArrayList iframes;

	private Map attributes;

	private String innerText = null;

	//------------------------------------------------------------------------------------------------------------------------------
	// contructors
	//------------------------------------------------------------------------------------------------------------------------------

	public FoundElement() {}

	public FoundElement(Channel channel) {
		final RemoteWebElement root = (RemoteWebElement) channel.getRootElement();
		if (root != null) {
			this.setRemoteWebElement(root);
			this.width = (double) root.getSize().getWidth(); //channel.getDimension().getWidth();
			this.height = (double) root.getSize().getHeight(); //channel.getDimension().getHeight();
		}
	}
	
	public FoundElement(Channel channel, String tagName, RemoteWebElement elem) { // Shadow dom
		try {
			this.width = (double) elem.getSize().getWidth(); //channel.getDimension().getWidth();
			this.height = (double) elem.getSize().getHeight(); //channel.getDimension().getHeight();
			this.x = (double) elem.getRect().getX() + channel.getSubDimension().getX();
			this.y = (double) elem.getRect().getY() + channel.getSubDimension().getY();
			this.screenX = this.x;
			this.screenY = this.y;
		}catch(Exception e) {}

		this.setTag(tagName);
		this.setRemoteWebElement(elem);
	}

	public FoundElement(RemoteWebElement elem) { // Shadow dom
		String tagName = "shadowroot";
		try {
			tagName = elem.getTagName();
			this.width = (double) elem.getSize().getWidth(); //channel.getDimension().getWidth();
			this.height = (double) elem.getSize().getHeight(); //channel.getDimension().getHeight();
		}catch(Exception e) {

		}

		this.setTag(tagName);
		this.setRemoteWebElement(elem);
		this.setShadowRoot(true);
	}

	public FoundElement(AtsElement element) {
		this.setRemoteWebElement(element.getElement());
		this.tag = element.getTag();
		this.width = element.getWidth();
		this.height = element.getHeight();
		this.numeric = element.isNumeric();
		this.password = element.isPassword();
		this.shadowRoot = element.isShadowRoot();
	}

	public FoundElement(DesktopElement element) {
		this.setRemoteWebElement(element.getElement());
		this.tag = element.getTag();
		this.width = element.getWidth();
		this.height = element.getHeight();
		this.x = element.getX();
		this.y = element.getY();
		this.screenX = element.getX();
		this.screenY = element.getY();
	}

	public FoundElement(DesktopWindow win) {
		this.id = win.getId();
		this.tag = win.getTag();
		this.width = win.getWidth();
		this.height = win.getHeight();
	}

	public FoundElement(AtsElement element, Channel channel, Double offsetX, Double offsetY) {

		this(element);

		final Double elemX = element.getX();
		final Double elemY = element.getY();

		this.updatePosition(elemX, elemY, channel, offsetX, offsetY);
		this.screenX = element.getScreenX() + elemX;
		this.screenY = element.getScreenY() + elemY;
		this.boundX = element.getBoundX();
		this.boundY = element.getBoundY();
	}

	public FoundElement(AtsElement element, ArrayList iframes, Channel channel, Double offsetX, Double offsetY) {
		this(element, channel, offsetX, offsetY);
		this.iframes = iframes;
	}

	public FoundElement(WebDriverEngine engine, AtsElement element, Channel channel, Double offsetX, Double offsetY, boolean waitAnimation) {
		this(element, channel, offsetX, offsetY);

		if(waitAnimation && element.getElement().isDisplayed()) {
			int maxTry = 5;
			while((this.width < 1 || this.height < 1) && maxTry > 0) {

				final List rect = engine.getBoundingClientRect(element.getElement());

				final Double rectX = rect.get(0);
				final Double rectY = rect.get(1);
				final Double rectW = rect.get(2);
				final Double rectH = rect.get(3);

				if(rectX != null && rectY != null && rectW != null && rectH != null && rectW >= 1 && rectH >=1) {
					this.x = rectX;
					this.y = rectY;
					this.boundX = rectX;
					this.boundY = rectY;
					this.width = rectW;
					this.height = rectH;
				}else {
					channel.sleep(100);
				}
				maxTry--;
			}
		}
	}

	public FoundElement(List desktops) {

		final AtsElement desktop = desktops.get(0);

		this.type = Channel.DESKTOP;
		this.visible = true;
		this.id = desktop.getId();

		this.password = false;

		this.tag = desktop.getTag();
		this.width = desktop.getWidth();
		this.height = desktop.getHeight();

		this.clickable = true;

		this.active = true;

		this.screenX = desktop.getX();
		this.screenY = desktop.getY();

		this.x = this.screenX;
		this.y = this.screenY;
	}

	public FoundElement(AtsElement element, TestBound channelDimension) {

		this.type = Channel.DESKTOP;
		this.visible = element.isVisible();
		this.id = element.getId();

		this.password = element.isPassword();

		this.tag = element.getTag();
		this.width = element.getWidth();
		this.height = element.getHeight();

		this.clickable = element.isClickable();

		this.active = this.clickable && this.visible;

		this.screenX = element.getX();
		this.screenY = element.getY();

		this.x = this.screenX - channelDimension.getX();
		this.y = this.screenY - channelDimension.getY();

		if(element.getChildren() != null) {
			this.children = element.getChildren().stream().map(e -> new FoundElement(e, channelDimension)).collect(Collectors.toCollection(ArrayList::new));
		}

		this.attributes = element.getAttributesMap();
	}

	public FoundElement(AtsSapElement element) {

		this.type = Channel.SAP;
		this.id = element.getId();

		this.tag = element.getTag();
		this.width = element.getWidth();
		this.height = element.getHeight();

		this.x = element.getX();
		this.y = element.getY();

		this.screenX = element.getScreenX();
		this.screenY = element.getScreenY();

		this.innerText = element.getInnerText();
	}

	public FoundElement(double channelX, double channelY, JsonNode node) {

		this.type = Channel.SAP;
		this.id = getNodeText(node, AtsSapElement.ID);

		this.tag = getNodeText(node, AtsSapElement.TAG);
		this.width = getNodeDouble(node, AtsSapElement.WIDTH);
		this.height = getNodeDouble(node, AtsSapElement.HEIGHT);

		this.visible = true;
		this.clickable = true;

		this.active = this.clickable && this.visible;

		this.screenX = getNodeDouble(node, AtsSapElement.SCREEN_X);
		this.screenY = getNodeDouble(node, AtsSapElement.SCREEN_Y);

		this.x = this.screenX - channelX;
		this.y = this.screenY - channelY;
	}

	private String getNodeText(JsonNode node, String attribute) {
		if(node.has(attribute)) {
			return node.get(attribute).asText();
		}
		return "";
	}

	private Double getNodeDouble(JsonNode node, String attribute) {
		if(node.has(attribute)) {
			return node.get(attribute).asDouble();
		}
		return 0.0;
	}

	public FoundElement(double channelX, double channelY, JsonNode node, JsonNode parentNode) {
		this(channelX, channelY, node);
		if(!parentNode.isNull()) {
			parent = new FoundElement(channelX, channelY, parentNode, parentNode.get("Parent"));
		}
	}

	public FoundElement(AtsMobileElement element) {

		this.type = Channel.MOBILE;
		this.id = element.getId();

		this.tag = element.getTag();
		this.width = element.getWidth();
		this.height = element.getHeight();

		this.screenX = element.getX();
		this.screenY = element.getY();

		this.x = this.screenX;
		this.y = this.screenY;

		this.innerText = element.getAttribute(AtsMobileElement.INNER_TEXT);
	}

	public FoundElement(AtsApiElement element) {
		this.type = Channel.API;
		this.visible = true;
		this.id = element.getId();
		this.tag = element.getTag();
		this.clickable = false;
	}

	public FoundElement(Channel channel, ArrayList iframes, ArrayList elements, Double initElementX, Double initElementY) {
		this(elements.remove(0), iframes, channel, initElementX, initElementY);
		if(elements.size() > 0) {
			setParent(new FoundElement(channel, iframes, elements, initElementX, initElementY));
		}else if(iframes != null && iframes.size() > 0) {
			elements.addAll(iframes);
			iframes.clear();
			setParent(new FoundElement(channel, iframes, elements, initElementX, initElementY));
		}
	}

	public FoundElement(Channel channel, TestElement parent, int duration, int device) {

		this.tag = SearchedElement.RECORD_TAG;

		this.screenX = parent.getFoundElement().getScreenX();
		this.screenY = parent.getFoundElement().getScreenY();

		this.width = parent.getFoundElement().getWidth();
		this.height = parent.getFoundElement().getHeight();

		this.attributes = Map.of(TestElementRecord.DURATION,String.valueOf(duration), TestElementRecord.DEVICE,String.valueOf(device));
	}

	public FoundElement(Channel channel, TestBound bound, Rectangle rect) {
		this.setRemoteWebElement((RemoteWebElement) channel.getRootElement());
		this.tag = SearchedElement.IMAGE_TAG;
		this.width = rect.getWidth();
		this.height = rect.getHeight();

		final int centerX = (int)(this.width/2);
		final int centerY = (int)(this.height/2);

		this.centerWidth = centerX;
		this.centerHeight = centerY;

		this.x = rect.getX() + bound.getX();
		this.y = rect.getY() + bound.getY();

		//if(parent != null) {
			//this.x += parent.getFoundElement().getX();
			//this.y += parent.getFoundElement().getY();
		//}

		this.boundX = this.x - channel.getSubDimension().getX() + centerX;
		this.boundY = this.y - channel.getSubDimension().getY() + centerY;

		this.screenX = this.x + channel.getDimension().getX() + centerX;
		this.screenY = this.y + channel.getDimension().getY() + centerY;

		this.innerX = this.boundX - (channel.getSubDimension().getWidth()/2);
		this.innerY = this.boundY - (channel.getSubDimension().getHeight()/2);
	}


	public String getInnerText() {
		if(value == null) {
			return innerText;
		}
		return value.getAttribute("innerText");
	}

	public void addShadowParent(FoundElement elem) {
		if(parent == null) {
			parent = elem;
		}else {
			parent.addShadowParent(elem);
		}
	}

	//------------------------------------------------------------------------------------------------------------------------------
	// end of contructors
	//------------------------------------------------------------------------------------------------------------------------------

	public FoundElement addParent(FoundElement p) {
		parent = p;
		return parent;
	}

	public void updateSize(double w, double h) {
		if(width < w) {
			width = w;
		}
		if(height < h) {
			height = h;
		}
	}

	public void updateSize(Double screenX, Double screenY, Double width, Double height, Double x, Double y) {
		this.screenX =  screenX;
		this.screenY =  screenY;
		this.width = width;
		this.height = height;
		this.x = x;
		this.y = y;
	}

	public String[] getItemAttribute() {
		if(attributes != null && attributes.size() == 2) {
			return new String[] {attributes.get("value"), attributes.get("text")};
		}
		return new String[0];
	}

	public Map getAttribute() { return attributes;}

	public CalculatedProperty[] getCalculatedProperty() {
		List lst = new ArrayList<>();

		for (Map.Entry entry : attributes.entrySet()) {
			lst.add(new CalculatedProperty(entry.getKey(), entry.getValue()));
		}
		return lst.toArray(new CalculatedProperty[attributes.size()]);
	}

	public int getCenterWidth() {
		return this.centerWidth;
	}

	public int getCenterHeight() {
		return this.centerHeight;
	}

	public boolean isDesktop() {
		return Channel.DESKTOP.equals(type);
	}

	public boolean isMobile() {
		return Channel.MOBILE.equals(type);
	}

	public boolean isSAP() {
		return Channel.SAP.equals(type);
	}

	public ArrayList getIframes(){
		return iframes;
	}

	public void dispose() {
		if(parent != null) {
			parent.dispose();
			parent = null;
		}
		value = null;
	}

	public void updateBounding(Double x, Double y, Channel channel, Double width, Double height) {
		updatePosition(x, y, channel, 0D, 0D);
		this.width = width;
		this.height = height;
	}

	public void updatePosition(Double x, Double y, Channel channel, Double offsetX, Double offsetY) {
		this.x = x + channel.getSubDimension().getX() + offsetX;
		this.y = y + channel.getSubDimension().getY() + offsetY;
	}

	private void setRemoteWebElement(RemoteWebElement rwe){
		this.value = rwe;
		if(rwe != null) {
			this.id = rwe.getId();
		}
	}

	public boolean isIframe(){
		return AtsElement.checkIframe(this.tag);
	}
	
	public boolean isBody(){
		return AtsElement.checkBody(this.tag);
	}
	
	public boolean isInput(){
		return AtsElement.checkInput(this.tag);
	}

	public WebElement getValue(){
		return value;
	}
	
	public String getWebElementId(){
		if(this.value == null) {
			return "N/A";
		}
		return this.value.getId();
	}
	
	public byte[] getWebElementImage(){
		return value.getScreenshotAs(OutputType.BYTES);
	}

	public void activate(RemoteWebDriver remoteWebDriver) {
		value = new RemoteWebElement();
		value.setParent(remoteWebDriver);
		value.setId(id);
	}

	public Rectangle getRectangle(){
		return new Rectangle(x, y, width, height);
	}

	public int[] getScreenRectangle(){
		return new int[] {screenX.intValue(), screenY.intValue(), width.intValue(), height.intValue()};
	}

	public Double getScreenX() {
		return screenX;
	}

	public Double getScreenY() {
		return screenY;
	}

	public boolean isNumeric() {
		return numeric;
	}

	public boolean isPassword() {
		return password;
	}

	public boolean isActive() {
		return active;
	}

	public ArrayList getChildren(){
		return children;
	}

	//----------------------------------------------------------------------------------------------------------------------
	// Get image recognition screen position
	//----------------------------------------------------------------------------------------------------------------------

	public int getInnerX() {
		return innerX.intValue();
	}

	public int getInnerY() {
		return innerY.intValue();
	}

	//----------------------------------------------------------------------------------------------------------------------
	// Getter and setter for serialization
	//----------------------------------------------------------------------------------------------------------------------

	public boolean isShadowRoot() {
		return shadowRoot;
	}

	public void setShadowRoot(boolean value) {
		this.shadowRoot = value;
	}

	public boolean isClickable() {
		return clickable;
	}

	public void setClickable(boolean value){
		this.clickable = value;
	}

	public boolean isVisible() {
		return visible;
	}

	public void setVisible(boolean value){
		this.visible = value;
	}

	public String getType() {
		return type;
	}

	public void setType(String type) {
		this.type = type;
	}

	public FoundElement getParent() {
		return parent;
	}

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

	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	public Double getX() {
		return x;
	}

	public void setX(Double x) {
		this.x = x;
	}

	public Double getY() {
		return y;
	}

	public void setY(Double y) {
		this.y = y;
	}

	public Double getWidth() {
		return width;
	}

	public void setWidth(Double width) {
		this.width = width;
	}

	public Double getHeight() {
		return height;
	}
	public Double getArea() {
		return height * width;
	}
	public void setHeight(Double height) {
		this.height = height;
	}

	public String getTag() {
		return tag;
	}

	public void setTag(String tag) {
		this.tag = tag;
	}

	public Double getBoundX() {
		return boundX;
	}

	public void setBoundX(Double boundX) {
		this.boundX = boundX;
	}

	public Double getBoundY() {
		return boundY;
	}

	public void setBoundY(Double boundY) {
		this.boundY = boundY;
	}

	//----------------------------------------------------------------------------------------------------------------------
	// Remote element
	//----------------------------------------------------------------------------------------------------------------------

	public ParameterElement getParameterElement() {
		return new ParameterElement(getWebElementId(), getTag(), getTestBound());
	}
	
	public RemoteWebElement getRemoteWebElement(RemoteWebDriver driver) {
		final RemoteWebElement element = new RemoteWebElement();

		element.setParent(driver);
		element.setId(id);

		return element;
	}

	public TestBound getTestBound() {
		return new TestBound(x, y, width, height);
	}

	public TestBound getTestScreenBound() {
		return new TestBound(screenX, screenY, width, height);
	}

	public AtsSapElement getAtsSapElement() {
		return new AtsSapElement(this);
	}

	public void flatten(List flatList) {
		if (children != null) {
			for (FoundElement child : children) {
				child.flatten(flatList);
			}
		}
		this.children = null;
		flatList.add(this);
	}
}