stakkr.configreader

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Test Coverage

Coverage

97.78%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	Config.__init__()	0	9	1
A	Config.display_errors()	0	9	1
A	Config.read()	0	22	3
A	Config._build_config_files_list()	0	7	1
A	Config._build_config_schemas_list()	0	5	1

# coding: utf-8
"""Simple Config Reader."""

from collections.abc import Iterable

Unused Iterable imported from collections.abc

from os import path
from sys import stderr
import anyconfig
from jsonschema.exceptions import _Error

third party import "from jsonschema.exceptions import _Error" should be placed before "import anyconfig"

from stakkr.file_utils import get_file, find_project_dir


class Config:
    """
    Parser of Stakkr.

    Set default values and validate stakkr.yml with specs
    """

    def __init__(self, config_file: str):
        """
        Build list of files to validate a config, set default values
        Then the given config file
        """
        self.config_file, self.project_dir = get_config_and_project_dir(config_file)
        self._build_config_files_list()
        self._build_config_schemas_list()
        self.error = ''

    def display_errors(self):
        """Display errors in STDOUT."""
        from click import style

Import outside toplevel (click)

        msg = 'Failed validating config ('
        msg += ', '.join(self.config_files)
        msg += '):\n    - {}\n'.format(self.error)
        msg += '\nMake sure you have the right services.\n'
        stderr.write(style(msg, fg='red'))

    def read(self):
        """
        Parse the configs and validate it.

        It could be either local or from a local services
        (first local then packages by alphabetical order).
        """
        schema = anyconfig.multi_load(self.spec_files)
        config = anyconfig.multi_load(self.config_files)
        # Make sure the compiled configuration is valid
        try:
            anyconfig.validate(config, schema, safe=False)
        except _Error as error:
            error_path = ' -> '.join(map(str, error.path))
            self.error = '{} ({})'.format(error.message, error_path)
            return False

        config['project_dir'] = path.realpath(path.dirname(self.config_file))
        if config['project_name'] == '':
            config['project_name'] = path.basename(config['project_dir'])

        return config

    def _build_config_files_list(self):
        self.config_files = [
            # Stakkr default config
            get_file('static', 'config_default.yml'),
            '{}/services/*/config_default.yml'.format(self.project_dir)]
        # Stakkr main config file finally with user's values
        self.config_files += [self.config_file]

    def _build_config_schemas_list(self):
        self.spec_files = [
            # Stakkr config validation
            get_file('static', 'config_schema.yml'),
            '{}/services/*/config_schema.yml'.format(self.project_dir)]


def get_config_and_project_dir(config_file: str):
    """Guess config file name and project dir"""
    if config_file is not None:
        config_file = path.abspath(config_file)
        project_dir = path.dirname(config_file)
    else:
        project_dir = find_project_dir()
        config_file = '{}/stakkr.yml'.format(project_dir)

    return config_file, project_dir