test_trace_df() fails on packages using \packageTitle when run from outside the package directory.

[venkatesh588]

Hi Team,

When running covtracer::test_trace_df() on a package, the function fails if the R process's working directory is not the root of the target package, and that package uses documentation macros like \packageTitle{} in its .Rd files.

Error Message: mvtnorm-package.Rd:6: file './DESCRIPTION' does not exist.

[dgkf]

I'm not able to reproduce this.

I download the source code for the package from its homepage on r-forge.

Using R --vanilla I ran the following outside the package's source code root directory

options(covr.record_tests = TRUE)
cov <- covr::package_coverage("path/to/mvtnorm")
ttdf <- covtracer::test_trace_df(cov)

nrow(ttdf)
#> [1] 253678

head(ttdf[, c("alias", "srcref", "count")])
#>      alias                    srcref count
#> 1 .adddiag ltMatrices.R:609:13:636:1    13
#> 2 .adddiag ltMatrices.R:609:13:636:1    13
#> 3 .adddiag ltMatrices.R:609:13:636:1     1
#> 4 .adddiag ltMatrices.R:609:13:636:1     1
#> 5 .adddiag ltMatrices.R:609:13:636:1     1
#> 6 .adddiag ltMatrices.R:609:13:636:1     1

Can you provide more explicit instructions on how you're producing this error?

[venkatesh588]

Hi Team,

Please find the how we are executing the covr and traceability.

covr_results <- covr::package_coverage(Sys.getenv('INPUT_REPORT_PKG_DIR', '.'))
covr_results

Traceability

Tracebility matrix that maps each unit test to the corresponding documentation, creating a link
between intended use and testing.

#show figure: set block(breakable: true)

Testing matrix

if (require("covtracer", quietly = TRUE)) {
  covtracer_df <- test_trace_df(covr_results)
  covtracer_df$filename <- basename(covtracer_df$filepath)

  covtracer_df_clean <-  covtracer_df %>%
    dplyr::select(
      alias,
      test_name,
      file,
      is_exported,
      doctype,
      direct
    ) %>%
    dplyr::filter(!doctype %in% c("data", "class"))  %>%  # ignore objects without testable code
    dplyr::filter(is_exported == TRUE) %>% # Only exported
    dplyr::filter(!duplicated(.)) %>%
    dplyr::mutate(alias = paste0(alias, "()")) %>%
    dplyr::mutate(file = paste0("man/", file))

  tt_covtracer_df <- covtracer_df_clean %>%
    dplyr::filter(!duplicated(.)) %>%
    dplyr::filter(!is.na(test_name)) %>%
    dplyr::filter(!is.na(file)) %>% # unexported?
    dplyr::arrange(file) %>%
    dplyr::mutate(test_name = paste0("``` ", test_name, " ```")) %>%
    dplyr::mutate(file = paste0("``` ", file, " ```")) %>%
    dplyr::select(`Test Description` = test_name, Documentation = file)

  if (nrow(tt_covtracer_df) > 0) {
    tt(
      tt_covtracer_df,
      caption = "Tracebility matrix mapping unit tests to documented behaviours.",
      theme = "default"
    )
  } else {
    cat("No test suites.")
  }
} else {
  cat("{covtracer} not available to produce a traceability matrix")
}

[dgkf]

I don't think that this script really gives me any new information. The initial call still boils down to just covr::package_coverage(<path>) and then covtracer::test_trace_df(<cov>) just as I had in my example.

Can you try running the code that I shared to see if that alone works for you?

[venkatesh588]

I'm able to replicate the issue using your suggestion and getting the same issue. Please find the below error message.

Error:
! mvtnorm-package.Rd:6: file './DESCRIPTION' does not exist
Backtrace:
x
Below code:

covr_results <- covr::package_coverage(
Sys.getenv('INPUT_REPORT_PKG_DIR', '.'),
install_args = c("--no-build-vignettes"),
quiet = FALSE

)

covr_results
ttdf <- covtracer::test_trace_df(covr_results)

[dgkf]

It's looking for the DESCRIPTION file in your local directory, which also looks like it's set as the default value if the environment variable INPUT_REPORT_PKG_DIR is not set.

Can you try running just Sys.getenv("INPUT_REPORT_PKG_DIR")? If it returns an empty string, "", then that would indicate that this environment variable is not being picked up by your script and that could explain this error message that you're seeing.