Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make interactive snapshot output a bit more obvious #2000

Merged
merged 7 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion R/describe.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,14 @@ describe <- function(description, code) {
}

describe_it <- function(description, code, env = parent.frame()) {
reporter <- get_reporter() %||% local_interactive_reporter()
local_test_context()

test_code(
description,
code,
env = env,
default_reporter = local_interactive_reporter(),
reporter = reporter,
skip_on_empty = FALSE
)
}
Expand Down
4 changes: 3 additions & 1 deletion R/reporter-progress.R
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,9 @@ issue_header <- function(x, pad = FALSE) {
issue_summary <- function(x, rule = FALSE) {
header <- cli::style_bold(issue_header(x))
if (rule) {
header <- cli::rule(header, width = max(cli::ansi_nchar(header) + 6, 80))
# Don't truncate long test names
width <- max(cli::ansi_nchar(header) + 6, getOption("width"))
header <- cli::rule(header, width = width)
}

paste0(header, "\n", format(x))
Expand Down
2 changes: 1 addition & 1 deletion R/snapshot-file.R
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@

snapshotter <- get_snapshotter()
if (is.null(snapshotter)) {
snapshot_not_available(paste0("New path: ", path))
snapshot_not_available(path)

Check warning on line 104 in R/snapshot-file.R

View check run for this annotation

Codecov / codecov/patch

R/snapshot-file.R#L104

Added line #L104 was not covered by tests
return(invisible())
}

Expand Down
9 changes: 6 additions & 3 deletions R/snapshot.R
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ expect_snapshot_helper <- function(lab, val,

snapshotter <- get_snapshotter()
if (is.null(snapshotter)) {
snapshot_not_available(paste0("Current value:\n", save(val)))
snapshot_not_available(save(val))
return(invisible())
}

Expand Down Expand Up @@ -323,11 +323,14 @@ snapshot_accept_hint <- function(variant, file, reset_output = TRUE) {
}

snapshot_not_available <- function(message) {
local_reporter_output()

cat(cli::rule("Snapshot"), "\n", sep = "")
cli::cli_inform(c(
"{.strong Can't compare snapshot to reference when testing interactively.}",
i = "Run {.run devtools::test()} or {.code testthat::test_file()} to see changes."
i = "Can't save or compare to reference when testing interactively."
))
cat(message, "\n", sep = "")
cat(cli::rule(), "\n", sep = "")
}

local_snapshot_dir <- function(snap_names, .env = parent.frame()) {
Expand Down
2 changes: 1 addition & 1 deletion R/source.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ source_file <- function(path,
test = NULL,
code = exprs,
env = env,
default_reporter = StopReporter$new()
reporter = get_reporter() %||% StopReporter$new()
))
} else {
withCallingHandlers(
Expand Down
2 changes: 1 addition & 1 deletion R/test-example.R
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
test = title,
code = parse(ex_path, encoding = "UTF-8"),
env = env,
default_reporter = StopReporter$new(),
reporter = get_reporter() %||% StopReporter$new(),

Check warning on line 68 in R/test-example.R

View check run for this annotation

Codecov / codecov/patch

R/test-example.R#L68

Added line #L68 was not covered by tests
skip_on_empty = FALSE
)
if (ok) succeed(path)
Expand Down
8 changes: 5 additions & 3 deletions R/test-that.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,23 @@ test_that <- function(desc, code) {
}
}

# Must initialise interactive reporter before local_test_context()
reporter <- get_reporter() %||% local_interactive_reporter()
local_test_context()

test_code(
desc,
code,
env = parent.frame(),
default_reporter = local_interactive_reporter()
reporter = reporter
)
}

# Access error fields with `[[` rather than `$` because the
# `$.Throwable` from the rJava package throws with unknown fields
test_code <- function(test, code, env, default_reporter, skip_on_empty = TRUE) {
test_code <- function(test, code, env, reporter, skip_on_empty = TRUE) {

frame <- caller_env()
reporter <- get_reporter() %||% default_reporter

if (!is.null(test)) {
reporter$start_test(context = reporter$.context, test = test)
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/test-snapshot-reporter.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ test_that("basic workflow", {
snapper$start_file("snapshot-2")
# output if not active (because test not set here)
expect_snapshot_output("x") %>%
expect_message("Can't compare") %>%
expect_output("Current value:\n[1] \"x\"", fixed = TRUE)
expect_message("Can't save") %>%
expect_output("[1] \"x\"", fixed = TRUE)

# warns on first creation
snapper$start_file("snapshot-2", "test")
Expand Down
Loading