Package io.testproject.sdk.drivers

Class GenericDriver

java.lang.Object

io.testproject.sdk.drivers.GenericDriver

All Implemented Interfaces:

ReportingDriver

public final class GenericDriver
extends java.lang.Object
implements ReportingDriver

Generic Driver that can be used to perform a non-UI automation.

Field Summary

Fields inherited from interface io.testproject.sdk.drivers.ReportingDriver

LOG

Constructor Summary

Constructors

Constructor	Description
GenericDriver()	Initiates a new session with the Agent using default token and URL.
GenericDriver(boolean disableReports)	Initiates a new session with the Agent using default token and URL and reports commands.
GenericDriver(boolean disableReports, ReportType reportType)	Initiates a new session with the Agent using default token and URL and reports commands.
GenericDriver(ReportType reportType)	Initiates a new session with the Agent using default token and URL.
GenericDriver(java.lang.String projectName)	Initiates a new session with the Agent using default token and URL with Project name.
GenericDriver(java.lang.String projectName, int sessionSocketTimeout)	Initiates a new session with the Agent using default token and URL with Project name.
GenericDriver(java.lang.String projectName, ReportType reportType)	Initiates a new session with the Agent using default token and URL with Project name.
GenericDriver(java.lang.String projectName, java.lang.String jobName)	Initiates a new session with the Agent using default token and URL.
GenericDriver(java.lang.String projectName, java.lang.String jobName, ReportType reportType)	Initiates a new session with the Agent using default token and URL.
GenericDriver(java.lang.String token, java.lang.String projectName, java.lang.String jobName)	Initiates a new session with the Agent using provided token and default URL and Project name.
GenericDriver(java.lang.String token, java.lang.String projectName, java.lang.String jobName, ReportType reportType)	Initiates a new session with the Agent using provided token and default URL and Project name.
GenericDriver(java.net.URL remoteAddress)	Initiates a new session with the Agent using provided Agent URL and default token.
GenericDriver(java.net.URL remoteAddress, ReportType reportType)	Initiates a new session with the Agent using provided Agent URL and default token.
GenericDriver(java.net.URL remoteAddress, java.lang.String token)	Initiates a new session with the Agent using provided Agent URL and token.
GenericDriver(java.net.URL remoteAddress, java.lang.String token, int sessionSocketTimeout)	Initiates a new session with the Agent using provided Agent URL and token.
GenericDriver(java.net.URL remoteAddress, java.lang.String token, ReportType reportType)	Initiates a new session with the Agent using provided Agent URL and token.
GenericDriver(java.net.URL remoteAddress, java.lang.String projectName, java.lang.String jobName)	Initiates a new session with the Agent using provided Agent URL, default token, Project and Job names.
GenericDriver(java.net.URL remoteAddress, java.lang.String projectName, java.lang.String jobName, ReportType reportType)	Initiates a new session with the Agent using provided Agent URL, default token, Project and Job names.
GenericDriver(java.net.URL remoteAddress, java.lang.String token, java.lang.String projectName, java.lang.String jobName, boolean disableReports, ReportType reportType)	Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.
GenericDriver(java.net.URL remoteAddress, java.lang.String token, java.lang.String projectName, java.lang.String jobName, boolean disableReports, ReportType reportType, int sessionSocketTimeout)	Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.
GenericDriver(java.net.URL remoteAddress, java.lang.String token, java.lang.String projectName, java.lang.String jobName, boolean disableReports, ReportType reportType, java.lang.String reportName, java.lang.String reportPath, int sessionSocketTimeout)	Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.

Method Summary

Modifier and Type	Method	Description
ReportingCommandsExecutor	getReportingCommandExecutor()	Returns a local command executor.
void	quit()	Quits the driver and reports test completion.
Reporter	report()	Provides access to the reporting functionality and settings.
void	stop()	Stops the driver and perform necessary cleanup.

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.drivers.ReportingDriver

addons, getScreenshot

Constructor Detail

GenericDriver

public GenericDriver()
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Parameters:

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(boolean disableReports)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL and reports commands.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

disableReports - True to disable automatic reporting of driver commands and tests, otherwise False.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(boolean disableReports,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL and reports commands.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

disableReports - True to disable automatic reporting of driver commands and tests, otherwise False.

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String projectName)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL with Project name.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

