OpenMetadata/ingestion/tests/unit/topology/pipeline/test_databricks_pipeline.py

#  Copyright 2025 Collate
#  Licensed under the Collate Community License, Version 1.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#  https://github.com/open-metadata/OpenMetadata/blob/main/ingestion/LICENSE
#  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.
"""
Databricks Pipeline utils tests
"""

import json
import uuid
from pathlib import Path
from unittest import TestCase
from unittest.mock import patch

from metadata.generated.schema.api.data.createPipeline import CreatePipelineRequest
from metadata.generated.schema.api.lineage.addLineage import AddLineageRequest
from metadata.generated.schema.entity.data.pipeline import (
    Pipeline,
    PipelineStatus,
    Task,
    TaskStatus,
)
from metadata.generated.schema.entity.data.table import Column, Table
from metadata.generated.schema.entity.services.pipelineService import (
    PipelineConnection,
    PipelineService,
    PipelineServiceType,
)
from metadata.generated.schema.metadataIngestion.workflow import (
    OpenMetadataWorkflowConfig,
)
from metadata.generated.schema.type.basic import FullyQualifiedEntityName
from metadata.generated.schema.type.entityLineage import (
    ColumnLineage,
    EntitiesEdge,
    LineageDetails,
)
from metadata.generated.schema.type.entityReference import EntityReference
from metadata.ingestion.models.pipeline_status import OMetaPipelineStatus
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.ingestion.source.pipeline.databrickspipeline.metadata import (
    DatabrickspipelineSource,
)
from metadata.ingestion.source.pipeline.databrickspipeline.models import (
    DataBrickPipelineDetails,
)
from metadata.utils.logger import log_ansi_encoded_string

mock_file_path = (
    Path(__file__).parent.parent.parent
    / "resources/datasets/databricks_pipeline_resource.json"
)
with open(mock_file_path) as file:
    mock_data: dict = json.load(file)

mock_file_path = (
    Path(__file__).parent.parent.parent
    / "resources/datasets/databricks_pipeline_history.json"
)
with open(mock_file_path) as file:
    mock_run_data: dict = json.load(file)


mock_databricks_config = {
    "source": {
        "type": "DatabricksPipeline",
        "serviceName": "DatabricksPipeline",
        "serviceConnection": {
            "config": {
                "type": "DatabricksPipeline",
                "token": "random_token",
                "hostPort": "localhost:443",
                "connectionTimeout": 120,
                "connectionArguments": {
                    "http_path": "sql/1.0/endpoints/path",
                },
            }
        },
        "sourceConfig": {"config": {"type": "PipelineMetadata"}},
    },
    "sink": {"type": "metadata-rest", "config": {}},
    "workflowConfig": {
        "openMetadataServerConfig": {
            "hostPort": "http://localhost:8585/api",
            "authProvider": "openmetadata",
            "securityConfig": {
                "jwtToken": "eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGc"
                "iOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE"
                "2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXB"
                "iEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fN"
                "r3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3u"
                "d-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
            },
        }
    },
}

MOCK_PIPELINE_SERVICE = PipelineService(
    id="85811038-099a-11ed-861d-0242ac120002",
    name="databricks_pipeline_test",
    fullyQualifiedName=FullyQualifiedEntityName("databricks_pipeline_test"),
    connection=PipelineConnection(),
    serviceType=PipelineServiceType.DatabricksPipeline,
)

MOCK_PIPELINE = Pipeline(
    id="2aaa012e-099a-11ed-861d-0242ac120002",
    name="11223344",
    fullyQualifiedName="databricks_pipeline_test.11223344",
    displayName="OpenMetadata Databricks Workflow",
    tasks=[
        Task(
            name="Orders_Ingest",
            description="Ingests order data",
            sourceUrl="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
            downstreamTasks=[],
            taskType="SINGLE_TASK",
        ),
        Task(
            name="Match",
            description="Matches orders with user sessions",
            sourceUrl="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
            downstreamTasks=["Orders_Ingested", "Sessionize"],
            taskType="SINGLE_TASK",
        ),
        Task(
            name="Sessionize",
            description="Extracts session data from events",
            sourceUrl="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
            downstreamTasks=[],
            taskType="SINGLE_TASK",
        ),
    ],
    service=EntityReference(
        id="85811038-099a-11ed-861d-0242ac120002", type="pipelineService"
    ),
)

