openmetadata-ingestion 1.6.0.0rc1__py3-none-any.whl → 1.6.0.0rc2__py3-none-any.whl

metadata/cli/classify.py

@@ -0,0 +1,52 @@
+#  Copyright 2021 Collate
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#  http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+"""
+Sampler utility for the metadata CLI
+"""
+import sys
+import traceback
+from pathlib import Path
+
+from metadata.config.common import load_config_file
+from metadata.generated.schema.entity.services.ingestionPipelines.ingestionPipeline import (
+    PipelineType,
+)
+from metadata.utils.logger import cli_logger, redacted_config
+from metadata.workflow.classification import AutoClassificationWorkflow
+from metadata.workflow.workflow_init_error_handler import WorkflowInitErrorHandler
+
+logger = cli_logger()
+
+
+def run_classification(config_path: Path) -> None:
+    """
+    Run the sampler workflow from a config path
+    to a JSON or YAML file
+    :param config_path: Path to load JSON config
+    """
+
+    config_dict = None
+    try:
+        config_dict = load_config_file(config_path)
+        logger.debug("Using workflow config:\n%s", redacted_config(config_dict))
+        workflow = AutoClassificationWorkflow.create(config_dict)
+    except Exception as exc:
+        logger.debug(traceback.format_exc())
+        WorkflowInitErrorHandler.print_init_error(
+            exc, config_dict, PipelineType.metadata
+        )
+        sys.exit(1)
+
+    workflow.execute()
+    workflow.stop()
+    workflow.print_status()
+    workflow.raise_from_status()

metadata/cmd.py

@@ -22,6 +22,7 @@ from typing import List, Optional, Union
 
 from metadata.__version__ import get_metadata_version
 from metadata.cli.app import run_app
+from metadata.cli.classify import run_classification
 from metadata.cli.dataquality import run_test
 from metadata.cli.ingest import run_ingest
 from metadata.cli.lineage import run_lineage
@@ -40,6 +41,7 @@ class MetadataCommands(Enum):
     WEBHOOK = "webhook"
     LINEAGE = "lineage"
     APP = "app"
+    AUTO_CLASSIFICATION = "classify"
 
 
 RUN_PATH_METHODS = {
@@ -49,6 +51,7 @@ RUN_PATH_METHODS = {
     MetadataCommands.PROFILE.value: run_profiler,
     MetadataCommands.TEST.value: run_test,
     MetadataCommands.APP.value: run_app,
+    MetadataCommands.AUTO_CLASSIFICATION.value: run_classification,
 }
 
 
@@ -124,6 +127,12 @@ def get_parser(args: Optional[List[str]] = None):
             help="Workflow for running external applications",
         )
     )
+    create_common_config_parser_args(
+        sub_parser.add_parser(
+            MetadataCommands.AUTO_CLASSIFICATION.value,
+            help="Workflow for running auto classification",
+        )
+    )
     webhook_args(
         sub_parser.add_parser(
             MetadataCommands.WEBHOOK.value,

metadata/data_quality/builders/{i_validator_builder.py → validator_builder.py}

@@ -14,9 +14,9 @@ Builder interface defining the structure of builders for validators.
 Validators are test classes (e.g. columnValuesToBeBetween, etc.)
 """
 
-from abc import ABC, abstractmethod
 from datetime import datetime, timezone
