SmartTest documentation

SmartTest reads a change, follows it through your code to the tests that can detect a regression, and runs only those, through Jest, Vitest, node --test, Playwright, Cypress, Angular, pytest, unittest, PHPUnit or Pest. When it cannot rule a test out, it runs it.

1. 1Install and looksmarttest initInstall @tkmremi/smarttest as a dev dependency; init detects the runners and explains the config before writing it.
2. 2Gate commits and pushessmarttest hook installRuns the affected tests on exactly what is committed or pushed.
3. 3Run it in CIsmarttest ciFinds the base, deepens shallow clones, and keeps the full suite where you want it.

Start#

• Getting startedInstall, run smarttest init, read the first selection.3 min read
• Commit and push hooksTest exactly what is committed or pushed, in a temporary checkout when needed.9 min read
• Running in CIPick the base, deepen shallow clones, shard by recorded durations.5 min read
• Rolling out to a repositoryThe steps that caught a problem in each real rollout, in order.3 min read

Guides#

• Auditing selectionInject faults, record traces and compare imports to measure missed tests.3 min read
• AngularTemplates and styles as edges, angular.json per project, ng test.3 min read
• Python (preview)pytest and unittest, analysed without running Python.3 min read
• PHP (preview)PHPUnit, Pest and Laravel, analysed without running PHP.7 min read
• StudioA local browser view of the analysis: impact, tests and evidence.9 min read
• VS CodeWhich tests protect a function, on hover; run what a change affects.3 min read
• PluginsThe frozen Plugin SDK: edges, rules, reporters and adapters.8 min read

Concepts#

• How selection worksFrom a diff to symbols, the dependency graph and a selection with reasons.11 min read
• Safety modelWhat SmartTest never does, and why unsure means selected.2 min read
• Runtime evidenceTraces of what a test ran, combined with the static graph.3 min read
• Running less, fasterResult cache, fail-fast order, parallel runners, adaptive mode.3 min read
• Change trackingGit, Mercurial, Subversion, or snapshots without version control.2 min read
• RulesArchitecture as testing policy: critical paths, required tests.1 min read

Reference#

• CLIEvery command and flag, with exit codes.16 min read
• ConfigurationEvery key of smarttest.config, with defaults.6 min read
• Public contractsWhat is frozen at 1.0.0 and what needs a major version.5 min read
• BenchmarksSelection and speed on the fixture harness, regenerated each release.2 min read
• ChangelogWhat changed in each version.51 min read

Results#

• Case study: LeadsItThe first real migration: six projects, no root package.9 min read
• Benchmarks for 1.0.0Real repositories replayed at 0 missed failures.11 min read
• Benchmarks for 1.2.0OpenPro's four JavaScript repositories: 0 missed failures, 16–75% less test time.2 min read
• External repositoriesThe 0.6.0 adoption check on repositories never seen before.3 min read

Project#

• RoadmapWhat comes next, in points, with exit gates.17 min read
• Roadmap 1.xThe 1.x sprints and their status.30 min read
• Delivery logWhat each version actually delivered.23 min read
• ArchitecturePackages, boundaries and data flow.5 min read
• Decision recordsAccepted architecture decisions.1 min read
• Security reviewThe 1.0.0 review of what SmartTest reads, writes and runs.20 min read
• Design systemTokens, type and colour shared by Studio and this site.3 min read
• SpecificationThe product specification; sections are cited as §11.4.56 min read

Section numbers such as §11.4 refer to the specification. The same pages are in the repository under documentation/.

Edit this page on GitHub