Move and extend the reference_results.metadata

tools/tests/README.md

@@ -166,7 +166,7 @@ Metadata and workflow/script files:
   - `docker-compose.template.yaml`: Describes how to prepare each test (Docker Componse service template)
   - `docker-compose.field_compare.template.yaml`: Describes how to compare results with fieldcompare (Docker Compose service template)
   - `components.yaml`: Declares the available components and their parameters/options
-  - `reference_results.metadata.template`: Template for reporting the versions used to generate the reference results
+  - `reference_results_metadata.template`: Template for reporting the versions used to generate the reference results
   - `reference_versions.yaml`: List of arguments to use for generating the reference results
   - `tests.yaml`: Declares the available tests, grouped in test suites
 

tools/tests/generate_reference_results.py

@@ -32,20 +32,26 @@ def command_is_avail(command: str):
 
         return rc == 0
     uname_info = "uname not available on the machine the systemtests were executed."
+    lsb_info = "lsb_release not available on the machine the systemtests were executed."
     lscpu_info = "lscpu not available on the machine the systemtests were executed."
     if (command_is_avail("uname")):
         result = subprocess.run(["uname", "-a"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
         if result.returncode == 0:
             uname_info = result.stdout
 
+    if (command_is_avail("lsb_release")):
+        result = subprocess.run(["lsb_release", "-a"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+        if result.returncode == 0:
+            lsb_info = result.stdout
+
     if (command_is_avail("lscpu") and command_is_avail("grep")):
         result_lscpu = subprocess.run(["lscpu"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
         result = subprocess.run(["grep", "-v", "Vulner"], input=result_lscpu.stdout,
                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
         if result.returncode == 0:
             lscpu_info = result.stdout
 
-    return (uname_info, lscpu_info)
+    return (uname_info, lsb_info, lscpu_info)
 
 
 def render_reference_results_info(
@@ -69,16 +75,17 @@ def sha256sum(filename):
             'time': time,
             'name': reference_result.path.name,
         })
-    uname, lscpu = get_machine_informations()
+    uname, lsb, lscpu = get_machine_informations()
     render_dict = {
         'arguments': arguments_used.arguments,
         'files': files,
         'uname': uname,
-        'lscpu': lscpu,
+        'lsb': lsb,
+        'lscpu': lscpu
     }
 
     jinja_env = Environment(loader=FileSystemLoader(PRECICE_TESTS_DIR))
-    template = jinja_env.get_template("reference_results.metadata.template")
+    template = jinja_env.get_template("reference_results_metadata.template")
     return template.render(render_dict)
 
 
@@ -142,7 +149,7 @@ def main():
 
     # write readme
     for tutorial in reference_result_per_tutorial.keys():
-        with open(tutorial.path / "reference_results.metadata", 'w') as file:
+        with open(tutorial.path / "reference-results/reference_results_metadata.md", 'w') as file:
             ref_results_info = render_reference_results_info(
                 reference_result_per_tutorial[tutorial], build_args, current_time_string)
             logging.info(f"Writing results for {tutorial.name}")

tools/tests/reference_results.metadata.template → tools/tests/reference_results_metadata.template

@@ -23,12 +23,26 @@ We also include some information on the machine used to generate them
 {% endfor -%}
 
 
-## Information about the machine
+## Platform information
 
-### uname -a
+### Operating system
 
+`uname -a` returns:
+
+```
 {{ uname }}
+```
+
+`lsb_release -a` returns:
+
+```
+{{ lsb }}
+```
+
+### Hardware
 
-### lscpu
+`lscpu` returns:
 
-{{ lscpu }}
+```
+{{ lscpu }}
+```