Automatically set log code and warnings when debuging a failing GHA r…

…un (#193)

Fixes #175

NEWS.md

@@ -1,5 +1,6 @@
 # evaluate (development version)
 
+* Setting `ACTIONS_STEP_DEBUG=1` (as in a failing GHA workflow) will automatically set `log_echo` and `log_warning` to `TRUE` (#175).
 * New `local_reproducible_output()` helper that sets various options and env vars to help ensure consistency of output across environments.
 * The `source` output handler is now passed the entire top-level expression, not just the first component.
 * `evaluate()` will now terminate on the first error in a top-level expression. This matches R's own behaviour more closely.

R/eval.R

@@ -38,6 +38,9 @@
 #'  force these arguments to be set to `NA`.
 #' @param log_echo,log_warning If `TRUE`, will immediately log code and
 #'   warnings (respectively) to `stderr`.
+#' 
+#'   This will be force to `TRUE` if env var `ACTIONS_STEP_DEBUG` is
+#'   `true`, as when debugging a failing GitHub Actions workflow.
 #' @param new_device if `TRUE`, will open a new graphics device and
 #'   automatically close it after completion. This prevents evaluation from
 #'   interfering with your existing graphics environment.
@@ -68,6 +71,11 @@ evaluate <- function(input,
     keep_message <- NA 
     keep_warning <- NA
   }
+  if (env_var_is_true("ACTIONS_STEP_DEBUG")) {
+    log_warning <- TRUE
+    log_echo <- TRUE
+  }
+
   on_message <- check_keep(keep_message, "keep_message")
   on_warning <- check_keep(keep_warning, "keep_warning", log_warning)
 

tests/testthat/test-eval.R

@@ -31,6 +31,18 @@ test_that("log_echo causes output to be immediately written to stderr()", {
   expect_equal(res[[1]]$src, "f()")
 })
 
+test_that("ACTIONS_STEP_DEBUG forces log_warning and log_echo to TRUE", {
+  f <- function() {
+    1
+    warning("abc")
+  }
+  out <- local({
+    withr::local_envvar(ACTIONS_STEP_DEBUG = "true")
+    capture.output(expect_warning(evaluate("f()"), "abc"), type = "message")
+  })
+  expect_equal(out, "f()")
+})
+
 test_that("data sets loaded", {
   skip_if_not_installed("lattice")