nosuggests (#1075)

* nosuggests workflow

* skip tests on missing suggests

* skip quarto tests on cran, as quarto leaves residue in ~/.cache

* NEWS

* link news to issue

.github/workflows/check-no-suggests.yaml

@@ -0,0 +1,60 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+#
+# NOTE: This workflow only directly installs "hard" dependencies, i.e. Depends,
+# Imports, and LinkingTo dependencies. Notably, Suggests dependencies are never
+# installed, with the exception of testthat, knitr, and rmarkdown. The cache is
+# never used to avoid accidentally restoring a cache containing a suggested
+# dependency.
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: R-CMD-check-hard
+
+permissions: read-all
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {os: ubuntu-latest,   r: 'release'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          dependencies: '"hard"'
+          cache: false
+          extra-packages: |
+            any::rcmdcheck
+            any::testthat
+            any::knitr
+            any::rmarkdown
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true
+          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

NEWS.md

@@ -12,6 +12,9 @@
 * `deployTF()` can deploy a TensorFlow model to Posit Connect. Requires Posit
   Connect 2024.05.0 or higher.
 
+* Skip tests when suggested packages are not available. Skip Quarto tests when
+  run by CRAN. (#1074)
+
 # rsconnect 1.2.2
 
 * Use internally computed SHA1 sums and PKI signing when SHA1 is disabled 

tests/testthat/test-appDependencies.R

@@ -11,6 +11,9 @@ test_that("appDependencies includes implicit deps", {
 
 test_that("appDependencies includes implicit deps when appMode forced", {
   skip_on_cran()
+  skip_if_not_installed("plumber")
+  skip_if_not_installed("shiny")
+  skip_if_not_installed("rmarkdown")
 
   withr::local_options(renv.verbose = TRUE)
 

tests/testthat/test-appMetadata-quarto.R

@@ -10,6 +10,7 @@ fakeQuartoMetadata <- function(version, engines) {
 }
 
 test_that("inferQuartoInfo correctly detects info when quarto is provided alone", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   quartoInfo <- inferQuartoInfo(
@@ -51,6 +52,7 @@ test_that("quartoInspect requires quarto", {
 })
 
 test_that("quartoInspect identifies Quarto projects", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   inspect <- quartoInspect(test_path("quarto-website-r"))
@@ -61,6 +63,7 @@ test_that("quartoInspect identifies Quarto projects", {
 })
 
 test_that("quartoInspect identifies Quarto documents", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   inspect <- quartoInspect(
@@ -71,6 +74,7 @@ test_that("quartoInspect identifies Quarto documents", {
 })
 
 test_that("quartoInspect processes content within paths containing spaces", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   parent <- withr::local_tempdir()
@@ -87,6 +91,7 @@ test_that("quartoInspect processes content within paths containing spaces", {
 })
 
 test_that("quartoInspect processes content with filenames containing spaces", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   dir <- local_temp_app(list("space file.qmd" = c(
@@ -112,6 +117,7 @@ strip_quarto_trace <- function(lines) {
 }
 
 test_that("quartoInspect produces an error when a document cannot be inspected", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   # Suppress colors from Quarto errors.
@@ -131,6 +137,7 @@ test_that("quartoInspect produces an error when a document cannot be inspected",
 })
 
 test_that("quartoInspect produces an error when a project cannot be inspected", {
+  skip_on_cran()
   skip_if_no_quarto()
 
   # Suppress colors from Quarto errors.

tests/testthat/test-appMetadata.R

@@ -1,6 +1,8 @@
 # appMetadata -------------------------------------------------------------
 
 test_that("quarto affects mode inference", {
+  skip_on_cran()
+
   dir <- local_temp_app(list("foo.Rmd" = ""))
 
   metadata <- appMetadata(dir, c("foo.Rmd"))
@@ -11,12 +13,16 @@ test_that("quarto affects mode inference", {
 })
 
 test_that("quarto path is deprecated", {
+  skip_on_cran()
   skip_if_no_quarto()
+
   dir <- local_temp_app(list("foo.Rmd" = ""))
   expect_snapshot(. <- appMetadata(dir, c("foo.Rmd"), quarto = "abc"))
 })
 
 test_that("validates quarto argument", {
+  skip_on_cran()
+
   dir <- local_temp_app(list("foo.Rmd" = ""))
   expect_snapshot(appMetadata(dir, c("foo.Rmd"), quarto = 1), error = TRUE)
 })

tests/testthat/test-client-cloud.R

@@ -898,6 +898,9 @@ test_that("deployApp() for shiny results in correct Cloud API calls", {
 })
 
 test_that("deployDoc() results in correct Cloud API calls", {
+  skip_on_cran()
+  skip_if_not_installed("rmarkdown")
+
   local_temp_config()
 
   mock <- deployAppMockServerFactory(expectedAppType = "static", outputState = "active")

tests/testthat/test-client-connect.R

@@ -33,6 +33,8 @@ test_that("messages without recognized timestamps are unmodified", {
 })
 
 test_that("waitForTask", {
+  skip_if_not_installed("webfakes")
+
   task_app <- webfakes::new_app()
   task_app$use(webfakes::mw_json())
   task_app$get("/tasks/:id", function(req, res) {

tests/testthat/test-deploySite.R

@@ -1,5 +1,8 @@
 test_that("can extract quarto metadata", {
+  skip_on_cran()
   skip_if_no_quarto()
+  skip_if_not_installed("quarto")
+
   app <- local_temp_app(list(`_quarto.yaml` = c(
     "project:",
     "  type: website",
@@ -14,6 +17,9 @@ test_that("can extract quarto metadata", {
 })
 
 test_that("can extract rmarkdown metadata", {
+  skip_on_cran()
+  skip_if_not_installed("rmarkdown")
+
   app <- local_temp_app(list(
     `_site.yml` = 'name: "my-website"'
   ))

tests/testthat/test-http-curl.R

@@ -1,5 +1,7 @@
 test_that("basic HTTP methods work", {
   skip_if(Sys.which("curl") == "")
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http = "curl", lifecycle_verbosity = "quiet")
 
   test_http_GET()

tests/testthat/test-http-internal.R

@@ -1,4 +1,6 @@
 test_that("basic HTTP methods work", {
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http = "internal", lifecycle_verbosity = "quiet")
 
   test_http_GET()

tests/testthat/test-http-libcurl.R

@@ -1,4 +1,6 @@
 test_that("basic HTTP methods work", {
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http = "libcurl")
 
   test_http_GET()
@@ -9,6 +11,8 @@ test_that("basic HTTP methods work", {
 })
 
 test_that("can trace JSON", {
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http.trace.json = TRUE)
   service <- httpbin_service()
 
@@ -27,6 +31,8 @@ test_that("can trace JSON", {
 
 test_that("can get and set cookies", {
   skip_on_cran()
+  skip_if_not_installed("webfakes")
+
   # uses live httpbin since webfakes doesn't support cookie endpoints
   service <- parseHttpUrl("http://httpbin.org/")
 

tests/testthat/test-http-rcurl.R

@@ -1,5 +1,7 @@
 test_that("basic HTTP methods work", {
   skip_if_not_installed("RCurl")
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http = "rcurl", lifecycle_verbosity = "quiet")
 
   test_http_GET()

tests/testthat/test-http.R

@@ -78,6 +78,8 @@ a3hEFijsjg/+FDMr+iAVzjry
 })
 
 test_that("can add user specific headers", {
+  skip_if_not_installed("webfakes")
+
   withr::local_options(rsconnect.http.headers = c(a = "1", b = "2"))
 
   service <- httpbin_service()
@@ -88,6 +90,8 @@ test_that("can add user specific headers", {
 
 test_that("can add user specific cookies", {
   skip_on_cran()
+  skip_if_not_installed("webfakes")
+
   # uses live httpbin since webfakes doesn't support cookie endpoints
   withr::local_options(rsconnect.http.cookies = c("a=1", "b=2"))
   service <- parseHttpUrl("http://httpbin.org/")
@@ -163,6 +167,8 @@ test_that("but still gives got error if no body", {
 })
 
 test_that("errors contain method", {
+  skip_if_not_installed("webfakes")
+
   service <- httpbin_service()
   expect_snapshot(error = TRUE, {
     GET(service, list(), path = "status/404")
@@ -171,6 +177,8 @@ test_that("errors contain method", {
 })
 
 test_that("http error includes status in error class", {
+  skip_if_not_installed("webfakes")
+
   service <- httpbin_service()
   expect_error(
     GET(service, list(), path = "status/404"),
@@ -183,6 +191,8 @@ test_that("http error includes status in error class", {
 })
 
 test_that("handles redirects", {
+  skip_if_not_installed("webfakes")
+
   service <- httpbin_service()
   out <- GET(service, list(), "absolute-redirect/3")
   expect_equal(out$url, paste0(buildHttpUrl(service), "get"))

tests/testthat/test-ide.R

@@ -67,6 +67,8 @@ current_user_service <- function() {
 }
 
 test_that("getUserFromRawToken having a single matching server", {
+  skip_if_not_installed("webfakes")
+
   local_temp_config()
 
   service <- current_user_service()
@@ -82,6 +84,8 @@ test_that("getUserFromRawToken having a single matching server", {
 })
 
 test_that("getUserFromRawToken having multiple matching servers", {
+  skip_if_not_installed("webfakes")
+
   local_temp_config()
 
   service <- current_user_service()

tests/testthat/test-servers.R

@@ -59,6 +59,8 @@ test_that("addServer() normalises url", {
 })
 
 test_that("addServer() errors if url not a connect server", {
+  skip_if_not_installed("webfakes")
+
   local_temp_config()
 
   service <- httpbin_service()