add tests

Author: wxtim

.github/workflows/build.yml renamed to .github/workflows/build.yml.b

@@ -0,0 +1,83 @@
+name: Test Cylc Review
+
+on:
+  pull_request:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - '*.*.x'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: 2
+
+defaults:
+  run:
+    shell: bash -c "exec $CONDA_PREFIX/bin/bash -elo pipefail {0}"
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest']
+        python-version: ['3.12']
+    env:
+      PYTEST_ADDOPTS: --cov --color=yes
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Patch DNS
+        uses: cylc/release-actions/patch-dns@v1
+
+      - name: Install System Dependencies
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          cache-environment: true
+          post-cleanup: 'all'
+          environment-name: cylc-uiserver
+          create-args: >-
+            python=${{ matrix.python-version }}
+            pip
+            bash
+            coreutils
+
+      - name: install cylc-flow
+        uses: cylc/release-actions/install-cylc-components@v1
+        with:
+          cylc_flow: true
+          cylc_flow_opts: ''
+
+      - name: install cylc-uiserver
+        run: pip install -e .[all]
+
+      - name: Functional Tests
+        run: |
+          pip uninstall cylc-flow -y
+          pip install git+https://github.com/wxtim/[email protected]
+
+          CONF_PATH="$HOME/.cylc/flow/8"
+          mkdir -p "$CONF_PATH"
+          touch "$CONF_PATH/global.cylc"
+          ln -s "$CONF_PATH/global.cylc" "$CONF_PATH/global-tests.cylc"
+
+          cat >> "$CONF_PATH/global.cylc" <<__HERE__
+          [platforms]
+            [[_local_background_indep_tcp]]
+              hosts = localhost
+              install target = localhost
+              ssh command = ssh -oBatchMode=yes -oConnectTimeout=8 -oStrictHostKeyChecking=no
+          __HERE__
+
+          # Check that Cylc Review is ready to run
+          cylc review --help || exit 1
+
+          ./etc/bin/run-functional-tests

.github/workflows/test.yml renamed to .github/workflows/test.yml.b

@@ -24,7 +24,7 @@
 )
 from cylc.uiserver.app import USER_CONF_ROOT
 from cylc.uiserver.authorise import CylcAuthorizer
-from cylc.uiserver.ws import get_review_service
+from cylc.uiserver.ws import get_review_service_config
 
 
 # the command the hub should spawn (i.e. the cylc uiserver itself)
@@ -108,4 +108,4 @@
 
 
 # Setup Cylc Review
-c.JupyterHub.services = [get_review_service()]
+c.JupyterHub.services = [get_review_service_config()]

.github/workflows/test_review.yml

@@ -23,6 +23,7 @@
 For 'cylc review start', if 'PORT' is not specified, port 8080 is used."""
 
 import cherrypy
+import contextlib
 from fnmatch import fnmatch
 from glob import glob
 import jinja2
@@ -40,15 +41,12 @@
 import traceback
 from urllib.parse import quote
 
-from cylc.flow.hostuserutil import get_host
-from cylc.uiserver.review_dao import CylcReviewDAO
-from cylc.flow.task_state import (
-    TASK_STATUSES_ORDERED,
-)
 from cylc.flow import __version__ as CYLC_VERSION
-from cylc.uiserver.ws import get_util_home
-from cylc.uiserver.review_dao import TASK_STATUS_GROUPS
+from cylc.flow.hostuserutil import get_host
+from cylc.flow.task_state import TASK_STATUSES_ORDERED
 from cylc.flow.workflow_files import WorkflowFiles
+from cylc.uiserver.review_dao import TASK_STATUS_GROUPS, CylcReviewDAO
+from cylc.uiserver.ws import get_util_home
 
 
 # Cylc 7 Task states.
@@ -69,7 +67,7 @@
 ]
 
 
-class CylcReviewService(object):
+class CylcReviewService:
     """'Cylc Review Service."""
 
     NS = "cylc"
