add tests for mod_repo

salt/modules/yumpkg.py

@@ -3012,7 +3012,7 @@ def mod_repo(repo, basedir=None, **kwargs):
 
     if [x in repo_opts for x in link_types].count(True) >= 2:
         raise SaltInvocationError(
-            f"One and only one of {', '.join(link_types)} must be specified and is required"
+            f"One and only one of {', '.join(link_types)} can be used"
         )
 
     use_copr = False

tests/pytests/functional/modules/test_yumpkg.py

@@ -1,10 +1,14 @@
+import shutil
+
 import pytest
 
 import salt.modules.cmdmod
 import salt.modules.config
 import salt.modules.pkg_resource
 import salt.modules.yumpkg
+import salt.utils.files
 import salt.utils.pkg.rpm
+from salt.exceptions import SaltInvocationError
 
 pytestmark = [
     pytest.mark.skip_if_binaries_missing("rpm", "yum"),
@@ -39,6 +43,30 @@ def configure_loader_modules(minion_opts, grains):
     }
 
 
+@pytest.fixture
+def repo_basedir(tmp_path):
+    basedir = tmp_path / "test_yum"
+    basedir.mkdir(exist_ok=True, parents=True)
+    repo_file = basedir / "salt-test-repo.repo"
+    file_contents = [
+        "[salt-repo]",
+        "name=Salt repo for RHEL/CentOS 8 PY3",
+        "baseurl=https://repo.saltproject.io/salt/py3/redhat/8/x86_64/latest",
+        "skip_if_unavailable=True",
+        "priority=10",
+        "enabled_metadata=1",
+        "gcheck=1",
+        "gkey=https://repo.saltproject.io/salt/py3/redhat/8/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub",
+    ]
+    with salt.utils.files.fopen(str(repo_file), "w") as fd:
+        for line in file_contents:
+            fd.write(f"{line}\n")
+    try:
+        yield basedir
+    finally:
+        shutil.rmtree(str(basedir))
+
+
 def test_yum_list_pkgs(grains):
     """
     compare the output of rpm -qa vs the return of yumpkg.list_pkgs,
@@ -65,3 +93,167 @@ def test_yumpkg_remove_wildcard():
     assert ret["httpd-devel"]["old"]
     assert not ret["httpd-tools"]["new"]
     assert ret["httpd-tools"]["old"]
+
+
+def test_yumpkg_mod_repo_fails(repo_basedir):
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="basedir-fail-test", basedir="/fake/directory"
+        )
+    assert (
+        str(excinfo.value)
+        == "The repo does not exist and needs to be created, but none of the following basedir directories exist: ['/fake/directory']"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="missing-name-fail", basedir=str(repo_basedir)
+        )
+    assert (
+        str(excinfo.value)
+        == "The repo does not exist and needs to be created, but a name was not given"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="missing-url-fail", basedir=str(repo_basedir), name="missing_url"
+        )
+    assert (
+        str(excinfo.value)
+        == "The repo does not exist and needs to be created, but none of baseurl, mirrorlist, metalink was given"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="too-many-url-fail",
+            basedir=str(repo_basedir),
+            name="toomanyurls",
+            baseurl="https://example.com",
+            mirrorlist="https://example.com",
+            metalink="https://example.com",
+        )
+    assert (
+        str(excinfo.value)
+        == "One and only one of baseurl, mirrorlist, metalink can be used"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="too-many-url-fail",
+            basedir=str(repo_basedir),
+            name="toomanyurls",
+            baseurl="https://example.com",
+            metalink="https://example.com",
+        )
+    assert (
+        str(excinfo.value)
+        == "One and only one of baseurl, mirrorlist, metalink can be used"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="too-many-url-fail",
+            basedir=str(repo_basedir),
+            name="toomanyurls",
+            baseurl="https://example.com",
+            mirrorlist="https://example.com",
+        )
+    assert (
+        str(excinfo.value)
+        == "One and only one of baseurl, mirrorlist, metalink can be used"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="too-many-url-fail",
+            basedir=str(repo_basedir),
+            name="toomanyurls",
+            mirrorlist="https://example.com",
+            metalink="https://example.com",
+        )
+    assert (
+        str(excinfo.value)
+        == "One and only one of baseurl, mirrorlist, metalink can be used"
+    )
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="salt-repo",
+            basedir=str(repo_basedir),
+            name="",
+        )
+    assert str(excinfo.value) == "The repo name cannot be deleted"
+
+    with pytest.raises(SaltInvocationError) as excinfo:
+        salt.modules.yumpkg.mod_repo(
+            repo="salt-repo",
+            basedir=str(repo_basedir),
+            name="Salt repo for RHEL/CentOS 8 PY3",
+            baseurl="",
+        )
+    assert str(excinfo.value).startswith("Cannot delete baseurl without specifying")
+    assert "metalink" in str(excinfo.value)
+    assert "mirrorlist" in str(excinfo.value)
+
+
+def test_yumpkg_mod_repo_nochange(repo_basedir):
+    repo_file = repo_basedir / "salt-test-repo.repo"
+    test_enable = salt.modules.yumpkg.mod_repo(
+        repo="salt-repo",
+        basedir=str(repo_basedir),
+        name="Salt repo for RHEL/CentOS 8 PY3",
+        enable=True,
+    )
+    # check return on thing that we included in command
+    assert test_enable[str(repo_file)]["salt-repo"]["enable"] is True
+    # check return on thing that we did not include in command
+    assert (
+        test_enable[str(repo_file)]["salt-repo"]["gkey"]
+        == "https://repo.saltproject.io/salt/py3/redhat/8/x86_64/latest/SALT-PROJECT-GPG-PUBKEY-2023.pub"
+    )
+
+
+def test_yumpkg_mod_repo_baseurl_to_metalink(repo_basedir):
+    repo_file = repo_basedir / "salt-test-repo.repo"
+    test_metalink = salt.modules.yumpkg.mod_repo(
+        repo="salt-repo",
+        basedir=str(repo_basedir),
+        name="Salt repo for RHEL/CentOS 8 PY3",
+        metalink="https://example.com",
+    )
+    # new metalink item?
+    assert (
+        test_metalink[str(repo_file)]["salt-repo"]["metalink"] == "https://example.com"
+    )
+    # make sure baseurl is not in the result
+    assert "baseurl" not in test_metalink[str(repo_file)]["salt-repo"]
+
+
+def test_yumpkg_mod_repo_baseurl_to_mirrorlist(repo_basedir):
+    repo_file = repo_basedir / "salt-test-repo.repo"
+    test_mirrorlist = salt.modules.yumpkg.mod_repo(
+        repo="salt-repo",
+        basedir=str(repo_basedir),
+        name="Salt repo for RHEL/CentOS 8 PY3",
+        mirrorlist="https://example.com",
+    )
+    # new metalink item?
+    assert (
+        test_mirrorlist[str(repo_file)]["salt-repo"]["mirrorlist"]
+        == "https://example.com"
+    )
+    # make sure baseurl is not in the result
+    assert "baseurl" not in test_mirrorlist[str(repo_file)]["salt-repo"]
+
+
+def test_yumpkg_mod_repo_create_repo(repo_basedir):
+    repo_file = repo_basedir / "test.repo"
+    test_repo = salt.modules.yumpkg.mod_repo(
+        repo="test",
+        basedir=str(repo_basedir),
+        name="test repo",
+        baseurl="https://example.com",
+    )
+    # new metalink item?
+    assert test_repo[str(repo_file)]["test"]["baseurl"] == "https://example.com"
+    assert test_repo[str(repo_file)]["test"]["name"] == "test repo"

tests/pytests/unit/modules/test_yumpkg.py

@@ -3234,7 +3234,3 @@ def test_59705_version_as_accidental_float_should_become_text(
         yumpkg.install("fnord", version=new)
         call = cmd_mock.mock_calls[0][1][0]
         assert call == expected_cmd
-
-
-def test_mod_repo():
-    pass