Snapshot-test a package error — expect_pkg_error

A convenience wrapper around testthat::expect_snapshot() and expect_pkg_error_classes() that captures both the error class hierarchy and the user-facing message in a single snapshot.

Usage

expect_pkg_error_snapshot(
  object,
  package,
  ...,
  transform = NULL,
  variant = NULL,
  env = caller_env()
)

object: An expression that is expected to throw an error.
package: (character(1)) The name of the package to use in classes.
...: (character) Components of the class name, from least-specific to most.
transform: (function or NULL) Optional function to scrub volatile output (e.g. temp paths) before snapshot comparison. Passed through to testthat::expect_snapshot().
variant: (character(1) or NULL) Optional snapshot variant name. Passed through to testthat::expect_snapshot().
env: (environment) The environment in which object should be evaluated. Assignments made inside object are visible to the caller after this function returns. expect_pkg_error_classes() is temporarily injected into env if it is not already findable, so this works even when this package is not attached.

The result of testthat::expect_snapshot(), invisibly.