here does not appear to find the package directory when run from inside the tests folder

[yogat3ch]

I am encountering issues with here::here() not being able to find the root directory of a package when it's called from inside the tests/testthat folder.
I have a .here file, a DESCRIPTION file, and an Rproj file two levels up from the tests/testthat as one might expect, but dr_here indicates the following:

- contains a file `.here`
- contains a file matching `[.]Rproj$` with contents matching `^Version: ` in the first line
- contains a file `DESCRIPTION` with contents matching `^Package: `
- contains a file `remake.yml`
- contains a file `.projectile`
- contains a directory `.git`
- contains a file `.git` with contents matching `^gitdir: `
- contains a directory `.svn`

It seems like it's not traversing up the tree to the proper parents given this output.
The following does work to find the root directory however:

rprojroot::find_root_file(criterion = rprojroot::has_file("DESCRIPTION"))

[krlmlr]

Thanks. It should work in tests (run by devtools::test()), but known to fail in R CMD check . Can you confirm?

[yogat3ch]

It fails in devtools::check, confirmed. That's what clued me into the issue. I think it fails at R CMD check because of the way the package directory constructed by R CMD Check extracts the tests folder to outside the package directory, thus no parent of the testing directory will meet the root criterion.

It also fails at the console, that's when I opened the issue.

[yogat3ch]

To work in R CMD check, maybe it could start in the working directory and use list.files(pattern "^DESCRIPTION$", recursive = TRUE) until it finds the lowest level directory that meets the criteria and set that as the root?

[yogat3ch]

Something like this:

#' @title find_path
#' @description Finds a file or directory by traversing the directory tree.
#' @param .fn The case-sensitive regex for the file passed to \code{\link[base]{list.files}}.
#' @param n the number of parent directories to traverse before erroring
#' @return The objects are loaded into the specified environment. 
#' @examples
#' find_path("Rminor.RData")
#' @export
#' @importFrom rlang warn

find_path <- function(.fn, n = 4) {
  .path <- "."
  .fs <- list.files(.path, pattern = .fn, all.files = TRUE, full.names = TRUE, recursive = TRUE)
  i <- 1
  while (length(.fs) < 1 && i <= n) {
    .path <- file.path("..", .path)
    .fs <- list.files(.path, pattern = .fn, all.files = TRUE, full.names = TRUE, recursive = TRUE)
    i <- 1 + i
  }
  if (length(.fs) > 1) {
   rlang::warn("More than one path found.")
  } else if (length(.fs) < 1) {
    rlang::abort("No path found for ", .fn)
  }  
  return(.fs)
}

[krlmlr]

R CMD check creates its own very specific structure -- the tests are top-level, with no DESCRIPTION above them. That's the reason for rprojroot::is_testthat :

rprojroot::is_testthat
#> Root criterion: directory name is `testthat` (also look in subdirectories: `tests/testthat`, `testthat`)

^{Created on 2020-10-23 by the reprex package (v0.3.0)}

Would that work for you? To get started, use find_root(is_testthat) .

[yogat3ch]

Boom, that's it - somehow I missed is_testthat! Thank you for the tip! Much appreciative of your time and willingness to help!

[github-actions]

This old thread has been automatically locked. If you think you have found something related to this, please open a new issue and link to this old issue if necessary.