config.py 9.12 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# Copyright 2018 Markus Scheidgen
#
# 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.

Markus Scheidgen's avatar
Markus Scheidgen committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
"""
This module describes all configurable parameters for the nomad python code. The
configuration is used for all executed python code including API, worker, CLI, and other
scripts. To use the configuration in your own scripts or new modules, simply import
this module.

All parameters are structured into objects for two reasons. First, to have
categories. Second, to allow runtime manipulation that is not effected
by python import logic. The categories are choosen along infrastructure components:
``mongo``, ``elastic``, etc.

This module also provides utilities to read the configuration from environment variables
and .yaml files. This is done automatically on import. The precedence is env over .yaml
over defaults.

.. autoclass:: nomad.config.NomadConfig
.. autofunction:: nomad.config.apply
.. autofunction:: nomad.config.load_config
"""

Markus Scheidgen's avatar
Markus Scheidgen committed
35
import logging
36
37
38
import os
import os.path
import yaml
Markus Scheidgen's avatar
Markus Scheidgen committed
39
40
import warnings

Markus Scheidgen's avatar
Markus Scheidgen committed
41
42
43
from nomad import gitinfo


Markus Scheidgen's avatar
Markus Scheidgen committed
44
45
46
warnings.filterwarnings("ignore", message="numpy.dtype size changed")
warnings.filterwarnings("ignore", message="numpy.ufunc size changed")

47

48
49
class NomadConfig(dict):
    """
Markus Scheidgen's avatar
Markus Scheidgen committed
50
51
    A class for configuration categories. It is a dict subclass that uses attributes as
    key/value pairs.
52
53
54
55
56
57
58
59
60
61
62
63
    """
    def __init__(self, **kwargs):
        super().__init__(**kwargs)

    def __getattr__(self, name):
        if name in self:
            return self[name]
        else:
            raise AttributeError("No such attribute: " + name)

    def __setattr__(self, name, value):
        self[name] = value
64

65
66
67
68
69
    def __delattr__(self, name):
        if name in self:
            del self[name]
        else:
            raise AttributeError("No such attribute: " + name)
70
71


72
73
CELERY_WORKER_ROUTING = 'worker'
CELERY_QUEUE_ROUTING = 'queue'
74

75
76
77
78
79
rabbitmq = NomadConfig(
    host='localhost',
    user='rabbitmq',
    password='rabbitmq'
)
80

81

82
83
def rabbitmq_url():
    return 'pyamqp://%s:%s@%s//' % (rabbitmq.user, rabbitmq.password, rabbitmq.host)
84

85

86
87
88
89
celery = NomadConfig(
    max_memory=64e6,  # 64 GB
    timeout=1800,  # 1/2 h
    acks_late=True,
90
    routing=CELERY_QUEUE_ROUTING,
91
92
93
94
95
    priorities={
        'Upload.process_upload': 5,
        'Upload.delete_upload': 9,
        'Upload.publish_upload': 10
    }
96
)
97

98
99
100
101
fs = NomadConfig(
    tmp='.volumes/fs/tmp',
    staging='.volumes/fs/staging',
    public='.volumes/fs/public',
102
    coe_extracted='.volumes/fs/extracted',
103
    migration_packages='.volumes/fs/migration_packages',
104
    local_tmp='/tmp',
105
106
    prefix_size=2,
    working_directory=os.getcwd()
107
)
108

109
110
111
112
113
elastic = NomadConfig(
    host='localhost',
    port=9200,
    index_name='nomad_fairdi_calcs'
)
114

115
repository_db = NomadConfig(
116
117
    sequential_publish=False,
    publish_enabled=True,
118
119
120
121
    host='localhost',
    port=5432,
    dbname='nomad_fairdi_repo_db',
    user='postgres',
122
    password='nomad',
123
124
    handle_prefix='21.11132/',
    mode='fairdi'
125
)
Markus Scheidgen's avatar
Markus Scheidgen committed
126

127
128
129
130
131
mongo = NomadConfig(
    host='localhost',
    port=27017,
    db_name='nomad_fairdi'
)
132

133
134
135
136
137
138
logstash = NomadConfig(
    enabled=True,
    host='localhost',
    tcp_port='5000',
    level=logging.DEBUG
)
Markus Scheidgen's avatar
Markus Scheidgen committed
139

140
141
142
services = NomadConfig(
    api_host='localhost',
    api_port=8000,
143
    api_base_path='/fairdi/nomad/latest/api',
144
    api_secret='defaultApiSecret',
145
    api_chaos=0,
146
    admin_password='password',
147
    disable_reset=True,
148
    not_processed_value='not processed',
149
    unavailable_value='unavailable',
150
    https=False,
151
    upload_limit=10
152
153
)

Markus Scheidgen's avatar
Markus Scheidgen committed
154
155
156
157
tests = NomadConfig(
    default_timeout=30
)

158

159
160
161
def api_url(ssl: bool = True):
    return '%s://%s%s' % (
        'https' if services.https and ssl else 'http',
Markus Scheidgen's avatar
Markus Scheidgen committed
162
163
        services.api_host,
        services.api_base_path)
164
165
166
167
168
169
170
171
172
173
174
175
176
177


migration_source_db = NomadConfig(
    host='db-repository.nomad.esc',
    port=5432,
    dbname='nomad_prod',
    user='nomadlab',
    password='*'
)

