Merge pull request xenserver#27 from xenserver-next/private/bernhardk/add-sar-system-load-testcase

Add system load testcase to check collecting sar output, improve verification code

Author: bernhardkaindl

tests/integration/test_system_load.py

@@ -0,0 +1,31 @@
+"""tests/integration/test_system_load.py: Test xen-bugtool --entries=system-load"""
+import os
+
+from utils import check_file, run_bugtool_entry, assert_content_from_dom0_template
+
+
+# In this test case we need to sleep for 1 sec, and it is sufficient
+# to test to only with zip archives to keep the test duration short:
+def test_system_load(output_archive_type="zip"):
+    """Test xen-bugtool --entries=system-load in test jail created by auto-fixtures in conftest.py"""
+    entry = "system-load"
+
+    # Create test input files:
+    os.mkdir("/var/log")
+    os.mkdir("/var/log/sa")
+    with open("/var/log/sa/sa01", "w") as sa01:
+        sa01.write("sa01 test data")
+    with open("/var/log/sa/sar31", "w") as sar31:
+        sar31.write("sar31 test data")
+
+    # Create a dummy sar script to assert that xen-bugtool captures its output:
+    os.environ["PATH"] = "/var:" + os.environ["PATH"]
+    with open("/var/sar", "w") as sar:
+        sar.write("#!/bin/sh\nsleep 1;cat /etc/xensource-inventory\n")
+    os.chmod("/var/sar", 0o777)
+
+    run_bugtool_entry(output_archive_type, entry)
+
+    assert_content_from_dom0_template("sar-A.out", "etc/xensource-inventory")
+    assert check_file("var/log/sa/sa01") == "sa01 test data"
+    assert check_file("var/log/sa/sar31") == "sar31 test data"

tests/integration/test_xenserver_config.py

@@ -1,18 +1,25 @@
 """tests/integration/test_xenserver_config.py: Test xen-bugtool --entries=xenserver-config"""
 import os
 
-from utils import assert_cmd, check_file, run_bugtool_entry, verify_content_from_dom0_template
+from utils import assert_cmd, check_file, run_bugtool_entry, assert_content_from_dom0_template
 
 
 def test_xenserver_config(output_archive_type):
     """Test xen-bugtool --entries=xenserver-config in test jail created by auto-fixtures in conftest.py"""
     entry = "xenserver-config"
+
     run_bugtool_entry(output_archive_type, entry)
+
+    # Assert that the bugtool output archive of --entries=xenserver-config matches our expectations for it:
     assert check_file("ls-lR-%opt%xensource.out").splitlines()[0] == "/opt/xensource:"
     assert check_file("ls-lR-%etc%xensource%static-vdis.out") == ""
     assert check_file("static-vdis-list.out") == "list"
+
+    # Assert the contents of the extracted etc/systemd.tar
     os.chdir("..")
+    # etc/systemd.tar's toplevel directory is os.environ["XENRT_BUGTOOL_BASENAME"] (= entries for the test)
     assert_cmd(["tar", "xvf", entry + "/etc/systemd.tar"], entry + "/etc/systemd.tar")
+
     os.chdir(entry)
-    verify_content_from_dom0_template("etc/xensource-inventory")
-    verify_content_from_dom0_template("etc/systemd")
+    assert_content_from_dom0_template("etc/systemd")
+    assert_content_from_dom0_template("etc/xensource-inventory")

tests/integration/utils.py

@@ -17,7 +17,7 @@
     from subprocess import getoutput
 
 BUGTOOL_OUTPUT_DIR = "/var/opt/xen/bug-report/"
-BUGTOOL_DOM0_TEMPL = "tests/integration/dom0-template"
+BUGTOOL_DOM0_TEMPL = "tests/integration/dom0-template/"
 
 
 def run(command):
@@ -49,11 +49,21 @@ def check_file(path):
     return contents
 
 
-def verify_content_from_dom0_template(path):
+def assert_content_from_dom0_template(path, control_path=None):
     """Compare the contents of output directories or files with the test's Dom0 template directories"""
     assert path[0] != "/"
-    assert filecmp.dircmp(path, BUGTOOL_DOM0_TEMPL + path)
-    # After successfuly verficiation of the files, remove the checked output files (missed files remain):
+    control = BUGTOOL_DOM0_TEMPL + (control_path or path)
+    print(control)
+    if os.path.isdir(path):
+        result = filecmp.dircmp(path, control)
+        if result.diff_files or result.right_only:
+            print(result.report)
+            raise RuntimeError("Missing or Differing files found in " + path)
+    else:
+        if not filecmp.cmp(path, control):
+            os.system("cat " + path)
+            raise RuntimeError(control)
+    # Remove verified output files/directories. Untested files will remain and cause the testcase to FAIL:
     try:
         os.unlink(path)
     except OSError:
@@ -99,3 +109,5 @@ def run_bugtool_entry(archive_type, test_entries):
         etree.XMLSchema(etree.parse(xmlschema)).assertValid(etree.parse("inventory.xml"))
         # After successfuly validation of the inventory.xml, remove it (not removed files make the test fail):
         os.unlink("inventory.xml")
+    # assert_content_from_dom0_template() does not know the srcdir: add a symlink so it can reach the tests
+    os.symlink(srcdir + "/tests", "tests")