projectName - Project name to report

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String projectName,
                     int sessionSocketTimeout)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL with Project name.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

projectName - Project name to report

sessionSocketTimeout - The connection timeout to the agent in milliseconds

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String projectName,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL with Project name.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

projectName - Project name to report

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String projectName,
                     java.lang.String jobName)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

projectName - Project name to report

jobName - Job name to report

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String projectName,
                     java.lang.String jobName,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using default token and URL.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

projectName - Project name to report

jobName - Job name to report

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String token,
                     java.lang.String projectName,
                     java.lang.String jobName)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided token and default URL and Project name.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Creates a new instance based on capabilities.

Parameters:

token - Development token that should be obtained from SDK page

projectName - Project name to report

jobName - Job name to report

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.lang.String token,
                     java.lang.String projectName,
                     java.lang.String jobName,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided token and default URL and Project name.

Default Agent URL can be set using TP_AGENT_URL environment variable. If the environment variable is not set, default URL http://localhost:8585 is used.

Creates a new instance based on capabilities.

Parameters:

token - Development token that should be obtained from SDK page

projectName - Project name to report

jobName - Job name to report

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL and default token.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL and default token.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String projectName,
                     java.lang.String jobName)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL, default token, Project and Job names.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

projectName - Project name to report

jobName - Job name to report

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String projectName,
                     java.lang.String jobName,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL, default token, Project and Job names.

Default token can be set using TP_DEV_TOKEN environment variable. You can get a token from SDK page

Creates a new instance based on capabilities.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

projectName - Project name to report

jobName - Job name to report

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL and token.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token,
                     int sessionSocketTimeout)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL and token.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

sessionSocketTimeout - The connection timeout to the agent in milliseconds

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL and token.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token,
                     java.lang.String projectName,
                     java.lang.String jobName,
                     boolean disableReports,
                     ReportType reportType)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

projectName - Project name to report

jobName - Job name to report

disableReports - True to disable automatic reporting of driver commands and tests, otherwise False.

reportType - A type of report to produce - cloud, local or both.

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token,
                     java.lang.String projectName,
                     java.lang.String jobName,
                     boolean disableReports,
                     ReportType reportType,
                     int sessionSocketTimeout)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

projectName - Project name to report

jobName - Job name to report

disableReports - True to disable automatic reporting of driver commands and tests, otherwise False.

reportType - A type of report to produce - cloud, local or both.

sessionSocketTimeout - The connection timeout to the agent in milliseconds

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

GenericDriver

public GenericDriver(java.net.URL remoteAddress,
                     java.lang.String token,
                     java.lang.String projectName,
                     java.lang.String jobName,
                     boolean disableReports,
                     ReportType reportType,
                     java.lang.String reportName,
                     java.lang.String reportPath,
                     int sessionSocketTimeout)
              throws InvalidTokenException,
                     AgentConnectException,
                     java.io.IOException,
                     ObsoleteVersionException

Initiates a new session with the Agent using provided Agent URL, token, Project and Job names.

Parameters:

remoteAddress - Agent API base URL (e.g. http://localhost:8585/)

token - Development token that should be obtained from SDK page

projectName - Project name to report

jobName - Job name to report

disableReports - True to disable automatic reporting of driver commands and tests, otherwise False.

reportType - A type of report to produce - cloud, local or both.

reportName - The name of the generated report.

reportPath - The path to the generated report.

sessionSocketTimeout - The connection timeout to the agent in milliseconds

Throws:

AgentConnectException - if Agent is not responding or responds with an error

InvalidTokenException - if the token provided is invalid

java.io.IOException - if the Agent API base URL provided is malformed

ObsoleteVersionException - if the SDK version is incompatible with the Agent

Method Detail

report

public Reporter report()

Provides access to the reporting functionality and settings.

Specified by:

report in interface ReportingDriver

Returns:

Reporter instance.

stop

public void stop()

Description copied from interface: ReportingDriver

Stops the driver and perform necessary cleanup.

Specified by:

stop in interface ReportingDriver

getReportingCommandExecutor

public ReportingCommandsExecutor getReportingCommandExecutor()

Returns a local command executor.

Specified by:

getReportingCommandExecutor in interface ReportingDriver

Returns:

An instance of ReportingCommandsExecutor used by the driver.

quit

public void quit()

Quits the driver and reports test completion.