e2e.pytest_plugins

e2e.pytest_plugins.pytest_addoption(parser: Parser, pluginmanager)

e2e.pytest_plugins.pytest_configure(config)

e2e.pytest_plugins.appium_service

class e2e.pytest_plugins.appium_service.AppiumServicePlugin

Bases: Plugin

property appium_log_path

is_server_up()

classmethod load_order()

pytest_sessionfinish(session, exitstatus)

pytest_sessionstart(session)

service: AppiumService | None = None

e2e.pytest_plugins.base

class e2e.pytest_plugins.base.Plugin

Bases: object

property appium_config

property artifacts_dir: Path

property e2e_config: E2EConfig | None

is_non_exec_session(session)

property item: Item | None

classmethod load_order()

property pytest_config: Config | None

property session_artifacts_dir: Path

property wd: WebDriver

property wd_utils: WDUtils | None

e2e.pytest_plugins.core

class e2e.pytest_plugins.core.CorePlugin

Bases: Plugin

clean_artifacts_dir()

destroy_cached_fixtures(scope)

hook_fixtures = {'e2e_hook_fixture_function': ['caplog', 'capsys'], 'e2e_hook_fixture_session': []}

classmethod load_order()

pytest_configure(config)

pytest_fixture_setup(fixturedef, request)

pytest_runtest_protocol(item, nextitem)

pytest_runtest_setup(item)

pytest_sessionfinish(session, exitstatus)

pytest_sessionstart(session)

e2e.pytest_plugins.core.e2e_config(request): E2E config including Appium server URL, artifacts dir, etc..

e2e.pytest_plugins.core.e2e_hook_fixture_function(): A special fixture for fixtures cache in e2e-mobile. Do NOT override it.

e2e.pytest_plugins.core.e2e_hook_fixture_session(): A special fixture for fixtures cache in e2e-mobile. Do NOT override it.

e2e.pytest_plugins.diagnostics

class e2e.pytest_plugins.diagnostics.DiagnosticsPlugin

Bases: Plugin

pytest_runtest_makereport(item, call)

pytest_runtest_protocol(item, nextitem)

pytest_runtest_setup(item)

save_page_source()

save_screenshot()

start_recording()

stop_recording()

e2e.pytest_plugins.log

class e2e.pytest_plugins.log.ItemFileHandler(filename, mode='a', encoding=None, delay=False, errors=None): Bases: FileHandler

class e2e.pytest_plugins.log.LogPlugin

Bases: Plugin

add_log_handler(path, dtype: Type[FileHandler])

property item_log_path

classmethod load_order()

pytest_runtest_logreport(report)

pytest_runtest_makereport(item, call)

pytest_runtest_protocol(item, nextitem)

pytest_runtest_setup(item)

pytest_sessionfinish(session, exitstatus)

pytest_sessionstart(session)

remove_log_handler(dtype)

separator = '--------------------------------------------------------------------------------'

property session_log_path

class e2e.pytest_plugins.log.SessionFileHandler(filename, mode='a', encoding=None, delay=False, errors=None): Bases: FileHandler

e2e.pytest_plugins.parallel

e2e.pytest_plugins.parallel.parallel_worker_id(request): A fixture indicating the parallel worker id (starting from 0) when using pytest-xdist. This returns None when pytest-xdist is not being used.

e2e.pytest_plugins.report

class e2e.pytest_plugins.report.ReportPlugin

Bases: Plugin

attach_links_to_report(report)

property html_path

pytest_runtest_makereport(item, call)

e2e.pytest_plugins.simulator

e2e.pytest_plugins.simulator.prepare_simulator(merged_capabilities: Dict[str, Any], parallel_worker_id: int | None) → str: An internal fixture to trigger preparing simulator if there’s no pre-defined devices in capabilities.

e2e.pytest_plugins.tester

e2e.pytest_plugins.tester.tester(request, e2e_config: E2EConfig, wd)

Use this fixture in your tests to perform test actions or simulations. Example:

def test_example(tester: Tester):
tester.ui.element(‘Settings’).tap() …

e2e.pytest_plugins.wd

e2e.pytest_plugins.wd.capabilities(): Override this fixture to provide Appium capabilities for testing. Refer to these docs for the extensive list of capabilities: - iOS: https://github.com/appium/appium-xcuitest-driver/blob/master/docs/reference/capabilities.md - Android: https://github.com/appium/appium-uiautomator2-driver/tree/master#capabilities

e2e.pytest_plugins.wd.merged_capabilities(capabilities: Dict[str, Any]): The final capabilities to be passed to web driver, including some pre-filled ones.

e2e.pytest_plugins.wd.setup_wd(): Override this fixture to provide customization for web driver.

e2e.pytest_plugins.wd.setup_wd_options(): Override this fixture to provide customization for Appium options (XCUITestOptions | UiAutomator2Options).

e2e.pytest_plugins.wd.wd(e2e_config, prepare_simulator, merged_capabilities, setup_wd, setup_wd_options): The web driver used for testing.