-from typing import TYPE_CHECKING, Optional, Type, Union
+from enum import Enum
+from typing import TYPE_CHECKING, Set, Type, Union
 
 from metadata.data_quality.validations.base_test_handler import BaseTestValidator
 from metadata.data_quality.validations.runtime_param_setter.param_setter import (
@@ -31,23 +31,29 @@ if TYPE_CHECKING:
     from pandas import DataFrame
 
 
-class IValidatorBuilder(ABC):
-    """Interface for validator builders"""
+class TestCaseImporter:
+    def import_test_case_validator(
+        self,
+        test_type: str,
+        runner_type: str,
+        test_definition: str,
+    ) -> Type[BaseTestValidator]:
+        return import_test_case_class(test_type, runner_type, test_definition)
 
-    @property
-    def test_case(self):
-        """Return the test case object"""
-        return self._test_case
 
-    @property
-    def validator(self):
-        """Return the validator object"""
-        return self._validator
+class SourceType(Enum):
+    PANDAS = "pandas"
+    SQL = "sqlalchemy"
+
+
+class ValidatorBuilder(TestCaseImporter):
+    """Interface for validator builders"""
 
     def __init__(
         self,
         runner: Union[QueryRunner, "DataFrame"],
         test_case: TestCase,
+        source_type: SourceType,
         entity_type: str,
     ) -> None:
         """Builder object for SQA validators. This builder is used to create a validator object
@@ -55,35 +61,45 @@ class IValidatorBuilder(ABC):
         Args:
             runner (QueryRunner): The runner object
             test_case (TestCase): The test case object
+            source_type (SourceType): The source type
             entity_type (str): one of COLUMN or TABLE -- fetched from the test definition
         """
+        super().__init__()
         self._test_case = test_case
         self.runner = runner
-        self.validator_cls: Type[BaseTestValidator] = import_test_case_class(
+        self.validator_cls: Type[
+            BaseTestValidator
+        ] = super().import_test_case_validator(
             entity_type,
-            self._get_source_type(),
-            self.test_case.testDefinition.fullyQualifiedName,  # type: ignore
+            source_type.value,
+            self.test_case.testDefinition.fullyQualifiedName,
         )
         self.reset()
 
-    def set_runtime_params(
-        self, runtime_params_setter: Optional[RuntimeParameterSetter]
-    ):
-        """Set the runtime parameters for the validator object
+    @property
+    def test_case(self):
+        """Return the test case object"""
+        return self._test_case
+
+    @property
+    def validator(self):
+        """Return the validator object"""
+        return self._validator
 
-        # TODO: We should support setting n runtime parameters
+    def set_runtime_params(self, runtime_params_setters: Set[RuntimeParameterSetter]):
+        """Set the runtime parameters for the validator object
 
         Args:
-            runtime_params_setter (Optional[RuntimeParameterSetter]): The runtime parameter setter
+            runtime_params_setters (Optional[RuntimeParameterSetter]): The runtime parameter setter
         """
-        if runtime_params_setter:
-            params = runtime_params_setter.get_parameters(self.test_case)
+        for setter in runtime_params_setters:
+            params = setter.get_parameters(self.test_case)
             if not self.test_case.parameterValues:
                 # If there are no parameters, create a new list
                 self.test_case.parameterValues = []
             self.test_case.parameterValues.append(
                 TestCaseParameterValue(
-                    name="runtimeParams", value=params.model_dump_json()
+                    name=type(params).__name__, value=params.model_dump_json()
                 )
             )
 
@@ -96,8 +112,3 @@ class IValidatorBuilder(ABC):
                 int(datetime.now(tz=timezone.utc).timestamp() * 1000)
             ),
         )
-
-    @abstractmethod
-    def _get_source_type(self):
-        """Get the source type"""
-        raise NotImplementedError

metadata/data_quality/interface/pandas/pandas_test_suite_interface.py

@@ -14,9 +14,9 @@ Interfaces with database for all database engine
 supporting sqlalchemy abstraction layer
 """
 
-from metadata.data_quality.builders.i_validator_builder import IValidatorBuilder
-from metadata.data_quality.builders.pandas_validator_builder import (
-    PandasValidatorBuilder,
+from metadata.data_quality.builders.validator_builder import (
+    SourceType,
+    ValidatorBuilder,
 )
 from metadata.data_quality.interface.test_suite_interface import TestSuiteInterface
 from metadata.generated.schema.entity.data.table import Table
@@ -25,8 +25,8 @@ from metadata.generated.schema.entity.services.connections.database.datalakeConn
 )
 from metadata.generated.schema.tests.testCase import TestCase
 from metadata.ingestion.ometa.ometa_api import OpenMetadata
-from metadata.ingestion.source.connections import get_connection
 from metadata.mixins.pandas.pandas_mixin import PandasInterfaceMixin
+from metadata.sampler.sampler_interface import SamplerInterface
 from metadata.utils.logger import test_suite_logger
 
 logger = test_suite_logger()
@@ -43,32 +43,32 @@ class PandasTestSuiteInterface(TestSuiteInterface, PandasInterfaceMixin):
         self,
         service_connection_config: DatalakeConnection,
         ometa_client: OpenMetadata,
-        table_entity: Table = None,
-        **kwargs,  # pylint: disable=unused-argument
+        sampler: SamplerInterface,
+        table_entity: Table,
+        **kwargs,
     ):
-        super().__init__()
-        self.table_entity = table_entity
-
-        self.ometa_client = ometa_client
-        self.service_connection_config = service_connection_config
+        super().__init__(
+            service_connection_config,
+            ometa_client,
+            sampler,
+            table_entity,
+            **kwargs,
+        )
 
         (
-            self.table_sample_query,
-            self.table_sample_config,
-            self.table_partition_config,
+            self.sample_query,
+            self.profile_sample_config,
+            self.partition_details,
         ) = self._get_table_config()
 
-        # add partition logic to test suite
-        self.dfs = self.return_ometa_dataframes_sampled(
-            service_connection_config=self.service_connection_config,
-            client=get_connection(self.service_connection_config).client._client,
-            table=self.table_entity,
-            profile_sample_config=self.table_sample_config,
-        )
-        if self.dfs and self.table_partition_config:
-            self.dfs = self.get_partitioned_df(self.dfs)
+        self.dataset = self.sampler.get_dataset()
 
     def _get_validator_builder(
         self, test_case: TestCase, entity_type: str
-    ) -> IValidatorBuilder:
-        return PandasValidatorBuilder(self.dfs, test_case, entity_type)
+    ) -> ValidatorBuilder:
+        return self.validator_builder_class(
+            runner=self.dataset,
+            test_case=test_case,
+            entity_type=entity_type,
+            source_type=SourceType.PANDAS,
+        )

