use a similar skipping strategy for shinytest

plotly · cpsievert · Jun 8, 2021 · Jun 8, 2021 · Jun 8, 2021 · Jun 9, 2021
commit 4a1ee0739603b0b3ea8a98a2a327bd734677cd6b
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -30,8 +30,8 @@ jobs:
          - {os: windows-latest, r: 'release'}
          - {os: windows-latest, r: '3.6', rspm: "https://packagemanager.rstudio.com/cran/latest"}
          - {os: ubuntu-18.04,   r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.1.0 (ubuntu-18.04) R (4.1.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
-          # visual tests are only run on linux r-release since the svg generator (orca) isn't cross-platform
-          - {os: ubuntu-18.04,   r: 'release', vdiffr: true, rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
+          # vdiffr & shinytest only runs on linux r-release since the results aren't cross-platform
+          - {os: ubuntu-18.04,   r: 'release', vdiffr: true, shinytest: true, rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
          - {os: ubuntu-18.04,   r: 'oldrel',  rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
          - {os: ubuntu-18.04,   r: '3.6',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
          - {os: ubuntu-18.04,   r: '3.5',     rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
@@ -40,6 +40,7 @@ jobs:
    env:
      RSPM: ${{ matrix.config.rspm }}
      VDIFFR: ${{ matrix.config.vdiffr }}
+      SHINYTEST: ${{ matrix.config.shinytest }}
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

    steps:

diff --git a/tests/testthat/helper-skip.R b/tests/testthat/helper-skip.R
@@ -15,3 +15,11 @@ skip_cloud_tests <- function() {
    skip("Cloud testing is only run on Windows with the current release of R")
  }
 }
+
+skip_shinytest_tests <- function() {
+  skip_on_cran()
+  skip_if_not_installed("shinytest")
+  if (!as.logical(Sys.getenv("SHINYTEST", FALSE))) {
+    skip("shinytest testing requires the SHINYTEST environment variable to be true")
+  }
+}
diff --git a/tests/testthat/helper-vdiffr.R b/tests/testthat/helper-vdiffr.R
@@ -46,9 +46,6 @@ if (enable_vdiffr) {
    writeLines(svg_txt, file)
  }

-  # force the vdiffr shiny app to open in a real browser 
-  # (some svg files seem to not render properly in RStudio)
-  options(shiny.launch.browser = interactive())
 } 

 expect_doppelganger <- function(p, name, ...) {

diff --git a/tests/testthat/test-plotly-shiny.R b/tests/testthat/test-plotly-shiny.R
@@ -20,13 +20,8 @@ test_that("event_unregister() de-registers an event", {
 })

 test_that("event_data shiny app works", {
-  skip_on_cran()
-  skip_if_not_installed("shinytest")
-  if (enable_vdiffr) skip("shiny testing not performed during visual testing")
+  skip_shinytest_tests()

-  # Use compareImages=FALSE because the expected image screenshots were created
-  # on a Mac, and they will differ from screenshots taken on the CI platform,
-  # which runs on Linux.
  appdir <- system.file(package = "plotly", "examples", "shiny", "event_data")
-  shinytest::expect_pass(shinytest::testApp(appdir, compareImages = FALSE))
+  shinytest::expect_pass(shinytest::testApp(appdir))
 })