Skip to content

Upgrading insta 0.16 to 1

Breaking0.16.1 → 1.49.0Breaking10Platform6Deprecated7New66Changed72Fixed76Other13

Full comparisonBack to insta
BreakingUpgrade verdict

10 breaking changes and 6 platform requirement changes.

In plain terms
  • To keep using JSON or YAML snapshot assertions, you must now enable the matching feature.
  • The force-update flag now rewrites all snapshots and accepts them, so inline snapshot delimiters and indentation get updated too. To keep the old behavior, use the new --require-full-match flag.
  • The command line flag for including ignored tests has a new name, so scripts using the old name must be updated.
  • The optional backtrace support has been removed from the package.
Must act Top 5 of 23 that need code or config changes

Requires Rust 1.66.0 from 1.47.0 (none stated before).

What you must change

Breaking10
assert_json_snapshot! and assert_yaml_snapshot! now require the json and yaml features respectively.
assert_json_snapshot!assert_yaml_snapshot!jsonyaml
1.19.0CHANGELOG.mdSummarizedView source
Changes --force-update-snapshots to write every snapshot and imply --accept; use --require-full-match for the old behavior.
--force-update-snapshots--accept--require-full-match
1.41.0GitHub ReleaseSummarizedView source
Renames the --no-ignore option to --include-ignored.
--no-ignore--include-ignored
1.24.0CHANGELOG.mdSummarizedView source
Removes the backtrace feature.
backtrace
1.19.0CHANGELOG.mdSummarizedView source
Removes the serialization feature.
serialization
1.19.0CHANGELOG.mdSummarizedView source
Removes deprecated Settings::bind_to_thread.
Settings::bind_to_thread
1.18.0CHANGELOG.mdSummarizedView source
Disallows unnamed snapshots in doctests.
1.17.0CHANGELOG.mdSummarizedView source
Changes snapshot name detection to use function names instead of thread names, altering snapshot names in some cases.
1.12.0CHANGELOG.mdSummarizedView source
Adds Send + Sync bounds to the Comparator trait for consistency with Arc-based storage.
Comparator
1.47.2GitHub ReleaseSummarizedView source
insta::internals::SettingsBindDropGuard returned from Settings::bind_to_scope no longer implements Send.
insta::internals::SettingsBindDropGuardSettings::bind_to_scopeSend
1.42.0GitHub ReleaseSummarizedView source
Platform6
Upgrades console to 0.16 and raises the minimum supported Rust version (MSRV) to 1.66.
console
1.47.0GitHub ReleaseSummarizedView source
Raises the MSRV for insta to 1.60 and for cargo-insta to 1.64.
instacargo-insta
1.40.0GitHub ReleaseSummarizedView source
Bumps the minimum supported Rust version to 1.56.1 because the serde-yaml dependency no longer supports older Rust versions.
1.15.0CHANGELOG.mdSummarizedView source
Bumps libc to 0.2.174, fixing musl builds, and raises the MSRV of insta to 1.64.0.
libc
1.43.2GitHub ReleaseSummarizedView source
Lowers the minimum supported Rust version to 1.41.0.
1.6.2CHANGELOG.mdSummarizedView source
Bumps the similar dependency to reintroduce support for Rust 1.43.0.
1.6.1CHANGELOG.mdSummarizedView source

Deprecations to plan for

Deprecated7
Adds a --disable-nextest-doctest flag together with a deprecation warning.
--disable-nextest-doctest
1.44.0GitHub ReleaseSummarizedView source
Hides the unseen CLI option, which is pending deprecation.
unseen
1.42.2GitHub ReleaseSummarizedView source
Deprecates --no-force-pass in cargo-insta in favor of the clearer --check option.
--no-force-pass--check
1.40.0GitHub ReleaseSummarizedView source
Deprecates the INSTA_FORCE_UPDATE_SNAPSHOTS env var in favor of INSTA_FORCE_UPDATE.
INSTA_FORCE_UPDATE_SNAPSHOTSINSTA_FORCE_UPDATE
1.36.0CHANGELOG.mdSummarizedView source
Deprecates the assert_display_snapshot! macro.
assert_display_snapshot!
1.36.0CHANGELOG.mdSummarizedView source
Deprecates unused serialization features.
serialization
1.18.0CHANGELOG.mdSummarizedView source
Deprecates unused backtrace feature.
backtrace
1.18.0CHANGELOG.mdSummarizedView source