From 7b935e07faac855bf4f0f406e48b2fa42865be91 Mon Sep 17 00:00:00 2001 From: Kevin Montag Date: Mon, 13 May 2024 21:55:51 +0200 Subject: [PATCH] Remove references to SSCOM port name --- CONTRIBUTING.md | 14 ++++++++++---- tests/conftest.py | 5 +++-- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d0e34f5..5e6d071 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,8 +9,8 @@ that source won't show up until tests are actually running, so you'll need to configure the control surface manually while you're running tests for the first time. -You can add the test control surface in addition to the main SSCOM -control surface, if you don't want to deal with switching the +You can safely add this test control surface alongside your primary +modeStep control surface, if you don't want to deal with switching the input/output when you want to run tests. To run tests, use: @@ -25,13 +25,19 @@ For debug output: DEBUG=1 make test ``` +To run only specs tagged with `@now`: + +```shell +.venv/bin/pytest -m now +``` + ## Linting and type checks Before submitting a PR, make sure the following are passing: ```shell -make lint # Validates code style -make check # Validates types +make lint # Validates code style. +make check # Validates types. ``` Some lint errors can be fixed automatically with: diff --git a/tests/conftest.py b/tests/conftest.py index 583ad7a..efad187 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -404,10 +404,11 @@ def ioport(): yield ioport -# Relay port to the physical device for visual feedback during tests, if available. +# Cheap thrills - relay the test port to the physical device for visual feedback during +# tests, if available. @fixture def relay_port() -> Generator[Optional[mido.ports.BaseOutput], Never, None]: - port_name = "SSCOM Port 1" + port_name = "SoftStep Control Surface" try: with mido.open_output(port_name) as relay_port: # type: ignore yield relay_port