result_summary: add cmdline option --output-dir

Introduce a new command-line option: --output-dir, and rename the old
--output to --output-file.

Signed-off-by: Ricardo Cañuelo <[email protected]>

Author: Ricardo Cañuelo

config/result-summary.yaml

@@ -11,7 +11,7 @@
 # file used for the summary generation. This template must be a file in
 # config/result_summary_templates. Other optional fields are supported:
 #
-#  - "output": name of the file where the output will be stored (in
+#  - "output_file": name of the file where the output will be stored (in
 #    data/output)
 #  - "title": title for the report
 #
@@ -34,7 +34,7 @@
 #     action: summary
 #     title: "Example test report"
 #     template: "mytemplate.jinja2"
-#     output: "default-test.txt"
+#     output_file: "default-test.txt"
 #  preset:
 #    test:
 #      # Query by group, name, arch and list of repos
@@ -62,7 +62,7 @@ monitor-active-stable-rc-build-regressions:
     action: monitor
     title: "<strong>stable-rc</strong> kernel build regression"
     template: "generic-regression-report.html.jinja2"
-    output: "stable-rc-build-regression-report.html"
+    output_file: "stable-rc-build-regression-report.html"
   preset:
     regression:
       - name__re: kbuild
@@ -77,7 +77,7 @@ monitor-stable-rc-build-failures:
     action: monitor
     title: "<strong>stable-rc</strong> kernel build failure"
     template: "generic-test-failure-report.html.jinja2"
-    output: "stable-rc-build-failure.html"
+    output_file: "stable-rc-build-failure.html"
   preset:
     kbuild:
       - result: fail
@@ -90,7 +90,7 @@ monitor-active-stable-rc-boot-regressions:
     action: monitor
     title: "<strong>stable-rc</strong> kernel boot regression"
     template: "generic-regression-report.html.jinja2"
-    output: "stable-rc-boot-regression-report.html"
+    output_file: "stable-rc-boot-regression-report.html"
   preset:
     regression:
       - group__re: baseline
@@ -104,20 +104,53 @@ monitor-all-regressions:
     action: monitor
     title: "KernelCI regression report"
     template: "generic-regression-report.html.jinja2"
-    output: "regression-report.html"
+    output_file: "regression-report.html"
   preset:
     regression:
 
+monitor-all-test-failures__runtime_errors:
+  metadata:
+    action: monitor
+    title: "KernelCI test failure report"
+    template: "generic-test-failure-report.html.jinja2"
+    output_file: "test-failure-report.html"
+  preset:
+    test:
+      - result: fail
+        data.error_code__ne: null
+
 monitor-all-test-failures:
   metadata:
     action: monitor
     title: "KernelCI test failure report"
     template: "generic-test-failure-report.html.jinja2"
-    output: "test-failure-report.html"
+    output_file: "test-failure-report.html"
   preset:
     test:
       - result: fail
+        data.error_code: null
 
+monitor-all-build-failures__runtime_errors:
+  metadata:
+    action: monitor
+    title: "KernelCI kbuild failure report"
+    template: "generic-test-failure-report.html.jinja2"
+    output_file: "kbuild-failure-report.html"
+  preset:
+    kbuild:
+      - result: fail
+        data.error_code__ne: null
+
+monitor-all-build-failures:
+  metadata:
+    action: monitor
+    title: "KernelCI kbuild failure report"
+    template: "generic-test-failure-report.html.jinja2"
+    output_file: "kbuild-failure-report.html"
+  preset:
+    kbuild:
+      - result: fail
+        data.error_code: null
 
 ### Summary presets
 
@@ -127,7 +160,7 @@ stable-rc-build-regressions:
     action: summary
     title: "<strong>stable-rc</strong> kernel build regressions"
     template: "generic-regressions.html.jinja2"
-    output: "stable-rc-build-regressions.html"
+    output_file: "stable-rc-build-regressions.html"
   preset:
     regression:
       - name__re: kbuild
@@ -140,7 +173,7 @@ active-stable-rc-build-regressions:
     action: summary
     title: "<strong>stable-rc</strong> kernel build regressions"
     template: "generic-regressions.html.jinja2"
-    output: "active-stable-rc-build-regressions.html"
+    output_file: "active-stable-rc-build-regressions.html"
   preset:
     regression:
       - name__re: kbuild
@@ -155,7 +188,7 @@ stable-rc-build-failures:
     action: summary
     title: "<strong>stable-rc</strong> kernel build failures"
     template: "generic-test-failures.html.jinja2"
-    output: "stable-rc-build-failures.html"
+    output_file: "stable-rc-build-failures.html"
   preset:
     kbuild:
       - result: fail
@@ -168,7 +201,7 @@ stable-rc-boot-regressions:
     action: summary
     title: "<strong>stable-rc</strong> kernel boot regressions"
     template: "generic-regressions.html.jinja2"
-    output: "stable-rc-boot-regressions.html"
+    output_file: "stable-rc-boot-regressions.html"
   preset:
     regression:
       - group__re: baseline
