Add CI

Author: Tom-Willemsen

.github/workflows/lint_and_test.yml

@@ -0,0 +1,45 @@
+env:
+  PYTHONUNBUFFERED: "TRUE"
+name: test
+on: [pull_request, workflow_call]
+jobs:
+  lint:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/linters.yml@main
+    with:
+      compare-branch: origin/main
+      python-ver: '3.11'
+  unit-tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["ubuntu-latest", "windows-latest"]
+        version: ['3.11']
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.version }}
+      - name: Install base requirements
+        run: pip install -e .
+      - name: Verify package is importable
+        run: |
+          python -c "from genie_python.genie_startup import *"
+          python -c "from genie_python import genie as g"
+      - name: Install dev requirements
+        run: pip install -e .[dev]
+      - name: Run unit tests
+        run: python -m pytest
+  results:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: Final Results
+    needs: [lint, unit-tests]
+    steps:
+    - run: exit 1
+      # see https://stackoverflow.com/a/67532120/4907315
+      if: >-
+          ${{
+               contains(needs.*.result, 'failure')
+            || contains(needs.*.result, 'cancelled')
+          }}

.github/workflows/linter.yml

@@ -41,10 +41,10 @@ dependencies = [
   "numpy",
   # EPICS PV access lib
   "p4p",
-  # Used to find process by name to kill it
-  "psutil",
   # For checking user scripts on g.load_script()
   "pylint",
+  # Used to find process by name to kill it
+  "psutil",
   # For setting windows job-object flags
   "pywin32;platform_system=='Windows'",
 ]
@@ -76,6 +76,8 @@ dev = [
   "parameterized",
   "pyhamcrest",
   "pyright",
+  "pytest",
+  "pytest-cov",
   "ruff>=0.6",
 ]
 
@@ -84,6 +86,25 @@ dev = [
 "Bug Reports" = "https://github.com/isiscomputinggroup/genie/issues"
 "Source" = "https://github.com/isiscomputinggroup/genie"
 
+[tool.pytest.ini_options]
+testpaths = "tests"
+addopts = "--cov --cov-report=html -vv"
+
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "if typing.TYPE_CHECKING:",
+  "@abstractmethod",
+]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
 [tool.pyright]
 include = ["src", "tests"]
 reportConstantRedefinition = true

pyproject.toml

@@ -75,6 +75,7 @@ def set_user_script_dir(*directory: str | list[str]) -> None:
             dirs_to_create.append(base_name)
 
     # Got to a single directory which does not exist
+    # If it ends with colon, we got to the root of the drive
     if base_name == "":
         raise OSError("Script dir does not exist and can not be created: {}".format(requested_dir))
 

src/genie_python/genie_api_setup.py

@@ -4,6 +4,7 @@
 
 from __future__ import absolute_import, print_function
 
+import os
 import threading
 from builtins import object
 from collections.abc import Callable
@@ -229,6 +230,7 @@ def get_chan(name: str, timeout: float = EXIST_TIMEOUT) -> CaChannel:
         Raises:
             UnableToConnectToPVException if it was unable to connect to the channel
         """
+
         try:
             lock = CACHE_LOCK.lock
         except AttributeError:
@@ -279,6 +281,7 @@ def get_pv_value(
             ReadAccessException: If read access is denied.
         """
         chan = CaChannelWrapper.get_chan(name)
+        print(f"set timeout to {timeout} on {name}")
         chan.setTimeout(timeout)
         if not chan.read_access():
             raise ReadAccessException(name)
@@ -363,6 +366,11 @@ def connect_to_pv(ca_channel: CaChannel) -> None:
         Raises:
             UnableToConnectToPVException: If cannot connect to PV.
         """
+        if os.getenv("GITHUB_ACTIONS"):
+            # genie_python does some PV accesses on import. To avoid them timing out and making CI
+            # builds really slow, shortcut every PV to "non-existent" here.
+            raise UnableToConnectToPVException("", "In CI")
+
         event = Event()
         try:
             ca_channel.search_and_connect(None, CaChannelWrapper.putCB, event)

src/genie_python/genie_cachannel_wrapper.py

@@ -1,5 +1,6 @@
 """Logging module for genie"""
 
+import getpass
 import logging
 import logging.config
 
@@ -93,7 +94,7 @@ def get_log_file_dir():
             if os.name == "nt":
                 return os.path.join("C:", os.sep, "Instrument", "Var", "logs", "genie_python")
             else:
-                return os.path.join("/tmp/{}/genie_python".format(os.getlogin()))
+                return os.path.join("/tmp/{}/genie_python".format(getpass.getuser()))
 
     @staticmethod
     def get_log_file_path():

src/genie_python/genie_logging.py

@@ -216,21 +216,21 @@ def test_GIVEN_running_state_WHEN_pause_run_THEN_pause_run(self):
 
     def test_GIVEN_one_block_WHEN_cset_runcontrol_and_wait__true_THEN_exception(self):
         create_dummy_blocks(["a"])
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
             Exception, "Cannot enable or disable runcontrol at the same time as setting a wait"
         ):
             genie.cset(a=1, runcontrol=True, wait=True)
 
     def test_GIVEN_multiple_blocks_WHEN_cset_runcontrol_THEN_exception(self):
         create_dummy_blocks(["a", "b"])
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
             Exception, "Runcontrol and wait can only be changed for one block at a time"
         ):
             genie.cset(a=1, b=2, runcontrol=True)
 
     def test_GIVEN_multiple_blocks_WHEN_cset_wait_THEN_exception(self):
         create_dummy_blocks(["a", "b"])
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
             Exception, "Runcontrol and wait can only be changed for one block at a time"
         ):
             genie.cset(a=1, b=2, wait=True)
@@ -240,7 +240,7 @@ def test_GIVEN_period_WHEN_set_period_to_higher_value_THEN_exception(self):
         period = genie.get_number_periods()
 
         # Assert
-        with self.assertRaisesRegexp(
+        with self.assertRaisesRegex(
             Exception, "Cannot set period as it is higher than the number of periods"
         ):
             genie.change_period(period + 1)

tests/test_simulation.py

@@ -282,7 +282,7 @@ def test_GIVEN_invalid_json_WHEN_get_pv_THEN_list_raise(self):
         api = Mock()
         api.get_pv_value = Mock(return_value=compressed_list)
 
-        self.assertRaisesRegexp(
+        self.assertRaisesRegex(
             PVReadException, "Can not unmarshal.*", get_json_pv_value, "name", api
         )
 
@@ -301,15 +301,15 @@ def test_GIVEN_invalid_compressed_string_WHEN_get_pv_THEN_raise(self):
         api = Mock()
         api.get_pv_value = Mock(return_value=(invalid_string))
 
-        self.assertRaisesRegexp(
+        self.assertRaisesRegex(
             PVReadException, "Can not decompress.*", get_json_pv_value, "name", api
         )
 
     def test_GIVEN_pv_can_not_be_read_WHEN_get_pv_THEN_raise(self):
         api = Mock()
         api.get_pv_value = Mock(side_effect=Exception())
 
-        self.assertRaisesRegexp(PVReadException, "Can not read.*", get_json_pv_value, "name", api)
+        self.assertRaisesRegex(PVReadException, "Can not read.*", get_json_pv_value, "name", api)
 
     def test_GIVEN_unicode_with_only_ascii_WHEN_converted_THEN_no_change(self):
         # Arrange