saboteur 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6007efb7a83e5669822a1622876457e9e654187acc923981e641835258c7637d
-  data.tar.gz: 373680f8e52d7cbd24f1eb3dde2322101eccf565c2752e10a174bd5ff9e6d8e2
+  metadata.gz: a5c52cb7485073b569359bf940160095370103747d55a6065b7f067726a1a53c
+  data.tar.gz: 40fca0c1c0f8391de86d7f17960d908add226682d93be2610775fc888ab36f60
 SHA512:
-  metadata.gz: c0d37ea099ca68c5dc3608e2229446cb4e4494c623e63bb8033eb85a8a10bd7953e2cc84031678a15adda5da0b0da1f6bb1177badde04fa06dbd472f2d674534
-  data.tar.gz: 7484ed59697969071030c78ab81b8a716da93b09d4e95900b69b110f087809a6e1293153375104732457205af0e0cfb94f64eb34810242febd1e63be613fb97a
+  metadata.gz: 061e0b5a97c95048048767d3724ea883ea144e7530b9a52631d52c896f4154e1a63f7b65ef7b5817053a42ab31eb97c168aa3079c87e9d9a3e8be1ae949d7bdf
+  data.tar.gz: e29bcfafdaf2fc7ecffbc4f8746349d79c908dfc2de1530998b525c691135c2bfb4ade67575374178742b1fddb29ab96a7d9ff67656d29dbd7c096ba0b50d0dc

data/CHANGELOG.md

