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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
# Pylint doesn't play well with fixtures and dependency injection from pytest
# pylint: disable=redefined-outer-name
import os
import pytest
from pluginbase import PluginBase
from buildstream import Node
from buildstream._elementfactory import ElementFactory
from buildstream._sourcefactory import SourceFactory
from buildstream._exceptions import PluginError
DATA_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "pluginfactory",)
# Simple fixture to create a PluginBase object that
# we use for loading plugins.
@pytest.fixture()
def plugin_fixture():
return {"base": PluginBase(package="buildstream.plugins")}
##############################################################
# Basics: test the fixture, test we can create the factories #
##############################################################
def test_fixture(plugin_fixture):
assert isinstance(plugin_fixture["base"], PluginBase)
def test_source_factory(plugin_fixture):
factory = SourceFactory(plugin_fixture["base"])
assert isinstance(factory, SourceFactory)
def test_element_factory(plugin_fixture):
factory = ElementFactory(plugin_fixture["base"])
assert isinstance(factory, ElementFactory)
##############################################################
# Check that we can load custom sources & elements #
##############################################################
@pytest.mark.datafiles(os.path.join(DATA_DIR, "customsource"))
def test_custom_source(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
assert isinstance(factory, SourceFactory)
foo_type, _ = factory.lookup("foo")
assert foo_type.__name__ == "FooSource"
@pytest.mark.datafiles(os.path.join(DATA_DIR, "customelement"))
def test_custom_element(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
assert isinstance(factory, ElementFactory)
foo_type, _ = factory.lookup("foo")
assert foo_type.__name__ == "FooElement"
##############################################################
# Check plugin loading failure modes #
##############################################################
def test_missing_source(plugin_fixture):
factory = SourceFactory(plugin_fixture["base"])
assert isinstance(factory, SourceFactory)
# Test fails if PluginError is not raised
with pytest.raises(PluginError):
factory.lookup("foo")
def test_missing_element(plugin_fixture):
factory = ElementFactory(plugin_fixture["base"])
assert isinstance(factory, ElementFactory)
# Test fails if PluginError is not raised
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin that returns a value instead of Source subclass
@pytest.mark.datafiles(os.path.join(DATA_DIR, "notatype"))
def test_source_notatype(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin that returns a value instead of Element subclass
@pytest.mark.datafiles(os.path.join(DATA_DIR, "notatype"))
def test_element_notatype(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin that returns a type
# which is not a Source subclass
@pytest.mark.datafiles(os.path.join(DATA_DIR, "wrongtype"))
def test_source_wrongtype(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin that returns a type
# which is not a Element subclass
@pytest.mark.datafiles(os.path.join(DATA_DIR, "wrongtype"))
def test_element_wrongtype(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which fails to provide a setup() function
@pytest.mark.datafiles(os.path.join(DATA_DIR, "nosetup"))
def test_source_missing_setup(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which fails to provide a setup() function
@pytest.mark.datafiles(os.path.join(DATA_DIR, "nosetup"))
def test_element_missing_setup(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which provides a setup symbol
# that is not a function
@pytest.mark.datafiles(os.path.join(DATA_DIR, "badsetup"))
def test_source_bad_setup(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which provides a setup symbol
# that is not a function
@pytest.mark.datafiles(os.path.join(DATA_DIR, "badsetup"))
def test_element_bad_setup(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which requires an absurdly
# high version of buildstream
@pytest.mark.datafiles(os.path.join(DATA_DIR, "badversionsource"))
def test_source_badversion(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = SourceFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
# Load a factory with a plugin which requires an absurdly
# high version of buildstream
@pytest.mark.datafiles(os.path.join(DATA_DIR, "badversionelement"))
def test_element_badversion(plugin_fixture, datafiles):
plugins = [
Node.from_dict(
{"origin": "local", "path": os.path.join(datafiles.dirname, datafiles.basename), "plugins": ["foo"],}
)
]
factory = ElementFactory(plugin_fixture["base"], plugin_origins=plugins)
with pytest.raises(PluginError):
factory.lookup("foo")
##############################################################
# Check we can load different contexts of plugin #
##############################################################
# Load two factories, both of which define a different 'foo' plugin
@pytest.mark.datafiles(DATA_DIR)
def test_source_multicontext(plugin_fixture, datafiles):
plugins1 = Node.from_dict(
{
"origin": "local",
"path": os.path.join(datafiles.dirname, datafiles.basename, "customsource"),
"plugins": ["foo"],
}
)
plugins2 = Node.from_dict(
{
"origin": "local",
"path": os.path.join(datafiles.dirname, datafiles.basename, "anothersource"),
"plugins": ["foo"],
}
)
factory1 = SourceFactory(plugin_fixture["base"], plugin_origins=[plugins1])
factory2 = SourceFactory(plugin_fixture["base"], plugin_origins=[plugins2])
assert isinstance(factory1, SourceFactory)
assert isinstance(factory2, SourceFactory)
foo_type1, _ = factory1.lookup("foo")
foo_type2, _ = factory2.lookup("foo")
assert foo_type1.__name__ == "FooSource"
assert foo_type2.__name__ == "AnotherFooSource"
# Load two factories, both of which define a different 'foo' plugin
@pytest.mark.datafiles(DATA_DIR)
def test_element_multicontext(plugin_fixture, datafiles):
plugins1 = Node.from_dict(
{
"origin": "local",
"path": os.path.join(datafiles.dirname, datafiles.basename, "customelement"),
"plugins": ["foo"],
}
)
plugins2 = Node.from_dict(
{
"origin": "local",
"path": os.path.join(datafiles.dirname, datafiles.basename, "anotherelement"),
"plugins": ["foo"],
}
)
factory1 = ElementFactory(plugin_fixture["base"], plugin_origins=[plugins1])
factory2 = ElementFactory(plugin_fixture["base"], plugin_origins=[plugins2])
assert isinstance(factory1, ElementFactory)
assert isinstance(factory2, ElementFactory)
foo_type1, _ = factory1.lookup("foo")
foo_type2, _ = factory2.lookup("foo")
assert foo_type1.__name__ == "FooElement"
assert foo_type2.__name__ == "AnotherFooElement"
|