EXPECTED_CREATED_PIPELINES = CreatePipelineRequest(
    name="11223344",
    displayName="OpenMetadata Databricks Workflow",
    description="This job contain multiple tasks that are required to produce the weekly shark sightings report.",
    tasks=[
        Task(
            name="Sessionize",
            description="Extracts session data from events",
            sourceUrl="https://localhost:443/#job/11223344",
            downstreamTasks=[],
            taskType="SINGLE_TASK",
        ),
        Task(
            name="Orders_Ingest",
            description="Ingests order data",
            sourceUrl="https://localhost:443/#job/11223344",
            downstreamTasks=[],
            taskType="SINGLE_TASK",
        ),
        Task(
            name="Matched_Changed",
            description="Matches orders with user sessions",
            sourceUrl="https://localhost:443/#job/11223344",
            downstreamTasks=["Orders_Ingest", "Sessionize", "Sessionize_duplicated"],
            taskType="SINGLE_TASK",
        ),
    ],
    scheduleInterval="20 30 * * * ?",
    service=FullyQualifiedEntityName(root="databricks_pipeline_test"),
)

EXPECTED_PIPELINE_STATUS = [
    OMetaPipelineStatus(
        pipeline_fqn="databricks_pipeline_test.11223344",
        pipeline_status=PipelineStatus(
            timestamp=1625060460483,
            executionStatus="Successful",
            taskStatus=[
                TaskStatus(
                    name="Orders_Ingest",
                    executionStatus="Successful",
                    startTime=1625060460483,
                    endTime=1625060863413,
                    logLink="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
                ),
                TaskStatus(
                    name="Match",
                    executionStatus="Successful",
                    startTime=1625060460483,
                    endTime=1625060863413,
                    logLink="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
                ),
                TaskStatus(
                    name="Sessionize",
                    executionStatus="Successful",
                    startTime=1625060460483,
                    endTime=1625060863413,
                    logLink="https://my-workspace.cloud.databricks.com/#job/11223344/run/123",
                ),
            ],
        ),
    ),
]

PIPELINE_LIST = [DataBrickPipelineDetails(**data) for data in mock_data]

EXPECTED_PIPELINE_LINEAGE = AddLineageRequest(
    edge=EntitiesEdge(
        fromEntity=EntityReference(
            id="cced5342-12e8-45fb-b50a-918529d43ed1", type="table"
        ),
        toEntity=EntityReference(
            id="6f5ad342-12e8-45fb-b50a-918529d43ed1", type="table"
        ),
        lineageDetails=LineageDetails(
            columnsLineage=[
                ColumnLineage(
                    fromColumns=[
                        FullyQualifiedEntityName(
                            root="local_table.dev.table_1.column_1"
                        )
                    ],
                    toColumn=FullyQualifiedEntityName(
                        root="local_table.dev.table_2.column_2"
                    ),
                )
            ],
            pipeline=EntityReference(
                id="1fa49082-a32c-4e71-ba4a-6a111b489ed6",
                type="pipeline",
            ),
            source="PipelineLineage",
        ),
    )
)


