Runner Smoke Tests
Purpose
Define the minimal reproducible smoke-test matrix for the YAML runner validate and run commands, including exact commands and expected artefacts.
Audience
- Maintainers preparing release evidence
- Engineers triaging runner regressions
- Reviewers confirming gate
QG-5andQG-6
Test scope
This smoke suite is intentionally small. It proves:
- CLI argument handling for
validateandrun - Config resolution and runner pre-flight path
- End-to-end artefact writing for one full run
This smoke suite does not replace unit tests or full package checks.
Preconditions
Run from repository root:
Expected outcome: commands resolve local package/library paths and use repo-scoped Stan cache.
Install DSAMbayes locally if needed:
Expected outcome: library(DSAMbayes) succeeds in the same shell session.
Smoke-test matrix
| Test ID | Command | Config | Run directory | Expected result |
|---|---|---|---|---|
SMK-VAL-01 |
validate |
config/blm_synthetic_mcmc.yaml |
results/smoke_validate_blm |
Exit code 0; metadata artefacts written. |
SMK-VAL-02 |
validate |
config/hierarchical_re_synthetic_mcmc.yaml |
results/smoke_validate_hier_re |
Exit code 0; metadata artefacts written. |
SMK-VAL-03 |
validate |
config/pooled_synthetic_mcmc.yaml |
results/smoke_validate_pooled |
Exit code 0; metadata artefacts written. |
SMK-RUN-01 |
run |
config/blm_synthetic_mcmc.yaml |
results/smoke_run_blm |
Exit code 0; core fit, post-run, and diagnostics artefacts written. |
Canonical commands
SMK-VAL-01
Expected outcome: validation completes without Stan fitting and prints Status: ok.
SMK-VAL-02
Expected outcome: validation completes for hierarchical RE config and prints Status: ok.
SMK-VAL-03
Expected outcome: validation completes for pooled config and prints Status: ok.
SMK-RUN-01
Expected outcome: full pipeline completes and prints Run complete with a resolved run directory.
Expected artefacts
Validate artefacts (SMK-VAL-01 to SMK-VAL-03)
For each validate run directory, these files are required:
00_run_metadata/config.original.yaml00_run_metadata/config.resolved.yaml00_run_metadata/session_info.txt
Failure rule: missing any required file is a smoke-test failure.
Run artefacts (SMK-RUN-01)
Required core artefacts:
00_run_metadata/config.resolved.yaml20_model_fit/model.rds30_post_run/posterior_summary.csv40_diagnostics/diagnostics_report.csv
Recommended additional checks for stronger confidence:
30_post_run/fitted.csv30_post_run/observed.csv40_diagnostics/diagnostics_summary.txt
Failure rule: missing any required core artefact is a smoke-test failure.
Verification helper commands
Check validate artefacts quickly:
Expected outcome: no MISSING: lines.
Check core run artefacts quickly:
Expected outcome: no MISSING: lines.
Failure triage
- If
validatefails, run the same command again with a clean run directory path and inspect CLI error output. - If
runfails before fitting, inspect00_run_metadata/config.resolved.yamlto confirm resolved values. - If
runfails during fitting, verify local Stan toolchain and cache path from Install and Setup. - If artefacts are missing after success exit code, inspect
outputs.*flags in the resolved config.
Evidence capture
For release evidence, capture:
- Full terminal logs and exit codes for
SMK-VAL-01toSMK-RUN-01. - Directory listings for each smoke run directory.
- The required artefacts listed above.
Store and review evidence with: