Package io.testproject.sdk.internal.helpers

Class CustomAppiumCommandExecutor

java.lang.Object

org.openqa.selenium.remote.HttpCommandExecutor

io.appium.java_client.remote.AppiumCommandExecutor

io.testproject.sdk.internal.helpers.CustomAppiumCommandExecutor

All Implemented Interfaces:

ReportingCommandsExecutor, org.openqa.selenium.logging.NeedsLocalLogs, org.openqa.selenium.remote.CommandExecutor

public final class CustomAppiumCommandExecutor
extends io.appium.java_client.remote.AppiumCommandExecutor
implements ReportingCommandsExecutor

A custom Appium commands executor for Appium drivers. Extends the original functionality by restoring driver session initiated by the Agent. Reports commands executed to Agent.

Field Summary

Fields inherited from interface io.testproject.sdk.internal.helpers.ReportingCommandsExecutor

LOG, STATE_SUCCESS

Constructor Summary

Constructors

Constructor	Description
CustomAppiumCommandExecutor(AgentClient agentClient, java.net.URL addressOfRemoteServer)	Initializes a new instance of this an Executor restoring command/response codecs.

Method Summary

Modifier and Type	Method	Description
org.openqa.selenium.remote.Response	execute(org.openqa.selenium.remote.Command command)
org.openqa.selenium.remote.Response	execute(org.openqa.selenium.remote.Command command, boolean skipReporting)	Extended command execution method.
AgentClient	getAgentClient()	Getter for AgentClient instance.
java.util.concurrent.atomic.AtomicReference<java.lang.String>	getCurrentTest()	Getter for CURRENT_TEST field.
io.testproject.sdk.internal.helpers.StashedCommands	getStashedCommands()	Getter for stashed commands hashmap.
boolean	isCommandReportsDisabled()	Getter for commandReportsDisabled field.
boolean	isRedactionDisabled()	Getter for redactionDisabled field.
boolean	isReportsDisabled()	Getter for reportsDisabled field.
boolean	isTestAutoReportsDisabled()	Getter for testReportsDisabled field.
void	setCommandReportsDisabled(boolean disable)	Setter for commandReportsDisabled field.
void	setRedactionDisabled(boolean disable)	Setter for redactionDisabled field.
void	setReportsDisabled(boolean disable)	Setter for reportsDisabled field.
void	setTestAutoReportsDisabled(boolean disable)	Setter for testReportsDisabled field.

Methods inherited from class io.appium.java_client.remote.AppiumCommandExecutor

getAdditionalCommands, getClient, getCommandCodec, getPrivateFieldValue, setCommandCodec, setPrivateFieldValue, setResponseCodec

Methods inherited from class org.openqa.selenium.remote.HttpCommandExecutor

defineCommand, getAddressOfRemoteServer, setLocalLogs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.testproject.sdk.internal.helpers.ReportingCommandsExecutor

clearStash, extractResponse, inferTestName, reportCommand, reportCommand, reportTest

Constructor Detail

CustomAppiumCommandExecutor

public CustomAppiumCommandExecutor(AgentClient agentClient,
                                   java.net.URL addressOfRemoteServer)

Initializes a new instance of this an Executor restoring command/response codecs.

Parameters:

agentClient - an instance of AgentClient used to pen the original driver session.

addressOfRemoteServer - URL of the remote Appium server managed by the Agent

Method Detail

execute

public org.openqa.selenium.remote.Response execute(org.openqa.selenium.remote.Command command)
                                            throws org.openqa.selenium.WebDriverException

Specified by:

execute in interface org.openqa.selenium.remote.CommandExecutor

Overrides:

execute in class io.appium.java_client.remote.AppiumCommandExecutor

Throws:

org.openqa.selenium.WebDriverException

execute

public org.openqa.selenium.remote.Response execute(org.openqa.selenium.remote.Command command,
                                                   boolean skipReporting)

Extended command execution method. Allows skipping reporting for "internal" commands, for example: - Taking screenshot for manual step reporting. - Inspecting element type to determine whether redaction is required.

Specified by:

execute in interface ReportingCommandsExecutor

Parameters:

command - Command to execute

skipReporting - Flag to control reporting

Returns:

Command execution response.

getAgentClient

public AgentClient getAgentClient()

Description copied from interface: ReportingCommandsExecutor

Getter for AgentClient instance.

Specified by:

getAgentClient in interface ReportingCommandsExecutor

Returns:

value of AgentClient field

getStashedCommands

public io.testproject.sdk.internal.helpers.StashedCommands getStashedCommands()

Description copied from interface: ReportingCommandsExecutor

Getter for stashed commands hashmap.

Specified by:

getStashedCommands in interface ReportingCommandsExecutor

Returns:

value of stashed commands hashmap.

isReportsDisabled

public boolean isReportsDisabled()

Getter for reportsDisabled field.

Specified by:

isReportsDisabled in interface ReportingCommandsExecutor

Returns:

value of reportsDisabled field

setReportsDisabled

public void setReportsDisabled(boolean disable)

Setter for reportsDisabled field.

Specified by:

setReportsDisabled in interface ReportingCommandsExecutor

Parameters:

disable - True to disable or False to enable.

isCommandReportsDisabled

public boolean isCommandReportsDisabled()

Description copied from interface: ReportingCommandsExecutor

Getter for commandReportsDisabled field.

Specified by:

isCommandReportsDisabled in interface ReportingCommandsExecutor

Returns:

value of commandReportsDisabled field

setCommandReportsDisabled

public void setCommandReportsDisabled(boolean disable)

Description copied from interface: ReportingCommandsExecutor

Setter for commandReportsDisabled field.

Specified by:

setCommandReportsDisabled in interface ReportingCommandsExecutor

Parameters:

disable - True to disable or False to enable.

isTestAutoReportsDisabled

public boolean isTestAutoReportsDisabled()

Getter for testReportsDisabled field.

Specified by:

isTestAutoReportsDisabled in interface ReportingCommandsExecutor

Returns:

value of testReportsDisabled field

setTestAutoReportsDisabled

public void setTestAutoReportsDisabled(boolean disable)

Setter for testReportsDisabled field.

Specified by:

setTestAutoReportsDisabled in interface ReportingCommandsExecutor

Parameters:

disable - True to disable or False to enable.

isRedactionDisabled

public boolean isRedactionDisabled()

Getter for redactionDisabled field.

Specified by:

isRedactionDisabled in interface ReportingCommandsExecutor

Returns:

value of redactionDisabled field

setRedactionDisabled

public void setRedactionDisabled(boolean disable)

Setter for redactionDisabled field.

Specified by:

setRedactionDisabled in interface ReportingCommandsExecutor

Parameters:

disable - True to disable or False to enable.

getCurrentTest

public java.util.concurrent.atomic.AtomicReference<java.lang.String> getCurrentTest()

Getter for CURRENT_TEST field.

Specified by:

getCurrentTest in interface ReportingCommandsExecutor

Returns:

value of CURRENT_TEST field