Skip to content

Fail fast and informatively for nonexistent file #261

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

Merged
merged 5 commits into from
Feb 7, 2022
Merged

Fail fast and informatively for nonexistent file #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
82b26b0
Initiate a snapshot test (non-informative failure)
jennybc Feb 4, 2022
2f0aa65
Fail early with a better message
jennybc Feb 4, 2022
c340b06
Explicitly check if `file` was provided
jennybc Feb 4, 2022
9a8fee9
Reveal the filepath that we can't find
jennybc Feb 4, 2022
0c3bdd9
NEWS
romainfrancois Feb 7, 2022
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
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# cpp11 (development version)

* `cpp_source()` errors on non-existent file (#261).

# cpp11 0.4.2

* Romain François is now the maintainer.
Expand Down
3 changes: 3 additions & 0 deletions R/source.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@
#' @export
cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), dir = tempfile()) {
stop_unless_installed(c("brio", "callr", "cli", "decor", "desc", "glue", "tibble", "vctrs"))
if (!missing(file) && !file.exists(file)) {
Copy link
Member Author

Choose a reason for hiding this comment

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

!missing(file) seems a bit counter to our "house style". I wonder if the signature should become file = NULL, to indicate file is not required (at least, if code is provided)?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this be informative about the name/path of the file that does not exist ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I was thinking that too. I've added the non-existent file path to the error now.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks. Perhaps ultimately this is something fs:: can help with ?

stop("Can't find `file` at this path:\n", file, "\n", call. = FALSE)
}

dir.create(dir, showWarnings = FALSE, recursive = TRUE)
dir.create(file.path(dir, "R"), showWarnings = FALSE)
Expand Down
8 changes: 8 additions & 0 deletions tests/testthat/_snaps/source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# cpp_source fails informatively for nonexistent file

Code
cpp_source(i_do_not_exist)
Error <simpleError>
Can't find `file` at this path:
{NON_EXISTENT_FILEPATH}

10 changes: 10 additions & 0 deletions tests/testthat/test-source.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,13 @@ test_that("cpp_source(d) functions work after sourcing file more than once", {
cpp11::cpp_source(test_path("single.cpp"), clean = TRUE)
expect_equal(foo(), 1)
})

test_that("cpp_source fails informatively for nonexistent file", {
i_do_not_exist <- tempfile(pattern = "nope-", fileext = ".cpp")
expect_false(file.exists(i_do_not_exist))
expect_snapshot(
error = TRUE,
cpp_source(i_do_not_exist),
transform = ~ sub("^.+[.]cpp$", "{NON_EXISTENT_FILEPATH}", .x)
)
})