Export context_start_file()

Replacing exported context_name() since this is a higher level API that should be used by external reporters

Fixes #1082

Author: hadley

DESCRIPTION

@@ -64,7 +64,6 @@ Collate:
     'compare-numeric.R'
     'compare-time.R'
     'context.R'
-    'context_name.R'
     'deprec-condition.R'
     'describe.R'
     'edition.R'

NAMESPACE

@@ -58,7 +58,7 @@ export(capture_warnings)
 export(check_reporter)
 export(compare)
 export(context)
-export(context_name)
+export(context_start_file)
 export(default_compact_reporter)
 export(default_reporter)
 export(describe)

NEWS.md

@@ -1,5 +1,8 @@
 # testthat (development version)
 
+* `context_start_file()` is now exported for external reporters (#983, #1082).
+  It now only strips first instance of prefix/suffix (#1041, @stufield).
+
 * New `CompactProgressReporter` tweaks the output of `ProgressReporter` for
   use with a single file, as in `devtools::test_file()`. You can pick a 
   different default by setting `testthat.default_compact_reporter` to
@@ -69,9 +72,6 @@
   `options(lifecycle_verbosity = "warning")` to ensure that lifecycle 
   warnings are always generated in tests.
 
-* `context_name()` is now exported (#983, @stufield) and only strips first 
-  instance of prefix/suffix (#1041, @stufield).
-
 * `verify_output()` now uses the `pdf()` device instead of `png()`; that makes
   it work on systems without X11 (#1011).
 

R/context.R

@@ -29,3 +29,22 @@ context_start <- function(desc) {
     get_reporter()$.start_context(desc)
   }
 }
+
+#' Start test context from a file name
+#'
+#' For use in external reporters
+#'
+#' @param name file name
+#' @keywords internal
+#' @export
+context_start_file <- function(name) {
+  context_start(context_name(name))
+}
+
+context_name <- function(filename) {
+  # Remove test- prefix
+  filename <- sub("^test-", "", filename)
+  # Remove terminal extension
+  filename <- sub("[.][Rr]$", "", filename)
+  filename
+}

R/context_name.R

@@ -74,8 +74,7 @@ JunitReporter <- R6::R6Class("JunitReporter",
 
     start_test = function(context, test) {
       if (is.null(context)) {
-        name <- context_name(self$file_name)
-        context_start(name)
+        context_start_file(self$file_name)
       }
     },
 

R/reporter-junit.R

@@ -76,8 +76,7 @@ ProgressReporter <- R6::R6Class("ProgressReporter",
       self$ctxt_issues <- Stack$new()
       self$ctxt_start_time <- proc.time()
 
-      name <- context_name(self$file_name)
-      context_start(name)
+      context_start_file(self$file_name)
     },
 
     start_context = function(context) {

R/reporter-progress.R

@@ -34,3 +34,10 @@ test_that("contexts are opened, then closed", {
   expect_equal(report$test_count, 4)
   expect_equal(report$test_i, 0)
 })
+
+test_that("context_name strips prefix and extensions correctly", {
+  expect_equal(context_name("test-metrics.R"), "metrics")     # uppercase
+  expect_equal(context_name("test-metrics.r"), "metrics")     # lowercase
+  expect_equal(context_name("test-check.Rfile.R"), "check.Rfile") # suffix only
+  expect_equal(context_name("test-test-test.R"), "test-test") # 1st prefix only
+})