def __init__(
self,
desired_capabilities: dict = None,
token: str = None,
project_name: str = None,
job_name: str = None,
disable_reports: bool = False,
):
if Remote.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
self._desired_capabilities = desired_capabilities
self._token = token if token is not None else ConfigHelper.get_developer_token(
)
if disable_reports:
# Setting the project and job name to empty strings will cause the Agent to not initialize a report
self._project_name = ""
self._job_name = ""
else:
self._project_name = (project_name if project_name is not None else
ReportHelper.infer_project_name())
self._job_name = (job_name if job_name is not None else
ReportHelper.infer_job_name())
report_settings = ReportSettings(self._project_name, self._job_name)
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=self._desired_capabilities,
report_settings=report_settings,
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
AppiumWebDriver.__init__(
self,
command_executor=self._agent_session.remote_address,
desired_capabilities=self._desired_capabilities,
)
self.command_executor = CustomAppiumCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
# this ensures that mobile-specific commands are also available for our command executor
self._addCommands()
Remote.__instance = self
class Remote(AppiumWebDriver):
"""Used to create a new Android driver instance
Args:
desired_capabilities (dict): Automation session desired capabilities and options
token (str): Developer token to be used to communicate with the Agent
projectname (str): Project name to report
jobname (str): Job name to report
disable_reports (bool): set to True to disable all reporting (no report will be created on TestProject)
Attributes:
_desired_capabilities (dict): Automation session desired capabilities and options
_agent_client (AgentClient): client responsible for communicating with the TestProject agent
_agent_session (AgentSession): stores properties of the current agent session
command_executor (CustomAppiumCommandExecutor): the HTTP command executor used to send commands
w3c (bool): indicates whether or not the driver instance uses the W3C dialect
session_id (str): contains the current session ID
"""
def __init__(
self,
desired_capabilities: dict = None,
token: str = None,
projectname: str = None,
jobname: str = None,
disable_reports: bool = False,
):
LoggingHelper.configure_logging()
self._desired_capabilities = desired_capabilities
self._token = token if token is not None else ConfigHelper.get_developer_token(
)
if disable_reports:
# Setting the project and job name to empty strings will cause the Agent to not initialize a report
self._projectname = ""
self._jobname = ""
else:
self._projectname = projectname if projectname is not None else ReportHelper.infer_project_name(
)
self._jobname = jobname if jobname is not None else ReportHelper.infer_job_name(
)
reportsettings = ReportSettings(self._projectname, self._jobname)
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=self._desired_capabilities,
reportsettings=reportsettings,
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
AppiumWebDriver.__init__(
self,
command_executor=self._agent_session.remote_address,
desired_capabilities=self._desired_capabilities,
)
self.command_executor = CustomAppiumCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
# this ensures that mobile-specific commands are also available for our command executor
self._addCommands()
def start_session(self, capabilities, browser_profile=None):
"""Sets capabilities and sessionId obtained from the Agent when creating the original session."""
self.session_id = self._agent_session.session_id
logging.info(f"Session ID is {self.session_id}")
def report(self) -> Reporter:
"""Enables access to the TestProject reporting actions from the driver object"""
return Reporter(self.command_executor)
def quit(self):
"""Quits the driver and stops the session with the Agent, cleaning up after itself."""
# Report any left over driver command reports
self.command_executor.clear_stash()
try:
AppiumWebDriver.quit(self)
except Exception:
pass
# Stop the Agent client
self.command_executor.agent_client.stop()
# Clean up any environment variables set in the decorator
for env_var in [
EnvironmentVariable.TP_TEST_NAME,
EnvironmentVariable.TP_PROJECT_NAME,
EnvironmentVariable.TP_JOB_NAME,
]:
EnvironmentVariable.remove(env_var)
def __init__(
self,
desired_capabilities: dict = None,
token: str = None,
project_name: str = None,
job_name: str = None,
disable_reports: bool = False,
):
if Remote.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
self._desired_capabilities = desired_capabilities
self._token = token if token is not None else ConfigHelper.get_developer_token(
)
if disable_reports:
# Setting the project and job name to empty strings will cause the Agent to not initialize a report
self._project_name = ""
self._job_name = ""
else:
self._project_name = (project_name if project_name is not None else
ReportHelper.infer_project_name())
if job_name:
self._job_name = job_name
else:
self._job_name = ReportHelper.infer_job_name()
# Can update job name at runtime if not specified.
os.environ[
EnvironmentVariable.TP_UPDATE_JOB_NAME.value] = "True"
report_settings = ReportSettings(self._project_name, self._job_name)
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=self._desired_capabilities,
report_settings=report_settings,
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
AppiumWebDriver.__init__(
self,
command_executor=self._agent_session.remote_address,
desired_capabilities=self._desired_capabilities,
)
self.command_executor = CustomAppiumCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
# this ensures that mobile-specific commands are also available for our command executor
self._addCommands()
# Disable automatic command and test reports if Behave reporting is enabled.
if os.getenv("TP_DISABLE_AUTO_REPORTING") == "True":
self.command_executor.disable_command_reports = True
self.command_executor.disable_auto_test_reports = True
Remote.__instance = self
class Remote(AppiumWebDriver):
"""Used to create a new Android driver instance
Args:
desired_capabilities (dict): Automation session desired capabilities and options
token (str): Developer token to be used to communicate with the Agent
project_name (str): Project name to report
job_name (str): Job name to report
disable_reports (bool): set to True to disable all reporting (no report will be created on TestProject)
Attributes:
_desired_capabilities (dict): Automation session desired capabilities and options
_agent_client (AgentClient): client responsible for communicating with the TestProject agent
_agent_session (AgentSession): stores properties of the current agent session
command_executor (CustomAppiumCommandExecutor): the HTTP command executor used to send commands
w3c (bool): indicates whether or not the driver instance uses the W3C dialect
session_id (str): contains the current session ID
"""
__instance = None
def __init__(
self,
desired_capabilities: dict = None,
token: str = None,
project_name: str = None,
job_name: str = None,
disable_reports: bool = False,
):
if Remote.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
self._desired_capabilities = desired_capabilities
self._token = token if token is not None else ConfigHelper.get_developer_token(
)
if disable_reports:
# Setting the project and job name to empty strings will cause the Agent to not initialize a report
self._project_name = ""
self._job_name = ""
else:
self._project_name = (project_name if project_name is not None else
ReportHelper.infer_project_name())
if job_name:
self._job_name = job_name
else:
self._job_name = ReportHelper.infer_job_name()
# Can update job name at runtime if not specified.
os.environ[
EnvironmentVariable.TP_UPDATE_JOB_NAME.value] = "True"
report_settings = ReportSettings(self._project_name, self._job_name)
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=self._desired_capabilities,
report_settings=report_settings,
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
AppiumWebDriver.__init__(
self,
command_executor=self._agent_session.remote_address,
desired_capabilities=self._desired_capabilities,
)
self.command_executor = CustomAppiumCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
# this ensures that mobile-specific commands are also available for our command executor
self._addCommands()
# Disable automatic command and test reports if Behave reporting is enabled.
if os.getenv("TP_DISABLE_AUTO_REPORTING") == "True":
self.command_executor.disable_command_reports = True
self.command_executor.disable_auto_test_reports = True
Remote.__instance = self
@classmethod
def instance(cls):
"""Returns the singleton instance of the driver object"""
return Remote.__instance
@property
def step_settings(self):
return self.command_executor.settings
@step_settings.setter
def step_settings(self, step_settings: StepSettings):
self.command_executor.settings = step_settings
def start_session(self, capabilities, browser_profile=None):
"""Sets capabilities and sessionId obtained from the Agent when creating the original session."""
self.session_id = self._agent_session.session_id
logging.info(f"Session ID is {self.session_id}")
def report(self) -> Reporter:
"""Enables access to the TestProject reporting actions from the driver object"""
return Reporter(self.command_executor)
def addons(self) -> AddonHelper:
"""Enables access to the TestProject addon execution actions from the driver object
Returns:
AddonHelper: object giving access to addon proxy methods
"""
return AddonHelper(self._agent_client, self.command_executor)
def pause(self, milliseconds: int):
self.command_executor.pause(milliseconds)
def update_job_name(self, job_name):
"""Updates the job name of the execution during runtime
Args:
job_name (str): updated job name to set for the execution.
"""
self._agent_client.update_job_name(job_name=job_name)
def quit(self):
"""Quits the driver and stops the session with the Agent, cleaning up after itself."""
# Report any left over driver command reports
self.command_executor.clear_stash()
# Make instance available again
Remote.__instance = None
try:
AppiumWebDriver.quit(self)
except Exception:
pass
# Stop the Agent client
self.command_executor.agent_client.stop()
# Clean up any environment variables set in the decorator
for env_var in [
EnvironmentVariable.TP_TEST_NAME,
EnvironmentVariable.TP_PROJECT_NAME,
EnvironmentVariable.TP_JOB_NAME,
]:
EnvironmentVariable.remove(env_var)