From fef0592fe20ab7367e6a08af6b9e26dd9796ad61 Mon Sep 17 00:00:00 2001
From: Ani Sinha <anisinha@redhat.com>
Date: Thu, 18 Jul 2024 09:03:11 +0530
Subject: [PATCH] Support setting mirrorlist in yum repository config

'mirrorlist' config can be specified instead or along with 'baseurl' in the yum
repository config. Add support for specifying mirrorlist instead of 'baseurl'.

Fixes GH-5520
Signed-off-by: Ani Sinha <anisinha@redhat.com>
---
 cloudinit/config/cc_yum_add_repo.py           |  2 +-
 .../schemas/schema-cloud-config-v1.json       | 10 +++++
 doc/examples/cloud-config-yum-repo.txt        |  3 +-
 .../unittests/config/test_cc_yum_add_repo.py  | 40 ++++++++++++++++++-
 4 files changed, 52 insertions(+), 3 deletions(-)

diff --git a/cloudinit/config/cc_yum_add_repo.py b/cloudinit/config/cc_yum_add_repo.py
index 9a717af3d1a..548c83bab6d 100644
--- a/cloudinit/config/cc_yum_add_repo.py
+++ b/cloudinit/config/cc_yum_add_repo.py
@@ -141,7 +141,7 @@ def handle(name: str, cfg: Config, cloud: Cloud, args: list) -> None:
                 n_repo_config[k] = v
         repo_config = n_repo_config
         missing_required = 0
-        req_fields = ["baseurl", "metalink"]
+        req_fields = ["baseurl", "metalink", "mirrorlist"]
         for req_field in req_fields:
             if req_field not in repo_config:
                 missing_required += 1
diff --git a/cloudinit/config/schemas/schema-cloud-config-v1.json b/cloudinit/config/schemas/schema-cloud-config-v1.json
index e45504d4113..253e90b8c55 100644
--- a/cloudinit/config/schemas/schema-cloud-config-v1.json
+++ b/cloudinit/config/schemas/schema-cloud-config-v1.json
@@ -3457,6 +3457,11 @@
                   "format": "uri",
                   "description": "Specifies a URL to a metalink file for the repomd.xml"
                 },
+                "mirrorlist": {
+                  "type": "string",
+                  "format": "uri",
+                  "description": "Specifies a URL to a file containing a baseurls list"
+                },
                 "name": {
                   "type": "string",
                   "description": "Optional human-readable name of the yum repo."
@@ -3494,6 +3499,11 @@
                   "required": [
                     "metalink"
                   ]
+                },
+                {
+                  "required": [
+                    "mirrorlist"
+                  ]
                 }
               ]
             }
diff --git a/doc/examples/cloud-config-yum-repo.txt b/doc/examples/cloud-config-yum-repo.txt
index 6a4037e2462..cee26677b49 100644
--- a/doc/examples/cloud-config-yum-repo.txt
+++ b/doc/examples/cloud-config-yum-repo.txt
@@ -11,9 +11,10 @@ yum_repos:
     # Any repository configuration options
     # See: man yum.conf
     #
-    # At least one of 'baseurl' or 'metalink' is required!
+    # At least one of 'baseurl' or 'metalink' or 'mirrorlist' is required!
     baseurl: http://download.fedoraproject.org/pub/epel/testing/5/$basearch
     metalink: https://mirrors.fedoraproject.org/metalink?repo=epel-$releasever&arch=$basearch&infra=$infra&content=$contentdir
+    mirrorlist: https://mirrors.fedoraproject.org/metalink?repo=fedora-$releasever&
     enabled: false
     failovermethod: priority
     gpgcheck: true
diff --git a/tests/unittests/config/test_cc_yum_add_repo.py b/tests/unittests/config/test_cc_yum_add_repo.py
index e6a9109ee19..c77262f508f 100644
--- a/tests/unittests/config/test_cc_yum_add_repo.py
+++ b/tests/unittests/config/test_cc_yum_add_repo.py
@@ -31,7 +31,8 @@ def test_bad_config(self):
             "yum_repos": {
                 "epel-testing": {
                     "name": "Extra Packages for Enterprise Linux 5 - Testing",
-                    # At least one of baseurl or metalink must be present.
+                    # At least one of baseurl or metalink or mirrorlist
+                    # must be present.
                     # Missing this should cause the repo not to be written
                     # 'baseurl': 'http://blah.org/pub/epel/testing/5/$barch',
                     "enabled": False,
@@ -84,6 +85,43 @@ def test_metalink_config(self):
             for k, v in expected[section].items():
                 self.assertEqual(parser.get(section, k), v)
 
+    def test_mirrorlist_config(self):
+        cfg = {
+            "yum_repos": {
+                "epel-testing": {
+                    "name": "Extra Packages for Enterprise Linux 5 - Testing",
+                    "mirrorlist": "http://mirrors.blah.org/metalink?repo=rhel-$releasever",
+                    "enabled": False,
+                    "gpgcheck": True,
+                    "gpgkey": "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL",
+                    "failovermethod": "priority",
+                },
+            },
+        }
+        self.patchUtils(self.tmp)
+        self.patchOS(self.tmp)
+        cc_yum_add_repo.handle("yum_add_repo", cfg, None, [])
+        contents = util.load_text_file("/etc/yum.repos.d/epel-testing.repo")
+        parser = configparser.ConfigParser()
+        parser.read_string(contents)
+        expected = {
+            "epel-testing": {
+                "name": "Extra Packages for Enterprise Linux 5 - Testing",
+                "failovermethod": "priority",
+                "gpgkey": "file:///etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL",
+                "enabled": "0",
+                "mirrorlist": "http://mirrors.blah.org/metalink?repo=rhel-$releasever",
+                "gpgcheck": "1",
+            }
+        }
+        for section in expected:
+            self.assertTrue(
+                parser.has_section(section),
+                "Contains section {0}".format(section),
+            )
+            for k, v in expected[section].items():
+                self.assertEqual(parser.get(section, k), v)
+
     def test_write_config(self):
         cfg = {
             "yum_repos": {