Rewrite test suite to pytest & run CTest

.github/workflows/ci.yml

@@ -15,6 +15,7 @@ jobs:
   make:
     name: "${{ matrix.os }} with make"
     runs-on: "${{ matrix.os }}"
+    timeout-minutes: 15
     strategy:
       fail-fast: false
       matrix:
@@ -40,10 +41,20 @@ jobs:
         env:
           CC: gcc
           CXX: g++
+      - name: Set up Python for tests
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Install test dependencies
+        run: pip install -r requirements.txt
+      - name: Test
+        run: make test
 
   cmake:
     name: "${{ matrix.os }} with cmake"
     runs-on: "${{ matrix.os }}"
+    timeout-minutes: 15
     strategy:
       fail-fast: false
       matrix:
@@ -61,6 +72,15 @@ jobs:
         run: |
           cmake -B build
           cmake --build build -j${{ steps.cpu-cores.outputs.count }}
+      - name: Set up Python for tests
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: 'pip'
+      - name: Install test dependencies
+        run: pip install -r requirements.txt
+      - name: Test
+        run: ctest --test-dir build --verbose
 
   # A dummy job that you can mark as a required check instead of each individual test
   test-suite:

CMakeLists.txt

@@ -731,3 +731,6 @@ add_custom_command(TARGET doc-for-web POST_BUILD
             ${PROJECT_SOURCE_DIR}/Documentation/es/documentation-es
             ${PROJECT_BINARY_DIR}/doc/es/documentation-es
 )
+
+include(CTest)
+add_test(NAME pytest COMMAND pytest -vv ${CMAKE_SOURCE_DIR}/tests)

Makefile

@@ -109,8 +109,8 @@ clean:
 clean-sqlite-shell:
 	make -C Storage/sqlite clean
 
-test:
-	make -C test
+test: railcontrol
+	pytest -vv
 
 tools:
 	make -C tools

requirements.txt

@@ -0,0 +1,2 @@
+pytest
+requests

tests/conftest.py

@@ -0,0 +1,62 @@
+import os
+import subprocess
+from pathlib import Path
+
+import pytest
+import requests
+import time
+
+
+class Client:
+    def __init__(self, url: str):
+        self.url = url
+        self.session = requests.Session()
+
+    def cmd(self, cmd: str, **kwargs):
+        params = kwargs.copy()
+        params['cmd'] = cmd
+        response = self.session.get(self.url, params=params)
+        response.raise_for_status()
+        return response
+
+    def ping(self):
+        print('Pinging', self.url)
+        try:
+            response = self.session.get(self.url, timeout=10)
+            response.raise_for_status()
+        except requests.exceptions.ConnectionError:
+            return False
+
+        return True
+
+
+@pytest.fixture
+def service(tmpdir: Path, port: int = 8022):
+    config = "dbfilename = 'railcontrol.sqlite'\n" \
+            f"webserverport = {port}\n" \
+            "numkeepbackups = 0\n"
+
+    configfile = tmpdir / 'config.conf'
+    configfile.write_text(config, 'UTF-8')
+
+    url = f"http://localhost:{port}"
+
+    command = [os.path.join(os.getcwd(), 'railcontrol'), '--config', str(configfile)]
+    print("Starting railcontrol")
+    with subprocess.Popen(command, cwd=tmpdir) as proc:
+        print("Started", proc.pid)
+        client = Client(url)
+
+        for _ in range(10):
+            print("Polling", proc.pid)
+            if proc.poll():
+                pytest.fail(f"Server exited with code {proc.returncode}")
+            if client.ping():
+                yield client
+                break
+            time.sleep(0.5)
+        else:
+            proc.kill()
+            pytest.fail("Could not connect to service")
+
+        proc.kill()

tests/loco_test.py

@@ -0,0 +1,26 @@
+# locolist
+
+def test_cmd_getlocolist_no_locos(service):
+    response = service.cmd('getlocolist')
+
+    assert response.headers['Content-Type'] == 'text/csv; charset=utf-8'
+    assert not response.text
+
+
+# locosave
+
+def test_cmd_locosave_no_data(service):
+    response = service.cmd('locosave')
+
+    assert 'eControl does not exist' in response.text
+
+# loco
+
+def test_cmd_loco_without_loco(service):
+    response = service.cmd('loco')
+    assert 'Please select a locomotive' in response.text
+
+
+def test_cmd_loco_with_loco_does_not_exist(service):
+    response = service.cmd('loco', loco=1)
+    assert 'Locomotive does not exist' in response.text