test-info: allow extra configuration to be set

Some tests may require additional information to run their tests, we can
provide this information in the extra section.

Signed-off-by: Sachin Prabhu <[email protected]>

Author: spuiuk

selftest/test-info1.yml

@@ -9,6 +9,13 @@ users:
 # Backend filesystem of the exported shares
 backend: glusterfs
 
+# Additional information which may be used by tests here
+# some tests may be skipped if the required config option is not set
+extra:
+  # The supplementary group to be used by test_permissions
+  supplementary_group: test_sg
+
+
 # shares: List of dict of exported shares
 shares:
   # share export1

selftest/test_testhelper.py

@@ -62,3 +62,16 @@ def test_generate_exported_shares():
         arr.append((share["server"], share["name"]))
     assert len(arr) == 1
     assert ("server_name", "export2") in arr
+
+
+def test_get_extra_configuration():
+    testinfo = testhelper.read_yaml("test-info1.yml")
+    sg = testhelper.get_extra_configuration(testinfo, "supplementary_group")
+    assert sg == "test_sg", "Could not read extra configuration"
+    other = testhelper.get_extra_configuration(testinfo, "other")
+    assert other is None, "Incorrectly read other from extra configuration"
+
+    # test-info2.yml does not have extra section
+    testinfo = testhelper.read_yaml("test-info2.yml")
+    sg = testhelper.get_extra_configuration(testinfo, "supplementary_group")
+    assert sg is None, "Could not read extra configuration"

test-info.yml.example

@@ -9,6 +9,12 @@ users:
 # Backend filesystem of the exported shares
 backend: glusterfs
 
+# Additional information which may be used by tests here
+# some tests may be skipped if the required config option is not set
+extra:
+  # The supplementary group to be used by test_supplementary_group
+  supplementary_group: sg
+
 # shares: List of dict of exported shares
 shares:
   # share export1

testhelper/testhelper.py

@@ -192,3 +192,18 @@ def get_exported_shares(test_info: dict) -> typing.List[str]:
         if not is_premounted_share(share):
             arr.append(share["name"])
     return arr
+
+
+def get_extra_configuration(test_info: dict, extra_var: str) -> typing.Any:
+    """ Return value of config set in extra section
+
+        Parameters:
+        test_info: Dict containing the parsed yaml file
+        extra_var: string containing extra config value required
+        Returns:
+        value set for the extra_var in the extra section
+    """
+    extra = test_info.get("extra")
+    if extra is None:
+        return None
+    return extra.get(extra_var)