metadata/data_quality/interface/sqlalchemy/sqa_test_suite_interface.py

@@ -19,8 +19,10 @@ from typing import Union
 from sqlalchemy.orm import DeclarativeMeta
 from sqlalchemy.orm.util import AliasedClass
 
-from metadata.data_quality.builders.i_validator_builder import IValidatorBuilder
-from metadata.data_quality.builders.sqa_validator_builder import SQAValidatorBuilder
+from metadata.data_quality.builders.validator_builder import (
+    SourceType,
+    ValidatorBuilder,
+)
 from metadata.data_quality.interface.test_suite_interface import TestSuiteInterface
 from metadata.generated.schema.entity.data.table import Table
 from metadata.generated.schema.entity.services.databaseService import DatabaseConnection
@@ -29,7 +31,7 @@ from metadata.ingestion.connections.session import create_and_bind_session
 from metadata.ingestion.ometa.ometa_api import OpenMetadata
 from metadata.mixins.sqalchemy.sqa_mixin import SQAInterfaceMixin
 from metadata.profiler.processor.runner import QueryRunner
-from metadata.profiler.processor.sampler.sqlalchemy.sampler import SQASampler
+from metadata.sampler.sampler_interface import SamplerInterface
 from metadata.utils.constants import TEN_MIN
 from metadata.utils.logger import test_suite_logger
 from metadata.utils.ssl_manager import get_ssl_connection
@@ -49,15 +51,15 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
         self,
         service_connection_config: DatabaseConnection,
         ometa_client: OpenMetadata,
+        sampler: SamplerInterface,
         table_entity: Table = None,
-        sqa_metadata=None,
+        **kwargs,
     ):
-        super().__init__()
-        self.ometa_client = ometa_client
-        self.table_entity = table_entity
-        self.service_connection_config = service_connection_config
+        super().__init__(
+            service_connection_config, ometa_client, sampler, table_entity, **kwargs
+        )
+        self.source_type = SourceType.SQL
         self.create_session()
-        self._table = self._convert_table_to_orm_object(sqa_metadata)
 
         (
             self.table_sample_query,
@@ -65,7 +67,6 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
             self.table_partition_config,
         ) = self._get_table_config()
 
-        self._sampler = self._create_sampler()
         self._runner = self._create_runner()
 
     def create_session(self):
@@ -74,7 +75,7 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
         )
 
     @property
-    def sample(self) -> Union[DeclarativeMeta, AliasedClass]:
+    def dataset(self) -> Union[DeclarativeMeta, AliasedClass]:
         """_summary_
 
         Returns:
@@ -85,7 +86,7 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
                 "You must create a sampler first `<instance>.create_sampler(...)`."
             )
 
-        return self.sampler.random_sample()
+        return self.sampler.get_dataset()
 
     @property
     def runner(self) -> QueryRunner:
@@ -96,47 +97,14 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
         """
         return self._runner
 
