Run Puzzle Tests

Run Puzzle Tests

Run the jigsawR test suite and interpret results.

When to Use

• After modifying any R source code in the package
• After adding a new puzzle type or feature
• Before committing changes to verify nothing is broken
• Debugging a specific test failure

Inputs

• Required: Test scope (full, filtered, or single)
• Optional: Filter pattern (for filtered mode, e.g. "snic", "rectangular")
• Optional: Specific test file path (for single mode)

Procedure

Step 1: Choose Test Scope

Expected: Test scope selected based on current workflow: full suite before commits, filtered when working on a specific puzzle type, single file when debugging one test.

On failure: If unsure which scope to use, default to full suite. It takes longer but catches cross-type regressions.

Step 2: Create and Execute Test Script

Full suite:

Create a script file (e.g., /tmp/run_tests.R):

devtools::test()

R_EXE="/mnt/c/Program Files/R/R-4.5.0/bin/Rscript.exe"
cd /mnt/d/dev/p/jigsawR && "$R_EXE" -e "devtools::test()"

Filtered by pattern:

"$R_EXE" -e "devtools::test(filter = 'snic')"

Single file:

"$R_EXE" -e "testthat::test_file('tests/testthat/test-snic-puzzles.R')"

Expected: Test output with pass/fail/skip counts.

On failure:

• Do NOT use --vanilla flag; renv needs .Rprofile to activate
• If renv errors, run renv::restore() first
• For complex commands that fail with Exit code 5, write to a script file instead

Step 3: Interpret Results

Look for the summary line:

[ FAIL 0 | WARN 0 | SKIP 7 | PASS 2042 ]

• PASS: Tests that succeeded
• FAIL: Tests that failed (need investigation)
• SKIP: Tests skipped (usually due to missing optional packages like snic)
• WARN: Warnings during tests (review but not blocking)

Expected: The summary line parsed to identify PASS, FAIL, SKIP, and WARN counts. FAIL = 0 for a clean test run.

On failure: If the summary line is not visible, the test runner may have crashed before completing. Check for R-level errors above the summary. If output is truncated, redirect to a file: "$R_EXE" -e "devtools::test()" > test_results.txt 2>&1.

Step 4: Investigate Failures

If tests fail:

1. Read the failure message — it includes file, line, and expected vs actual
2. Check if it's a new failure or pre-existing
3. For assertion failures, read the test and the function being tested
4. For error failures, check if a function signature changed

# Run just the failing test with verbose output
"$R_EXE" -e "testthat::test_file('tests/testthat/test-failing.R', reporter = 'summary')"

Expected: Root cause of each failing test identified. The failure is either a genuine regression (code needs fixing) or a test environment issue (missing dependency, path problem).

On failure: If the failure message is unclear, add browser() or print() statements to the test and re-run with testthat::test_file() for interactive debugging.

Step 5: Verify Skip Reasons

Skipped tests are normal when optional dependencies are missing:

• snic package tests skip with skip_if_not_installed("snic")
• Tests requiring specific OS skip with skip_on_os()
• CRAN-only skips with skip_on_cran()

Confirm skip reasons are legitimate, not masking real failures.

Expected: All skips are accounted for by legitimate reasons (optional dependency not installed, platform-specific skip, CRAN-only skip). No skips are masking actual test failures.

On failure: If a skip seems suspicious, temporarily remove the skip_if_*() call and run the test to see if it passes or reveals a hidden failure.

Validation

• All tests pass (FAIL = 0)
• No unexpected warnings
• Skip count matches expected (only optional dependency skips)
• Test count hasn't decreased (no tests accidentally removed)

Common Pitfalls

• Using --vanilla: Breaks renv activation. Never use it with jigsawR.
• Complex -e strings: Shell escaping issues cause Exit code 5. Use script files.
• Stale package state: Run devtools::load_all() or devtools::document() before testing if you changed NAMESPACE-affecting code.
• Missing test dependencies: Some tests need suggested packages. Check DESCRIPTION Suggests field.
• Parallel test issues: If tests interfere, run sequentially with testthat::test_file().

Related Skills

• generate-puzzle — generate puzzles to verify behavior matches tests
• add-puzzle-type — new types need comprehensive test suites
• write-testthat-tests — general patterns for writing R tests
• validate-piles-notation — test PILES parsing independently