ci: added pytest config to CI and fixed stuff that broke in refactor

Author: ErikBjare

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Test
 
 on:
   push:
-    branches: [ master, 'dev/*' ]
+    branches: [ master ]
   pull_request:
     branches: [ master ]
 
@@ -57,7 +57,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip wheel
         pip install .
-    - name: Run eegnb install test
+    - name: Run eegnb cli test
       shell: bash
       run: |
         if [ "$RUNNER_OS" == "Linux" ]; then
@@ -66,6 +66,10 @@ jobs:
         fi
         eegnb --help
         eegnb runexp --help
+    - name: Run tests
+      shell: bash
+      run: |
+        pytest
 
   typecheck:
     runs-on: ${{ matrix.os }}

.gitignore

@@ -1,10 +1,18 @@
 __pycache__
-
 *.egg-info/
 
+# Created by tests
+.coverage
+coverage.xml
+htmlcov
+prof
+
 # Built as part of docs
 doc/auto_examples
 doc/_build
 
 # Built by auto_examples
 examples/visual_cueing/*.csv
+
+# present for people who use pyenv
+.venv

eegnb/cli/__main__.py

@@ -1,10 +1,13 @@
 import click
+import logging
+
+logger = logging.getLogger(__name__)
 
 
 @click.group(name="eegnb")
 def main():
     """eeg-notebooks command line interface"""
-    pass
+    logging.basicConfig(level=logging.INFO)
 
 
 @main.command()
@@ -55,13 +58,16 @@ def runexp(
         run_introprompt()
     else:
         from .utils import run_experiment
-        from eegnb.devices.eeg import EEG
+        from eegnb.devices import EEGDevice
 
         if eegdevice == "ganglion":
             # if the ganglion is chosen a MAC address should also be proviced
-            eeg = EEG(device=eegdevice, mac_addr=macaddr)
+            eeg = EEGDevice.create(device_name=eegdevice, mac_addr=macaddr)
         else:
-            eeg = EEG(device=eegdevice)
+            if eegdevice:
+                eeg = EEGDevice.create(device_name=eegdevice)
+            else:
+                print("No EEG device provided, using a synthetic one.")
 
         run_experiment(experiment, eeg, recdur, outfname)
 

eegnb/cli/introprompt.py

@@ -1,11 +1,9 @@
-import os
-
 from eegnb import generate_save_fn
-from eegnb.devices.eeg import EEG
+from eegnb.devices import EEGDevice
 from .utils import run_experiment, get_exp_desc, experiments
 
 
-def device_prompt() -> EEG:
+def device_prompt() -> EEGDevice:
     # define the names of the available boards
     # boards is a mapping from board code to board description
     boards = {
@@ -51,9 +49,7 @@ def device_prompt() -> EEG:
             board_code = board_code + "_wifi"
         if board_code == "ganglion":
             # If the Ganglion is being used, you can enter optional Ganglion mac address
-            ganglion_mac_address = input(
-                "\nGanglion MAC Address (Press Enter to Autoscan): "
-            )
+            mac_address = input("\nGanglion MAC Address (Press Enter to Autoscan): ")
         elif board_code == "ganglion_wifi":
             # IP address is required for this board configuration
             ip_address = input("\nEnter Ganglion+WiFi IP Address: ")
@@ -66,13 +62,11 @@ def device_prompt() -> EEG:
     # initialize the EEG device
     if board_code.startswith("ganglion"):
         if board_code == "ganglion_wifi":
-            eeg_device = EEG(device=board_code, ip_addr=ip_address)
+            return EEGDevice.create(device_name=board_code, ip_addr=ip_address)
         else:
-            eeg_device = EEG(device=board_code, mac_addr=ganglion_mac_address)
+            return EEGDevice.create(device_name=board_code, mac_addr=mac_address)
     else:
-        eeg_device = EEG(device=board_code)
-
-    return eeg_device
+        return EEGDevice.create(device_name=board_code)
 
 
 def exp_prompt():

eegnb/cli/utils.py

@@ -1,4 +1,4 @@
-from eegnb.devices.eeg import EEG
+from eegnb.devices import EEGDevice
 
 from eegnb.experiments.visual_n170 import n170
 from eegnb.experiments.visual_p300 import p300
@@ -27,7 +27,7 @@ def get_exp_desc(exp: str):
 
 
 def run_experiment(
-    experiment: str, eeg_device: EEG, record_duration: float = None, save_fn=None
+    experiment: str, eeg_device: EEGDevice, record_duration: float = None, save_fn=None
 ):
     if experiment in experiments:
         module = experiments[experiment]

pyproject.toml

@@ -0,0 +1,16 @@
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--cov-report=term --cov-report=xml --cov-report=html --cov=eegnb --profile --nbval-lax --current-env"
+testpaths = [
+    "eegnb/devices",
+    "eegnb/cli",
+]
+python_files = ["*.py", "*.ipynb"]
+
+[tool.coverage.report]
+exclude_lines = [
+    # Have to re-enable the standard pragma
+    "pragma: no cover",
+    # Don't complain if tests don't hit defensive assertion code
+    "raise NotImplementedError"
+]

requirements.txt

@@ -25,6 +25,11 @@ pywinhook @ https://github.com/ActivityWatch/wheels/raw/master/pywinhook/pyWinho
 
 # Test requirements
 mypy>=0.790
+pytest
+pytest-cov
+pytest-profiling
+coverage[toml]
+nbval
 
 # Docs requirements
 sphinx==3.1.1