class DatabricksPipelineTests(TestCase):
    """
    Implements the necessary methods to extract
    Databricks Pipeline test
    """

    maxDiff = None

    @patch(
        "metadata.ingestion.source.pipeline.pipeline_service.PipelineServiceSource.test_connection"
    )
    def __init__(self, methodName, test_connection) -> None:
        super().__init__(methodName)
        log_ansi_encoded_string(message="init")
        test_connection.return_value = False
        config = OpenMetadataWorkflowConfig.model_validate(mock_databricks_config)

        self.databricks = DatabrickspipelineSource.create(
            mock_databricks_config["source"],
            config.workflowConfig.openMetadataServerConfig,
        )
        self.databricks.context.get().__dict__["pipeline"] = MOCK_PIPELINE.name.root
        self.databricks.context.get().__dict__[
            "pipeline_service"
        ] = MOCK_PIPELINE_SERVICE.name.root
        self.databricks.metadata = OpenMetadata(
            config.workflowConfig.openMetadataServerConfig
        )

    @patch(
        "metadata.ingestion.source.database.databricks.client.DatabricksClient.list_jobs"
    )
    # @patch(
    #     "metadata.ingestion.source.database.databricks.client.DatabricksClient.get_job_runs"
    # )
    def test_get_pipelines_list(self, list_jobs):
        list_jobs.return_value = mock_data
        results = list(self.databricks.get_pipelines_list())
        self.assertEqual(PIPELINE_LIST, results)

    def test_yield_pipeline(self):
        pipelines = list(self.databricks.yield_pipeline(PIPELINE_LIST[0]))[0].right
        self.assertEqual(pipelines, EXPECTED_CREATED_PIPELINES)

    @patch(
        "metadata.ingestion.source.database.databricks.client.DatabricksClient.get_job_runs"
    )
    def test_yield_pipeline_status(self, get_job_runs):
        get_job_runs.return_value = mock_run_data
        pipeline_status = [
            either.right
            for either in self.databricks.yield_pipeline_status(
                DataBrickPipelineDetails(**mock_data[0])
            )
        ]
        self.assertEqual(pipeline_status, EXPECTED_PIPELINE_STATUS)

    def test_databricks_pipeline_lineage(self):
        self.databricks.context.get().__dict__["pipeline"] = "11223344"
        self.databricks.context.get().__dict__[
            "pipeline_service"
        ] = "databricks_pipeline_test"
        mock_pipeline = Pipeline(
            id=uuid.uuid4(),
            name="11223344",
            fullyQualifiedName="databricks_pipeline_test.11223344",
            service=EntityReference(id=uuid.uuid4(), type="pipelineService"),
        )

        # Create source and target tables
        mock_source_table = Table(
            id="cced5342-12e8-45fb-b50a-918529d43ed1",
            name="table_1",
            fullyQualifiedName="local_table.dev.table_1",
            database=EntityReference(id=uuid.uuid4(), type="database"),
            columns=[
                Column(
                    name="column_1",
                    fullyQualifiedName="local_table.dev.table_1.column_1",
                    dataType="VARCHAR",
                )
            ],
            databaseSchema=EntityReference(id=uuid.uuid4(), type="databaseSchema"),
        )

        mock_target_table = Table(
            id="6f5ad342-12e8-45fb-b50a-918529d43ed1",
            name="table_2",
            fullyQualifiedName="local_table.dev.table_2",
            database=EntityReference(id=uuid.uuid4(), type="database"),
            columns=[
                Column(
                    name="column_2",
                    fullyQualifiedName="local_table.dev.table_2.column_2",
                    dataType="VARCHAR",
                )
            ],
            databaseSchema=EntityReference(id=uuid.uuid4(), type="databaseSchema"),
        )

        with patch.object(self.databricks.metadata, "get_by_name") as mock_get_by_name:

            def get_by_name_side_effect(entity, fqn):
                if entity == Pipeline:
                    if fqn == "databricks_pipeline_test.11223344":
                        return mock_pipeline
                elif entity == Table:
                    if "table_1" in fqn:
                        return mock_source_table
                    elif "table_2" in fqn:
                        return mock_target_table
                return None

            mock_get_by_name.side_effect = get_by_name_side_effect

            with patch.object(
                self.databricks.client, "get_table_lineage"
            ) as mock_get_table_lineage:
                mock_get_table_lineage.return_value = [
                    {
                        "source_table_full_name": "local_table.dev.table_1",
                        "target_table_full_name": "local_table.dev.table_2",
                    }
                ]
                with patch.object(
                    self.databricks.client, "get_column_lineage"
                ) as mock_get_column_lineage:
                    mock_get_column_lineage.return_value = [
                        ("column_1", "column_2"),
                        ("column_3", "column_4"),
                    ]
                    lineage_details = list(
                        self.databricks.yield_pipeline_lineage_details(
                            DataBrickPipelineDetails(**mock_data[0])
                        )
                    )[0].right
                    self.assertEqual(
                        lineage_details.edge.fromEntity.id,
                        EXPECTED_PIPELINE_LINEAGE.edge.fromEntity.id,
                    )
                    self.assertEqual(
                        lineage_details.edge.toEntity.id,
                        EXPECTED_PIPELINE_LINEAGE.edge.toEntity.id,
                    )
                    self.assertEqual(
                        lineage_details.edge.lineageDetails.columnsLineage,
                        EXPECTED_PIPELINE_LINEAGE.edge.lineageDetails.columnsLineage,
                    )

        with patch.object(self.databricks.metadata, "get_by_name") as mock_get_by_name:

            def get_by_name_side_effect(entity, fqn):
                if entity == Pipeline:
                    if fqn == "databricks_pipeline_test.11223344":
                        return mock_pipeline
                elif entity == Table:
                    if "table_1" in fqn:
                        return mock_source_table
                    elif "table_2" in fqn:
                        return mock_target_table
                return None

            mock_get_by_name.side_effect = get_by_name_side_effect

            with patch.object(
                self.databricks.client, "get_table_lineage"
            ) as mock_get_table_lineage:
                mock_get_table_lineage.return_value = [
                    {
                        "source_table_full_name": "local_table.dev.table_1",
                        "target_table_full_name": "local_table.dev.table_2",
                    }
                ]
                with patch.object(
                    self.databricks.client, "get_column_lineage"
                ) as mock_get_column_lineage:
                    mock_get_column_lineage.return_value = []  # No column lineage
                    lineage_details = list(
                        self.databricks.yield_pipeline_lineage_details(
                            DataBrickPipelineDetails(**mock_data[0])
                        )
                    )[0].right
                    self.assertEqual(
                        lineage_details.edge.fromEntity.id,
                        EXPECTED_PIPELINE_LINEAGE.edge.fromEntity.id,
                    )
                    self.assertEqual(
                        lineage_details.edge.toEntity.id,
                        EXPECTED_PIPELINE_LINEAGE.edge.toEntity.id,
                    )
                    self.assertEqual(
                        lineage_details.edge.lineageDetails.columnsLineage,
                        [],
                    )