Merge branch 'main' into pkg_support

* main:
  fix(snapshot): Use local testthat edition to announcing files (#419)
  feat: Allow for dev packages to be dynamically loaded (#402)
  fix(testthat): Use `muffle_expectation`, not `continue_test` (#418)
  v0.4.1 (#415)
  fix: default `transform=` to NULL, not itself (#413)
  Increment version number to 0.4.0.9000
  v0.4.0 (#410)
  Pre-release cleanups for shinytest 2 0.3.3 (#409)
  feat: Add `transform=` parameter to `$expect_download()` and `$expect_values()` (#403)
  chore!: Skip all tests using `AppDriver` during CRAN testing. Deprecate `cran=` parameters (#407)
  docs: Namespace `ChromoteSession` (#406)

Author: schloerke

.Rbuildignore

@@ -20,5 +20,6 @@ _\.new\.png$
 
 ^tests/testthat/migrate-apps$
 ^tests/testthat/apps$
+^tests/testthat/pkgs$
 ^CRAN-SUBMISSION$
 ^_dev$

.github/workflows/test-actions.yaml

@@ -35,8 +35,10 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages:
-            "local::."
+          needs: |
+            shinytest2-testing
+          extra-packages: |
+            local::.
 
       # ## Suggested usage
       # - name: Test app

.lintr

@@ -2,11 +2,14 @@ linters: linters_with_defaults(
     line_length_linter = NULL,
     indentation_linter = NULL,
     commented_code_linter = NULL,
-    cyclocomp_linter = NULL
+    return_linter = NULL
   )
 exclusions: list(
     "inst/gha/audit-app.R" = list(
       "object_usage_linter" = 81
     ),
-    "R/cpp11.R"
+    "R/cpp11.R",
+    "tests/testthat/pkgs/golem/R/run_app.R",
+    "vignettes/use-package.Rmd",
+    "tests/testthat/pkgs/"
   )

DESCRIPTION

@@ -1,64 +1,74 @@
 Package: shinytest2
 Title: Testing for Shiny Applications
-Version: 0.3.2.9001
-Authors@R:
-    c(
-        person("Barret", "Schloerke", role = c("cre", "aut"), email = "barret@posit.co", comment = c(ORCID = "0000-0001-9986-114X")),
-        person(family = "Posit Software, PBC", role = c("cph", "fnd")),
-        person("Winston", "Chang", role ="ctb", email = "winston@posit.co", comment = "Original author to rstudio/shinytest"),
-        person("Gábor", "Csárdi", role = "ctb", email = "gabor@posit.co", comment = "Original author to rstudio/shinytest"),
-        person("Hadley", "Wickham", role = "ctb", email = "hadley@posit.co", comment = "Original author to rstudio/shinytest"),
-        person(family = "Mango Solutions", role = c("cph", "ccp"), comment = "Original author to rstudio/shinytest")
-    )
-Description: Automated unit testing of Shiny applications through a headless 'Chromium' browser.
+Version: 0.4.1.9001
+Authors@R: c(
+    person("Barret", "Schloerke", , "barret@posit.co", role = c("cre", "aut"),
+           comment = c(ORCID = "0000-0001-9986-114X")),
+    person(, "Posit Software, PBC", role = c("cph", "fnd")),
+    person("Winston", "Chang", , "winston@posit.co", role = "ctb",
+           comment = "Original author to rstudio/shinytest"),
+    person("Gábor", "Csárdi", , "gabor@posit.co", role = "ctb",
+           comment = "Original author to rstudio/shinytest"),
+    person("Hadley", "Wickham", , "hadley@posit.co", role = "ctb",
+           comment = "Original author to rstudio/shinytest"),
+    person(, "Mango Solutions", role = c("cph", "ccp"),
+           comment = "Original author to rstudio/shinytest")
+  )
+Description: Automated unit testing of Shiny applications through a
+    headless 'Chromium' browser.
 License: MIT + file LICENSE
-Encoding: UTF-8
-Language: en-US
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
-URL: https://rstudio.github.io/shinytest2/, https://github.com/rstudio/shinytest2
+URL: https://rstudio.github.io/shinytest2/,
+    https://github.com/rstudio/shinytest2
 BugReports: https://github.com/rstudio/shinytest2/issues
-VignetteBuilder: knitr
 Depends:
-    testthat (>= 3.1.2)
+    testthat (>= 3.3.0)
 Imports:
-    R6 (>= 2.4.0),
     callr,
     checkmate (>= 2.0.0),
-    chromote (>= 0.1.2),
+    chromote (>= 0.5.0),
     cli,
     fs,
     globals (>= 0.14.0),
     httr,
     jsonlite,
     lifecycle (>= 1.0.3),
     pingr,
+    pkgload,
+    R6 (>= 2.4.0),
     rlang (>= 1.0.0),
     rmarkdown,
     shiny,
     withr
 Suggests:
+    box,
     deSolve,
     diffobj,
     ggplot2,
+    golem,
     knitr,
     plotly,
     png,
+    rhino,
     rstudioapi,
-    shinyWidgets,
     shinytest (>= 1.5.1),
     shinyvalidate (>= 0.1.2),
+    shinyWidgets,
     showimage,
+    spelling,
     usethis,
-    vdiffr (>= 1.0.0),
-    spelling
-Config/Needs/check:
-    rstudio/shiny,
-    bslib
-Config/Needs/website:
-    pkgdown,
-    tidyverse/tidytemplate
+    vdiffr (>= 1.0.0)
+LinkingTo:
+    cpp11
+VignetteBuilder:
+    knitr
+Config/Needs/check: rstudio/shiny, bslib
+Config/Needs/shinytest2-testing: decor
+Config/Needs/website: pkgdown, tidyverse/tidytemplate
 Config/testthat/edition: 3
+Encoding: UTF-8
+Language: en-US
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.3
 Collate:
     'R6-helper.R'
     'app-driver-chromote.R'
@@ -101,5 +111,3 @@ Collate:
     'shinytest2-package.R'
     'test-app.R'
     'use.R'
-LinkingTo:
-    cpp11

NEWS.md

@@ -1,5 +1,24 @@
 # shinytest2 (development version)
 
+* Added support for local package development for the background Shiny App process in `AppDriver$new(app_dir=)`. In the background test R process, any `library(<pkg>)` or `require(<pkg>)` call will automatically execute `pkgload::load_all()` to load the local R package's source code. Installing the package before testing is no longer required! (#402).
+
+* Added support for function execution for `AppDriver$new(app_dir=)`. You must run the App or document yourself. Similar to `{mirai}`, all packages must be `library()`'d or `require()`'d again as the function is being ran in the background R process (#402).
+
+* Fixed internal bug where `{testthat}` v3.3.0 changed expectation behavior for screenshot snapshots within `App$expect_values()` (#418).
+
+# shinytest2 0.4.1
+
+## Bug
+
+* Fixed a bug where `AppDriver$expect_values(transform=)` default value caused error to be thrown. (#413)
+
+
+# shinytest2 0.4.0
+
+## Breaking changes
+
+* `{shinytest2}` will skip and test on CRAN where an `AppDriver` is initialized. From a request from CRAN, using [`{chromote}` during CRAN package testing](https://rstudio.github.io/chromote/articles/example-cran-tests.html) should be avoided as it can create failing tests over time due to application changes within the testing machine, not changes in package code. Since `AppDriver` directly depends on `{chromote}` to test Shiny applications, creating an `AppDriver` should always skip the current test during CRAN package testing. This decision was made to achieve consistent testing behavior over time (rather than silently skipping tests that are expected to run due to a Chrome update). To escape this behavior, you can set the system environment variable `SHINYTEST2_APP_DRIVER_TEST_ON_CRAN=1`. Following `{chromote}`'s recommendation, you should test your R package [in a CI environment, ideally on a weekly or monthly schedule](https://rstudio.github.io/chromote/articles/example-cran-tests.html) to test your Shiny app with the latest R package versions. (#407)
+
 ## Bug / Improvements
 
 * Add support for `$click()`ing `{bslib}`'s `input_task_button()` (#389).
@@ -8,7 +27,10 @@
 
 * The `threshold` and `kernel_size` default values of the `AppDriver$expect_screenshot()` method are now configurable via two new global options: `shinytest2.compare_screenshot.threshold` and `shinytest2.compare_screenshot.kernel_size` (#401)
 
-* `{shinytest2}` now imports `{cli}` and no longer imports `{crayon}` (@olivroy, #399). 
+* `{shinytest2}` now imports `{cli}` and no longer imports `{crayon}` (@olivroy, #399).
+
+* Added [`{testthat}`'s snapshot file `transform=` parameter support](https://github.com/r-lib/testthat/pull/1530) to `AppDriver$expect_download()` and `AppDriver$expect_values()`. This allows for text transformations of the snapshot files before they are compared. (#403)
+
 
 # shinytest2 0.3.2
 

R/app-driver-dir.R

@@ -1,10 +1,47 @@
-
 app_set_dir <- function(
-  self, private,
+  self,
+  private,
   app_dir
 ) {
   ckm8_assert_app_driver(self, private)
 
+  if (is.function(app_dir)) {
+    # package_path <- tryCatch(pkgload::pkg_path(), error = function(e) NULL)
+    package_name <- tryCatch(pkgload::pkg_name(), error = function(e) NULL)
+
+    if (
+      !is.null(package_name) &&
+        rlang::env_label(environment(app_dir)) ==
+          rlang::env_label(pkgload::pkg_ns())
+    ) {
+      # If the function is from the local package, ensure the package is loaded
+      # Make a new function that first loads the package, then runs the original function
+      message(
+        "Upgrading `app_dir` function to load dev package: ",
+        package_name
+      )
+
+      app_fn <- app_dir
+      app_dir <- function() {}
+      rlang::fn_body(app_dir) <- rlang::expr({
+        # Run app with dev package loaded
+        # `library()` shimmed in app driver start
+        library(!!package_name, character.only = TRUE)
+
+        .pkg_ns <- rlang::ns_env(!!package_name)
+        .dev_pkg_run_app <- !!app_fn
+        environment(.dev_pkg_run_app) <- .pkg_ns
+
+        .dev_pkg_run_app()
+      })
+      rlang::fn_env(app_dir) <- globalenv()
+    }
+
+    # Set app function
+    private$dir <- app_dir
+    return()
+  }
+
   app_dir <- app_dir_value(app_dir)
 
   if (!fs::dir_exists(app_dir)) {
@@ -16,7 +53,8 @@ app_set_dir <- function(
         paste0("\"", cur_dir, "\"")
       }
     app_abort(
-      self, private,
+      self,
+      private,
       c(
         "`app_dir` must be an existing directory",
         "i" = paste0("Received: ", cur_dir)
@@ -25,25 +63,33 @@ app_set_dir <- function(
   }
 
   shiny_app_and_rmd_abort <- function() {
-    app_abort(self, private, c(
-      "`app_dir` must be a directory containing:",
-      "",
-      "*" = "an `./app.R` Shiny application",
-      "",
-      " " = "or",
-      "",
-      "*" = "a Shiny R Markdown file",
-      "*" = "a `./server.R` Shiny server",
-      "",
-      "i" = "If a Shiny R Markdown document is found, it will be the prefered document.",
-      "i" = "`./app.R` is not compatible with Shiny R Markdown files."
-    ))
+    app_abort(
+      self,
+      private,
+      c(
+        "`app_dir` must be a directory containing:",
+        "",
+        "*" = "an `./app.R` Shiny application",
+        "",
+        " " = "or",
+        "",
+        "*" = "a Shiny R Markdown file",
+        "*" = "a `./server.R` Shiny server",
+        "",
+        "i" = "If a Shiny R Markdown document is found, it will be the prefered document.",
+        "i" = "`./app.R` is not compatible with Shiny R Markdown files."
+      )
+    )
   }
   shiny_app_and_server_abort <- function() {
-    app_abort(self, private, c(
-      "`app_dir` contains both `app.R` and `server.R`. Unintented behavior may occur.",
-      "!" = "Please either use `app.R` or `server.R`, but not both."
-    ))
+    app_abort(
+      self,
+      private,
+      c(
+        "`app_dir` contains both `app.R` and `server.R`. Unintented behavior may occur.",
+        "!" = "Please either use `app.R` or `server.R`, but not both."
+      )
+    )
   }
 
   if (!fs::dir_exists(app_dir)) {
@@ -74,6 +120,10 @@ app_set_dir <- function(
 
 app_get_dir <- function(self, private) {
   ckm8_assert_app_driver(self, private)
+  if (is.function(private$dir)) {
+    return(private$dir)
+  }
+
   as.character(private$dir)
 }
 
@@ -82,6 +132,9 @@ app_dir_has_rmd <- function(self, private, app_dir = missing_arg()) {
     ckm8_assert_app_driver(self, private)
     app_dir <- self$get_dir()
   }
+  if (is.function(app_dir)) {
+    return(FALSE)
+  }
   length(app_dir_rmd(app_dir = app_dir)) >= 1
 }
 app_dir_rmd <- function(self, private, app_dir = rlang::missing_arg()) {
@@ -90,7 +143,11 @@ app_dir_rmd <- function(self, private, app_dir = rlang::missing_arg()) {
     app_dir <- self$get_dir()
   }
   # Similar to https://github.com/rstudio/rmarkdown/issues/2236
-  docs <- fs::dir_ls(app_dir, regexp = "^[^_].*\\.[Rrq][Mm][Dd]$", type = "file")
+  docs <- fs::dir_ls(
+    app_dir,
+    regexp = "^[^_].*\\.[Rrq][Mm][Dd]$",
+    type = "file"
+  )
 
   if (length(docs) >= 1) {
     docs <- Filter(docs, f = function(doc_path) {