expect_pkg_error_snapshot: Snapshot-test a package error

In stbl: Stabilize Function Arguments

Snapshot-test a package error

Description

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()
)

Arguments

object	An expression that is expected to throw an error.
package	⁠(length-1 character)⁠ 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. The actual evaluation will occur in a child of this environment, with expect_pkg_error_classes() available even if this package is not attached.

Value

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

stbl documentation built on April 4, 2026, 5:06 p.m.