markusressel/container-app-conf

#  Copyright (c) 2019 Markus Ressel
#  .
#  Permission is hereby granted, free of charge, to any person obtaining a copy
#  of this software and associated documentation files (the "Software"), to deal
#  in the Software without restriction, including without limitation the rights
#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
#  copies of the Software, and to permit persons to whom the Software is
#  furnished to do so, subject to the following conditions:
#  .
#  The above copyright notice and this permission notice shall be included in all
#  copies or substantial portions of the Software.
#  .
#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
#  SOFTWARE.
import os
from pathlib import Path
from typing import List

from container_app_conf import ConfigEntry, ConfigFormatter
from container_app_conf.formatter.yaml import YamlFormatter


def find_duplicates(l: list) -> []:
    """
    Finds duplicate entries in the given list
    :param l: the list to check
    :return: map of (value -> list of indexes)
    """
    if not len(l) != len(set(l)):
        return []

    # remember indexes of items with equal hash
    tmp = {}
    for i, v in enumerate(l):
        if v in tmp.keys():
            tmp[v].append(i)
        else:
            tmp[v] = [i]

    result = {}
    for k, v in tmp.items():
        if len(v) > 1:
            result[k] = v

    return result


def generate_reference_config(config_entries: List[ConfigEntry]) -> {}:
    """
    Generates a dictionary containing the expected config tree filled with default and example values
    :return: a dictionary containing the expected config tree
    """
    return config_entries_to_dict(config_entries, use_examples=True)


def config_entries_to_dict(config_entries: List[ConfigEntry], hide_secrets: bool = False,
                           use_examples: bool = False) -> {}:
    """
    Converts a list of config entries to a dictionary
    :return: a dictionary containing the expected config tree
    """
    config_tree = {}
    for entry in config_entries:
        current_level = config_tree
        for path in entry.key_path[:-1]:
            if path not in current_level:
                current_level[path] = {}
            current_level = current_level[path]

        if hide_secrets and entry.secret:
            value = "_REDACTED_"
        else:
            value = entry._type_to_value(entry.example if use_examples else entry.value)

        current_level[entry.key_path[-1]] = value

    return config_tree


def regex_deepcopy_36_workaround():
    """
    Workaround for deepcopy bug in python<=3.6
    see: https://stackoverflow.com/questions/6279305/typeerror-cannot-deepcopy-this-pattern-object/56935186#56935186
    """
    import copy
    import re
    copy._deepcopy_dispatch[type(re.compile(''))] = lambda r, _: r


def write_reference(config, path: str or Path, formatter: ConfigFormatter = YamlFormatter()):
    """
    Writes an example configuration to the given path.
    :param config:
    :param path:
    :param formatter:
    :return:
    """
    path = Path(path).expanduser().resolve()
    if path.exists() and not path.is_file():
        raise AssertionError("Path exists and is not a file: {}".format(path))

    reference_config = generate_reference_config(list(config._config_entries.values()))
    text = formatter.format(reference_config)

    os.makedirs(path.parent, exist_ok=True)
    with open(path, "w") as file:
        file.seek(0)
        file.write(text)
        file.truncate()