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
|
# Pylint doesn't play well with fixtures and dependency injection from pytest
# pylint: disable=redefined-outer-name
import os
import pytest
from buildstream._context import Context
from buildstream import _yaml, utils
from buildstream._exceptions import LoadError
from buildstream.exceptions import LoadErrorReason
DATA_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "context",)
# Simple fixture to create a Context object.
@pytest.fixture()
def context_fixture():
if os.environ.get("XDG_CACHE_HOME"):
cache_home = os.environ["XDG_CACHE_HOME"]
else:
cache_home = os.path.expanduser("~/.cache")
with Context() as context:
yield {"xdg-cache": cache_home, "context": context}
#######################################
# Test instantiation #
#######################################
def test_context_create(context_fixture):
context = context_fixture["context"]
assert isinstance(context, Context)
#######################################
# Test configuration loading #
#######################################
def test_context_load(context_fixture):
context = context_fixture["context"]
cache_home = os.path.normpath(context_fixture["xdg-cache"])
assert isinstance(context, Context)
context.load(config=os.devnull)
assert context.sourcedir == os.path.join(cache_home, "buildstream", "sources")
assert context.builddir == os.path.join(cache_home, "buildstream", "build")
assert context.cachedir == os.path.join(cache_home, "buildstream")
assert context.logdir == os.path.join(cache_home, "buildstream", "logs")
# Assert that a changed XDG_CACHE_HOME doesn't cause issues
def test_context_load_envvar(context_fixture):
os.environ["XDG_CACHE_HOME"] = "/some/path/"
context = context_fixture["context"]
assert isinstance(context, Context)
context.load(config=os.devnull)
assert context.sourcedir == os.path.join("/", "some", "path", "buildstream", "sources")
assert context.builddir == os.path.join("/", "some", "path", "buildstream", "build")
assert context.cachedir == os.path.join("/", "some", "path", "buildstream")
assert context.logdir == os.path.join("/", "some", "path", "buildstream", "logs")
# Reset the environment variable
del os.environ["XDG_CACHE_HOME"]
# Test that values in a user specified config file
# override the defaults
@pytest.mark.datafiles(os.path.join(DATA_DIR))
def test_context_load_user_config(context_fixture, datafiles):
context = context_fixture["context"]
cache_home = context_fixture["xdg-cache"]
assert isinstance(context, Context)
conf_file = os.path.join(datafiles.dirname, datafiles.basename, "userconf.yaml")
context.load(conf_file)
assert context.sourcedir == os.path.expanduser("~/pony")
assert context.builddir == os.path.join(cache_home, "buildstream", "build")
assert context.cachedir == os.path.join(cache_home, "buildstream")
assert context.logdir == os.path.join(cache_home, "buildstream", "logs")
@pytest.mark.datafiles(os.path.join(DATA_DIR))
def test_context_priority(datafiles):
confdir = os.path.join(str(datafiles), "config")
os.makedirs(confdir)
# The fallback (usual) config file
bst_conf_path = os.path.join(confdir, "buildstream.conf")
bst_conf = {"sourcedir": "/sources"}
_yaml.roundtrip_dump(bst_conf, bst_conf_path)
# The version specific config file
major_version, _ = utils._get_bst_api_version()
bst_conf_path = os.path.join(confdir, "buildstream{}.conf".format(major_version))
bst_conf = {"sourcedir": "/other_sources"}
_yaml.roundtrip_dump(bst_conf, bst_conf_path)
# Load the Context() object and assert that we've chosen
# the version specific one.
#
os.environ["XDG_CONFIG_HOME"] = confdir
with Context() as context:
context.load()
assert context.sourcedir == "/other_sources"
del os.environ["XDG_CONFIG_HOME"]
#######################################
# Test failure modes #
#######################################
@pytest.mark.datafiles(os.path.join(DATA_DIR))
def test_context_load_missing_config(context_fixture, datafiles):
context = context_fixture["context"]
assert isinstance(context, Context)
conf_file = os.path.join(datafiles.dirname, datafiles.basename, "nonexistant.yaml")
with pytest.raises(LoadError) as exc:
context.load(conf_file)
assert exc.value.reason == LoadErrorReason.MISSING_FILE
@pytest.mark.datafiles(os.path.join(DATA_DIR))
def test_context_load_malformed_config(context_fixture, datafiles):
context = context_fixture["context"]
assert isinstance(context, Context)
conf_file = os.path.join(datafiles.dirname, datafiles.basename, "malformed.yaml")
with pytest.raises(LoadError) as exc:
context.load(conf_file)
assert exc.value.reason == LoadErrorReason.INVALID_YAML
@pytest.mark.datafiles(os.path.join(DATA_DIR))
def test_context_load_notdict_config(context_fixture, datafiles):
context = context_fixture["context"]
assert isinstance(context, Context)
conf_file = os.path.join(datafiles.dirname, datafiles.basename, "notdict.yaml")
with pytest.raises(LoadError) as exc:
context.load(conf_file)
# XXX Should this be a different LoadErrorReason ?
assert exc.value.reason == LoadErrorReason.INVALID_YAML
|
