1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
#!/usr/bin/env python3
#
# Copyright (C) 2016 Codethink Limited
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
"""Context for running BuildStream pipelines
The :class:`.Context` object holds all of the user preferences
and context for a given invocation of BuildStream.
This is a collection of data from configuration files and command
line arguments and consists of information such as where to store
logs and artifacts, where to perform builds and cache downloaded sources,
verbosity levels and basically anything pertaining to the context
in which BuildStream was invoked.
Users can provide a configuration file to override parameters in
the default configuration.
The default BuildStream configuration is included here for reference:
.. literalinclude:: ../../buildstream/data/userconfig.yaml
"""
import os
from . import _site
from . import _yaml
from ._yaml import CompositeTypeError
from . import LoadError, LoadErrorReason
class Context():
"""Context of how BuildStream was invoked
Args:
arch (string): The target architecture to build for
"""
def __init__(self, arch):
self.arch = arch
"""The target architecture to build for"""
self.sourcedir = None
"""The directory where various sources are stored"""
self.builddir = None
"""The directory where build sandboxes will be created"""
self.deploydir = None
"""The directory where deployment elements will place output"""
self.artifactdir = None
"""The local binary artifact cache directory"""
self.ccachedir = None
"""The directory for holding ccache state"""
def load(self, config=None):
"""Loads the configuration files
Args:
config (filename): The user specified configuration file, if any
Raises:
:class:`.LoadError`
This will first load the BuildStream default configuration and then
override that configuration with the configuration file indicated
by *config*, if any was specified.
"""
# Load default config
#
defaults = _yaml.load(_site.default_user_config)
if config:
user_config = _yaml.load(config)
try:
_yaml.composite_dict(defaults, user_config, typesafe=True)
except CompositeTypeError as e:
raise LoadError(LoadErrorReason.ILLEGAL_COMPOSITE,
"Expected '%s' type for configuration '%s', instead received '%s'" %
(e.expected_type.__name__,
e.path,
e.actual_type.__name__)) from e
for dir in ['sourcedir', 'builddir', 'deploydir', 'artifactdir', 'ccachedir']:
setattr(self, dir, os.path.expanduser(_yaml.node_get(defaults, str, dir)))
|