mail = NomadConfig(
    enabled=False,
    with_login=False,
    host='',
Markus Scheidgen's avatar
Markus Scheidgen committed
178
    port=8995,
179
180
    user='',
    password='',
181
182
    from_address='webmaster@nomad-coe.eu',
    cc_address='webmaster@nomad-coe.eu'
183
184
185
)

normalize = NomadConfig(
186
    all_systems=False,
187
    system_classification_with_clusters_threshold=50
188
189
190
191
192
)

client = NomadConfig(
    user='leonard.hofstadter@nomad-fairdi.tests.de',
    password='password',
193
    url='http://localhost:8000/fairdi/nomad/latest/api'
194
195
)

196
version = '0.5.4'
197
commit = gitinfo.commit
198
release = 'devel'
199
200
domain = 'DFT'
service = 'unknown nomad service'
201
auxfile_cutoff = 100
202
parser_matching_size = 9128
203
console_log_level = logging.WARNING
204

205

206
207
def normalize_loglevel(value, default_level=logging.INFO):
    plain_value = value
208
209
210
211
212
213
    if plain_value is None:
        return default_level
    else:
        try:
            return int(plain_value)
        except ValueError:
214
            return getattr(logging, plain_value)
215
216


217
transformations = {
218
219
    'console_log_level': normalize_loglevel,
    'logstash_level': normalize_loglevel
220
}
Markus Scheidgen's avatar
Markus Scheidgen committed
221

Markus Scheidgen's avatar
Markus Scheidgen committed
222

223
224
225
226
# use std python logger, since logging is not configured while loading configuration
logger = logging.getLogger(__name__)


227
def apply(key, value) -> None:
228
229
230
231
232
233
234
235
    """
    Changes the config according to given key and value. The keys are interpreted as paths
    to config values with ``_`` as a separator. E.g. ``fs_staging`` leading to
    ``config.fs.staging``
    """
    path = list(reversed(key.split('_')))
    child_segment = None
    current_value = None
236
    child_config = globals()
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
    child_key = None

    try:
        while len(path) > 0:
            if child_segment is None:
                child_segment = path.pop()
            else:
                child_segment += '_' + path.pop()

            if child_segment in child_config:
                current_value = child_config[child_segment]

            if current_value is None:
                if len(path) == 0:
                    raise KeyError
252
253

                continue
254
255
            if isinstance(current_value, NomadConfig):
                child_config = current_value
256
                current_value = None
257
258
259
260
                child_segment = None
            else:
                if len(path) > 0:
                    raise KeyError()
Markus Scheidgen's avatar
Markus Scheidgen committed
261
262
263

                child_key = child_segment
                break
264
265
266
267

        if child_key is None or current_value is None:
            raise KeyError()
    except KeyError:
Markus Scheidgen's avatar
Markus Scheidgen committed
268
        return
269
270
271
272
273
274
275
276
277
278
279

    if not isinstance(value, type(current_value)):
        try:
            value = transformations.get(key, type(current_value))(value)
        except Exception as e:
            logger.error(
                'config key %s value %s has wrong type: %s' % (key, str(value), str(e)))

    child_config[child_key] = value


Markus Scheidgen's avatar
Markus Scheidgen committed
280
def load_config(config_file: str = os.environ.get('NOMAD_CONFIG', 'nomad.yaml')) -> None:
Markus Scheidgen's avatar
Markus Scheidgen committed
281
282
283
284
285
286
287
    """
    Loads the configuration from the ``config_file`` and environment.

    Arguments:
        config_file: Override the configfile, default is file stored in env variable
            NOMAD_CONFIG or ``nomad.yaml``.
    """
Markus Scheidgen's avatar
Markus Scheidgen committed
288
    # load yaml and override defaults
289
290
291
    if os.path.exists(config_file):
        with open(config_file, 'r') as stream:
            try:
292
                config_data = yaml.load(stream, Loader=getattr(yaml, 'FullLoader'))
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
            except yaml.YAMLError as e:
                logger.error('cannot read nomad config', exc_info=e)

        def adapt(config, new_config, child_key=None):
            for key, value in new_config.items():
                if key in config:
                    if child_key is None:
                        qualified_key = key
                    else:
                        qualified_key = '%s_%s' % (child_key, key)

                    current_value = config[key]
                    if isinstance(value, dict) and isinstance(current_value, NomadConfig):
                        adapt(current_value, value, qualified_key)
                    else:
                        if not isinstance(value, type(current_value)):
                            try:
                                value = transformations.get(qualified_key, type(current_value))(value)
                            except Exception as e:
                                logger.error(
                                    'config key %s value %s has wrong type: %s' % (key, str(value), str(e)))
                        else:
                            config[key] = value
316
                            logger.info('override config key %s with value %s' % (key, str(value)))
317
318
319
320
321
                else:
                    logger.error('config key %s does not exist' % key)

        adapt(globals(), config_data)

Markus Scheidgen's avatar
Markus Scheidgen committed
322
    # load env and override yaml and defaults
323
324
325
326
327
    kwargs = {
        key[len('NOMAD_'):].lower(): value
        for key, value in os.environ.items()
        if key.startswith('NOMAD_')
    }
328

329
    for key, value in kwargs.items():
330
        apply(key, value)
331
332
333


load_config()