com.ats.executor.drivers.engines.IDriverEngine 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.executor.drivers.engines;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Predicate;

import org.openqa.selenium.Keys;
import org.openqa.selenium.WebElement;

import com.ats.data.Rectangle;
import com.ats.driver.AtsRemoteWebDriver;
import com.ats.element.AtsBaseElement;
import com.ats.element.DialogBox;
import com.ats.element.FoundElement;
import com.ats.element.ParameterElement;
import com.ats.element.test.TestElement;
import com.ats.executor.ActionStatus;
import com.ats.executor.ActionTestScript;
import com.ats.executor.SendKeyData;
import com.ats.executor.TestBound;
import com.ats.executor.channels.Channel;
import com.ats.executor.drivers.IDriverInfo;
import com.ats.executor.drivers.desktop.SystemDriver;
import com.ats.generator.objects.BoundData;
import com.ats.generator.objects.MouseDirection;
import com.ats.generator.variables.CalculatedProperty;
import com.ats.graphic.ImageTemplateMatchingSimple;
import com.ats.script.actions.ActionApi;

public interface IDriverEngine{

	public void started(ActionTestScript script, ActionStatus status);
	public SystemDriver getSystemDriver();
	public IDriverInfo getDriverInfo();
	public WebElement getRootElement(Channel cnl);
	public void close();
	public void quit();

	public String getApplicationPath();
	public boolean switchWindow(ActionStatus status, int index, int tries, boolean refresh);
	public void closeWindow(ActionStatus status);
	public Object executeScript(ActionStatus status, String script, Object ... params);
	public Object executeJavaScript(ActionStatus status, String script, TestElement element);
	public Object executeJavaScript(ActionStatus status, String script, boolean returnValue);
	public void goToUrl(ActionStatus status, String url);

	public List findElements(boolean sysComp, TestElement testObject, String tagName, String[] attributes, String[] attributesValues, Predicate searchPredicate, WebElement startElement);
	public List findElements(TestElement parent, ImageTemplateMatchingSimple template);

	public Rectangle getBoundRect(TestElement testElement);

	public void waitAfterAction(ActionStatus status);
	public void updateDimensions();
	public FoundElement getElementFromPoint(Boolean syscomp, Double x, Double y);
	public FoundElement getElementFromRect(Boolean syscomp, Double x, Double y, Double w, Double h);
	public String getAttribute(ActionStatus status, FoundElement element, String attributeName, int maxTry);
	public CalculatedProperty[] getAttributes(FoundElement element, boolean reload);
	public String getTextData(FoundElement e);
	public String getSelectedText(TestElement e);
	public CalculatedProperty[] getCssAttributes(FoundElement element);
	public CalculatedProperty[] getHtmlAttributes(FoundElement element);
	public CalculatedProperty[] getFunctions(FoundElement element);

	public void setSysProperty(String propertyName, String propertyValue);

	public List loadSelectOptions(TestElement element);
	public List findSelectOptions(TestBound dimension, TestElement element);
	public void selectOptionsItem(ActionStatus status, TestElement testElement, CalculatedProperty selectProperty, boolean keepSelect);

	public void loadParents(FoundElement hoverElement);
	public String getParentsDomCode(WebElement hoverElement);
	public boolean isAtsLearningEnabled();

	public void scroll(int delta);
	public void scroll(FoundElement element);
	public void scroll(FoundElement element, int delta);
	
	public void swipe(ActionStatus status, FoundElement foundElement, MouseDirection position, MouseDirection direction);

	public void sendTextData(ActionStatus status, TestElement element, ArrayList textActionList, int waitChar, ActionTestScript topScript);
	public void clearText(ActionStatus status, TestElement testElement, MouseDirection md);

	public void updateScreenshot(TestBound dimension, boolean isRef);
	public byte[] getScreenshot(WebElement element, TestBound bound);

	public void createVisualAction(Channel channel, boolean stop, String actionType, int scriptLine, String scriptName, long timeline, boolean sync);
	public String setWindowBound(BoundData x, BoundData y, BoundData width, BoundData height);

	public void mouseMoveToElement(ActionStatus status, FoundElement foundElement, MouseDirection position, boolean desktopDragDrop, int offsetX, int offsetY);
	public void mouseMoveToElement(FoundElement foundElement);
	public void mouseClick(ActionStatus status, FoundElement element, MouseDirection position, int offsetX, int offsetY);
	public void doubleClick();
	public void rightClick();
	public void middleClick(ActionStatus status, MouseDirection position, TestElement element);
	public void buttonClick(ActionStatus status, String id);
	public void tap(int count, FoundElement element);
	public void press(int duration, ArrayList paths, FoundElement element);

	public void drag(ActionStatus status, FoundElement element, MouseDirection position, int offsetX, int offsetY, boolean offset);
	public void drop(FoundElement element, MouseDirection md, boolean desktopDragDrop);
	public void keyDown(Keys key);
	public void keyUp(Keys key);
	public void moveByOffset(int hDirection, int vDirection);

	public DialogBox switchToAlert();
	public boolean switchToDefaultContent(boolean dialog);
	public void setWindowToFront();
	public void switchToFrameId(String id);
	public void refreshElementMapLocation();
	public String getSource();
	public void api(ActionStatus status, ActionApi api);
	public int getCurrentWindow();
	public void windowState(ActionStatus status, Channel channel, String state);
	public String getTitle();
	public int getNumWindows();
	public String getUrl();
	public String getCookies();
	public String getHeaders(ActionStatus status);
	public String getCurrentHandle();
	public Channel getChannel();
	public FoundElement getParamElement(ParameterElement elem);
	public AtsRemoteWebDriver getAtsRemoteDriver();
}