cephadm: add unit test coverage for cephadm NFSGanesha class

Fixes: https://tracker.ceph.com/issues/57621
Signed-off-by: John Mulligan <jmulligan@redhat.com>

diff --git a/src/cephadm/tests/test_nfs.py b/src/cephadm/tests/test_nfs.py
new file mode 100644 (file)
index 0000000..0649ef9
--- /dev/null
+++ b/src/cephadm/tests/test_nfs.py
@@ -0,0 +1,239 @@
+from unittest import mock
+import json
+
+import pytest
+
+from tests.fixtures import with_cephadm_ctx, cephadm_fs, import_cephadm
+
+_cephadm = import_cephadm()
+
+
+SAMPLE_UUID = "2d018a3f-8a8f-4cb9-a7cf-48bebb2cbaae"
+
+
+def good_nfs_json():
+    return nfs_json(
+        pool=True,
+        files=True,
+    )
+
+
+def nfs_json(**kwargs):
+    result = {}
+    if kwargs.get("pool"):
+        result["pool"] = "party"
+    if kwargs.get("files"):
+        result["files"] = {
+            "ganesha.conf": "",
+        }
+    if kwargs.get("rgw_content"):
+        result["rgw"] = dict(kwargs["rgw_content"])
+    elif kwargs.get("rgw"):
+        result["rgw"] = {
+            "keyring": "foobar",
+            "user": "jsmith",
+        }
+    return result
+
+
+@pytest.mark.parametrize(
+    "args,kwargs",
+    # args: <fsid>, <daemon_id>, <config_json>; kwargs: <image>
+    [
+        # fail due to: invalid fsid
+        (["foobar", "fred", good_nfs_json()], {}),
+        # fail due to: invalid daemon_id
+        ([SAMPLE_UUID, "", good_nfs_json()], {}),
+        # fail due to: invalid image
+        (
+            [SAMPLE_UUID, "fred", good_nfs_json()],
+            {"image": ""},
+        ),
+        # fail due to: no files in config_json
+        (
+            [
+                SAMPLE_UUID,
+                "fred",
+                nfs_json(pool=True),
+            ],
+            {},
+        ),
+        # fail due to: no pool in config_json
+        (
+            [
+                SAMPLE_UUID,
+                "fred",
+                nfs_json(files=True),
+            ],
+            {},
+        ),
+        # fail due to: bad rgw content
+        (
+            [
+                SAMPLE_UUID,
+                "fred",
+                nfs_json(pool=True, files=True, rgw_content={"foo": True}),
+            ],
+            {},
+        ),
+        # fail due to: rgw keyring given but no user
+        (
+            [
+                SAMPLE_UUID,
+                "fred",
+                nfs_json(
+                    pool=True, files=True, rgw_content={"keyring": "foo"}
+                ),
+            ],
+            {},
+        ),
+    ],
+)
+def test_nfsganesha_validation_errors(args, kwargs):
+    with pytest.raises(_cephadm.Error):
+        with with_cephadm_ctx([]) as ctx:
+            _cephadm.NFSGanesha(ctx, *args, **kwargs)
+
+
+def test_nfsganesha_init():
+    with with_cephadm_ctx([]) as ctx:
+        ctx.config_json = json.dumps(good_nfs_json())
+        ctx.image = "test_image"
+        nfsg = _cephadm.NFSGanesha.init(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+        )
+    assert nfsg.fsid == SAMPLE_UUID
+    assert nfsg.daemon_id == "fred"
+    assert nfsg.pool == "party"
+
+
+def test_nfsganesha_container_mounts():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        cmounts = nfsg.get_container_mounts("/var/tmp")
+        assert len(cmounts) == 3
+        assert cmounts["/var/tmp/config"] == "/etc/ceph/ceph.conf:z"
+        assert cmounts["/var/tmp/keyring"] == "/etc/ceph/keyring:z"
+        assert cmounts["/var/tmp/etc/ganesha"] == "/etc/ganesha:z"
+
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            nfs_json(pool=True, files=True, rgw=True),
+        )
+        cmounts = nfsg.get_container_mounts("/var/tmp")
+        assert len(cmounts) == 4
+        assert cmounts["/var/tmp/config"] == "/etc/ceph/ceph.conf:z"
+        assert cmounts["/var/tmp/keyring"] == "/etc/ceph/keyring:z"
+        assert cmounts["/var/tmp/etc/ganesha"] == "/etc/ganesha:z"
+        assert (
+            cmounts["/var/tmp/keyring.rgw"]
+            == "/var/lib/ceph/radosgw/ceph-jsmith/keyring:z"
+        )
+
+
+def test_nfsganesha_container_envs():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        envs = nfsg.get_container_envs()
+        assert len(envs) == 1
+        assert envs[0] == "CEPH_CONF=/etc/ceph/ceph.conf"
+
+
+def test_nfsganesha_get_version():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+
+        with mock.patch("cephadm.call") as _call:
+            _call.return_value = ("NFS-Ganesha Release = V100", "", 0)
+            ver = nfsg.get_version(ctx, "fake_version")
+            _call.assert_called()
+        assert ver == "100"
+
+
+def test_nfsganesha_get_daemon_name():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        assert nfsg.get_daemon_name() == "nfs.fred"
+
+
+def test_nfsganesha_get_container_name():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        name1 = nfsg.get_container_name()
+        assert name1 == "ceph-2d018a3f-8a8f-4cb9-a7cf-48bebb2cbaae-nfs.fred"
+        name2 = nfsg.get_container_name(desc="extra")
+        assert (
+            name2 == "ceph-2d018a3f-8a8f-4cb9-a7cf-48bebb2cbaae-nfs.fred-extra"
+        )
+
+
+def test_nfsganesha_get_daemon_args():
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        args = nfsg.get_daemon_args()
+        assert args == ["-F", "-L", "STDERR"]
+
+
+@mock.patch("cephadm.logger")
+def test_nfsganesha_create_daemon_dirs(_logger, cephadm_fs):
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            good_nfs_json(),
+        )
+        with pytest.raises(OSError):
+            nfsg.create_daemon_dirs("/var/tmp", 45, 54)
+        cephadm_fs.create_dir("/var/tmp")
+        nfsg.create_daemon_dirs("/var/tmp", 45, 54)
+        # TODO: make assertions about the dirs created
+
+
+@mock.patch("cephadm.logger")
+def test_nfsganesha_create_daemon_dirs_rgw(_logger, cephadm_fs):
+    with with_cephadm_ctx([]) as ctx:
+        nfsg = _cephadm.NFSGanesha(
+            ctx,
+            SAMPLE_UUID,
+            "fred",
+            nfs_json(pool=True, files=True, rgw=True),
+        )
+        cephadm_fs.create_dir("/var/tmp")
+        nfsg.create_daemon_dirs("/var/tmp", 45, 54)
+        # TODO: make assertions about the dirs created