@@ -181,7 +214,7 @@ stable-rc-boot-active-regressions:
     action: summary
     title: "<strong>stable-rc</strong> kernel boot regressions"
     template: "generic-regressions.html.jinja2"
-    output: "stable-rc-boot-regressions.html"
+    output_file: "stable-rc-boot-regressions.html"
   preset:
     regression:
       - group__re: baseline
@@ -196,7 +229,7 @@ stable-rc-boot-failures:
     action: summary
     title: "<strong>stable-rc</strong> kernel boot failures"
     template: "generic-test-failures.html.jinja2"
-    output: "stable-rc-boot-failures.html"
+    output_file: "stable-rc-boot-failures.html"
   preset:
     test:
       - group__re: baseline
@@ -210,7 +243,7 @@ tast-failures:
     action: summary
     title: "General Tast test failures"
     template: "generic-test-failures.html.jinja2"
-    output: "tast-failures.html"
+    output_file: "tast-failures.html"
   preset:
     test:
       - group__re: tast
@@ -224,7 +257,7 @@ tast-failures__runtime_errors:
     action: summary
     title: "General Tast test failures"
     template: "generic-test-failures.html.jinja2"
-    output: "tast-failures.html"
+    output_file: "tast-failures.html"
   preset:
     test:
       - group__re: tast
@@ -239,7 +272,7 @@ mainline-next-regressions:
     action: summary
     title: "Regressions found in mainline and next"
     template: "generic-regressions.html.jinja2"
-    output: "mainline-next-regressions.html"
+    output_file: "mainline-next-regressions.html"
   preset:
     regression:
       - data.error_code: null
@@ -252,7 +285,7 @@ mainline-next-test-failures:
     action: summary
     title: "Regressions found in mainline and next"
     template: "generic-regressions.html.jinja2"
-    output: "mainline-next-regressions.html"
+    output_file: "mainline-next-regressions.html"
   preset:
     test:
       - result: fail
@@ -268,7 +301,7 @@ mainline-next-active-regressions:
     action: summary
     title: "Regressions found in mainline and next"
     template: "generic-regressions.html.jinja2"
-    output: "mainline-next-active-regressions.html"
+    output_file: "mainline-next-active-regressions.html"
   preset:
     regression:
       - data.error_code: null
@@ -285,7 +318,7 @@ mainline-next-regressions__runtime_errors:
     action: summary
     title: "'Regressions' found in mainline and next due to runtime errors"
     template: "generic-regressions.html.jinja2"
-    output: "mainline-next-regressions__runtime_errors.html"
+    output_file: "mainline-next-regressions__runtime_errors.html"
   preset:
     regression:
       - data.error_code__ne: null
@@ -300,7 +333,7 @@ tast-regressions-x86_64:
     action: summary
     title: "Regressions found on Tast tests for x86_64"
     template: "generic-regressions.html.jinja2"
-    output: "tast-regressions-x86_64.html"
+    output_file: "tast-regressions-x86_64.html"
   preset:
     regression:
       - group__re: tast
@@ -315,7 +348,7 @@ tast-regressions-x86_64__runtime_errors:
     action: summary
     title: "'Regressions' found on Tast tests for x86_64 due to runtime errors"
     template: "generic-regressions.html.jinja2"
-    output: "tast-regressions-x86_64__runtime_errors.html"
+    output_file: "tast-regressions-x86_64__runtime_errors.html"
   preset:
     regression:
       - group__re: tast
@@ -329,7 +362,7 @@ active-kunit-regressions:
     action: summary
     title: "Active regressions found on kunit tests"
     template: "generic-regressions.html.jinja2"
-    output: "kunit-regressions.html"
+    output_file: "kunit-regressions.html"
   preset:
     regression:
       - group__re: kunit
@@ -342,7 +375,7 @@ all-kunit-failures:
     action: summary
     title: "All kunit test failures"
     template: "generic-test-failures.html.jinja2"
-    output: "kunit-failures.html"
+    output_file: "kunit-failures.html"
   preset:
     test:
       - group__re: kunit

src/result_summary.py

@@ -19,22 +19,21 @@
 # (default: yesterday) and --date-to (default: now) options, formatted
 # as YYYY-MM-DD or YYYY-MM-DDTHH:mm:SS (UTC)
 #
-# Each preset may define the name of the output file generated (in
-# data/output). This can be overriden with the --output option. If no
-# output file is defined, the output will be printed to stdout.
+# Each preset may define the name and the directory of the output file
+# generated (in data/output). This can be overriden with the
+# --output-dir and --output-file options. If no output file is defined,
+# the output will be printed to stdout.
 #
 # For current status info, see the development changelog in
-# config/result_summary_templates/CHANGELOG
+# doc/result-summary-CHANGELOG
 
 # TODO:
 # - Refactor liberally