-    @property
-    def sampler(self) -> SQASampler:
-        """getter method for the Runner object
-
-        Returns:
-            Sampler: sampler object
-        """
-        return self._sampler
-
-    @property
-    def table(self):
-        """getter method for the table object
-
-        Returns:
-            Table: table object
-        """
-        return self._table
-
-    def _create_sampler(self) -> SQASampler:
-        """Create sampler instance"""
-        from metadata.profiler.processor.sampler.sampler_factory import (  # pylint: disable=import-outside-toplevel
-            sampler_factory_,
-        )
-
-        return sampler_factory_.create(
-            self.service_connection_config.__class__.__name__,
-            client=self.session,
-            table=self.table,
-            profile_sample_config=self.table_sample_config,
-            partition_details=self.table_partition_config,
-            profile_sample_query=self.table_sample_query,
-        )
-
-    def _create_runner(self) -> None:
+    def _create_runner(self) -> QueryRunner:
         """Create a QueryRunner Instance"""
 
         return cls_timeout(TEN_MIN)(
             QueryRunner(
                 session=self.session,
-                table=self.table,
-                sample=self.sample,
+                dataset=self.dataset,
+                raw_dataset=self.sampler.raw_dataset,
                 partition_details=self.table_partition_config,
                 profile_sample_query=self.table_sample_query,
             )
@@ -144,5 +112,10 @@ class SQATestSuiteInterface(SQAInterfaceMixin, TestSuiteInterface):
 
     def _get_validator_builder(
         self, test_case: TestCase, entity_type: str
-    ) -> IValidatorBuilder:
-        return SQAValidatorBuilder(self.runner, test_case, entity_type)
+    ) -> ValidatorBuilder:
+        return self.validator_builder_class(
+            runner=self.runner,
+            test_case=test_case,
+            entity_type=entity_type,
+            source_type=self.source_type,
+        )

metadata/data_quality/interface/test_suite_interface.py

@@ -15,9 +15,9 @@ supporting sqlalchemy abstraction layer
 """
 
 from abc import ABC, abstractmethod
-from typing import Optional, Type
+from typing import Optional, Set, Type
 
-from metadata.data_quality.builders.i_validator_builder import IValidatorBuilder
+from metadata.data_quality.builders.validator_builder import ValidatorBuilder
 from metadata.data_quality.validations.base_test_handler import BaseTestValidator
 from metadata.data_quality.validations.runtime_param_setter.param_setter import (
     RuntimeParameterSetter,
@@ -31,9 +31,8 @@ from metadata.generated.schema.tests.basic import TestCaseResult
 from metadata.generated.schema.tests.testCase import TestCase
 from metadata.generated.schema.tests.testDefinition import TestDefinition
 from metadata.ingestion.ometa.ometa_api import OpenMetadata
-from metadata.profiler.api.models import ProfileSampleConfig
+from metadata.sampler.sampler_interface import SamplerInterface
 from metadata.utils.logger import test_suite_logger
-from metadata.utils.partition import get_partition_details
 
 logger = test_suite_logger()
 
@@ -43,27 +42,44 @@ class TestSuiteInterface(ABC):
 
     runtime_params_setter_fact = RuntimeParameterSetterFactory
 
-    def __init__(self):
-        """This constructor exists to staisfy the linter. Its fields should be set in the implementation class"""
-        self.ometa_client: DatabaseConnection = None
-        self.ometa_client: OpenMetadata = None
-        self.table_entity: Table = None
-        self.service_connection_config: DatabaseConnection = None
-
-    @property
-    def sampler(self):
-        """Get the sampler object
+    def __init__(
+        self,
+        service_connection_config: DatabaseConnection,
+        ometa_client: OpenMetadata,
+        sampler: SamplerInterface,
+        table_entity: Table,
+        validator_builder: Type[ValidatorBuilder],
+    ):
+        """Required attribute for the interface"""
+        self.ometa_client = ometa_client
+        self.service_connection_config = service_connection_config
+        self.table_entity = table_entity
+        self.sampler = sampler
+        self.validator_builder_class = validator_builder
 
-        Note: Overriden in the implementation class. This should be removed from the interface. It has been
-        implemented as the RuntimeParameterSetter takes the sampler as an argument, though we may want to
-        remove that dependency.
-        """
-        return None
+    @classmethod
+    def create(
+        cls,
+        service_connection_config: DatabaseConnection,
+        ometa_client: OpenMetadata,
+        sampler: SamplerInterface,
+        table_entity: Table,
+        *args,
+        **kwargs,
+    ):
+        return cls(
+            service_connection_config,
+            ometa_client,
+            sampler,
+            table_entity,
+            *args,
+            **kwargs,
+        )
 
     @abstractmethod
     def _get_validator_builder(
         self, test_case: TestCase, entity_type: str
-    ) -> IValidatorBuilder:
+    ) -> ValidatorBuilder:
         """get the builder class for the validator. Define this in the implementation class
 
         Args:
