OpenMetadata/openmetadata-airflow-apis/src/openmetadata/operations/test_connection.py

#  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.
"""
Module containing the logic to test a connection
from a WorkflowSource
"""
from flask import Response
from openmetadata.api.response import ApiResponse

from metadata.utils.engines import (
    SourceConnectionException,
    get_engine,
    test_connection,
)


def test_source_connection(connection) -> Response:
    """
    Create the engine and test the connection
    :param workflow_source: Source to test
    :return: None or exception
    """
    engine = get_engine(connection)

    try:
        test_connection(engine)

    except SourceConnectionException as err:
        return ApiResponse.error(
            status=ApiResponse.STATUS_SERVER_ERROR,
            error=f"Connection error from {engine} - {err}",
        )

    return ApiResponse.success({"message": f"Connection with {engine} successful!"})