refactor(tests): new report

Let's use an off-the-shelf report like JUnit

Signed-off-by: Pablo Barbáchano <[email protected]>

Author: pb8o

tests/conftest.py

@@ -81,13 +81,15 @@ def test_with_any_microvm(test_microvm_any):
   by the MicrovmImageFetcher, but not by the fixture template.
 """
 
+import inspect
+import json
 import os
 import platform
+import re
 import shutil
 import sys
 import tempfile
 import uuid
-import json
 from pathlib import Path
 
 import pytest
@@ -101,6 +103,7 @@ def test_with_any_microvm(test_microvm_any):
 from framework.s3fetcher import MicrovmImageS3Fetcher
 from framework.utils import get_firecracker_version_from_toml
 from framework.with_filelock import with_filelock
+from framework.properties import GLOBAL_PROPS
 
 # Tests root directory.
 SCRIPT_FOLDER = os.path.dirname(os.path.realpath(__file__))
@@ -115,8 +118,6 @@ def test_with_any_microvm(test_microvm_any):
     raise PermissionError("Test session needs to be run as root.")
 
 
-
-
 def _test_images_s3_bucket():
     """Auxiliary function for getting this session's bucket name."""
     return os.environ.get(
@@ -234,6 +235,34 @@ def pytest_collection_modifyitems(config, items):
                 item.add_marker(skip_marker)
 
 
+def pytest_runtest_makereport(item, call):
+    """Decorate test results with additional properties."""
+    if call.when != "setup":
+        return
+
+    for prop_name, prop_val in GLOBAL_PROPS.items():
+        # if record_testsuite_property worked with xdist we could use that
+        # https://docs.pytest.org/en/7.1.x/reference/reference.html#record-testsuite-property
+        # to record the properties once per report. But here we record each
+        # prop per test. It just results in larger report files.
+        item.user_properties.append((prop_name, prop_val))
+
+    function_docstring = inspect.getdoc(item.function)
+    description = []
+    attributes = {}
+    for line in function_docstring.split("\n"):
+        # extract tags like @type, @issue, etc
+        match = re.match(r"\s*@(?P<attr>\w+):\s*(?P<value>\w+)", line)
+        if match:
+            attr, value = match["attr"], match["value"]
+            attributes[attr] = value
+        else:
+            description.append(line)
+    for attr_name, attr_value in attributes.items():
+        item.user_properties.append((attr_name, attr_value))
+    item.user_properties.append(("description", "".join(description)))
+
+
 def test_session_root_path():
     """Create and return the testrun session root directory.
 

tests/framework/mpsing.py

@@ -0,0 +1,26 @@
+# Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Metadata we want to attach to tests for further analysis and troubleshooting
+"""
+
+import platform
+import subprocess
+
+from framework.utils_cpuid import get_cpu_model_name
+
+
+def run_cmd(cmd):
+    """Return the stdout of a command"""
+    stdout = subprocess.check_output(cmd, shell=True).decode().strip()
+    return stdout
+
+
+GLOBAL_PROPS = {
+    "architecture": platform.machine(),
+    "host_linux_kernel": platform.release(),
+    "libc_ver": "-".join(platform.libc_ver()),
+    "cpu_model": get_cpu_model_name(),
+    "commit_id": run_cmd("git rev-parse HEAD"),
+}