waft.mark module

waft.mark.ci_test() → MarkDecorator

Marker to indicate test is only to be run in CI and not locally.

waft.mark.defect(jira_id: str, title: str, warning: str | None = None)

Marker to associate a JIRA defect with a test.

Parameters:

  • jira_id (str) – JIRA ID

  • title (str) – Defect title

  • warning (Optional[str]) – Custom message to log (in addition to the defect reference) when called dynamically

waft.mark.gateway_inspection(cert_installation: bool = True, tls_decryption: bool = False) → MarkDecorator

Marker to indicate test is for gateway inspection.

Parameters:

  • cert_installation (bool) – True for WARP to automatically install gateway certificates (Default: True)

  • tls_decryption (bool) – True to enable TLS decryption (Default: False)

waft.mark.local_test() → MarkDecorator

Marker to indicate test is only to be run locally and not in CI.

waft.mark.platform(platform: Platforms, codename: str | None = None, version: str | None = None, reason: str | None = None) → MarkDecorator

Marker to indicate test is intended to run with a particular platform; codename/version optional.

Parameters:

  • platform (Platforms) – Supported waft.mark.Platforms enum value.

  • codename (Optional[str]) – Optional version codename.

  • version (Optional[str]) – Optional version number prefix.

  • reason (Optional[str]) – Optional reason to display for skipping.

waft.mark.platform_skip(platform: Platforms, codename: str | None = None, version: str | None = None, reason: str | None = None) → MarkDecorator

Marker to indicate test is NOT intended to run with a particular platform; codename/version optional.

Parameters:

  • platform (Platforms) – Supported waft.mark.Platforms enum value.

  • codename (Optional[str]) – Optional version codename.

  • version (Optional[str]) – Optional version number prefix.

  • reason (Optional[str]) – Optional reason to display for skipping.

waft.mark.warp_consumer() → MarkDecorator

Marker to indicate test is for consumer WARP.

waft.mark.warp_fresh_install() → MarkDecorator

Marker to indicate test requires WARP to be freshly (re)installed before test begins.

waft.mark.warp_mdm_parameters(**kwargs) → MarkDecorator

Marker to specify MDM configuration parameters for WARP Zero Trust.

Parameters:

  • **kwargs – specify any supported option and value as keyword arguments…

  • organization (str) – Name of the organization.

  • gateway_unique_id (Optional[str]) – Optional unique identifier for the gateway.

  • service_mode (str) – Operating mode of the service (defaults to ‘warp’).

  • onboarding (bool) – Whether onboarding is enabled (defaults to True).

  • switch_locked (bool) – Whether the switch is locked (defaults to False).

  • auto_connect (Optional[int]) – Auto-connect timeout in seconds, if applicable.

  • support_url (Optional[str]) – URL for customer support, if provided.

  • override_api_ep (Optional[str]) – Override default API endpoint, if provided.

  • override_doh_ep (Optional[str]) – Override default DNS over HTTPS endpoint, if provided.

  • override_warp_ep (Optional[str]) – Override default WARP endpoint, if provided.

  • unique_client_id (Optional[str]) – Unique client identifier, if provided.

  • display_name (Optional[str]) – Display name, if provided.

  • auth_client_id (Optional[str]) – Authentication client identifier, if provided. Set by TRM, by default.

  • auth_client_secret (Optional[str]) – Authentication client secret, if provided. Set by TRM, by default.

waft.mark.warp_uninstalled() → MarkDecorator

Marker to indicate test requires WARP to be uninstalled before test begins.

waft.mark.warp_zero_trust(organization: str | None = None, dynamic: bool = False, enroll: Literal['token', 'identity', False] = 'token') → MarkDecorator

Marker to indicate test is for WARP Zero Trust.

Parameters:

  • organization (Optional[str]) – Name of a static org for the test node to be enrolled in

  • dynamic (bool) – True to use a dynamically provisioned org, mutually exclusive to naming a static org (Default: False)

  • enroll (Literal['token', 'identity', False]) – Method to use to enroll test node in given organization: service auth token (default), identity, or False (to not enroll)