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
|
import os
import sys
import traceback
from contextlib import contextmanager, ExitStack
from click.testing import CliRunner
import pytest
# Import the main cli entrypoint
from buildstream._frontend.main import cli as bst_cli
from buildstream import _yaml
class Cli():
def __init__(self, directory):
self.directory = directory
self.config = None
self.cli_runner = CliRunner()
# configure():
#
# Serializes a user configuration into a buildstream.conf
# to use for this test cli.
#
# Args:
# config (dict): The user configuration to use
#
def configure(self, config):
self.config = config
# run():
#
# Runs buildstream with the given arguments, additionally
# also passes some global options to buildstream in order
# to stay contained in the testing environment.
#
# Args:
# configure (bool): Whether to pass a --config argument
# project (str): An optional path to a project
# silent (bool): Whether to pass --no-verbose
# env (dict): Environment variables to temporarily set during the test
# args (list): A list of arguments to pass buildstream
#
def run(self, configure=True, project=None, silent=False, env=None, cwd=None, args=None):
if args is None:
args = []
with ExitStack() as stack:
bst_args = []
if silent:
bst_args += ['--no-verbose']
if configure:
config_file = stack.enter_context(
configured(self.directory, self.config)
)
bst_args += ['--config', config_file]
if project:
bst_args += ['--directory', project]
bst_args += args
if cwd is not None:
stack.enter_context(chdir(cwd))
if env is not None:
stack.enter_context(environment(env))
# Ensure we have a working stdout - required to work
# around a bug that appears to cause AIX to close
# sys.__stdout__ after setup.py
try:
sys.__stdout__.fileno()
except ValueError:
sys.__stdout__ = open('/dev/stdout', 'w')
result = self.cli_runner.invoke(bst_cli, bst_args)
# Some informative stdout we can observe when anything fails
command = "bst " + " ".join(bst_args)
print("BuildStream exited with code {} for invocation:\n\t{}"
.format(result.exit_code, command))
print("Program output was:\n{}".format(result.output))
if result.exc_info and result.exc_info[0] != SystemExit:
traceback.print_exception(*result.exc_info)
return result
# Fetch an element state by name by
# invoking bst show on the project with the CLI
#
def get_element_state(self, project, element_name):
result = self.run(project=project, silent=True, args=[
'show',
'--deps', 'none',
'--format', '%{state}',
element_name
])
assert result.exit_code == 0
return result.output.strip()
# Fetch an element's cache key by invoking bst show
# on the project with the CLI
#
def get_element_key(self, project, element_name):
result = self.run(project=project, silent=True, args=[
'show',
'--deps', 'none',
'--format', '%{full-key}',
element_name
])
assert result.exit_code == 0
return result.output.strip()
# Main fixture
#
# Use result = cli.run([arg1, arg2]) to run buildstream commands
#
@pytest.fixture()
def cli(tmpdir):
directory = os.path.join(str(tmpdir), 'cache')
os.makedirs(directory)
return Cli(directory)
@contextmanager
def chdir(directory):
old_dir = os.getcwd()
os.chdir(directory)
yield
os.chdir(old_dir)
@contextmanager
def environment(env):
old_env = {}
for key, value in env.items():
old_env[key] = os.environ.get(key)
os.environ[key] = value
yield
for key, value in old_env.items():
if value is None:
del os.environ[key]
else:
os.environ[key] = value
@contextmanager
def configured(directory, config=None):
# Ensure we've at least relocated the caches to a temp directory
if not config:
config = {}
config['sourcedir'] = os.path.join(directory, 'sources')
config['builddir'] = os.path.join(directory, 'build')
config['artifactdir'] = os.path.join(directory, 'artifacts')
config['logdir'] = os.path.join(directory, 'logs')
# Dump it and yield the filename for test scripts to feed it
# to buildstream as an artument
filename = os.path.join(directory, "buildstream.conf")
_yaml.dump(config, filename)
yield filename
|
