mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-14 10:34:06 +02:00
## What this PR is End-to-end cucumber coverage for the PAYG shadow charging engine (the filter + interceptor stack from #6519), wired into CI via a new `docker-compose-tests-saas.yml` workflow that runs only on PAYG-touching PRs. Stacked on #6519. ## Automated scenarios (run by `docker-compose-tests-saas.yml`) See [`testing/cucumber/features/payg/shadow_charges.feature`](../tree/payg-s3-cucumber/testing/cucumber/features/payg/shadow_charges.feature): | Scenario | Validates | |---|---| | First tool call writes a CHARGED row | Filter + interceptor fire end-to-end | | Lineage join — second call on output | `JobService.joinOrOpen` matching; no new shadow row | | 4xx leaves the row CHARGED | "Customer paid for the attempt" semantics | | ZIP-returning tool records per-PDF OUTPUT | `PaygOutputExtractor` unpacks + records signatures | | Multi-file input writes a single shadow row | Multi-input group sizing | | `X-Stirling-Automation` sets PIPELINE source | Header → `JobSource` detection | All 6 run locally via `./testing/test-payg.sh` and will run on CI for any PR that touches `app/saas/**`, the PAYG cucumber features, the saas compose stack, or the workflow itself. ## Manual-only scenarios — documented in design doc, not in this suite Two parts of the shadow engine are deliberately not automated; the engine paths are unit-tested in `PaygChargeInterceptorTest.afterCompletion_5xx_opened_*`, and the manual procedures (which require a temporary throw endpoint or a container restart with a flag flipped) live in [`notes/PAYG_DESIGN.md` §7.5.2 "PAYG cucumber: manual-only scenarios"](../tree/payg-s3-cucumber/notes/PAYG_DESIGN.md). - **5xx first-step failure → REFUNDED + CLOSED.** No reliably-5xx-ing endpoint exists; manual procedure adds a throw endpoint, runs, asserts, removes. - **Kill-switch (`PAYG_FILTER_ENABLED=false`).** Needs a container restart mid-suite; manual procedure tears down, flips env, brings up, asserts zero shadow rows. If either gets a hot-reload path (test-only throw endpoint shipped behind a profile gate, or admin endpoint for the kill switch), automate it in a follow-up and drop the manual procedure. ## CI workflow `.github/workflows/docker-compose-tests-saas.yml` (new) — self-contained, not wired into `build.yml`'s `files-changed` matrix so the saas-cucumber job fails and succeeds independently. Triggers only on PAYG-relevant paths. No JaCoCo coverage in v1 (saas compose doesn't have the coverage override; can add later). ## Test infrastructure (recap) - **`testing/compose/docker-compose-saas.yml`** — Stirling-PDF backend with `STIRLING_FLAVOR=saas` + Postgres holding the `stirling_pdf` schema. Supabase JWT auto-config disabled; API-key auth via `SECURITY_CUSTOMGLOBALAPIKEY` is the live path the cucumber tests exercise. - **`testing/compose/payg/saas-init.sql`** + **`saas-seed.sql`** — schema bootstrap + idempotent seed (team / user / wallet_policy). - **`testing/cucumber/features/payg/shadow_charges.feature`** — the 6 scenarios above. - **`testing/cucumber/features/steps/payg_step_definitions.py`** — step defs using `requests` (HTTP) + `psycopg` (direct DB inspection). Direct DB reads are deliberate — we want to see the filter's side effects, not relay them through another API layer. - **`testing/test-payg.sh`** — companion runner to `testing/test.sh`. Brings up the saas compose, waits for health, seeds, runs behave, tears down. - **`behave.ini`** excludes `features/payg` from the default behave run (the saas-cucumber CI job invokes it explicitly). ## Why a separate harness from `testing/test.sh` The existing `test.sh` covers the proprietary-flavour stack (no PAYG tables, no saas profile). Coupling two CI matrices that fail and succeed independently into one script is asking for trouble. Keep the saas-cucumber job focused on its own concerns; once the harness is mature, the wider team can decide whether to merge them. ## Tracked in `notes/PAYG_DESIGN.md` §7.5 (PR-S3) + §7.5.2 (manual scenarios).
105 lines
4.2 KiB
YAML
105 lines
4.2 KiB
YAML
services:
|
|
# ---------------------------------------------------------------------
|
|
# Postgres holding the stirling_pdf schema. Flyway migrates V1-V13 on
|
|
# backend startup against this DB. Exposed on host port 5433 so the
|
|
# cucumber harness can connect via psycopg from features/steps/payg_*.
|
|
# ---------------------------------------------------------------------
|
|
postgres-saas:
|
|
image: postgres:17-alpine
|
|
container_name: payg-cucumber-postgres
|
|
environment:
|
|
POSTGRES_PASSWORD: postgres
|
|
POSTGRES_DB: postgres
|
|
ports:
|
|
- "5433:5432"
|
|
volumes:
|
|
# Bootstrap stirling_pdf schema + seed test team / api key.
|
|
# Runs once when the container is first created.
|
|
- ./payg/saas-init.sql:/docker-entrypoint-initdb.d/00-init.sql:ro
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "pg_isready -U postgres -d postgres"]
|
|
interval: 3s
|
|
timeout: 5s
|
|
retries: 20
|
|
networks:
|
|
- payg-cucumber-network
|
|
|
|
# ---------------------------------------------------------------------
|
|
# Stirling-PDF backend with STIRLING_FLAVOR=saas. Authenticates via
|
|
# API key (SECURITY_CUSTOMGLOBALAPIKEY) — Supabase JWT enforcement is
|
|
# disabled for the test profile via SAAS_DB_PROJECT_REF=disabled so the
|
|
# OAuth resource-server filter no-ops. The PaygChargeInterceptor's
|
|
# resolveUser() ApiKey-token path is what the cucumber tests exercise.
|
|
# ---------------------------------------------------------------------
|
|
stirling-pdf-saas:
|
|
build:
|
|
context: ../..
|
|
dockerfile: docker/embedded/Dockerfile
|
|
args:
|
|
STIRLING_FLAVOR: saas
|
|
container_name: payg-cucumber-stirling
|
|
depends_on:
|
|
postgres-saas:
|
|
condition: service_healthy
|
|
restart: "no"
|
|
deploy:
|
|
resources:
|
|
limits:
|
|
memory: 4G
|
|
healthcheck:
|
|
test: ["CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP'"]
|
|
interval: 5s
|
|
timeout: 10s
|
|
retries: 24
|
|
ports:
|
|
- "8080:8080"
|
|
environment:
|
|
# Activate the saas profile + bring the saas subproject onto the classpath.
|
|
# `payg-cucumber` registers the test-only throw-500 controller in
|
|
# `app/saas/.../payg/test/PaygCucumberThrowController.java` — that bean is
|
|
# @Profile("payg-cucumber") so it never registers in production.
|
|
SPRING_PROFILES_ACTIVE: "saas,payg-cucumber"
|
|
STIRLING_FLAVOR: "saas"
|
|
ENABLE_SAAS: "true"
|
|
DISABLE_ADDITIONAL_FEATURES: "false"
|
|
|
|
# Datasource — point Flyway + JPA at the test postgres.
|
|
SAAS_DB_URL: "jdbc:postgresql://postgres-saas:5432/postgres"
|
|
SAAS_DB_USERNAME: "postgres"
|
|
SAAS_DB_PASSWORD: "postgres"
|
|
SAAS_DB_PROJECT_REF: "disabled"
|
|
|
|
# The saas Flyway migrations assume `users` and `teams` already exist
|
|
# (V2 ALTERs `users`; V5 references `teams(id)`) because in production
|
|
# those tables are provisioned by Supabase before Stirling starts. On
|
|
# a clean test postgres they don't exist, so we disable Flyway and let
|
|
# Hibernate's `ddl-auto=create-drop` build the full schema from the
|
|
# entity graph. The default-pricing-policy row that V12 seeds in
|
|
# production is re-seeded by testing/compose/payg/saas-seed.sql.
|
|
SPRING_FLYWAY_ENABLED: "false"
|
|
SPRING_JPA_HIBERNATE_DDL_AUTO: "create-drop"
|
|
|
|
# Disable Supabase JWT enforcement for the test profile. The
|
|
# PaygChargeInterceptor resolves via ApiKey-token authority — that
|
|
# path is what we cover here.
|
|
SPRING_AUTOCONFIGURE_EXCLUDE: "org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration"
|
|
|
|
# Test API key matching the user seeded by saas-init.sql.
|
|
SECURITY_CUSTOMGLOBALAPIKEY: "payg-cucumber-key"
|
|
SECURITY_ENABLELOGIN: "false"
|
|
|
|
# Conservative defaults. The cucumber runs send small fixtures so
|
|
# the in-memory threshold never bites; the kill-switch is needed by
|
|
# one scenario but is toggled via a separate compose override.
|
|
PAYG_FILTER_ENABLED: "true"
|
|
PAYG_FILTER_RESPONSE_IN_MEMORY_THRESHOLD_BYTES: "10485760"
|
|
|
|
SYSTEM_DEFAULTLOCALE: "en-US"
|
|
SYSTEM_MAXFILESIZE: "100"
|
|
networks:
|
|
- payg-cucumber-network
|
|
|
|
networks:
|
|
payg-cucumber-network:
|
|
driver: bridge
|