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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
#
# Copyright (C) 2017 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:
# Jürg Billeter <juerg.billeter@codethink.co.uk>
"""
junction - Integrate subprojects
================================
This element is a link to another BuildStream project. It allows integration
of multiple projects into a single pipeline.
Overview
--------
.. code:: yaml
kind: junction
# Specify the BuildStream project source
sources:
- kind: git
url: upstream:projectname.git
track: master
ref: d0b38561afb8122a3fc6bafc5a733ec502fcaed6
# Specify the junction configuration
config:
# Override project options
options:
machine_arch: "%{machine_arch}"
debug: True
# Optionally look in a subpath of the source repository for the project
path: projects/hello
# Optionally specify another junction element to serve as a target for
# this element. Target should be defined using the syntax
# ``{junction-name}:{element-name}``.
#
# Note that this option cannot be used in conjunction with sources.
target: sub-project.bst:sub-sub-project.bst
.. note::
The configuration option to allow specifying junction targets is available
since :ref:`format version 24 <project_format_version>`.
.. note::
Junction elements may not specify any dependencies as they are simply
links to other projects and are not in the dependency graph on their own.
With a junction element in place, local elements can depend on elements in
the other BuildStream project using the additional ``junction`` attribute in the
dependency dictionary:
.. code:: yaml
depends:
- junction: toolchain.bst
filename: gcc.bst
type: build
While junctions are elements, only a limited set of element operations is
supported. They can be tracked and fetched like other elements.
However, junction elements do not produce any artifacts, which means that
they cannot be built or staged. It also means that another element cannot
depend on a junction element itself.
.. note::
BuildStream does not implicitly track junction elements. This means
that if we were to invoke: `bst build --track-all ELEMENT` on an element
which uses a junction element, the ref of the junction element
will not automatically be updated if a more recent version exists.
Therefore, if you require the most up-to-date version of a subproject,
you must explicitly track the junction element by invoking:
`bst source track JUNCTION_ELEMENT`.
Furthermore, elements within the subproject are also not tracked by default.
For this, we must specify the `--track-cross-junctions` option. This option
must be preceeded by `--track ELEMENT` or `--track-all`.
Sources
-------
``bst show`` does not implicitly fetch junction sources if they haven't been
cached yet. However, they can be fetched explicitly:
.. code::
bst source fetch junction.bst
Other commands such as ``bst build`` implicitly fetch junction sources.
Options
-------
.. code:: yaml
options:
machine_arch: "%{machine_arch}"
debug: True
Junctions can configure options of the linked project. Options are never
implicitly inherited across junctions, however, variables can be used to
explicitly assign the same value to a subproject option.
.. _core_junction_nested:
Nested Junctions
----------------
Junctions can be nested. That is, subprojects are allowed to have junctions on
their own. Nested junctions in different subprojects may point to the same
project, however, in most use cases the same project should be loaded only once.
BuildStream uses the junction element name as key to determine which junctions
to merge. It is recommended that the name of a junction is set to the same as
the name of the linked project.
As the junctions may differ in source version and options, BuildStream cannot
simply use one junction and ignore the others. Due to this, BuildStream requires
the user to resolve possibly conflicting nested junctions by creating a junction
with the same name in the top-level project, which then takes precedence.
Targeting other junctions
~~~~~~~~~~~~~~~~~~~~~~~~~
When working with nested junctions, you can also create a junction element that
targets another junction element in the sub-project. This can be useful if you
need to ensure that both the top-level project and the sub-project are using
the same version of the sub-sub-project.
This can be done using the ``target`` configuration option. See below for an
example:
.. code:: yaml
kind: junction
config:
target: subproject.bst:subsubproject.bst
In the above example, this junction element would be targeting the junction
element named ``subsubproject.bst`` in the subproject referred to by
``subproject.bst``.
Note that when targeting another junction, the names of the junction element
must not be the same as the name of the target.
"""
from buildstream import Element, ElementError
from buildstream._pipeline import PipelineError
# Element implementation for the 'junction' kind.
class JunctionElement(Element):
# pylint: disable=attribute-defined-outside-init
# Junctions are not allowed any dependencies
BST_FORBID_BDEPENDS = True
BST_FORBID_RDEPENDS = True
def configure(self, node):
self.path = node.get_str('path', default='')
self.options = node.get_mapping('options', default={})
self.target = node.get_str('target', default=None)
self.target_element = None
self.target_junction = None
def preflight(self):
# "target" cannot be used in conjunction with:
# 1. sources
# 2. config['options']
# 3. config['path']
if self.target and any(self.sources()):
raise ElementError("junction elements cannot define both 'sources' and 'target' config option")
if self.target and any(self.options.items()):
raise ElementError("junction elements cannot define both 'options' and 'target'")
if self.target and self.path:
raise ElementError("junction elements cannot define both 'path' and 'target'")
# Validate format of target, if defined
if self.target:
try:
self.target_junction, self.target_element = self.target.split(":")
except ValueError:
raise ElementError("'target' option must be in format '{junction-name}:{element-name}'")
# We cannot target a junction that has the same name as us, since that
# will cause an infinite recursion while trying to load it.
if self.name == self.target_element:
raise ElementError("junction elements cannot target an element with the same name")
def get_unique_key(self):
# Junctions do not produce artifacts. get_unique_key() implementation
# is still required for `bst source fetch`.
return 1
def configure_sandbox(self, sandbox):
raise PipelineError("Cannot build junction elements")
def stage(self, sandbox):
raise PipelineError("Cannot stage junction elements")
def generate_script(self):
raise PipelineError("Cannot build junction elements")
def assemble(self, sandbox):
raise PipelineError("Cannot build junction elements")
# Plugin entry point
def setup():
return JunctionElement
|