@@ -71,7 +87,7 @@ class TestSuiteInterface(ABC):
             entity_type (str): type of the entity
 
         Returns:
-            IValidatorBuilder: a validator builder
+            ValidatorBuilder: a validator builder
         """
         raise NotImplementedError
 
@@ -97,9 +113,9 @@ class TestSuiteInterface(ABC):
         runtime_params_setter_fact: RuntimeParameterSetterFactory = (
             self._get_runtime_params_setter_fact()
         )  # type: ignore
-        runtime_params_setter: Optional[
+        runtime_params_setters: Set[
             RuntimeParameterSetter
-        ] = runtime_params_setter_fact.get_runtime_param_setter(
+        ] = runtime_params_setter_fact.get_runtime_param_setters(
             test_case.testDefinition.fullyQualifiedName,  # type: ignore
             self.ometa_client,
             self.service_connection_config,
@@ -113,7 +129,7 @@ class TestSuiteInterface(ABC):
         ).entityType.value
 
         validator_builder = self._get_validator_builder(test_case, entity_type)
-        validator_builder.set_runtime_params(runtime_params_setter)
+        validator_builder.set_runtime_params(runtime_params_setters)
         validator: BaseTestValidator = validator_builder.validator
         try:
             return validator.run_validation()
@@ -123,37 +139,10 @@ class TestSuiteInterface(ABC):
             )
             raise RuntimeError(err)
 
-    def _get_sample_query(self) -> Optional[str]:
-        """Get the sampling query for the data quality tests
-
-        Args:
-            entity (Table): _description_
-        """
-        if self.table_entity.tableProfilerConfig:
-            return self.table_entity.tableProfilerConfig.profileQuery
-
-        return None
-
-    def _get_profile_sample(self) -> Optional[ProfileSampleConfig]:
-        try:
-            if self.table_entity.tableProfilerConfig.profileSample:
-                return ProfileSampleConfig(
-                    profile_sample=self.table_entity.tableProfilerConfig.profileSample,
-                    profile_sample_type=self.table_entity.tableProfilerConfig.profileSampleType,
-                )
-        except AttributeError:
-            # if tableProfilerConfig is None it will indicate that the table has not profiler config
-            # hence we can return None
-            return None
-        return None
-
     def _get_table_config(self):
         """Get the sampling configuration for the data quality tests"""
-        sample_query = self._get_sample_query()
-        sample_config = None
-        partition_config = None
-        if not sample_query:
-            sample_config = self._get_profile_sample()
-            partition_config = get_partition_details(self.table_entity)
-
-        return sample_query, sample_config, partition_config
+        return (
+            self.sampler.sample_query,
+            self.sampler.sample_config,
+            self.sampler.partition_details,
+        )

metadata/data_quality/processor/test_case_runner.py

@@ -23,10 +23,8 @@ from metadata.data_quality.api.models import (
     TestCaseResults,
     TestSuiteProcessorConfig,
 )
+from metadata.data_quality.runner.base_test_suite_source import BaseTestSuiteRunner
 from metadata.data_quality.runner.core import DataTestsRunner
-from metadata.data_quality.runner.test_suite_source_factory import (
-    test_suite_source_factory,
-)
 from metadata.generated.schema.api.tests.createTestCase import CreateTestCaseRequest
 from metadata.generated.schema.entity.data.table import Table
 from metadata.generated.schema.entity.services.ingestionPipelines.status import (
@@ -95,12 +93,7 @@ class TestCaseRunner(Processor):
             record.table, openmetadata_test_cases
         )
 
-        test_suite_runner = test_suite_source_factory.create(
-            record.service_type.lower(),
-            self.config,
-            self.metadata,
-            record.table,
-        ).get_data_quality_runner()
+        test_suite_runner = self.get_test_suite_runner(record.table)
 
         logger.debug(
             f"Found {len(openmetadata_test_cases)} test cases for table {record.table.fullyQualifiedName.root}"
@@ -357,3 +350,10 @@ class TestCaseRunner(Processor):
             else:
                 result.append(tc)
         return result
+
+    def get_test_suite_runner(self, table: Table):
+        return BaseTestSuiteRunner(
+            self.config,
+            self.metadata,
+            table,
+        ).get_data_quality_runner()