Skip to content

Commit

Permalink
tests use testcontainers for mysql
Browse files Browse the repository at this point in the history
  • Loading branch information
pmbrull committed Sep 16, 2024
1 parent b396580 commit 37b9413
Show file tree
Hide file tree
Showing 10 changed files with 473 additions and 466 deletions.
17 changes: 10 additions & 7 deletions ingestion/src/metadata/ingestion/source/database/sample_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
from metadata.utils.fqn import FQN_SEPARATOR
from metadata.utils.helpers import get_standard_chart_type
from metadata.utils.logger import ingestion_logger
from metadata.utils.time_utils import convert_timestamp_to_milliseconds, datetime_to_timestamp
from metadata.utils.time_utils import datetime_to_timestamp

logger = ingestion_logger()

Expand Down Expand Up @@ -1647,8 +1647,9 @@ def ingest_life_cycle(self) -> Iterable[Either[OMetaLifeCycleData]]:
timestamp=Timestamp(
int(
datetime_to_timestamp(
datetime_value=datetime.now() - timedelta(days=life_cycle["created"]["days"]),
milliseconds=True
datetime_value=datetime.now()
- timedelta(days=life_cycle["created"]["days"]),
milliseconds=True,
)
)
),
Expand All @@ -1659,8 +1660,9 @@ def ingest_life_cycle(self) -> Iterable[Either[OMetaLifeCycleData]]:
timestamp=Timestamp(
int(
datetime_to_timestamp(
datetime_value=datetime.now() - timedelta(days=life_cycle["updated"]["days"]),
milliseconds=True
datetime_value=datetime.now()
- timedelta(days=life_cycle["updated"]["days"]),
milliseconds=True,
)
),
),
Expand All @@ -1671,8 +1673,9 @@ def ingest_life_cycle(self) -> Iterable[Either[OMetaLifeCycleData]]:
timestamp=Timestamp(
int(
datetime_to_timestamp(
datetime_value=datetime.now() - timedelta(days=life_cycle["accessed"]["days"]),
milliseconds=True
datetime_value=datetime.now()
- timedelta(days=life_cycle["accessed"]["days"]),
milliseconds=True,
)
),
),
Expand Down
25 changes: 25 additions & 0 deletions ingestion/tests/integration/automations/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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.

"""Automations integration tests"""
import uuid

import pytest

from ..containers import MySqlContainerConfigs, get_mysql_container


@pytest.fixture(scope="session")
def mysql_container():
with get_mysql_container(
MySqlContainerConfigs(container_name=str(uuid.uuid4()))
) as container:
yield container
182 changes: 74 additions & 108 deletions ingestion/tests/integration/automations/test_connection_automation.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
"""
OpenMetadata high-level API Workflow test
"""
from unittest import TestCase

from sqlalchemy.engine import Engine

from metadata.generated.schema.api.automations.createWorkflow import (
Expand All @@ -34,129 +32,97 @@
MysqlConnection,
MySQLType,
)
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
OpenMetadataConnection,
)
from metadata.generated.schema.entity.services.connections.testConnectionResult import (
StatusType,
)
from metadata.generated.schema.entity.services.databaseService import DatabaseConnection
from metadata.generated.schema.entity.services.serviceType import ServiceType
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.ingestion.source.connections import get_connection, get_test_connection_fn

SERVICE_CONNECTION = MysqlConnection(
username="openmetadata_user",
authType=BasicAuth(password="openmetadata_password"),
hostPort="localhost:3306",
)


class TestConnectionAutomationTest(TestCase):
def test_connection_workflow(metadata, mysql_container):
"""
Run this integration test with the local API available
Install the ingestion package before running the tests
Test all the steps related to the test connection automation workflow
"""

service_entity_id = None
service_connection = MysqlConnection(
username=mysql_container.username,
authType=BasicAuth(password=mysql_container.password),
hostPort=f"localhost:{mysql_container.get_exposed_port(3306)}",
)

