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
|
# Pylint doesn't play well with fixtures and dependency injection from pytest
# pylint: disable=redefined-outer-name
import os
import shutil
import pytest
from buildstream import _yaml
from buildstream.testing import cli_integration as cli # pylint: disable=unused-import
from buildstream.testing._utils.site import HAVE_SANDBOX
pytestmark = pytest.mark.integration
DATA_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "project")
def create_manual_element(name, path, config, variables, environment, sources=None):
element = {
"kind": "manual",
"depends": [{"filename": "base.bst", "type": "build"}],
"config": config,
"variables": variables,
"environment": environment,
}
if sources:
element["sources"] = sources
os.makedirs(os.path.dirname(os.path.join(path, name)), exist_ok=True)
_yaml.roundtrip_dump(element, os.path.join(path, name))
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_element(cli, datafiles):
project = str(datafiles)
checkout = os.path.join(cli.directory, "checkout")
element_path = os.path.join(project, "elements")
element_name = "import/import.bst"
create_manual_element(
element_name,
element_path,
{
"configure-commands": ["echo './configure' >> test"],
"build-commands": ["echo 'make' >> test"],
"install-commands": ["echo 'make install' >> test", "cp test %{install-root}"],
"strip-commands": ["echo 'strip' >> %{install-root}/test"],
},
{},
{},
)
res = cli.run(project=project, args=["build", element_name])
assert res.exit_code == 0
res = cli.run(project=project, args=["artifact", "checkout", element_name, "--directory", checkout])
assert res.exit_code == 0
with open(os.path.join(checkout, "test")) as f:
text = f.read()
assert (
text
== """./configure
make
make install
strip
"""
)
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_element_environment(cli, datafiles):
project = str(datafiles)
checkout = os.path.join(cli.directory, "checkout")
element_path = os.path.join(project, "elements")
element_name = "import/import.bst"
create_manual_element(
element_name, element_path, {"install-commands": ["echo $V >> test", "cp test %{install-root}"]}, {}, {"V": 2}
)
res = cli.run(project=project, args=["build", element_name])
assert res.exit_code == 0
res = cli.run(project=project, args=["artifact", "checkout", element_name, "--directory", checkout])
assert res.exit_code == 0
with open(os.path.join(checkout, "test")) as f:
text = f.read()
assert text == "2\n"
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_element_noparallel(cli, datafiles):
project = str(datafiles)
checkout = os.path.join(cli.directory, "checkout")
element_path = os.path.join(project, "elements")
element_name = "import/import.bst"
create_manual_element(
element_name,
element_path,
{"install-commands": ["echo $MAKEFLAGS >> test", "echo $V >> test", "cp test %{install-root}"]},
{"notparallel": True},
{"MAKEFLAGS": "-j%{max-jobs} -Wall", "V": 2},
)
res = cli.run(project=project, args=["build", element_name])
assert res.exit_code == 0
res = cli.run(project=project, args=["artifact", "checkout", element_name, "--directory", checkout])
assert res.exit_code == 0
with open(os.path.join(checkout, "test")) as f:
text = f.read()
assert (
text
== """-j1 -Wall
2
"""
)
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_element_logging(cli, datafiles):
project = str(datafiles)
element_path = os.path.join(project, "elements")
element_name = "import/import.bst"
create_manual_element(
element_name,
element_path,
{
"configure-commands": ["echo configure"],
"build-commands": ["echo build"],
"install-commands": ["echo install"],
"strip-commands": ["echo strip"],
},
{},
{},
)
res = cli.run(project=project, args=["build", element_name])
assert res.exit_code == 0
# Verify that individual commands are logged
assert "echo configure" in res.stderr
assert "echo build" in res.stderr
assert "echo install" in res.stderr
assert "echo strip" in res.stderr
# Regression test for https://gitlab.com/BuildStream/buildstream/-/issues/1295.
#
# Test that the command-subdir variable works as expected.
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_command_subdir(cli, datafiles):
project = str(datafiles)
checkout = os.path.join(cli.directory, "checkout")
element_path = os.path.join(project, "elements")
element_name = "manual/command-subdir.bst"
sources = [{"kind": "local", "path": "files/manual-element/root"}]
create_manual_element(
element_name, element_path, {"install-commands": ["cp hello %{install-root}"]}, {}, {}, sources=sources,
)
# First, verify that element builds, and has the correct expected output.
result = cli.run(project=project, args=["build", element_name])
result.assert_success()
result = cli.run(project=project, args=["artifact", "checkout", element_name, "--directory", checkout])
result.assert_success()
with open(os.path.join(checkout, "hello")) as f:
assert f.read() == "hello from root\n"
# Now, change element configuration to have a different command-subdir.
# This should result in a different cache key.
create_manual_element(
element_name,
element_path,
{"install-commands": ["cp hello %{install-root}"]},
{"command-subdir": "subdir"},
{},
sources=sources,
)
# Verify that the element needs to be rebuilt.
assert cli.get_element_state(project, element_name) == "buildable"
# Finally, ensure that the variable actually takes effect.
result = cli.run(project=project, args=["build", element_name])
result.assert_success()
shutil.rmtree(checkout)
result = cli.run(project=project, args=["artifact", "checkout", element_name, "--directory", checkout])
result.assert_success()
with open(os.path.join(checkout, "hello")) as f:
assert f.read() == "hello from subdir\n"
# Test staging artifacts into subdirectories
@pytest.mark.datafiles(DATA_DIR)
@pytest.mark.skipif(not HAVE_SANDBOX, reason="Only available with a functioning sandbox")
def test_manual_stage_custom(cli, datafiles):
project = str(datafiles)
checkout = os.path.join(cli.directory, "checkout")
# Verify that the element builds, and has the correct expected output.
result = cli.run(project=project, args=["build", "manual/manual-stage-custom.bst"])
result.assert_success()
result = cli.run(
project=project, args=["artifact", "checkout", "manual/manual-stage-custom.bst", "--directory", checkout]
)
result.assert_success()
with open(os.path.join(checkout, "test.txt")) as f:
assert f.read() == "This is another test\n"
|