sdk

No menu items for this category
OpenMetadata Documentation

module tests_mixin

Mixin class containing Tests specific methods

To be used by OpenMetadata class


OpenMetadata API methods related to Tests.

To be inherited by OpenMetadata


Add logical test cases to a test suite

Args:

  • data (CreateLogicalTestCases): logical test cases

Add test case results to a test case

Args:

  • test_results (TestCaseResult): test case results to pass to the test case
  • test_case_fqn (str): test case fqn

Returns:

  • _type_: description

Create or update an executable test suite

Args:

  • data (CreateTestSuiteRequest): test suite request

Returns:

  • TestSuite: test suite object

Delete executable test suite

Args:

  • entity_id (str): test suite ID
  • recursive (bool, optional): delete children if true
  • hard_delete (bool, optional): hard delete if true

Given an entity fqn, retrieve the link test suite if it exists or create a new one

Args:

  • table_fqn (str): entity fully qualified name

Returns: TestSuite:


Get or create a test case

Args:

  • test_case_fqn (str): fully qualified name for the test
  • entity_link (Optional[str], optional): description. Defaults to None.
  • test_suite_fqn (Optional[str], optional): description. Defaults to None.
  • test_definition_fqn (Optional[str], optional): description. Defaults to None.
  • test_case_parameter_values (Optional[str], optional): description. Defaults to None.

Returns:

  • _type_: description

Get or create a test definition

Args:

  • test_definition_fqn (str): test definition fully qualified name
  • test_definition_description (Optional[str], optional): description for the test definition. Defaults to None.
  • entity_type (Optional[EntityType], optional): entity type (COLUMN or TABLE). Defaults to None.
  • test_platforms (Optional[List[TestPlatform]], optional): test platforms. Defaults to None.
  • test_case_parameter_definition (Optional[List[TestCaseParameterDefinition]], optional): parameters for the test case definition. Defaults to None.

Returns:

  • TestDefinition: a test definition object

Get or create a TestSuite

Args:

  • test_suite_name (str): test suite name
  • test_suite_description (Optional[str], optional): test suite description. Defaults to f"Test Suite created on {datetime.now(timezone.utc).strftime('%Y-%m-%d')}".

Returns: TestSuite:


Retrieve list of test cases

Args:

  • test_case_fqn (str): test_case_fqn
  • start_ts (int): timestamp
  • end_ts (int): timestamp