Passed
Push — master ( c12d52...1f46d0 )
by Emmanuel
08:49
created

stakkr.configreader.get_config_and_project_dir()   A

Complexity

Conditions 2

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 2.0116

Importance

Changes 0
Metric Value
cc 2
eloc 7
nop 1
dl 0
loc 10
ccs 6
cts 7
cp 0.8571
crap 2.0116
rs 10
c 0
b 0
f 0
1
# coding: utf-8
2 1
"""Simple Config Reader."""
3
4 1
from collections.abc import Iterable
0 ignored issues
show
Unused Code introduced by
Unused Iterable imported from collections.abc
Loading history...
5 1
from os import path
6 1
from sys import stderr
7 1
import anyconfig
8 1
from jsonschema.exceptions import _Error
0 ignored issues
show
introduced by
third party import "from jsonschema.exceptions import _Error" should be placed before "import anyconfig"
Loading history...
9 1
from stakkr.file_utils import get_file, find_project_dir
10
11
12 1
class Config:
13
    """
14
    Parser of Stakkr.
15
16
    Set default values and validate stakkr.yml with specs
17
    """
18
19 1
    def __init__(self, config_file: str):
20
        """
21
        Build list of files to validate a config, set default values
22
        Then the given config file
23
        """
24 1
        self.config_file, self.project_dir = get_config_and_project_dir(config_file)
25 1
        self._build_config_files_list()
26 1
        self._build_config_schemas_list()
27 1
        self.error = ''
28
29 1
    def display_errors(self):
30
        """Display errors in STDOUT."""
31 1
        from click import style
32
33 1
        msg = 'Failed validating config ('
34 1
        msg += ', '.join(self.config_files)
35 1
        msg += '):\n    - {}\n'.format(self.error)
36 1
        msg += '\nMake sure you have the right services.\n'
37 1
        stderr.write(style(msg, fg='red'))
38
39 1
    def read(self):
40
        """
41
        Parse the configs and validate it.
42
43
        It could be either local or from a local services
44
        (first local then packages by alphabetical order).
45
        """
46 1
        schema = anyconfig.multi_load(self.spec_files)
47 1
        config = anyconfig.multi_load(self.config_files)
48
        # Make sure the compiled configuration is valid
49 1
        try:
50 1
            anyconfig.validate(config, schema, safe=False)
51 1
        except _Error as error:
52 1
            self.error = '{} ({})'.format(error.message, ' -> '.join(map(str, error.path)))
53 1
            return False
54
55 1
        config['project_dir'] = path.realpath(path.dirname(self.config_file))
56 1
        if config['project_name'] == '':
57 1
            config['project_name'] = path.basename(config['project_dir'])
58
59 1
        return config
60
61 1
    def _build_config_files_list(self):
62 1
        self.config_files = [
63
            # Stakkr default config
64
            get_file('static', 'config_default.yml'),
65
            '{}/services/*/config_default.yml'.format(self.project_dir)]
66
        # Stakkr main config file finally with user's values
67 1
        self.config_files += [self.config_file]
68
69 1
    def _build_config_schemas_list(self):
70 1
        self.spec_files = [
71
            # Stakkr config validation
72
            get_file('static', 'config_schema.yml'),
73
            '{}/services/*/config_schema.yml'.format(self.project_dir)]
74
75
76 1
def get_config_and_project_dir(config_file: str):
77
    """Guess config file name and project dir"""
78 1
    if config_file is not None:
79 1
        config_file = path.abspath(config_file)
80 1
        project_dir = path.dirname(config_file)
81
    else:
82 1
        project_dir = find_project_dir()
83
        config_file = '{}/stakkr.yml'.format(project_dir)
84
85
    return config_file, project_dir
86