-# - Implement loop mode
 # - Send email reports
 # - Do we want to focus on regressions only or on any kind of result?
 #   If we want test results as well:
 #   - Provide logs for test leaf nodes
 # - Tweak output and templates according to user needs
-# - Parameterize/generalize templates to avoid duplication
 # - Other suggested improvements
 
 import sys
@@ -81,9 +80,12 @@ def _setup(self, args):
         extra_query_params = {}
         if args.query_params:
             extra_query_params = split_query_params(args.query_params)
-        output = None
-        if args.output:
-            output = args.output
+        output_dir = None
+        if args.output_dir:
+            output_dir = args.output_dir
+        output_file = None
+        if args.output_file:
+            output_file = args.output_file
         # End of command line argument loading and sanity checks
 
         # Load presets and template
@@ -103,7 +105,8 @@ def _setup(self, args):
             'preset_params': preset_params,
             'extra_query_params': extra_query_params,
             'template': template,
-            'output': output,
+            'output_file': output_file,
+            'output_dir': output_dir,
         }
         # Action-specific setup
         if metadata.get('action') == 'summary':
@@ -171,7 +174,11 @@ class cmd_run(Command):
                      "(YYYY-mm-DDTHH:MM:SS). Default: until now"),
         },
         {
-            'name': '--output',
+            'name': '--output-dir',
+            'help': "Override the 'output_dir' preset parameter"
+        },
+        {
+            'name': '--output-file',
             'help': "Override the 'output' preset parameter"
         },
         {

src/result_summary/__init__.py

@@ -1,4 +1,4 @@
 SERVICE_NAME = 'result_summary'
 TEMPLATES_DIR = './config/result_summary_templates/'
-OUTPUT_DIR = '/home/kernelci/data/output/'
+BASE_OUTPUT_DIR = '/home/kernelci/data/output/'
 logger = None

src/result_summary/monitor.py

@@ -90,17 +90,29 @@ def run(service, context):
                     'node': node,
                 }
                 output_text = context['template'].render(template_params)
-                output = context['output']
-                if not output:
-                    # Since we expect many reports to be generated,
-                    # prepend them with a timestamp
-                    now_str = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S")
-                    if 'output' in context['metadata']:
-                        output = now_str + '__' + context['metadata']['output']
-                if output:
-                    with open(os.path.join(result_summary.OUTPUT_DIR, output), 'w') as output_file:
-                        output_file.write(output_text)
-                    service.log.info(f"Report generated in {output}")
+                # Setup output dir from base path and user-specified
+                # parameter (in preset metadata or cmdline)
+                output_dir = result_summary.BASE_OUTPUT_DIR
+                if context.get('output_dir'):
+                    output_dir = os.path.join(output_dir, context['output_dir'])
+                elif 'output_dir' in context['metadata']:
+                    output_dir = os.path.join(output_dir, context['metadata']['output_dir'])
+                os.makedirs(output_dir, exist_ok=True)
+                # Generate and dump output
+                # output_file specified in cmdline:
+                output_file = context['output_file']
+                if not output_file:
+                    # Check if output_file is specified as a preset
+                    # parameter. Since we expect many reports to be
+                    # generated, prepend them with a timestamp
+                    if 'output_file' in context['metadata']:
+                        now_str = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S")
+                        output_file = now_str + '__' + context['metadata']['output_file']
+                if output_file:
+                    output_file = os.path.join(output_dir, output_file)
+                    with open(output_file, 'w') as outfile:
+                        outfile.write(output_text)
+                    service.log.info(f"Report generated in {output_file}")
                 else:
                     result_summary.logger.info(output_text)
             else:

src/result_summary/summary.py

@@ -130,13 +130,25 @@ def run(service, context):
         'last_updated_to': context['date_params'].get(_date_params['last_updated_to']),
     }
     output_text = context['template'].render(template_params)
-    output = context['output']
-    if not output:
-        if 'output' in context['metadata']:
-            output = context['metadata']['output']
-    if output:
-        with open(os.path.join(result_summary.OUTPUT_DIR, output), 'w') as output_file:
-            output_file.write(output_text)
+    # Setup output dir from base path and user-specified
+    # parameter (in preset metadata or cmdline)
+    output_dir = result_summary.BASE_OUTPUT_DIR
+    if context.get('output_dir'):
+        output_dir = os.path.join(output_dir, context['output_dir'])
+    elif 'output_dir' in context['metadata']:
+        output_dir = os.path.join(output_dir, context['metadata']['output_dir'])
+    os.makedirs(output_dir, exist_ok=True)
+    # Generate and dump output
+    # output_file specified in cmdline:
+    output_file = context['output_file']
+    if not output_file:
+        # Check if output_file is specified as a preset parameter
+        if 'output_file' in context['metadata']:
+            output_file = context['metadata']['output_file']
+    if output_file:
+        output_file = os.path.join(output_dir, output_file)
+        with open((output_file), 'w') as outfile:
+            outfile.write(output_text)
     else:
         result_summary.logger.info(output_text)
     return True