File: test_project_image_mirrors.py

package info (click to toggle)
gitlabracadabra 2.8.0
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,520 kB
  • sloc: python: 12,305; javascript: 663; makefile: 4
file content (544 lines) | stat: -rw-r--r-- 22,718 bytes parent folder | download | duplicates (2)
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
#
# Copyright (C) 2019-2025 Mathieu Parent <math.parent@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from typing import NamedTuple
from unittest import skipIf
from unittest.mock import MagicMock, call, patch

from semantic_version import __version__ as semantic_version_version
from vcr import __version__ as vcr_version

from gitlabracadabra.containers.registries import Registries
from gitlabracadabra.containers.registry import Registry
from gitlabracadabra.containers.with_digest import WithDigest
from gitlabracadabra.objects.project import GitLabracadabraProject
from gitlabracadabra.tests import my_vcr
from gitlabracadabra.tests.case import TestCaseWithManager

VERIFY_DIGEST_METHOD = "_verify_digest"


class FixtureData(NamedTuple):
    mirrors: list[dict]
    mappings: list[tuple[str, str]]


TEST_DATA = (
    FixtureData(
        [{"from": "debian"}],
        [("docker.io/library/debian:latest", "mygroup/myproject/library/debian:latest")],
    ),
    FixtureData(
        [{"from": "debian:buster"}],
        [("docker.io/library/debian:buster", "mygroup/myproject/library/debian:buster")],
    ),
    FixtureData(
        [{"from": "debian:buster", "to": ""}],
        [("docker.io/library/debian:buster", "mygroup/myproject:buster")],
    ),
    FixtureData(
        [{"from": "debian:buster", "to": ":latest"}],
        [("docker.io/library/debian:buster", "mygroup/myproject:latest")],
    ),
    FixtureData(
        [{"from": "quay.org/coreos/etcd:v3.4.1", "to": "etcd:v3.4.1"}],
        [("quay.org/coreos/etcd:v3.4.1", "mygroup/myproject/etcd:v3.4.1")],
    ),
    FixtureData(
        [{"from": {"repositories": ["a"]}, "to": "etcd:v3.4.1"}],
        [("docker.io/library/a:latest", "mygroup/myproject/etcd:v3.4.1")],
    ),
    FixtureData(
        [{"from": {"repositories": ["a", "b"]}, "to": "etcd:v3.4.1"}],
        [
            ("docker.io/library/a:latest", "mygroup/myproject/etcd:v3.4.1"),
            ("docker.io/library/b:latest", "mygroup/myproject/etcd:v3.4.1"),
        ],
    ),
    FixtureData(
        [
            {
                "from": {
                    "base": "k8s.gcr.io/kubernetes",
                    "repositories": ["kube-apiserver", "kube-proxy"],
                    "tags": ["v1.20.4", "v1.20.6"],
                }
            }
        ],
        [
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4", "mygroup/myproject/kubernetes/kube-apiserver:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6", "mygroup/myproject/kubernetes/kube-apiserver:v1.20.6"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.4", "mygroup/myproject/kubernetes/kube-proxy:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.6", "mygroup/myproject/kubernetes/kube-proxy:v1.20.6"),
        ],
    ),
    FixtureData(
        [
            {
                "from": {
                    "base": "k8s.gcr.io/kubernetes",
                    "repositories": ["kube-apiserver", "kube-proxy"],
                    "tags": ["v1.20.4", "v1.20.6"],
                },
                "to": {},
            }
        ],
        [
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4",
                "mygroup/myproject/k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4",
            ),
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6",
                "mygroup/myproject/k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6",
            ),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.4", "mygroup/myproject/k8s.gcr.io/kubernetes/kube-proxy:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.6", "mygroup/myproject/k8s.gcr.io/kubernetes/kube-proxy:v1.20.6"),
        ],
    ),
    FixtureData(
        [
            {
                "from": {
                    "base": "k8s.gcr.io/kubernetes",
                    "repositories": ["kube-apiserver", "kube-proxy"],
                    "tags": ["v1.20.4", "v1.20.6"],
                },
                "to": {
                    "base": "new_base",
                },
            }
        ],
        [
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4", "mygroup/myproject/new_base/kube-apiserver:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6", "mygroup/myproject/new_base/kube-apiserver:v1.20.6"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.4", "mygroup/myproject/new_base/kube-proxy:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.6", "mygroup/myproject/new_base/kube-proxy:v1.20.6"),
        ],
    ),
    FixtureData(
        [
            {
                "from": {
                    "base": "k8s.gcr.io/kubernetes",
                    "repositories": ["kube-apiserver", "kube-proxy"],
                    "tags": ["v1.20.4", "v1.20.6"],
                },
                "to": {
                    "repository": "new_repo",
                },
            }
        ],
        [
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4",
                "mygroup/myproject/k8s.gcr.io/kubernetes/new_repo:v1.20.4",
            ),
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6",
                "mygroup/myproject/k8s.gcr.io/kubernetes/new_repo:v1.20.6",
            ),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.4", "mygroup/myproject/k8s.gcr.io/kubernetes/new_repo:v1.20.4"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.6", "mygroup/myproject/k8s.gcr.io/kubernetes/new_repo:v1.20.6"),
        ],
    ),
    FixtureData(
        [
            {
                "from": {
                    "base": "k8s.gcr.io/kubernetes",
                    "repositories": ["kube-apiserver", "kube-proxy"],
                    "tags": ["v1.20.4", "v1.20.6"],
                },
                "to": {
                    "tag": "new_tag",
                },
            }
        ],
        [
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.4",
                "mygroup/myproject/k8s.gcr.io/kubernetes/kube-apiserver:new_tag",
            ),
            (
                "k8s.gcr.io/kubernetes/kube-apiserver:v1.20.6",
                "mygroup/myproject/k8s.gcr.io/kubernetes/kube-apiserver:new_tag",
            ),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.4", "mygroup/myproject/k8s.gcr.io/kubernetes/kube-proxy:new_tag"),
            ("k8s.gcr.io/kubernetes/kube-proxy:v1.20.6", "mygroup/myproject/k8s.gcr.io/kubernetes/kube-proxy:new_tag"),
        ],
    ),
    # Regexps
    FixtureData(
        [
            {
                "from": {
                    "repositories": ["busybox", "debian"],
                    "tags": ["/(uns|s)(id|table)/"],
                },
                "to": {
                    "tag": r"how-\1-\2",
                },
            }
        ],
        [
            ("docker.io/library/busybox:stable", "mygroup/myproject/busybox:how-s-table"),
            ("docker.io/library/busybox:unstable", "mygroup/myproject/busybox:how-uns-table"),
            ("docker.io/library/debian:sid", "mygroup/myproject/debian:how-s-id"),
            ("docker.io/library/debian:stable", "mygroup/myproject/debian:how-s-table"),
            ("docker.io/library/debian:unstable", "mygroup/myproject/debian:how-uns-table"),
        ],
    ),
    FixtureData(
        [
            {
                "from": "busybox:/(uns|s)(id|table)/",
            }
        ],
        [
            ("docker.io/library/busybox:stable", "mygroup/myproject/library/busybox:stable"),
            ("docker.io/library/busybox:unstable", "mygroup/myproject/library/busybox:unstable"),
        ],
    ),
    FixtureData(
        [
            {
                "from": "busybox:/(uns|s)(id|table)/",
                "to": {
                    "tag": r"how-\1-\2",
                },
            }
        ],
        [
            ("docker.io/library/busybox:stable", "mygroup/myproject/docker.io/library/busybox:how-s-table"),
            ("docker.io/library/busybox:unstable", "mygroup/myproject/docker.io/library/busybox:how-uns-table"),
        ],
    ),
    # Semver
    FixtureData(
        [
            {
                "from": "k8s.gcr.io/kubernetes/kube-apiserver",
                "semver": ">=1.20.5",
            }
        ],
        [
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.20.5", "mygroup/myproject/kubernetes/kube-apiserver:v1.20.5"),
            ("k8s.gcr.io/kubernetes/kube-apiserver:v1.21.0", "mygroup/myproject/kubernetes/kube-apiserver:v1.21.0"),
        ],
    ),
)