server_config = OpenMetadataConnection(
hostPort="http://localhost:8585/api",
authProvider="openmetadata",
securityConfig=OpenMetadataJWTClientConfig(
jwtToken="eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
new_workflow_request = CreateWorkflowRequest(
name="test-connection-mysql",
description="description",
workflowType=WorkflowType.TEST_CONNECTION,
request=TestServiceConnectionRequest(
serviceType=ServiceType.Database,
connectionType=MySQLType.Mysql.value,
connection=DatabaseConnection(
config=service_connection,
),
),
)
metadata = OpenMetadata(server_config)

assert metadata.health_check()

def test_connection_workflow(self):
"""
Test all the steps related to the test connection automation workflow
"""
new_workflow_request = CreateWorkflowRequest(
name="test-connection-mysql",
description="description",
workflowType=WorkflowType.TEST_CONNECTION,
request=TestServiceConnectionRequest(
serviceType=ServiceType.Database,
connectionType=MySQLType.Mysql.value,
connection=DatabaseConnection(
config=SERVICE_CONNECTION,
),
),
)

automation_workflow: Workflow = self.metadata.create_or_update(
data=new_workflow_request
)
engine: Engine = get_connection(SERVICE_CONNECTION)

test_connection_fn = get_test_connection_fn(SERVICE_CONNECTION)
test_connection_fn(
self.metadata, engine, SERVICE_CONNECTION, automation_workflow
)

final_workflow: Workflow = self.metadata.get_by_name(
entity=Workflow, fqn="test-connection-mysql"
)

self.assertEqual(final_workflow.status, WorkflowStatus.Successful)
self.assertEqual(len(final_workflow.response.steps), 4)
self.assertEqual(
final_workflow.response.status.value, StatusType.Successful.value
)

self.metadata.delete(
entity=Workflow,
entity_id=str(automation_workflow.id.root),
hard_delete=True,
)

def test_connection_workflow_ko(self):
"""Test connection that will fail"""
wrong_service_connection = MysqlConnection(
username="openmetadata_user",
authType=BasicAuth(password="openmetadata_password"),
hostPort="localhost:8585", # There's something running there, but it's not MySQL
databaseSchema="openmetadata_db",
)

wrong_workflow_request = CreateWorkflowRequest(
name="test-connection-mysql-bad",
description="description",
workflowType=WorkflowType.TEST_CONNECTION,
request=TestServiceConnectionRequest(
serviceType=ServiceType.Database,
connectionType=MySQLType.Mysql.value,
connection=DatabaseConnection(
config=wrong_service_connection,
),

automation_workflow: Workflow = metadata.create_or_update(data=new_workflow_request)
engine: Engine = get_connection(service_connection)

test_connection_fn = get_test_connection_fn(service_connection)
test_connection_fn(metadata, engine, service_connection, automation_workflow)

final_workflow: Workflow = metadata.get_by_name(
entity=Workflow, fqn="test-connection-mysql"
)

assert final_workflow.status == WorkflowStatus.Successful
assert len(final_workflow.response.steps) == 4
assert final_workflow.response.status.value == StatusType.Successful.value

metadata.delete(
entity=Workflow,
entity_id=str(automation_workflow.id.root),
hard_delete=True,
)


def test_connection_workflow_ko(metadata):
"""Test connection that will fail"""
wrong_service_connection = MysqlConnection(
username="openmetadata_user",
authType=BasicAuth(password="openmetadata_password"),
hostPort="localhost:8585", # There's something running there, but it's not MySQL
databaseSchema="openmetadata_db",
)

wrong_workflow_request = CreateWorkflowRequest(
name="test-connection-mysql-bad",
description="description",
workflowType=WorkflowType.TEST_CONNECTION,
request=TestServiceConnectionRequest(
serviceType=ServiceType.Database,
connectionType=MySQLType.Mysql.value,
connection=DatabaseConnection(
config=wrong_service_connection,
),
)
),
)

automation_workflow: Workflow = self.metadata.create_or_update(
data=wrong_workflow_request
)
engine: Engine = get_connection(wrong_service_connection)
automation_workflow: Workflow = metadata.create_or_update(
data=wrong_workflow_request
)
engine: Engine = get_connection(wrong_service_connection)

test_connection_fn = get_test_connection_fn(wrong_service_connection)
test_connection_fn(
self.metadata, engine, wrong_service_connection, automation_workflow
)
test_connection_fn = get_test_connection_fn(wrong_service_connection)
test_connection_fn(metadata, engine, wrong_service_connection, automation_workflow)

final_workflow: Workflow = self.metadata.get_by_name(
entity=Workflow, fqn="test-connection-mysql-bad"
)
final_workflow: Workflow = metadata.get_by_name(
entity=Workflow, fqn="test-connection-mysql-bad"
)

self.assertEqual(final_workflow.response.status, StatusType.Failed)
assert final_workflow.response.status == StatusType.Failed

self.metadata.delete(
entity=Workflow,
entity_id=str(automation_workflow.id.root),
hard_delete=True,
)
metadata.delete(
entity=Workflow,
entity_id=str(automation_workflow.id.root),
hard_delete=True,
)
25 changes: 25 additions & 0 deletions ingestion/tests/integration/connections/conftest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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.

"""Connections integration tests"""
import uuid

import pytest

from ..containers import MySqlContainerConfigs, get_mysql_container


@pytest.fixture(scope="session")
def mysql_container():
with get_mysql_container(
MySqlContainerConfigs(container_name=str(uuid.uuid4()))
) as container:
yield container
54 changes: 12 additions & 42 deletions ingestion/tests/integration/connections/test_mysql_connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@
# 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.

"""
MySQL connection test
"""
from unittest import TestCase

from sqlalchemy.engine import Engine

from metadata.generated.schema.entity.services.connections.database.common.basicAuth import (
Expand All @@ -22,51 +19,24 @@
from metadata.generated.schema.entity.services.connections.database.mysqlConnection import (
MysqlConnection,
)
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.ingestion.source.connections import get_connection, get_test_connection_fn


class MySQLConnectionTest(TestCase):
def test_test_connection(metadata, mysql_container):
"""
Validate MySQL connections
Test connection function requires:
- ometa
- connection object, i.e., the engine
- the service connection
"""

server_config = OpenMetadataConnection(
hostPort="http://localhost:8585/api",
authProvider="openmetadata",
securityConfig=OpenMetadataJWTClientConfig(
jwtToken="eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
),
)
metadata = OpenMetadata(server_config)

assert metadata.health_check()

service_connection = MysqlConnection(
username="openmetadata_user",
authType=BasicAuth(password="openmetadata_password"),
hostPort="localhost:3306",
databaseSchema="openmetadata_db",
username=mysql_container.username,
authType=BasicAuth(password=mysql_container.password),
hostPort=f"localhost:{mysql_container.get_exposed_port(3306)}",
)

def test_get_connection(self):
engine = get_connection(self.service_connection)
self.assertTrue(isinstance(engine, Engine))

def test_test_connection(self):
"""
Test connection function requires:
- ometa
- connection object, i.e., the engine
- the service connection
"""
engine = get_connection(self.service_connection)
engine = get_connection(service_connection)
assert isinstance(engine, Engine)

_test_connection_fn = get_test_connection_fn(self.service_connection)
_test_connection_fn(self.metadata, engine, self.service_connection)
_test_connection_fn = get_test_connection_fn(service_connection)
_test_connection_fn(metadata, engine, service_connection)
Loading

0 comments on commit 37b9413

Please sign in to comment.