@@ -509,14 +507,12 @@ def suites(
             item = os.path.relpath(dirpath, user_suite_dir_root)
             if not any(fnmatch(item, glob_) for glob_ in name_globs):
                 continue
-            try:
+            with contextlib.suppress(OSError):
                 data["entries"].append({
                     "name": str(item),
                     "info": {},
                     "last_activity_time": (
                         self.get_last_activity_time(user, item))})
-            except OSError:
-                pass
 
         if order == "name_asc":
             data["entries"].sort(key=lambda entry: entry["name"])
@@ -542,14 +538,14 @@ def suites(
             rosie_suite_info = os.path.join(user_suite_dir, "rose-suite.info")
             if os.path.isfile(rosie_suite_info):
                 rosie_info = {}
-                try:
-                    for line in open(rosie_suite_info, 'r').readlines():
+                with contextlib.suppress(IOError):
+                    for line in open(   # noqa: SIM115
+                        rosie_suite_info, 'r'
+                    ).readlines():
                         if not line.strip().startswith('#') and '=' in line:
                             rosie_key, rosie_val = line.strip().split("=", 1)
                             if rosie_key in ("project", "title"):
                                 rosie_info[rosie_key] = rosie_val
-                except IOError:
-                    pass
                 entry["info"].update(rosie_info)
 
         data["time"] = strftime("%Y-%m-%dT%H:%M:%SZ", gmtime())
@@ -600,7 +596,7 @@ def get_file(self, user, suite, path, path_in_tar=None, mode=None):
             text = handle.read()
         else:
             f_size = os.stat(f_name).st_size
-            if open(f_name).read(2) == "#!":
+            if open(f_name).read(2) == "#!":  # noqa: SIM115
                 mime = self.MIME_TEXT_PLAIN
             else:
                 mime = mimetypes.guess_type(quote(f_name))[0]
@@ -614,7 +610,7 @@ def get_file(self, user, suite, path, path_in_tar=None, mode=None):
             ):
                 cherrypy.response.headers["Content-Type"] = mime
                 return cherrypy.lib.static.serve_file(f_name, mime)
-            text = open(f_name).read()
+            text = open(f_name).read()  # noqa: SIM115
         try:
             text = str(text)
             if mode in [None, "text"]:

cylc/uiserver/jupyter_config.py

@@ -15,22 +15,23 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Provide data access object for the suite runtime database."""
 
-import sqlite3
+import contextlib
+from glob import glob
 import os
 from pathlib import Path
-import tarfile
 import re
-from glob import glob
+import sqlite3
 from sqlite3 import OperationalError
+import tarfile
 
 from cylc.flow.rundb import CylcWorkflowDAO
-from cylc.flow.workflow_files import WorkflowFiles
 from cylc.flow.task_state import (
     TASK_STATUSES_ACTIVE,
     TASK_STATUSES_FAILURE,
     TASK_STATUSES_NEVER_ACTIVE,
     TASK_STATUSES_SUCCESS,
 )
+from cylc.flow.workflow_files import WorkflowFiles
 
 TASK_STATUS_GROUPS = {
     "active": list(TASK_STATUSES_ACTIVE | TASK_STATUSES_NEVER_ACTIVE),
@@ -39,7 +40,7 @@
 }
 
 
-class CylcReviewDAO(object):
+class CylcReviewDAO:
     """Cylc Review data access object to the suite runtime database."""
 
     CYCLE_ORDERS = {"time_desc": " DESC", "time_asc": " ASC"}
@@ -455,9 +456,11 @@ def _get_job_logs(self, user_name, suite_name, entries, entry_of):
                             "exists": True,
                             "seq_key": None}
                         continue
-            if entry["cycle"] in targzip_log_cycles:
-                if entry["cycle"] not in relevant_targzip_log_cycles:
-                    relevant_targzip_log_cycles.append(entry["cycle"])
+            if (
+                entry["cycle"] in targzip_log_cycles
+                and entry["cycle"] not in relevant_targzip_log_cycles
+            ):
+                relevant_targzip_log_cycles.append(entry["cycle"])
 
         for cycle in relevant_targzip_log_cycles:
             path = os.path.join("log", "job-%s.tar.gz" % cycle)
@@ -561,12 +564,10 @@ def get_suite_cycles_summary(
         user_suite_dir = os.path.expanduser(os.path.join(
             prefix, os.path.join("cylc-run", suite_name)))
         targzip_log_cycles = []
-        try:
+        with contextlib.suppress(OSError):
             for item in os.listdir(os.path.join(user_suite_dir, "log")):
                 if item.startswith("job-") and item.endswith(".tar.gz"):
                     targzip_log_cycles.append(item[4:-7])
-        except OSError:
-            pass
 
         if self.is_cylc8:
             # Cylc 8 has a smaller set of task states.
@@ -695,7 +696,7 @@ def get_suite_state_summary(self, user_name, suite_name):
         try:
             host = None
             port_str = None
-            for line in open(port_file_path):
+            for line in open(port_file_path):   # noqa: SIM115
                 key, value = [item.strip() for item in line.split("=", 1)]
                 if key in ["CYLC_SUITE_HOST", "CYLC_WORKFLOW_HOST"]:
                     host = value
@@ -710,17 +711,14 @@ def get_suite_state_summary(self, user_name, suite_name):
 
         stmt = "SELECT status FROM task_states WHERE status GLOB ? LIMIT 1"
         stmt_args = ["*failed"]
-        try:
+        with contextlib.suppress(sqlite3.Error):
             for _ in self._db_exec(user_name, suite_name, stmt, stmt_args):
                 ret["is_failed"] = True
                 break
-        except sqlite3.Error:
-            pass  # case with no task_states table.
         self._db_close(user_name, suite_name)
 
         return ret
 
-
     def pre_select_broadcast_events(self, order=None):
         """Query statement and args formation for select_broadcast_events."""
         form_stmt = r"SELECT time,change,point,namespace,key,value FROM %s"

cylc/uiserver/review.py

@@ -20,14 +20,14 @@
 ws_cli - Parse CLI. Start/Stop ad-hoc server.
 """
 
+from annotated_types import Ge
 import cherrypy
 from glob import glob
 import os
 from pathlib import Path
 from random import shuffle
 import socket
 from typing import Annotated
-from annotated_types import Ge
 
 LOG_ROOT_TMPL = "~/.cylc/%(ns)s-%(util)s-%(host)s-%(port)s"
 
@@ -77,9 +77,9 @@ def _ws_init(service_cls, port, service_root, *args, **kwargs):
         handle.write("pid=%d\n" % os.getpid())
 
     cherrypy.config["log.access_file"] = log_root + "-access.log"
-    open(cherrypy.config["log.access_file"], "w").close()
+    open(cherrypy.config["log.access_file"], "w").close()   # noqa: SIM115
     cherrypy.config["log.error_file"] = log_root + "-error.log"
-    open(cherrypy.config["log.error_file"], "w").close()
+    open(cherrypy.config["log.error_file"], "w").close()   # noqa: SIM115
 
     root = '/'
     if service_root != '/':
@@ -144,7 +144,7 @@ def _get_server_status(service_cls):
     )
     for filename in glob(log_root_glob):
         try:
-            for line in open(filename):
+            for line in open(filename):   # noqa: SIM115
                 key, value = line.strip().split("=", 1)
                 ret[key] = value
             break
@@ -162,7 +162,7 @@ def get_util_home(*args):
     return str(Path(__file__).parent / '/'.join(args))
 
 
-def get_review_service(
+def get_review_service_config(
     ports: tuple[Annotated[int, Ge(0)], Annotated[int, Ge(0)]] = (8000, 8999),
     service_root: str = 'services/cylc'
 ) -> dict:
@@ -194,4 +194,4 @@ def get_review_service(
             f"--service-root={service_root}",
         ],
         "url": f"http://127.0.0.1:{port}/",
-    }
+    }