class TestProjectImageMirrors(TestCaseWithManager):
    """Test image_mirrors param."""

    @my_vcr.use_cassette
    def test_image_mirrors_mocked(self, cass):
        """Test image_mirrors, with mocked Registry.import_manifest.

        Args:
            cass: VCR cassette.
        """
        registry = Registries().get_registry("registry.example.com")
        for test_data in TEST_DATA:
            with (
                self.subTest(mirrors=test_data.mirrors),
                patch.object(Registry, "import_manifest", autospec=True) as import_manifest_mock,
            ):
                project = GitLabracadabraProject(
                    "memory",
                    "mygroup/myproject",
                    {
                        "image_mirrors": test_data.mirrors,
                    },
                )
                assert project.errors() == []
                project._get = MagicMock()
                project._obj = type("", (), {})()
                project._obj.container_registry_image_prefix = "registry.example.com/mygroup/myproject"
                project.process()
                if any("semver" in mirror for mirror in test_data.mirrors) and semantic_version_version == "2.6.0":
                    self.skipTest(f"Too old semantic_version version={semantic_version_version}")
                    continue
                self._assert_mappings(registry, import_manifest_mock, test_data.mappings)
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirrors_auth(self, cass):
        """Test image_mirrors, auth'ing using JWT.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:c6b45a95f932202dbb27c31333c4789f45184a744060f6e569cc9d2bf1b9ad6f"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test_registry",
                {
                    "image_mirrors": [
                        {
                            "enabled": True,
                            "from": "busybox",
                            "to": "busybox",
                        }
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test_registry] ",
                            f"docker.io/library/busybox:latest@{expected_digest}",
                            "",
                            "root/test_registry/busybox",
                            "latest",
                            "1+0=1 uploaded+existing manifests",
                            "2+0+0=2 uploaded+mounted+existing blobs",
                            "766112+0+0=766112 uploaded+mounted+existing blobs size",
                        )
                    ]
                )
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirror_digest(self, cass):
        """Test image_mirrors, with source digest.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:de396b540b82219812061d0d753440d5655250c621c753ed1dc67d6154741607"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test_registry",
                {
                    "image_mirrors": [
                        {
                            "from": f"quay.io/operator-framework/olm@{expected_digest}",
                        }
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test_registry] ",
                            f"quay.io/operator-framework/olm:latest@{expected_digest}",
                            "",
                            "root/test_registry/operator-framework/olm",
                            "latest",
                            "1+0=1 uploaded+existing manifests",
                            "1+0+5=6 uploaded+mounted+existing blobs",
                            "16792050+0+76720801=93512851 uploaded+mounted+existing blobs size",
                        )
                    ]
                )
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirror_no_digest_header(self, cass):
        """Test image_mirrors, without Docker-Content-Digest header.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:7b4f6f33cdbdeaa631fc0ef53050d6880749acd965cd655e4a6b7604a027ff91"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test_registry",
                {
                    "image_mirrors": [
                        {
                            "from": "registry.access.redhat.com/rhscl/postgresql-10-rhel7:1",
                        }
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test_registry] ",
                            f"registry.access.redhat.com/rhscl/postgresql-10-rhel7:1@{expected_digest}",
                            "",
                            "root/test_registry/rhscl/postgresql-10-rhel7",
                            "1",
                            "1+0=1 uploaded+existing manifests",
                            "4+0+1=5 uploaded+mounted+existing blobs",
                            "117503892+0+6812=117510704 uploaded+mounted+existing blobs size",
                        )
                    ]
                )
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirror_manifest_v1(self, cass):
        """Test image_mirrors, application/vnd.docker.distribution.manifest.v1+prettyjws.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:b19e1c859c5d1b23169453a5abfaa37299106f77a1e1227381739c4461915984"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test_registry",
                {
                    "image_mirrors": [
                        {
                            "from": "quay.io/jetstack/cert-manager-controller:v0.1.0",
                        }
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test_registry] ",
                            f"quay.io/jetstack/cert-manager-controller:v0.1.0@{expected_digest}",
                            "",
                            "root/test_registry/jetstack/cert-manager-controller",
                            "v0.1.0",
                            "1+0=1 uploaded+existing manifests",
                            "4+0+3=7 uploaded+mounted+existing blobs",
                            "-4+0+-3=-7 uploaded+mounted+existing blobs size",  # 14173208+0+96=14173304
                        )
                    ]
                )
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirrors_mounted(self, cass):
        """Test image_mirrors, with mounted blobs.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:37aafd8a0b88f753556b2dc89091671f8bedeb869b2acf9aa2a22bffd563807a"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test_registry",
                {
                    "image_mirrors": [
                        {"from": "registry.developers.crunchydata.com/crunchydata/pgo-apiserver:centos8-4.6.2"},
                        {"from": "registry.developers.crunchydata.com/crunchydata/pgo-event:centos8-4.6.2"},
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test_registry] ",
                            f"registry.developers.crunchydata.com/crunchydata/pgo-event:centos8-4.6.2@{expected_digest}",
                            "",
                            "root/test_registry/crunchydata/pgo-event",
                            "centos8-4.6.2",
                            "1+0=1 uploaded+existing manifests",
                            "2+11+2=15 uploaded+mounted+existing blobs",
                            "18993004+121840748+64=140833816 uploaded+mounted+existing blobs size",
                        )
                    ]
                )
        assert cass.all_played

    @skipIf(vcr_version == "6.0.1", "vcrpy without iterator support https://github.com/kevin1024/vcrpy/pull/851")
    @my_vcr.use_cassette
    def test_image_mirrors_redirect(self, cass):
        """Test image_mirrors, with redirect.

        Args:
            cass: VCR cassette.
        """
        expected_digest = "sha256:4fd21f36075b44d1a423dfb262ad79202ce54e95f5cbc4622a6c1c38ab287ad6"
        with patch.object(WithDigest, VERIFY_DIGEST_METHOD) as verify_digest_mock:
            verify_digest_mock.return_value = None
            project = GitLabracadabraProject(
                "memory",
                "root/test-registry",
                {
                    "image_mirrors": [
                        {"from": "registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.5.0"},
                    ],
                },
            )
            assert project.errors() == []
            with patch("gitlabracadabra.containers.registry_importer.logger", autospec=True) as logger:
                project.process()
                logger.info.assert_has_calls(
                    [
                        call(
                            "%s%s %simported as %s:%s (%s, %s, %s)",
                            "[root/test-registry] ",
                            f"registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.5.0@{expected_digest}",
                            "",
                            "root/test-registry/sig-storage/csi-node-driver-registrar",
                            "v2.5.0",
                            "1+0=1 uploaded+existing manifests",
                            "3+0+0=3 uploaded+mounted+existing blobs",
                            "9128096+0+0=9128096 uploaded+mounted+existing blobs size",
                        )
                    ]
                )
        assert cass.all_played

    def _assert_mappings(self, registry, import_manifest_mock, mappings):
        assert len(import_manifest_mock.mock_calls) == len(mappings)
        for mapping_index, mapping in enumerate(mappings):
            _, args, kwargs = import_manifest_mock.mock_calls[mapping_index]
            assert len(args) == 3
            assert args[0] == registry
            assert str(args[1]) == mapping[0]
            assert "{}:{}".format(args[2], kwargs["tag"]) == mapping[1]
            assert kwargs == {
                "tag": mapping[1].rsplit(":").pop(),
                "platform": None,
                "log_prefix": "[mygroup/myproject] ",
                "dry_run": False,
            }