wrolpi/.circleci/config.yml
lrnselfreliance 1867382d7b
Some checks are pending
CodeQL / Analyze (push) Waiting to run
Controller Tests / controller-tests (push) Waiting to run
Jest Tests / jest-tests (push) Waiting to run
test: the component suite has not run since cypress 15, on any machine (#661)
* test: the component suite has not run since cypress 15, on any machine

Six component spec files -- 334 tests, including the 4,300-line layout suite -- could not
start.  Cypress exited before printing anything, and under its default Electron browser it
did not even do that: it hung at 0% CPU until killed.  Chrome prints the error in seconds,
which is the only reason this was findable.

Three things broke, all of them from the 13.17.0 -> 15.20.0 bump.

`baseUrl: "src"`.  Cypress 15 loads its config with tsx, and tsx honours tsconfig path
resolution.  Cypress requires Node's core `events` module; with that baseUrl the bare
specifier resolves against `src`, and on a case-insensitive filesystem it matches
`src/Events.js`.  That file imports the app, so the whole component tree was required in
Node: JSX in `.js` files, which esbuild will not parse.

This is why CI stayed green while every local run died.  Linux is case-sensitive, `events`
never matched `Events.js`, and it resolved to the built-in.  The baseUrl buys nothing --
there is not one absolute import in the codebase -- so it goes.

`framework: "create-react-app"`.  Cypress 14 removed that dev server; the handler is in the
13.17.0 binary and absent from 15.  The webpack config is handed over explicitly now, taken
from react-scripts so components compile exactly as `npm start` compiles them.  Two things
follow from that: `webpack-dev-server` 5 is a devDependency because Cypress requires 5 and
react-scripts pins 4 (npm nests react-scripts' copy, and the production build is unchanged),
and babel-loader is widened to `cypress/`, which react-scripts does not compile -- the
support file is JSX and was reaching babel with no preset.

The suite ran nowhere.  `cypress run` means e2e -- its specPattern is `cypress/e2e/**` --
and these specs sit beside the components in `src`, so no job has ever executed them.  A
`cypress-component-tests` job runs them now; without it this breaks again in silence.

One test fails the moment the suite can run, and it is mine, from #660: it asserted the URL
column is the widest in the row.  It is not, and never was -- at that width the fixed columns
take ~307px of 400, leaving the URL ~93 against Control's 146.  It shipped green because
nothing could run it.  It asserts a usable remainder instead.

334 component tests pass, 69 suites / 1214 jest tests pass, `npm run build` is clean.

* review: an assertion with a floor, and comments that told the story instead of the rule

The leftover-width test had a lower bound and nothing else, so it passed on any column
wide enough to have padding -- including one that had grown, which is what losing
table-layout: fixed does.  It measures the leftover now: the sized columns are held to
the widths they declare, and the truncating column to exactly what they did not take.

Comments in the config, the CI job and the spec cut back to the rule a reader needs.  The
version history and the measurements are in the PR.
2026-08-12 21:57:07 -06:00

253 lines
9.8 KiB
YAML

# Use the latest 2.1 version of CircleCI pipeline process engine.
# See: https://circleci.com/docs/2.0/configuration-reference
version: 2.1
# Define a job to be invoked later in a workflow.
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
jobs:
api-tests:
docker:
- image: cimg/python:3.13
# `large` (4 vCPU, 8 GB) so pytest-xdist's `-nauto` has room to scale.
resource_class: large
steps:
- checkout
- run: sudo apt-get update
- run: sudo apt-get install -y ffmpeg catdoc
- restore_cache:
key: deps-3.13-{{ checksum "requirements.txt" }}-6
- run:
name: Install Requirements
command: |
# A restored venv points at the exact interpreter that built it. CircleCI's
# cimg/python:3.13 gets patch bumps, and this cache key does not name the
# patch, so a venv cached before a bump has a dangling bin/python3 -- and
# `python3 -m venv` over it fails with `[Errno 2]` instead of repairing it,
# which broke every Python job. Rebuild when it cannot run: that costs a
# reinstall only on the first run after a bump.
if ! ./venv/bin/python3 --version >/dev/null 2>&1; then rm -rf venv; fi
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
- save_cache:
key: deps-3.13-{{ checksum "requirements.txt" }}-6
paths:
- "venv"
# `-nauto` parallelizes across all available cores via pytest-xdist.
# `-svv` was dumping the full test stdout to CircleCI logs on every run,
# which inflated wall time and produced multi-MB log artifacts; dropped.
- run:
command: './venv/bin/pytest -nauto --junitxml=test-results.xml'
- store_test_results:
path: test-results.xml
# Do the API and the frontend's test fixtures still agree?
#
# `api-tests` runs these too, as part of the whole suite. This job exists for the
# signal: fixture drift is silent by nature -- the frontend suite passes against a body the
# API stopped sending -- so it is worth a check whose name says what broke, failing in under a
# minute rather than somewhere inside seventeen hundred results.
#
# It needs no ffmpeg or catdoc (verified), and shares the dependency cache key with the other
# Python jobs, so it costs a venv restore and one test file.
api-contract-tests:
docker:
- image: cimg/python:3.13
resource_class: medium
steps:
- checkout
- restore_cache:
key: deps-3.13-{{ checksum "requirements.txt" }}-6
- run:
name: Install Requirements
command: |
# A restored venv points at the exact interpreter that built it. CircleCI's
# cimg/python:3.13 gets patch bumps, and this cache key does not name the
# patch, so a venv cached before a bump has a dangling bin/python3 -- and
# `python3 -m venv` over it fails with `[Errno 2]` instead of repairing it,
# which broke every Python job. Rebuild when it cannot run: that costs a
# reinstall only on the first run after a bump.
if ! ./venv/bin/python3 --version >/dev/null 2>&1; then rm -rf venv; fi
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
- run:
name: Fixtures match the OpenAPI spec, and the spec matches the handlers
command: './venv/bin/pytest wrolpi/test/test_api_fixtures.py -v'
api-alembic-migrations:
docker:
- image: cimg/python:3.13
resource_class: medium
steps:
- checkout
- restore_cache:
key: deps-3.13-{{ checksum "requirements.txt" }}-6
- run:
name: Install Requirements
command: |
# A restored venv points at the exact interpreter that built it. CircleCI's
# cimg/python:3.13 gets patch bumps, and this cache key does not name the
# patch, so a venv cached before a bump has a dangling bin/python3 -- and
# `python3 -m venv` over it fails with `[Errno 2]` instead of repairing it,
# which broke every Python job. Rebuild when it cannot run: that costs a
# reinstall only on the first run after a bump.
if ! ./venv/bin/python3 --version >/dev/null 2>&1; then rm -rf venv; fi
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
- run:
name: Create Media Directory
command: mkdir -p /tmp/wrolpi-media/config
- run:
name: Run Alembic Migrations
command: MEDIA_DIRECTORY=/tmp/wrolpi-media ./venv/bin/python ./main.py db upgrade
- run:
name: Check for Missing Migrations
command: MEDIA_DIRECTORY=/tmp/wrolpi-media ./venv/bin/python ./main.py db check
sanic-api-start:
docker:
- image: cimg/python:3.13
steps:
- checkout
- restore_cache:
key: deps-3.13-{{ checksum "requirements.txt" }}-6
- run:
name: Install dependencies
command: |
# A restored venv points at the exact interpreter that built it. CircleCI's
# cimg/python:3.13 gets patch bumps, and this cache key does not name the
# patch, so a venv cached before a bump has a dangling bin/python3 -- and
# `python3 -m venv` over it fails with `[Errno 2]` instead of repairing it,
# which broke every Python job. Rebuild when it cannot run: that costs a
# reinstall only on the first run after a bump.
if ! ./venv/bin/python3 --version >/dev/null 2>&1; then rm -rf venv; fi
python -m venv venv
. venv/bin/activate
pip install -r requirements.txt
sudo mkdir -p /media/wrolpi
- run:
name: Start Sanic API
command: |
. venv/bin/activate
sanic main:api_app -H 0.0.0.0 -p 8081
background: true
- run:
name: Test Sanic API
command: |
sleep 20
curl http://0.0.0.0:8081/api/echo
- run:
name: Stop Sanic API
command: pkill -f sanic
react-app-start:
docker:
- image: cimg/node:20.19
resource_class: large
steps:
- checkout
- restore_cache:
key: app-{{ checksum "app/package-lock.json" }}
- run: cd app && npm install
- save_cache:
key: app-{{ checksum "app/package-lock.json" }}
paths:
- ./app/node_modules
- run:
name: Build React App
command: cd app && DISABLE_ESLINT_PLUGIN=true npm run build
- run:
name: Start React App
command: cd app && DISABLE_ESLINT_PLUGIN=true npm run start
background: true
- run:
name: Test React App
command: |
sleep 20
curl http://0.0.0.0:3000/manifest.json
- run:
name: Stop React App
command: pkill -f npm
# Jest tests moved to GitHub Actions (.github/workflows/jest-tests.yml)
# Component specs live under `src/`, so they need `cypress run --component`; the e2e job's
# `cypress run` will not match them. Cypress starts its own dev server, so no `npm start`.
cypress-component-tests:
docker:
- image: cimg/node:20.19-browsers
resource_class: large
steps:
- checkout
- restore_cache:
key: app-browsers-{{ checksum "app/package-lock.json" }}
- run:
name: Install Dependencies
command: cd app && npm install
- run:
name: Install Cypress Binary
command: cd app && npx cypress install
- run:
name: Run Cypress Component Tests
command: cd app && CI=true npx cypress run --component
- store_artifacts:
path: app/cypress/screenshots
cypress-e2e-tests:
docker:
- image: cimg/node:20.19-browsers
resource_class: large
steps:
- checkout
- restore_cache:
key: app-browsers-{{ checksum "app/package-lock.json" }}
- run:
name: Install Dependencies
command: cd app && npm install
# The Cypress binary lives outside node_modules, so caching only
# node_modules lets the two drift apart: a restored cache satisfies npm,
# npm skips the postinstall download, and the binary for the new version
# is never fetched. Cache both, and install explicitly (a no-op when the
# binary is already present).
- run:
name: Install Cypress Binary
command: cd app && npx cypress install
- save_cache:
key: app-browsers-{{ checksum "app/package-lock.json" }}
paths:
- ./app/node_modules
- ~/.cache/Cypress
- run:
name: Start React App in Background
command: cd app && DISABLE_ESLINT_PLUGIN=true npm start
background: true
- run:
name: Wait for React App
command: |
for i in {1..60}; do
if curl -s http://localhost:3000 > /dev/null; then
echo "React app is ready!"
exit 0
fi
echo "Waiting for React app... ($i/60)"
sleep 2
done
echo "React app failed to start"
exit 1
- run:
name: Run Cypress Tests
command: cd app && CI=true npx cypress run
- store_artifacts:
path: app/cypress/videos
- store_artifacts:
path: app/cypress/screenshots
workflows:
wrolpi-api-tests:
jobs:
- sanic-api-start
- api-tests
- api-contract-tests
- api-alembic-migrations
wrolpi-app-test:
jobs:
- react-app-start
# jest-tests moved to GitHub Actions
- cypress-e2e-tests
- cypress-component-tests