fix(ci): add ruff.toml, format check, coverage, merge tests.yml, fix bare excepts (#454)

Author: avinxshKD

.github/workflows/ci.yml

@@ -7,67 +7,58 @@ on:
     branches: [main, dev]
 
 jobs:
-  lint-and-test:
+  lint:
     runs-on: ubuntu-latest
-    
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
           cache: 'pip'
 
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Check formatting
+        run: ruff format --check .
+
+      - name: Lint
+        run: ruff check . --output-format=github
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-ci.txt
-        # Uses minimal CI requirements (no tensorflow/heavy packages)
 
-      - name: Run linter (ruff)
+      - name: Run tests
         run: |
-          ruff check . --select=E9,F63,F7,F82 --output-format=github \
-            --exclude="Dockerfile.*" \
-            --exclude="linktest/" \
-            --exclude="measurements/" \
-            --exclude="0mq/" \
-            --exclude="ratc/"
-        # E9: Runtime errors (syntax errors, etc.)
-        # F63: Invalid print syntax
-        # F7: Syntax errors in type comments
-        # F82: Undefined names in __all__
-        # Excludes: Dockerfiles (not Python), linktest (symlinks),
-        # measurements/0mq/ratc (config-dependent experimental scripts)
-
-      - name: Run tests (pytest)
-        run: |
-          set +e
           pytest --tb=short -q \
+            --cov=concore_cli --cov=concore_base \
+            --cov-report=term-missing \
             --ignore=measurements/ \
             --ignore=0mq/ \
             --ignore=ratc/ \
             --ignore=linktest/
-          status=$?
-          set -e
-          # Allow success if no tests are collected (pytest exit code 5)
-          if [ "$status" -ne 0 ] && [ "$status" -ne 5 ]; then
-            exit "$status"
-          fi
-        # Fails on real test failures, passes on no tests collected
 
   docker-build:
     runs-on: ubuntu-latest
-    # Only run when Dockerfile.py or related files change
-    if: |
-      github.event_name == 'push' ||
-      (github.event_name == 'pull_request' && 
-       contains(github.event.pull_request.changed_files, 'Dockerfile'))
-    
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
       - name: Check if Dockerfile.py changed
         uses: dorny/paths-filter@v3
@@ -80,7 +71,4 @@ jobs:
 
       - name: Validate Dockerfile build
         if: steps.filter.outputs.dockerfile == 'true'
-        run: |
-          docker build -f Dockerfile.py -t concore-py-test .
-        # Validates that Dockerfile.py can be built successfully
-        # Does not push the image
+        run: docker build -f Dockerfile.py -t concore-py-test .

.github/workflows/tests.yml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.12
+    hooks:
+      - id: ruff
+        args: [--output-format=full]
+      - id: ruff-format

.pre-commit-config.yaml

@@ -1,33 +1,33 @@
-import time
+import time  # noqa: F401
 import logging
 import os
 import atexit
-from ast import literal_eval
+from ast import literal_eval  # noqa: F401
 import sys
-import re
-import zmq
-import numpy as np
+import re  # noqa: F401
+import zmq  # noqa: F401
+import numpy as np  # noqa: F401
 import signal
 
 import concore_base
 
-logger = logging.getLogger('concore')
+logger = logging.getLogger("concore")
 logger.addHandler(logging.NullHandler())
 
-#these lines mute the noisy library
-logging.getLogger('matplotlib').setLevel(logging.WARNING)
-logging.getLogger('PIL').setLevel(logging.WARNING)
-logging.getLogger('urllib3').setLevel(logging.WARNING) 
-logging.getLogger('requests').setLevel(logging.WARNING) 
+# these lines mute the noisy library
+logging.getLogger("matplotlib").setLevel(logging.WARNING)
+logging.getLogger("PIL").setLevel(logging.WARNING)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+logging.getLogger("requests").setLevel(logging.WARNING)
 
 
-# if windows, create script to kill this process 
+# if windows, create script to kill this process
 # because batch files don't provide easy way to know pid of last command
 # ignored for posix != windows, because "concorepid" is handled by script
 # ignored for docker (linux != windows), because handled by docker stop
-if hasattr(sys, 'getwindowsversion'):
-    with open("concorekill.bat","w") as fpid:
-        fpid.write("taskkill /F /PID "+str(os.getpid())+"\n")
+if hasattr(sys, "getwindowsversion"):
+    with open("concorekill.bat", "w") as fpid:
+        fpid.write("taskkill /F /PID " + str(os.getpid()) + "\n")
 
 ZeroMQPort = concore_base.ZeroMQPort
 convert_numpy_to_python = concore_base.convert_numpy_to_python
@@ -38,17 +38,19 @@
 zmq_ports = {}
 _cleanup_in_progress = False
 
-s = ''
-olds = ''
+s = ""
+olds = ""
 delay = 1
 retrycount = 0
-inpath = "./in" #must be rel path for local
+inpath = "./in"  # must be rel path for local
 outpath = "./out"
 simtime = 0
 
+
 def _port_path(base, port_num):
     return base + str(port_num)
 
+
 concore_params_file = os.path.join(_port_path(inpath, 1), "concore.params")
 concore_maxtime_file = os.path.join(_port_path(inpath, 1), "concore.maxtime")
 
@@ -58,16 +60,19 @@ def _port_path(base, port_num):
 
 _mod = sys.modules[__name__]
 
+
 # ===================================================================
 # ZeroMQ Communication Wrapper
 # ===================================================================
 def init_zmq_port(port_name, port_type, address, socket_type_str):
     concore_base.init_zmq_port(_mod, port_name, port_type, address, socket_type_str)
 
+
 def terminate_zmq():
     """Clean up all ZMQ sockets and contexts before exit."""
     concore_base.terminate_zmq(_mod)
 
+
 def signal_handler(sig, frame):
     """Handle interrupt signals gracefully."""
     print(f"\nReceived signal {sig}, shutting down gracefully...")
@@ -78,20 +83,23 @@ def signal_handler(sig, frame):
     concore_base.terminate_zmq(_mod)
     sys.exit(0)
 
+
 # Register cleanup handlers
 atexit.register(terminate_zmq)
-signal.signal(signal.SIGINT, signal_handler)   # Handle Ctrl+C
-if not hasattr(sys, 'getwindowsversion'):
+signal.signal(signal.SIGINT, signal_handler)  # Handle Ctrl+C
+if not hasattr(sys, "getwindowsversion"):
     signal.signal(signal.SIGTERM, signal_handler)  # Handle termination (Unix only)
 
 params = concore_base.load_params(concore_params_file)
 
-#9/30/22
+
+# 9/30/22
 def tryparam(n, i):
     """Return parameter `n` from params dict, else default `i`."""
     return params.get(n, i)
 
-#9/12/21
+
+# 9/12/21
 # ===================================================================
 # Simulation Time Handling
 # ===================================================================
@@ -100,12 +108,15 @@ def default_maxtime(default):
     global maxtime
     maxtime = safe_literal_eval(concore_maxtime_file, default)
 
+
 default_maxtime(100)
 
+
 def unchanged():
     """Check if global string `s` is unchanged since last call."""
     return concore_base.unchanged(_mod)
 
+
 # ===================================================================
 # I/O Handling (File + ZMQ)
 # ===================================================================
@@ -116,5 +127,6 @@ def read(port_identifier, name, initstr_val):
 def write(port_identifier, name, val, delta=0):
     concore_base.write(_mod, port_identifier, name, val, delta)
 
-def initval(simtime_val_str): 
+
+def initval(simtime_val_str):
     return concore_base.initval(_mod, simtime_val_str)