Skip to content

Make accept_snapshot() work on filenames containing a dot (#1669) #2029

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

Make accept_snapshot() work on filenames containing a dot (#1669) #2029

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
18efb9e
Make accept_snapshot() work on filenames containing a dot (#1669)
mcol Dec 21, 2024
8244bd7
Merged origin/main into mcol-issue_1669
hadley Jul 23, 2025
5cf6fa4
Update news bullet
hadley Jul 23, 2025
c524d33
Merged origin/main into mcol-issue_1669
hadley Jul 24, 2025
349561e
Move bullet to top
hadley Jul 24, 2025
2aa0829
Add partial support for any snapshot extension.
mcol Jul 24, 2025
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
1 change: 1 addition & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

* `it()` now finds the correct evaluation environment in more cases (@averissimo, #2085).
* Fixed an issue preventing compilation from succeeding due to deprecation / removal of `std::uncaught_exception()` (@kevinushey, #2047).
* `snapshot_accept()` now works also when the tested file contains dots in the filename (@mcol, #1669).

# testthat 3.2.3

Expand Down
6 changes: 4 additions & 2 deletions R/snapshot-manage.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,11 @@ snapshot_meta <- function(files = NULL, path = "tests/testthat") {
files <- files[!is_dir]

dirs <- substr(dirs, 1, nchar(dirs) - 1)
files <- ifelse(tools::file_ext(files) == "", paste0(files, ".md"), files)
files <- gsub("\\.md|\\.txt$", "", files)
Copy link
Member

@hadley hadley Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your fix assumes that snapshots can only have file names ending in .md or .txt, but in fact they can have any extension because the user supplies the extension in expect_snapshot_file().

But overall I find this code (i.e. the code that existed before your PR) very hard to understand: I don't understand what it's try is trying to achieve, or how the logic flows. So that might imply it's time to take a step back and rewrite this code to make it more clear what the varies inputs are.

Copy link
Contributor Author

@mcol mcol Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed a partial fix for the hardcoded extensions, although it may not work if there are multiple snapshot extensions being used simultaneously (but also, there's no pre-existing test for that case, independently of dots in the filenames).

Having said that, I agree that this code is quite hacky as it is. Are you planning to do it or should I have a go?

Copy link
Member

@hadley hadley Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd really appreciate it if you wanted to have a go 😄


out <- out[out$name %in% files | out$test %in% dirs, , drop = FALSE]
out_name_sans_ext <- tools::file_path_sans_ext(out$name)
out <- out[out_name_sans_ext %in% files |
out$test %in% dirs, , drop = FALSE]
}

out
Expand Down
16 changes: 16 additions & 0 deletions tests/testthat/_snaps/snapshot-manage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@
Updating snapshots:
* test/a.txt

---

Code
snapshot_accept("test/c.d.md", path = path)
Message
Updating snapshots:
* test/c.d.md

---

Code
snapshot_accept("test/c.d", path = path)
Message
Updating snapshots:
* test/c.d.md

# can work with variants

Code
Expand Down
9 changes: 9 additions & 0 deletions tests/testthat/test-snapshot-manage.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ test_that("can accept specific files", {
expect_snapshot(snapshot_accept("test/", path = path))
expect_equal(dir(file.path(path, "_snaps"), recursive = TRUE), "test/a.txt")

## file names with dots
path <- local_snapshot_dir(c("test/c.d.md", "test/c.d.new.md"))
expect_snapshot(snapshot_accept("test/c.d.md", path = path))
expect_equal(dir(file.path(path, "_snaps"), recursive = TRUE), "test/c.d.md")

path <- local_snapshot_dir(c("test/c.d.md", "test/c.d.new.md"))
expect_snapshot(snapshot_accept("test/c.d", path = path))
expect_equal(dir(file.path(path, "_snaps"), recursive = TRUE), "test/c.d.md")

})

test_that("can work with variants", {
Expand Down
Loading