@@ -6,6 +6,158 @@ All notable changes are documented here. The format follows
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-10-12
+
+### Changed
+- **Breaking:** configuration moved from YAML to Ruby. `.saboteur.yml` becomes
+  `config/saboteur.rb` (`Saboteur.configure do |c| ... end`, same key names),
+  and `.saboteur-ignore.yml` becomes `config/saboteur_ignore.rb`
+  (`Saboteur.ignore do |i| i.mutation "<digest>", subject:, reason: end`,
+  reason still mandatory). A legacy YAML file stops the run with a pointer to
+  the new file instead of being read. Unknown settings fail with the line
+  number and a did-you-mean suggestion. `rails generate saboteur:install`
+  writes `config/saboteur.rb` (never overwriting without `--force`);
+  `config/saboteur_ignore.rb` and `config/saboteur_custom_map.rb` are optional
+  and created by hand when needed.
+- A run in which more than half of the executed mutants errored now exits 3
+  (the tool failed). Before, only a run where every executed mutant errored
+  did. Errored mutants are outside the score, so such a run tested almost
+  nothing. This applies with and without `--threshold`. The JSON report records the reason under
+  `saboteur.exitCause` (`ok`, `survivors`, `belowThreshold`, `errorMajority`,
+  `incompleteUnderThreshold`; in `--agent` mode `ok`, `survivors`,
+  `errorMajority` or `incomplete`).
+- A whole-suite coverage build that records no lines for any included file
+  now exits 3 and the empty map is not cached, instead of testing nothing.
+  With `--test`, an empty map stays a legitimate "no coverage" outcome.
+- Rails fixtures (`spec/fixtures`, `test/fixtures`), `db/structure.sql`,
+  `db/schema.rb` and `config/*.yml` are part of the coverage and verdict
+  cache fingerprint, so a changed fixture or schema invalidates cached
+  results. The new `fingerprint_extra` setting adds other globs whose
+  contents should invalidate caches, for example `data/*.csv`.
+- The baseline and coverage phases show progress and write real logs, so a
+  slow or failing phase can be diagnosed from the output.
+- When the baseline child is killed by a signal, the message names it
+  (`SIGKILL` adds a possible-OOM hint) instead of reporting a bare failure.
+
+### Removed
+- The coarse-survivor gate: a surviving whole-body mutant no longer skips the
+  method's fine mutants; every eligible fine mutant runs.
+
+### Fixed
+- Mutations inside private `module_function` helpers are preserved when the
+  method is re-evaluated; they previously reverted and reported as false
+  survivors.
+- Rails apps that test against in-memory SQLite (`:memory:`) no longer fail
+  in forked workers with "Could not find table": saboteur never disconnects,
+  renames or copies an in-memory pool. Each in-memory database is
+  snapshotted to a temporary file after boot, and every forked child
+  restores the snapshot into its own fresh database.
+- With a Rails app under Bootsnap, Coverage no longer sees an empty map:
+  saboteur sets `DISABLE_BOOTSNAP_COMPILE_CACHE=1` for its own process when
+  the variable is unset, because bytecode from Bootsnap's compile cache
+  carries no coverage counters.
+- A relative SQLite `database:` path resolves against `Rails.root` (as Rails
+  7.1+ does) for the per-worker copy and its cleanup. The copy uses SQLite's
+  backup API after a WAL checkpoint, refuses to run when a reader keeps the
+  WAL busy, and a missing source file is an error rather than a skipped copy.
+- Per-worker database copies (`jobs` above 1) are dropped when the run ends,
+  best effort: a failed drop is a warning and never changes the outcome. A
+  copy left by a killed run is reclaimed by the next run. A failed copy
+  names the sessions blocking it.
+- For `rails: true`, the app's `spec/` directory is on the load path before
+  `require` is processed, as with rspec, so a boot file such as a dummy app's
+  `spec/rails_helper.rb` can require its siblings.
+- When Rails did not load, the error points engine users at the dummy app's
+  environment file or helper (`DummyApp.setup` in `spec/rails_helper.rb`).
+
+### Added
+- `rails generate saboteur:install` and a Rails quickstart in the README. The
+  generator writes `config/saboteur.rb` and never overwrites without `--force`.
+- The warning about threads alive when a worker forks names those threads,
+  falling back to their backtraces for unnamed ones.
+- `--test` no longer requires source operands when `--since` is given: the
+  changed files are the sources, so `saboteur run --since origin/main --test
+  spec/billing_spec.rb` scopes a pull-request run to chosen specs. A `--since`
+  run without `--test` now warns before it starts that the two baseline passes
+  run the loaded suite (a cold coverage cache adds one more pass), with the
+  spec-file count and how to scope them, instead of going quiet for hours on a
+  large app.
+- `config/saboteur_custom_map.rb` declares explicit source-file to spec-file
+  mappings (`SABOTEUR_CUSTOM_MAP`): exact paths, globs (the more specific glob
+  wins; equal specificity is an error) and Regexps with capture substitution.
+  Invalid maps fail the run with the file and key; stale and duplicate keys
+  warn on runs, and `saboteur doctor` fails on stale keys. The map is parsed
+  and validated only for now - it does not change which specs run yet.
+
+- An integration target can declare a known error profile
+  (`allow_error_fraction` per strategy in integration/targets.yml): the
+  majority-error exit is accepted only when the run's own fresh report
+  carries the CLI's `errorMajority` marker, the errored fraction stays
+  within the bound, and no mutant hit a resource limit. The JSON report
+  records the run's exit cause under `saboteur.exitCause`.
+- A survivor lists the first five tests that covered its line and still passed
+  with the mutant applied, in the terminal and the HTML page.
+- In diff mode (`--since`), each survivor names the changed line it relates to
+  (`changed line: path:N` in the terminal, `changedLines` in each JSON finding),
+  because a multi-line statement is reported at its first line.
+- The score is split into assertion kills and crash kills, in the terminal,
+  the JSON report (`saboteur.scores`) and the HTML page. A second score leaves
+  out whole-body mutants (`body_nil`, `body_true`, `body_false`, `body_raise`). The headline score and
+  `--threshold` are unchanged.
+- `saboteur run --agent` (`--format agent`): one bounded JSON summary (under 8 KiB) on stdout
+  with status, verdict, provenance, the first three findings and the commands for full
+  detail. Exit 0 means a complete, clean run only: 1 survivors, 2 usage or config error,
+  3 incomplete or failed. `--threshold` cannot be combined with it. The next commands are shell-escaped and keep the
+  full selection; the working-tree state is read before the run; target output stays on stderr. `saboteur agent-skill`
+  prints an AGENTS.md block for coding agents (also in `docs/agent-skill.md`). Classic
+  exit codes are unchanged.
+- Fine `pair_removal` mutants for hash literals and keyword lists, including
+  sole associations, with token-based separators and the normal method cap.
+- Fine `argument_removal` mutants: remove one ordinary argument from a
+  parenthesized call while preserving keywords and blocks. Token-based comma
+  edits respect comments and strings. Existing candidate validation, order and
+  per-method caps apply. Unparenthesized calls and heredoc arguments are skipped.
+
+## [0.3.0] - 2026-10-11
+
+### Added
+- Fine `literal_boolean` and `literal_string` mutants: true/false swaps and
+  nonempty static string replacement with `""`. Body-only traversal excludes
+  arid/nested scopes, interpolation, heredocs and non-string text literals.
+  New proposals can change scores and per-method-cap coverage.
+- `saboteur run --id DIGEST`: replay one exact current mutant with selected tests,
+  independent of caps, coarse gating, ignore suppression and incremental reuse.
+  Prints the mutation diff and selected test ids for every replay result.
+- Review findings in the JSON report (`saboteur.findings`,
+  `Saboteur::Reporter::Findings`): a bounded, deterministically ordered list
+  of survivors (coarse first, then file, line and digest) with the file,
+  line, digest, subject, operator, original and replacement a note on a
+  pull-request diff needs. Survivors accepted on the ignore list are listed
+  separately with their reason; `survivorsTruncated` counts the rest, which
+  stay in the full `files` data.
+- Self-contained HTML report (`Saboteur::Reporter::Html`): one file with inline
+  style and no script or network use, written to `.saboteur/report.html`.
+  Change the path with `--html PATH` or `html_report:`. It shows the score,
+  per-file mutants, survivors, warnings and skipped subjects.
+- A GitHub Action (`uses: vamsipavanmahesh/saboteur`) that runs diff mode on pull
+  requests. Advisory by default, with a job summary, outputs and a cached
+  coverage map. See `docs/github-action.md`.
+- Built-in `filter_replacement` mutants: `select` / `reject` and
+  `select!` / `reject!`, for explicit-receiver calls with a block and no ordinary
+  arguments. For unchanged subjects, existing mutants retain their digests and order.
+  Runs may now include more mutants and report a different score.
+- `saboteur doctor [--config PATH] [--seed N]`: environment checks and two fresh
+  unchanged-suite checks, without mutation reports or coverage/verdict cache writes.
+- `saboteur run SOURCE... --test TEST...`: mutate the named source files and
+  run only the named spec files or directories. Positional sources replace
+  `include` and `exclude`; `--test` replaces the spec paths in `rspec_args`.
+- `--threshold PERCENT` (and `threshold:` in `.saboteur.yml`): exit 1 when the
+  score is below PERCENT. The score decides the exit code instead of survivors.
+  It fails closed: no score exits 1, and errored or resource-limited mutants
+  exit 3.
+- Positional sources must exist (exit 2 otherwise), and the selected tests are
+  part of the coverage-map and `--incremental` cache keys.
+
 ## [0.2.0] - 2026-10-10
 
 ### Added
@@ -24,7 +176,7 @@ First release that does mutation testing. MIT licensed.
 ### Added
 - `saboteur run` with `--since`, `--subject`, `--timeout-factor`, `--jobs`,
   `--reeval`, `--json`, `--no-cache`, `--incremental`, `--config`.
-- Subjects found with Prism; mutations are byte-range edits: whole-method
+- Subjects found with Prism; mutations are byte-range edits: whole-body
   `nil`/`true`/`false`/`raise` first, then comparison, boolean, arithmetic,
   numeric literal, statement removal, condition, negation, safe navigation
   and `||=`.