def __init__(
self,
capabilities: dict,
token: str,
projectname: str,
jobname: str,
disable_reports: bool,
):
if BaseDriver.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
if token is not None:
logging.info(f"Token used as specified in constructor: {token}")
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())
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=capabilities,
reportsettings=ReportSettings(self._projectname, self._jobname),
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
# Create a custom command executor to enable:
# - automatic logging capabilities
# - customized reporting settings
self.command_executor = CustomCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
self.command_executor.disable_reports = disable_reports
RemoteWebDriver.__init__(
self,
command_executor=self.command_executor,
desired_capabilities=self._agent_session.capabilities,
)
BaseDriver.__instance = self
class BaseDriver(RemoteWebDriver):
"""Base class with common functions for all web browser types
Args:
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:
_agent_client (AgentClient): client responsible for communicating with the TestProject agent
_agent_session (AgentSession): stores properties of the current agent session
command_executor (CustomCommandExecutor): the HTTP command executor used to send instructions
to remote WebDriver
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,
capabilities: dict,
token: str,
projectname: str,
jobname: str,
disable_reports: bool,
):
if BaseDriver.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
if token is not None:
logging.info(f"Token used as specified in constructor: {token}")
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())
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=capabilities,
reportsettings=ReportSettings(self._projectname, self._jobname),
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
# Create a custom command executor to enable:
# - automatic logging capabilities
# - customized reporting settings
self.command_executor = CustomCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
self.command_executor.disable_reports = disable_reports
RemoteWebDriver.__init__(
self,
command_executor=self.command_executor,
desired_capabilities=self._agent_session.capabilities,
)
BaseDriver.__instance = self
@classmethod
def instance(cls):
"""Returns the singleton instance of the driver object"""
return cls.__instance
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
Returns:
Reporter: object giving access to reporting methods
"""
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()
# Make instance available again
BaseDriver.__instance = None
try:
RemoteWebDriver.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,
capabilities: dict,
token: str,
project_name: str,
job_name: str,
disable_reports: bool,
report_type: ReportType,
):
if BaseDriver.__instance is not None:
raise SdkException("A driver session already exists")
LoggingHelper.configure_logging()
if token is not None:
logging.info(f"Token used as specified in constructor: {token}")
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"
self._agent_client: AgentClient = AgentClient(
token=self._token,
capabilities=capabilities,
report_settings=ReportSettings(self._project_name, self._job_name,
report_type),
)
self._agent_session: AgentSession = self._agent_client.agent_session
self.w3c = True if self._agent_session.dialect == "W3C" else False
# Create a custom command executor to enable:
# - automatic logging capabilities
# - customized reporting settings
self.command_executor = CustomCommandExecutor(
agent_client=self._agent_client,
remote_server_addr=self._agent_session.remote_address,
)
self.command_executor.disable_reports = disable_reports
# 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
RemoteWebDriver.__init__(
self,
command_executor=self.command_executor,
desired_capabilities=self._agent_session.capabilities,
)
BaseDriver.__instance = self