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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
#!/usr/bin/python3
# This file is part of libmodulemd
# Copyright (C) 2017-2018 Stephen Gallagher
#
# Fedora-License-Identifier: MIT
# SPDX-2.0-License-Identifier: MIT
# SPDX-3.0-License-Identifier: MIT
#
# This program is free software.
# For more information on the license, see COPYING.
# For more information on free software, see
# <https://www.gnu.org/philosophy/free-sw.en.html>.
from os import path
import sys
try:
import unittest
import gi
gi.require_version("Modulemd", "2.0")
from gi.repository import Modulemd
from gi.repository.Modulemd import ModuleIndex
from gi.repository import GLib
except ImportError:
# Return error 77 to skip this test on platforms without the necessary
# python modules
sys.exit(77)
from base import TestBase
def debug_dump_failures(failures):
if failures is None or len(failures) == 0:
return
print("{} YAML subdocuments were invalid".format(len(failures)))
for f in failures:
print(
"Failed subdocument ({}):\n{}\n".format(
str(f.get_gerror()), f.get_yaml()
)
)
class TestModuleIndex(TestBase):
def test_constructors(self):
# Test that the new() function works
idx = ModuleIndex.new()
self.assertIsNotNone(idx)
self.assertListEqual(idx.get_module_names(), [])
self.assertIsNone(idx.get_module("foo"))
def test_read(self):
idx = ModuleIndex.new()
with open(
path.join(self.source_root, "yaml_specs/modulemd_stream_v1.yaml"),
"r",
) as v1:
res, failures = idx.update_from_string(v1.read(), True)
debug_dump_failures(failures)
self.assertListEqual(failures, [])
self.assertTrue(res)
for fname in [
"yaml_specs/modulemd_stream_v2.yaml",
"yaml_specs/modulemd_translations_v1.yaml",
"yaml_specs/modulemd_defaults_v1.yaml",
]:
res, failures = idx.update_from_file(
path.join(self.source_root, fname), True
)
debug_dump_failures(failures)
self.assertListEqual(failures, [])
self.assertTrue(res)
res, failures = idx.update_from_file(
path.join(self.test_data_path, "te.yaml"), True
)
self.assertFalse(res)
self.assertEqual(len(failures), 1)
self.assertIn(
"No document type specified", str(failures[0].get_gerror())
)
self.assertMultiLineEqual(
failures[0].get_yaml(),
"""---
summary: An example module
description: An example module.
profiles:
profile_a: An example profile
...
""",
)
self.assertListEqual(idx.get_module_names(), ["foo"])
mod_foo = idx.get_module("foo")
self.assertTrue(mod_foo.validate())
self.assertEqual(mod_foo.get_module_name(), "foo")
with self.assertRaisesRegex(
gi.repository.GLib.GError, "No streams matched"
):
mod_foo.get_stream_by_NSVCA("a", 5, "c")
self.assertEqual(len(mod_foo.get_all_streams()), 2)
self.assertIsNotNone(mod_foo.get_defaults())
defaults = mod_foo.get_defaults()
self.assertIsNotNone(defaults)
self.assertEqual(defaults.get_default_stream(), "x.y")
stream = mod_foo.get_stream_by_NSVCA(
"latest", 20160927144203, "c0ffee43"
)
self.assertIsNotNone(stream)
self.assertEqual(
stream.get_nsvc(), "foo:latest:20160927144203:c0ffee43"
)
self.assertEqual(
stream.get_description(None),
"A module for the demonstration of the metadata format. Also, the "
"obligatory lorem ipsum dolor sit amet goes right here.",
)
self.assertEqual(
stream.get_description("C"),
"A module for the demonstration of the metadata format. Also, the "
"obligatory lorem ipsum dolor sit amet goes right here.",
)
self.assertEqual(stream.get_description("en_GB"), "An example module.")
def test_get_default_streams(self):
idx = Modulemd.ModuleIndex.new()
idx.update_from_file(path.join(self.test_data_path, "f29.yaml"), True)
default_streams = idx.get_default_streams()
self.assertIsNotNone(default_streams)
self.assertIn("dwm", default_streams.keys())
self.assertEqual("6.1", default_streams["dwm"])
self.assertIn("stratis", default_streams.keys())
self.assertEqual("1", default_streams["stratis"])
self.assertNotIn("nodejs", default_streams.keys())
def test_dump_empty_index(self):
idx = Modulemd.ModuleIndex.new()
with self.assertRaisesRegex(
gi.repository.GLib.GError, "Index contains no modules."
):
yaml = idx.dump_to_string()
self.assertIsNone(yaml)
def test_update_from_defaults_directory(self):
idx = Modulemd.ModuleIndex.new()
self.assertIsNotNone(idx)
# First, verify that it works without overrides
ret = idx.update_from_defaults_directory(
path=path.join(self.test_data_path, "defaults"), strict=True
)
self.assertTrue(ret)
# There should be three modules here: meson, ninja and nodejs
self.assertEqual(len(idx.get_module_names()), 3)
self.assertIn("meson", idx.get_module_names())
self.assertIn("ninja", idx.get_module_names())
self.assertIn("nodejs", idx.get_module_names())
# Check default streams
defs = idx.get_default_streams()
self.assertIn("meson", defs)
self.assertEqual("latest", defs["meson"])
self.assertIn("ninja", defs)
self.assertEqual("latest", defs["ninja"])
self.assertNotIn("nodejs", defs)
# Now add overrides too
# First, verify that it works without overrides
ret = idx.update_from_defaults_directory(
path=path.join(self.test_data_path, "defaults"),
overrides_path=path.join(
self.test_data_path, "defaults", "overrides"
),
strict=True,
)
self.assertTrue(ret)
# There should be four modules here: meson, ninja, nodejs and
# testmodule
self.assertEqual(len(idx.get_module_names()), 4)
self.assertIn("meson", idx.get_module_names())
self.assertIn("ninja", idx.get_module_names())
self.assertIn("nodejs", idx.get_module_names())
self.assertIn("testmodule", idx.get_module_names())
# Check default streams
defs = idx.get_default_streams()
self.assertIn("meson", defs)
self.assertEqual("latest", defs["meson"])
self.assertIn("ninja", defs)
self.assertEqual("latest", defs["ninja"])
self.assertIn("nodejs", defs)
self.assertEqual("12", defs["nodejs"])
self.assertIn("testmodule", defs)
self.assertIn("teststream", defs["testmodule"])
# Nonexistent defaults dir
with self.assertRaisesRegex(GLib.Error, "No such file or directory"):
ret = idx.update_from_defaults_directory(
path=path.join(self.test_data_path, "defaults_nonexistent"),
strict=True,
)
self.assertFalse(ret)
# Nonexistent override dir
with self.assertRaisesRegex(GLib.Error, "No such file or directory"):
ret = idx.update_from_defaults_directory(
path=path.join(self.test_data_path, "defaults"),
overrides_path="overrides_nonexistent",
strict=True,
)
self.assertFalse(ret)
def test_clear_xmds(self):
if "_overrides_module" in dir(Modulemd) and hasattr(
gi.overrides.Modulemd, "ModuleStreamV2"
):
idx = Modulemd.ModuleIndex.new()
self.assertIsNotNone(idx)
ret, failures = idx.update_from_string(
"""
---
document: modulemd
version: 2
data:
name: foo
stream: latest
version: 1
static_context: true
context: c0ffee43
arch: s390x
summary: An example module
description: A longer description
license:
module: MIT
xmd:
a_key: a_value
another_key: another_value
an_array:
- a
- b
...
---
document: modulemd
version: 2
data:
name: foo
stream: latest
version: 2
static_context: true
context: c0ffee43
arch: s390x
summary: An example module
description: A longer description
license:
module: MIT
xmd:
a_key: a_value
another_key: another_value
an_array:
- a
- b
...
""",
strict=True,
)
self.assertEqual(len(failures), 0)
module_names = idx.get_module_names()
self.assertEqual(len(module_names), 1)
self.assertEqual(module_names[0], "foo")
module = idx.get_module(module_names[0])
self.assertEqual(len(module.get_all_streams()), 2)
ref_xmd = {
"a_key": "a_value",
"another_key": "another_value",
"an_array": ["a", "b"],
}
for stream in module.get_all_streams():
# Verify that the XMD data is present.
xmd = stream.get_xmd()
self.assertEqual(xmd, ref_xmd)
idx.clear_xmds()
for stream in module.get_all_streams():
# Verify that the XMD data is gone now.
self.assertEqual(stream.get_xmd(), {})
if __name__ == "__main__":
unittest.main()
|
