mirror of
				https://github.com/open-metadata/OpenMetadata.git
				synced 2025-11-03 20:19:31 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			107 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			107 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
#  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 to parse source connecetion config, to handle validation error
 | 
						|
"""
 | 
						|
 | 
						|
from openmetadata_managed_apis.utils.logger import utils_logger
 | 
						|
from pydantic import ValidationError
 | 
						|
 | 
						|
from metadata.ingestion.api.parser import (
 | 
						|
    HAS_INNER_CONNECTION,
 | 
						|
    InvalidWorkflowException,
 | 
						|
    _unsafe_parse_config,
 | 
						|
    get_connection_class,
 | 
						|
    get_service_type,
 | 
						|
)
 | 
						|
 | 
						|
logger = utils_logger()
 | 
						|
 | 
						|
 | 
						|
def parse_validation_err(validation_error: ValidationError) -> str:
 | 
						|
    """
 | 
						|
    Convert the validation error into a message to log
 | 
						|
    """
 | 
						|
    missing_fields = [
 | 
						|
        f"Extra parameter '{err.get('loc')[0]}'"
 | 
						|
        if len(err.get("loc")) == 1
 | 
						|
        else f"Extra parameter in {err.get('loc')}"
 | 
						|
        for err in validation_error.errors()
 | 
						|
        if err.get("type") == "value_error.extra"
 | 
						|
    ]
 | 
						|
 | 
						|
    extra_fields = [
 | 
						|
        f"Missing parameter '{err.get('loc')[0]}'"
 | 
						|
        if len(err.get("loc")) == 1
 | 
						|
        else f"Missing parameter in {err.get('loc')}"
 | 
						|
        for err in validation_error.errors()
 | 
						|
        if err.get("type") == "value_error.missing"
 | 
						|
    ]
 | 
						|
 | 
						|
    invalid_fields = [
 | 
						|
        f"Invalid parameter value for  '{err.get('loc')[0]}'"
 | 
						|
        if len(err.get("loc")) == 1
 | 
						|
        else f"Missing parameter in {err.get('loc')}"
 | 
						|
        for err in validation_error.errors()
 | 
						|
        if err.get("type") not in ("value_error.missing", "value_error.extra")
 | 
						|
    ]
 | 
						|
 | 
						|
    return "\n".join(missing_fields + extra_fields + invalid_fields)
 | 
						|
 | 
						|
 | 
						|
def _parse_inner_connection(connection_dict: dict, source_type: str) -> None:
 | 
						|
    """
 | 
						|
    Parse the inner connection of the flagged connectors
 | 
						|
 | 
						|
    :param config_dict: JSON configuration
 | 
						|
    :param source_type: source type name, e.g., Airflow.
 | 
						|
    """
 | 
						|
    inner_source_type = connection_dict["connection"]["config"]["connection"]["type"]
 | 
						|
    inner_service_type = get_service_type(inner_source_type)
 | 
						|
    inner_connection_class = get_connection_class(inner_source_type, inner_service_type)
 | 
						|
    _unsafe_parse_config(
 | 
						|
        config=connection_dict["connection"]["config"]["connection"],
 | 
						|
        cls=inner_connection_class,
 | 
						|
        message=f"Error parsing the inner service connection for {source_type}",
 | 
						|
    )
 | 
						|
 | 
						|
 | 
						|
def parse_service_connection(connection_dict: dict) -> None:
 | 
						|
    """
 | 
						|
    Parse the service connection and raise any scoped
 | 
						|
    errors during the validation process
 | 
						|
 | 
						|
    :param connection_dict: JSON configuration
 | 
						|
    """
 | 
						|
    # Unsafe access to the keys. Allow a KeyError if the config is not well formatted
 | 
						|
    source_type = connection_dict["connection"]["config"].get("type")
 | 
						|
    if source_type is None:
 | 
						|
        raise InvalidWorkflowException("Missing type in the serviceConnection config")
 | 
						|
 | 
						|
    logger.debug(
 | 
						|
        f"Error parsing the Workflow Configuration for {source_type} ingestion"
 | 
						|
    )
 | 
						|
 | 
						|
    service_type = get_service_type(source_type)
 | 
						|
    connection_class = get_connection_class(source_type, service_type)
 | 
						|
 | 
						|
    if source_type in HAS_INNER_CONNECTION:
 | 
						|
        # We will first parse the inner `connection` configuration
 | 
						|
        _parse_inner_connection(connection_dict, source_type)
 | 
						|
 | 
						|
    # Parse the service connection dictionary with the scoped class
 | 
						|
    _unsafe_parse_config(
 | 
						|
        config=connection_dict["connection"]["config"],
 | 
						|
        cls=connection_class,
 | 
						|
        message="Error parsing the service connection",
 | 
						|
    )
 |