add tests

Author: wxtim

.github/workflows/build.yml

@@ -0,0 +1,80 @@
+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: |
+          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

@@ -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"]: