Add test framework using pytest and playwright

.devcontainer/devcontainer.json

@@ -2,58 +2,62 @@
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/docker-existing-docker-compose
 // If you want to run as a non-root user in the container, see .devcontainer/docker-compose.yml.
 {
-	"name": "MyRadio + Postgres, Memcached, Mailhog",
-
-	// Update the 'dockerComposeFile' list if you have more compose files or use different names.
-	// The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
-	"dockerComposeFile": [
-		"../docker-compose.yml",
-		"docker-compose.yml"
-	],
-
-	"service": "myradio",
-
-	// The optional 'workspaceFolder' property is the path VS Code should open by default when
-	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
-	"workspaceFolder": "/var/www/myradio",
-
-	// Set *default* container specific settings.json values on container create.
-	"settings": {
-		"sqltools.connections": [{
-			"name": "Container database",
-			"driver": "PostgreSQL",
-			"server": "postgres",
-			"previewLimit": 50,
-			"port": 5432,
-			"database": "myradio",
-			"username": "myradio",
-			"password": "myradio"
-		}]
-	},
-
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"bmewburn.vscode-intelephense-client",
-		"felixfbecker.php-debug",
-		"mtxr.sqltools",
-		"mtxr.sqltools-driver-pg",
-		"whatwedo.twig"
-	],
-
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	"forwardPorts": [7080, 8025],
-
-	// "initializeCommand": ""
-
-	// Uncomment the next line if you want start specific services in your Docker Compose config.
-	// "runServices": [],
-
-	// Uncomment the next line if you want to keep your containers running after VS Code shuts down.
-	// "shutdownAction": "none",
-
-	// Uncomment the next line to run commands after the container is created - for example installing curl.
-	"postCreateCommand": "COMPOSER_VENDOR_DIR=/workspaces/MyRadio/src/vendor composer install && apachectl restart",
-
-	// Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-	// "remoteUser": "vscode"
+  "name": "MyRadio + Postgres, Memcached, Mailhog",
+
+  // Update the 'dockerComposeFile' list if you have more compose files or use different names.
+  // The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+  "dockerComposeFile": ["../docker-compose.yml", "docker-compose.yml"],
+
+  "service": "myradio",
+
+  // The optional 'workspaceFolder' property is the path VS Code should open by default when
+  // connected. This is typically a file mount in .devcontainer/docker-compose.yml
+  "workspaceFolder": "/var/www/myradio",
+
+  "customizations": {
+    "vscode": {
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "sqltools.connections": [
+          {
+            "name": "Container database",
+            "driver": "PostgreSQL",
+            "server": "postgres",
+            "previewLimit": 50,
+            "port": 5432,
+            "database": "myradio",
+            "username": "myradio",
+            "password": "myradio"
+          }
+        ]
+      },
+
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "bmewburn.vscode-intelephense-client",
+        "felixfbecker.php-debug",
+        "mtxr.sqltools",
+        "mtxr.sqltools-driver-pg",
+        "whatwedo.twig",
+        "xdebug.php-debug"
+      ]
+    }
+  },
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [7080, 8025],
+
+  // "initializeCommand": ""
+
+  // Uncomment the next line if you want start specific services in your Docker Compose config.
+  // "runServices": [],
+
+  // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+  // "shutdownAction": "none",
+
+  // Uncomment the next line to run commands after the container is created - for example installing curl.
+  "postCreateCommand": "COMPOSER_VENDOR_DIR=/workspaces/MyRadio/src/vendor composer install && apachectl restart"
+
+  // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+  // "remoteUser": "vscode"
 }

.devcontainer/docker-compose.yml

@@ -17,9 +17,11 @@ services:
     # user: vscode
 
     init: true
+    environment:
+      E2E_TEST: 'true'
 
     volumes:
       # Update this to wherever you want VS Code to mount the folder of your project
-      - .:/workspaces/MyRadio:cached
+      - .:/var/www/myradio:cached
       - ./sample_configs/codespaces-server-name.conf:/etc/apache2/conf-enabled/server-name.conf
       - ./sample_configs/codespaces-apache.conf:/etc/apache2/sites-available/myradio.conf

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build MyRadio and set up test environment
+        run: |
+          docker compose -f docker-compose.yml -f docker-compose.test.yml up -d
+      - name: Run tests
+        run: |
+          docker compose exec myradio poetry run py.test

.gitignore

@@ -14,4 +14,7 @@ src/vendor
 composer.lock
 node_modules/
 src/Public/img/stats_training_*.svg
-.idea/
+.idea/
+__pycache__/
+*.pyc
+*.pyo

Dockerfile

@@ -2,9 +2,9 @@ FROM php:8.2-apache
 
 RUN apt-get update && apt-get install -y libpq-dev libpng-dev libjpeg-dev libldap-dev unzip \
                                          libcurl4-openssl-dev libxslt-dev git libz-dev libzip-dev libmemcached-dev \
-                                         postgresql-client jq msmtp-mta ffmpeg
+                                         postgresql-client python3-dev jq msmtp-mta ffmpeg
 
-RUN docker-php-ext-install pgsql pdo_pgsql gd ldap curl xsl zip
+RUN docker-php-ext-install pgsql gd ldap curl xsl zip
 
 RUN pecl install memcached && \
     echo extension=memcached.so >> /usr/local/etc/php/conf.d/memcached.ini
@@ -52,4 +52,13 @@ COPY src src
 COPY sample_configs/docker-config.php src/MyRadio_Config.local.php
 RUN chown www-data:www-data /var/www/myradio/src/MyRadio_Config.local.php && chmod 664 /var/www/myradio/src/MyRadio_Config.local.php
 
+# Testing requirements
+COPY pyproject.toml poetry.lock ./
+RUN curl -sSL https://install.python-poetry.org | python3 -
+ENV PATH="${PATH}:/root/.local/bin" 
+RUN poetry config virtualenvs.in-project true && \
+  poetry install
+
+COPY *.py ./
+
 CMD ["apache2-foreground"]

Dockerfile.prod

@@ -4,7 +4,7 @@ RUN apt-get update && apt-get install -y libpq-dev libpng-dev libjpeg-dev liblda
                                          libcurl4-openssl-dev libxslt-dev git libz-dev libzip-dev libmemcached-dev \
                                          postgresql-client jq msmtp-mta ffmpeg
 
-RUN docker-php-ext-install pgsql pdo_pgsql gd ldap curl xsl zip
+RUN docker-php-ext-install pgsql gd ldap curl xsl zip
 
 RUN pecl install memcached && \
     echo extension=memcached.so >> /usr/local/etc/php/conf.d/memcached.ini

composer.json

@@ -12,16 +12,14 @@
         "spatie/icalendar-generator": "^2.1",
         "simshaun/recurr": "^4.0",
         "geoip2/geoip2": "^2.10.0",
-        "spatie/icalendar-generator": "^2.1",
         "ext-pgsql": "*",
-	"rbdwllr/reallysimplejwt": "4.0.3"
+	    "rbdwllr/reallysimplejwt": "4.0.3"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": "~3.5",
         "pdepend/pdepend": "~2.5",
         "phpmd/phpmd": "~2.6",
         "theseer/phpdox": "~0.11",
-        "codeception/codeception": "~4.2",
         "flow/jsonpath": "~0.4"
     },
     "config": {

conftest.py

@@ -0,0 +1,147 @@
+from pathlib import Path
+from typing import Dict
+import pytest
+import subprocess
+import psycopg2
+import hashlib
+import json
+from playwright.sync_api import Playwright, Browser  # type: ignore
+
+
+def _get_myradio_config(field: str):
+    return json.loads(
+        subprocess.check_output(
+            [
+                "php",
+                "-r",
+                f'require "src/Controllers/root_cli.php"; echo json_encode(\\MyRadio\\Config::${field});',
+            ]
+        ).decode("utf-8")
+    )
+
+
+# We want each test to run in an isolated environment, otherwise tests may randomly fail
+# depending on the order that they ran.
+# We do this by creating a new PostgreSQL database for each test.
+# To speed it up, we first set up a template database, and then make a copy of it
+# for each test.
+# Database.php respects the X-MyRadio-Database header in E2E test mode (env var E2E_TEST == "true").
+
+@pytest.fixture(autouse=True, scope="session")
+def db_conn():
+    # Get the config details
+    host = _get_myradio_config("db_hostname")
+    user = _get_myradio_config("db_user")
+    password = _get_myradio_config("db_pass")
+
+    db = psycopg2.connect(
+        f"host={host} dbname=postgres user={user} password={password}"
+    )
+    # Create myradio database and seed
+    db.autocommit = True
+    cursor = db.cursor()
+    cursor.execute("DROP DATABASE IF EXISTS myradio_test")
+    cursor.execute("CREATE DATABASE myradio_test")
+    cursor.execute("DROP USER IF EXISTS myradio_test")
+    cursor.execute("CREATE USER myradio_test WITH PASSWORD 'myradio_test'")
+    cursor.execute("GRANT ALL PRIVILEGES ON DATABASE myradio_test TO myradio_test")
+    cursor.close()
+    db.close()
+    db = psycopg2.connect(
+        f"host={host} dbname=myradio_test user={user} password={password}"
+    )
+    db.autocommit = True
+
+    schema_dir = Path(__file__).parent / "schema"
+    sample_configs_dir = Path(__file__).parent / "sample_configs"
+    for file in [
+        schema_dir / "base.sql",
+        *sorted(filter(lambda f: f.suffix == '.sql', (schema_dir / "patches").iterdir()), key=lambda patch: int(patch.stem)),
+        sample_configs_dir / "test-auth.sql",
+    ]:
+        with file.open() as f:
+            cur = db.cursor()
+            cur.execute("SET search_path = 'public'")
+            cur.execute(f.read())
+            db.commit()
+            cur.close()
+
+    yield db
+
+    db.close()
+    db = psycopg2.connect(
+        f"host={host} dbname=postgres user={user} password={password}"
+    )
+    db.autocommit = True
+    cursor = db.cursor()
+    cursor.execute("DROP DATABASE myradio_test")
+    cursor.execute("DROP USER myradio_test")
+    cursor.close()
+    db.close()
+
+
+def _make_pool_db(conn: psycopg2.extensions.connection, name: str):
+    cur = conn.cursor()
+    cur.execute(f"DROP DATABASE IF EXISTS {name}")
+    cur.execute(f"CREATE DATABASE {name} TEMPLATE myradio_test")
+    cur.close()
+    return name
+
+
+def _release_pool_db(conn: psycopg2.extensions.connection, name: str):
+    cur = conn.cursor()
+    cur.execute(f"DROP DATABASE {name}")
+    cur.close()
+
+
+phase_report_key = pytest.StashKey[Dict[str, pytest.CollectReport]]()
+@pytest.hookimpl(wrapper=True, tryfirst=True)
+def pytest_runtest_makereport(item, call):
+    # execute all other hooks to obtain the report object
+    rep = yield
+
+    # store test results for each phase of a call, which can
+    # be "setup", "call", "teardown"
+    item.stash.setdefault(phase_report_key, {})[rep.when] = rep
+
+    return rep
+
+
+@pytest.fixture(autouse=True, scope="function")
+def myradio_database(request: pytest.FixtureRequest, db_conn):
+    name = request.node.name
+    name_hash = hashlib.sha256(name.encode()).hexdigest()[:8]
+    db_name = f"myradio_test_{name_hash}"
+    _make_pool_db(db_conn, db_name)
+    yield db_name
+    report = request.node.stash[phase_report_key]
+    if "call" not in report or report["call"].failed:
+        print(f"Test {name} failed, keeping database {db_name}")
+    else:
+        _release_pool_db(db_conn, db_name)
+
+
+INSIDE_MYRADIO_CONTAINER = Path("/etc/apache2/sites-available/myradio.conf").is_file()
+
+
+@pytest.fixture()
+def api_v2(myradio_database, playwright: Playwright):
+    ctx = playwright.request.new_context(
+        base_url=f"http://localhost:{80 if INSIDE_MYRADIO_CONTAINER else 7080}/api/v2/",
+        extra_http_headers={
+            "X-MyRadio-Database": myradio_database,
+            "APIKey": "test-key",  # schema/test-auth.sql
+        },
+    )
+    yield ctx
+    ctx.dispose()
+
+
+@pytest.fixture()
+def browser(myradio_database, browser: Browser):
+    ctx = browser.new_context(
+        base_url=f"http://localhost:{80 if INSIDE_MYRADIO_CONTAINER else 7080}/myradio",
+        extra_http_headers={"X-MyRadio-Database": myradio_database},
+    )
+    yield ctx
+    ctx.close()

docker-compose.test.yml

@@ -0,0 +1,6 @@
+version: '3'
+services:
+  myradio:
+    environment:
+      - E2E_TEST=true
+    volumes: []

docker-compose.yml

@@ -28,6 +28,7 @@ services:
     volumes:
       - ./schema:/var/www/myradio/schema
       - ./src:/var/www/myradio/src:rw
+      - ./tests:/var/www/myradio/tests:rw
   # daemon:
   #   build: .
   #   depends_on: