Skip to content

TESTING.md

Latest commit

 

History

History
129 lines (91 loc) · 3.63 KB

TESTING.md

File metadata and controls

129 lines (91 loc) · 3.63 KB

Testing

Automated tests are the primary verification method for this repository.

Run automated tests

  1. Install Python dependencies:
pip install -r requirements-dev.txt
  1. Run the full suite:
pytest
  1. Run with coverage (same command used in CI):
pytest --cov=application --cov-report=term-missing

Test layout

  • tests/conftest.py: shared fixtures (test client, isolated in-memory DB, seed data)
  • tests/test_models.py: unit tests for User, Course, Enrollment
  • tests/test_routes.py: integration tests for login/register/enrollment/courses
  • tests/test_api.py: API endpoint tests for /api and /api/<idx>

Manual smoke test (supplementary)

Use this quick click-through when you want a UI confidence check in addition to pytest:

  1. Follow the steps in CONTRIBUTING.md, then bring up the environment with docker compose up -d --build.
  2. Go to home page. The web page should load.
  3. Go to the courses page. The web page should load and show 5 courses.
  4. Go to the registration page. The web page should load with a form.
  5. Fill in the form with some data, and hit "Register Now". You should be redirected to the home page.
  6. Go to the login page. The web page should load with a login form.
  7. Fill in the form with the data from earlier, and hit "Login". You should be redirected to the home page.
  8. Go to the courses page and click "Enroll" for a course. You should be redirected to the enrollment page.
  9. Click the Logout navigation button and you should be logged out.

Automated E2E walkthrough (Playwright)

The repository includes an automated UI walkthrough that mirrors the manual flow above.

One-time setup

npm install
npx playwright install chromium

Run the app (Docker)

docker compose up -d --build

Run the walkthrough in Docker (no local npm needed)

docker compose run --rm e2e-tests

From Makefile:

make e2e-docker

Run the automated walkthrough

npm run e2e:walkthrough

For a faster walkthrough (normal input speed, no extra per-character typing delay):

npm run e2e:walkthrough:fast

From Makefile:

make e2e-fast

For a viewer-friendly recording pace, use slow motion:

npm run e2e:walkthrough:demo

This executes e2e/ui-walkthrough.spec.js against http://127.0.0.1:5000.

Other useful commands

  • npm run e2e : all Playwright tests (headless)
  • npm run e2e:headed : all Playwright tests (headed)
  • npm run e2e:report : open HTML test report
  • docker compose run --rm e2e-tests : run walkthrough from Docker container
  • npm run e2e:walkthrough:fast : walkthrough with fast form input (PW_FAST_INPUT=1)
  • npm run e2e:walkthrough:demo : walkthrough with PW_SLOWMO=400 for demos
  • make e2e-docker : Docker-only walkthrough via Makefile target
  • make e2e-fast : fast walkthrough via Makefile target
  • make e2e-demo : demo walkthrough via Makefile target

Artifacts and GIF export

Playwright outputs video and trace artifacts under test-results/.

Convert the generated .webm video to GIF:

ffmpeg -i test-results/ui-walkthrough-UI-walkthrough-from-TESTING-md-chromium/video.webm   -vf "fps=12,scale=900:-1:flags=lanczos,split[s0][s1];[s0]palettegen=max_colors=128[p];[s1][p]paletteuse=dither=bayer:bayer_scale=5"   docs/walkthrough.gif