File: common.py

package info (click to toggle)
libmodulemd 2.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 5,152 kB
  • sloc: ansic: 37,845; python: 3,236; xml: 1,739; sh: 377; makefile: 42
file content (221 lines) | stat: -rw-r--r-- 8,046 bytes parent folder | download | duplicates (3)
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
import json
import logging
import os
import sys

try:
    import unittest
    import gi

    gi.require_version("Modulemd", "2.0")
    from gi.repository import GLib
    from gi.repository import Modulemd
except ImportError:
    # Return error 77 to skip this test on platforms without the necessary
    # python modules
    sys.exit(77)

from base import TestBase

logging.basicConfig(level=logging.DEBUG)


class TestCommon(TestBase):
    def test_packager_read_file(self):
        # We have a chicken-egg problem with overrides, since they can only
        # be tested if they are already installed. This means they need to
        # be run in the CI. In order to avoid changes to these tests or the
        # overrides breaking things, we'll skip them if the appropriate
        # override is not installed.
        if not (
            "_overrides_module" in dir(Modulemd)
            and hasattr(gi.overrides.Modulemd, "read_packager_file")
        ):
            logging.debug(
                "read_packager_file() override not installed, skipping tests"
            )
            return

        # Validate that the PackagerV2 specification parses correctly
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_packager_v2.yaml"
            )
        )
        self.assertIsNotNone(doc)
        # Once read in, a modulemd-packager v2 document is a ModuleStream of the
        # same version.
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names are undefined
        self.assertIsNone(doc.get_module_name())
        self.assertIsNone(doc.get_stream_name())

        # Read the PackagerV2 specification with module/stream name overrides
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_packager_v2.yaml"
            ),
            "modulename-override",
            "streamname-override",
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")

        # Valid PackagerV3 file
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_packager_v3.yaml"
            )
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.PackagerV3)

        # Read PackagerV3 with module/stream name overrides
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_packager_v3.yaml"
            ),
            "modulename-override",
            "streamname-override",
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.PackagerV3)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")

        # Validate that the ModuleStreamV2 specification parses correctly
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_stream_v2.yaml"
            )
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names are correct
        self.assertEqual(doc.get_module_name(), "foo")
        self.assertEqual(doc.get_stream_name(), "latest")

        # Read the ModuleStreamV2 specification with module/stream name overrides
        doc = Modulemd.read_packager_file(
            os.path.join(
                self.source_root, "yaml_specs/modulemd_stream_v2.yaml"
            ),
            "modulename-override",
            "streamname-override",
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")

    def test_packager_read_string(self):
        # We have a chicken-egg problem with overrides, since they can only
        # be tested if they are already installed. This means they need to
        # be run in the CI. In order to avoid changes to these tests or the
        # overrides breaking things, we'll skip them if the appropriate
        # override is not installed.
        if not (
            "_overrides_module" in dir(Modulemd)
            and hasattr(gi.overrides.Modulemd, "read_packager_string")
        ):
            logging.debug(
                "read_packager_string() override not installed, skipping tests"
            )
            return

        # PackagerV2
        minimal_valid = """---
document: modulemd-packager
version: 2
data:
  summary: A minimal valid module
  description: A minimalistic module description
  license:
    module:
      - DUMMY
...
"""
        doc = Modulemd.read_packager_string(minimal_valid)
        self.assertIsNotNone(doc)
        # Once read in, a modulemd-packager document is a ModuleStream of the
        # same version.
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names are undefined
        self.assertIsNone(doc.get_module_name())
        self.assertIsNone(doc.get_stream_name())

        # Read again with module/stream name overrides
        doc = Modulemd.read_packager_string(
            minimal_valid, "modulename-override", "streamname-override"
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")

        # PackagerV3
        minimal_valid = """---
document: modulemd-packager
version: 3
data:
  summary: A minimal valid module
  description: A minimalistic module description
  license:
    - DUMMY
...
"""
        doc = Modulemd.read_packager_string(minimal_valid)
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.PackagerV3)
        # Confirm module and stream names are undefined
        self.assertIsNone(doc.get_module_name())
        self.assertIsNone(doc.get_stream_name())

        # Read again with module/stream name overrides
        doc = Modulemd.read_packager_string(
            minimal_valid, "modulename-override", "streamname-override"
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.PackagerV3)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")

        # ModuleStreamV2
        minimal_valid = """---
document: modulemd-stream
version: 2
data:
  summary: A minimal valid module
  description: A minimalistic module description
  license:
    module:
      - DUMMY
...
"""
        doc = Modulemd.read_packager_string(minimal_valid)
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names are undefined
        self.assertIsNone(doc.get_module_name())
        self.assertIsNone(doc.get_stream_name())

        # Read again with module/stream name overrides
        doc = Modulemd.read_packager_string(
            minimal_valid, "modulename-override", "streamname-override"
        )
        self.assertIsNotNone(doc)
        self.assertIs(type(doc), Modulemd.ModuleStreamV2)
        # Confirm module and stream names were set
        self.assertEqual(doc.get_module_name(), "modulename-override")
        self.assertEqual(doc.get_stream_name(), "streamname-override")


if __name__ == "__main__":
    unittest.main()