Add an API call to list available reports of CMSSW comparisons

- Add an option to fff_dqmtools to configure the default
  directory where the reports are to be found.
- Add a case to the cr_api function to return a list of
  available CMSSW comparisons as JSON.

Author: nothingface0

applets/fff_web.py

@@ -2,7 +2,8 @@
 import json
 import re
 import sqlite3
-import os, time
+import os
+import time
 import socket
 import logging
 
@@ -12,9 +13,11 @@
 
 # fff_dqmtools fixed the imports for us
 import bottle
+from bottle import abort
 import zlib
 import itertools
 import requests
+from pathlib import Path
 
 log = logging.getLogger(__name__)
 
@@ -403,6 +406,42 @@ def __init__(self, str):
         return output_messages
 
 
+def get_list_of_release_comparisons(cmssw_comparison_reports_path: Path):
+    valid_reports = []
+    for subdir in cmssw_comparison_reports_path.iterdir():
+        m = re.match(
+            r"^(?P<timestamp>\d{8}-\d{6})_"
+            + r"comparison_base_\d{4}_"
+            + r"CMSSW_(?P<cmssw_base>\d{1,2}_\d{1,2}_\d{1,2}(_pre\d|_patch\d)?)(?P<base_prs>(_\d{1,5})*?)"
+            + r"_vs_comparison_comp_\d{4}_"
+            + r"CMSSW_(?P<cmssw_comp>\d{1,2}_\d{1,2}_\d{1,2}(_pre\d|_patch\d)?)(?P<comp_prs>(_\d{1,5})*?)$",
+            subdir.name,
+        )
+
+        if m and subdir.joinpath("dqm-histo-comparison-summary.html").exists():
+            # Path matches comparison results regex,
+            # and the expected html report is in there.
+            # Convert to str because Path is not JSON serializable.
+            answer = {
+                "timestamp": m["timestamp"],
+                "base": m["cmssw_base"],
+                "base_prs": (
+                    []
+                    if "base_prs" not in m.groupdict()
+                    else [pr for pr in m["base_prs"].split("_") if pr]
+                ),
+                "comp": m["cmssw_comp"],
+                "comp_prs": (
+                    []
+                    if "comp_prs" not in m.groupdict()
+                    else [pr for pr in m["comp_prs"].split("_") if pr]
+                ),
+                "id": subdir.name,
+            }
+            valid_reports.append(answer)
+    return valid_reports
+
+
 class WebServer(bottle.Bottle):
     def __init__(self, db=None, opts={}):
         bottle.Bottle.__init__(self)
@@ -1020,13 +1059,44 @@ def cr_api():
                     sock.shutdown(socket.SHUT_WR)
                     sock.close()
                     return "start_playback_run Ok"
+                elif what == "cmssw_comparison_reports":
+                    """
+                    Return a list of directories created by cmssw_release_comparison.
+
+                    If 'id' is also passed as an argument, use it to serve
+                    the comparison result
+                    """
+                    cmssw_comparison_reports_path = Path(
+                        self.opts["cmssw_comparison_reports"]
+                    )
+                    assert cmssw_comparison_reports_path.exists()
+
+                    comparison_id = bottle.request.query.get("id")
+                    if comparison_id:
+                        if cmssw_comparison_reports_path.joinpath(
+                            comparison_id, "dqm-histo-comparison-summary.html"
+                        ).exists():
+                            return bottle.static_file(
+                                "dqm-histo-comparison-summary.html",
+                                root=cmssw_comparison_reports_path.joinpath(
+                                    comparison_id
+                                ),
+                            )
+                        else:
+                            abort(400, f"Comparison with id {comparison_id} not found")
+
+                    # Populate directory of release comparisons and return it as JSON
+                    valid_reports = get_list_of_release_comparisons(
+                        cmssw_comparison_reports_path
+                    )
+                    return json.dumps(valid_reports)
 
-            except Exception as error_log:
-                msg = f"cr_api@{what}: error: {error_log}"
+            except Exception as e:
+                msg = f"cr_api@{what}: error: {e}"
                 log.error(msg, exc_info=True)
-                return msg, 400
+                abort(400, msg)
             log.warning(f"cr_api@{what} : No actions defined for that request")
-            return f"No actions defined for request {what}", 400
+            abort(400, f"Invalid request '{what}'")
 
 
 def run_web_greenlet(db, host="0.0.0.0", port=9215, opts={}, **kwargs):

fff_dqmtools.py

@@ -470,6 +470,8 @@ def detach(logfile, pidfile):
         "web.secret_name": "selenium-secret-secret",
         "cmssw_path_playback": "/dqmdata/dqm_cmssw/current_playback",
         "cmssw_path_production": "/dqmdata/dqm_cmssw/current_production",
+        # The default output directory of cmssw_release_comparison
+        "cmssw_comparison_reports": "/nfshome0/dqmdev/cmssw_comparison_results",
         "dqm_clients_subdir": "/src/DQM/Integration/python/clients/",
         "hltd_clients_path": "/etc/appliance/dqm_resources/",
         "deleter.ramdisk": "/fff/ramdisk/",