mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-07-22 15:11:24 -05:00

Files

T

History

Vijay Janapa Reddi cfd1f66349 docs(tinytorch/tests): update user-journey duration to match measured CI

The docstring stated full_journey takes ~10min; the most recent CI
run that reached the JSON output reported 451.63 seconds = 7.5 min
for 20 modules + 6 milestones. Update to ~7-8min and note the
20-module + 6-milestone shape so the comment reflects what the test
actually exercises.

Also serves as the path-touching change that retriggers
tinytorch-validate-dev on a push event (the prior push-event run
was cancelled by an inadvertent manual workflow_dispatch — the
concurrency group's cancel-in-progress flag superseded the
in-progress push run, leaving the badge red despite a healthy
workflow).

2026-05-12 09:42:01 -04:00

__init__.py

…

conftest.py

…

README.md

…

test_user_journey.py

…

README.md

End-to-End User Journey Tests

This directory contains tests that simulate the complete student experience with TinyTorch.

Philosophy

Unlike unit tests (test components) or integration tests (test interactions), E2E tests verify:

The complete user journey works from start to finish
Commands chain together correctly
Progress tracking persists across operations
Milestones unlock at the right time

Test Levels

Level 1: Quick Verification (~30 seconds)

pytest tests/e2e/test_user_journey.py -k quick -v

Verifies CLI commands work
Checks module/milestone structure exists
No actual training

Level 2: Module Flow (~2 minutes)

pytest tests/e2e/test_user_journey.py -k module_flow -v

Tests module start → complete → export cycle
Verifies progress tracking
Tests prerequisite enforcement

Level 3: Full Journey (~5-10 minutes)

pytest tests/e2e/test_user_journey.py -k full_journey -v

Complete flow from setup to first milestone
Actual module completion
Milestone unlock verification

Level 4: Release Validation (~30 minutes)

./tests/e2e/validate_release.sh

Simulates fresh git clone
Full setup through milestone 01
Tests pip installability
Comprehensive verification

Running Before Release

Before any release, run:

# Quick sanity check
make e2e-quick

# Full validation (recommended before release)
make e2e-full

What Gets Tested

Setup Flow
- tito setup --skip-profile works non-interactively
- Environment validation passes
- Package is importable
Module Workflow
- tito module start 01 works
- tito module complete 01 exports correctly
- Progress tracking updates
- tito module status shows correct state
Prerequisite Enforcement
- Can't start module 02 without completing 01
- Can't run milestone 02 without prerequisites
Milestone Flow
- Milestones list correctly
- tito milestone run 01 executes
- Completion is tracked
Error Handling
- Graceful failures for invalid commands
- Helpful error messages