selftest: Add selftests

With the latest updates to testhelper, the complexity of the helper code
has increased and there is now a good case for adding selftests to
ensure that the helper code works as expected.

We start by creating a few simple tests for the code in
testhelper/testhelper.py.

Signed-off-by: Sachin Prabhu <sp@spui.uk>

Author: spuiuk

Makefile

@@ -10,6 +10,10 @@ define runtox
 	@cd "$(ROOT_DIR)" && tox -e $1
 endef
 
+.PHONY: selftest
+selftest:
+	$(call runtox, "selftest")
+
 .PHONY: test
 test:
 	$(call runtox, "pytest")

selftest/test-info1.yml

@@ -0,0 +1,30 @@
+# Server hostname to be tested
+server: server_name
+
+# Users to use for authentication
+users:
+  user1: user1password
+  user2: user2password
+
+# Backend filesystem of the exported shares
+backend: glusterfs
+
+# shares: List of dict of exported shares
+shares:
+  # share export1
+  export1:
+    # If present, it means the share is pre-mounted
+    # at the location given
+    path: /mnt/share/export1-cephfs-vfs
+    backend:
+      # If present override default backend filesystem
+      name: cephfs.vfs
+    # If present, use these credentials to perform the
+    # tests for this share
+    users:
+      test2: x
+    # If present, override the server to test for this share
+    server: hostname1
+  # share name export2
+  export2:
+    # Use default values set for this share

selftest/test-info2.yml

@@ -0,0 +1,12 @@
+public_interfaces:
+  - "192.168.123.10"
+  - "192.168.123.11"
+
+exported_sharenames:
+  - "gluster-vol"
+
+test_users:
+  - {"username": "test1", "password": "x"}
+  - {"username": "test2", "password": "x"}
+
+test_backend: glusterfs

selftest/test_testhelper.py

@@ -0,0 +1,62 @@
+import testhelper
+from pathlib import Path
+
+
+def test_read_yaml1():
+    testinfo = testhelper.read_yaml("test-info1.yml")
+
+    export1 = testinfo["shares"]["export1"]
+    assert export1["server"] == "hostname1"
+    assert export1["path"] == "/mnt/share/export1-cephfs-vfs"
+    assert export1["backend"]["name"] == "cephfs.vfs"
+    assert "user1" not in export1["users"]
+    assert "test2" in export1["users"]
+    assert export1["users"]["test2"] == "x"
+
+    export2 = testinfo["shares"]["export2"]
+    assert export2["server"] == "server_name"
+    assert "path" not in export2
+    assert export2["backend"]["name"] == "glusterfs"
+    assert "test2" not in export2["users"]
+    assert "user2" in export2["users"]
+    assert export2["users"]["user2"] == "user2password"
+
+
+def test_read_yaml2():
+    testinfo = testhelper.read_yaml("test-info2.yml")
+
+    export = testinfo["shares"]["gluster-vol"]
+    assert export["server"] == "192.168.123.10"
+    assert "path" not in export
+    assert export["backend"]["name"] == "glusterfs"
+    assert "user1" not in export["users"]
+    assert "test1" in export["users"]
+    assert export["users"]["test1"] == "x"
+
+
+def test_get_share():
+    testinfo = testhelper.read_yaml("test-info1.yml")
+    export2 = testhelper.get_share(testinfo, "export2")
+    assert export2["server"] == "server_name"
+    assert "path" not in export2
+    assert export2["backend"]["name"] == "glusterfs"
+    assert "test2" not in export2["users"]
+    assert "user2" in export2["users"]
+    assert export2["users"]["user2"] == "user2password"
+
+
+def test_list_premounted():
+    testinfo = testhelper.read_yaml("test-info1.yml")
+    premounted = testhelper.get_premounted_shares(testinfo)
+    assert len(premounted) == 1
+    assert Path("/mnt/share/export1-cephfs-vfs") in premounted
+
+
+def test_generate_exported_shares():
+    testinfo = testhelper.read_yaml("test-info1.yml")
+    arr = []
+    for sharename in testhelper.get_exported_shares(testinfo):
+        share = testhelper.get_share(testinfo, sharename)
+        arr.append((share["server"], share["name"]))
+    assert len(arr) == 1
+    assert ("server_name", "export2") in arr

tox.ini

@@ -32,6 +32,13 @@ deps =
 changedir = {toxinidir}
 commands = pytest -vrfEsxXpP testcases/consistency
 
+[testenv:selftest]
+deps =
+    pytest
+    pyyaml
+changedir = {toxinidir}/selftest
+commands = pytest -vrfEsxXpP .
+
 [testenv:flake8]
 deps = flake8
 changedir = {toxinidir}