merge

Merge branch 'main' into landing_popup@503-introduce-shinytest2@main # Conflicts: # R/TealAppDriver.R # man/TealAppDriver.Rd
insightsengineering · Mar 19, 2024 · f1501f0 · f1501f0
2 parents 13d2f75 + d13a73e
commit f1501f0
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 28 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Type: Package
 Package: teal
 Title: Exploratory Web Apps for Analyzing Clinical Trials Data
-Version: 0.15.2.9005
-Date: 2024-03-18
+Version: 0.15.2.9007
+Date: 2024-03-19
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-9533-457X")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# teal 0.15.2.9005
+# teal 0.15.2.9007
 
 # teal 0.15.2
 

diff --git a/R/TealAppDriver.R b/R/TealAppDriver.R
@@ -365,6 +365,14 @@ TealAppDriver <- R6::R6Class( # nolint: object_name.
         rvest::html_attr("onclick")
     },
     #' @description
+    #' Wrapper around `get_html` that passes the output directly to `rvest::read_html`.
+    #'
+    #' @param selector `(character(1))` passed to `get_html`.
+    #'
+    #' @return An XML document.
+    get_html_rvest = function(selector) {
+      rvest::read_html(self$get_html(selector))
+    },
     #' Wrapper around `get_url()` method that opens the app in the browser.
     #'
     #' @return Nothing. Opens the underlying teal app in the browser.

diff --git a/man/TealAppDriver.Rd b/man/TealAppDriver.Rd
diff --git a/tests/testthat/test-shinytest2-init.R b/tests/testthat/test-shinytest2-init.R
@@ -8,6 +8,62 @@ testthat::test_that("e2e: teal app initializes with no errors", {
   app$stop()
 })
 
+testthat::test_that("e2e: teal app initializes with sessionInfo modal", {
+  app <- TealAppDriver$new(
+    data = simple_teal_data(),
+    modules = example_module(label = "Example Module")
+  )
+  app$wait_for_idle(timeout = default_idle_timeout)
+
+  # Check if button exists.
+  button_selector <- "#teal-sessionInfo-button"
+  testthat::expect_equal(
+    app$get_text(button_selector),
+    "Session Info"
+  )
+
+  app$click(selector = button_selector)
+  app$wait_for_idle(timeout = default_idle_timeout)
+
+  # Check header and title content.
+  testthat::expect_equal(
+    app$get_text("#shiny-modal > div > div > div.modal-header > h4"),
+    "SessionInfo"
+  )
+
+  # There are two Copy buttons with similar id and the same label.
+  testthat::expect_setequal(
+    testthat::expect_length(
+      app$get_text(
+        "#shiny-modal [id^='teal-sessionInfo-copy_button']"
+      ),
+      2
+    ),
+    "Copy to Clipboard"
+  )
+  # There are two Dismiss buttons with similar id and the same label.
+  testthat::expect_setequal(
+    testthat::expect_length(
+      app$get_text("#shiny-modal button[data-dismiss]"),
+      2
+    ),
+    "Dismiss"
+  )
+
+  # Check session info output.
+  session_info <- app$get_text("#teal-sessionInfo-verbatim_content")
+
+  testthat::expect_match(session_info, "R version", fixed = TRUE)
+  testthat::expect_match(session_info, "attached base packages:", fixed = TRUE)
+  testthat::expect_match(session_info, "loaded via a namespace (and not attached):", fixed = TRUE)
+
+  testthat::expect_match(session_info, "shiny", fixed = TRUE)
+  testthat::expect_match(session_info, "teal.slice", fixed = TRUE)
+  testthat::expect_match(session_info, "teal.reporter", fixed = TRUE)
+
+  app$stop()
+})
+
 testthat::test_that("e2e: init creates UI containing specified title, favicon, header and footer", {
   app_title <- "Custom Teal App Title"
   app_favicon <- "https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/PNG/teal.png"
@@ -30,8 +86,7 @@ testthat::test_that("e2e: init creates UI containing specified title, favicon, h
     app_title
   )
   testthat::expect_equal(
-    app$get_html("head > link[rel='icon']") %>%
-      rvest::read_html() %>%
+    app$get_html_rvest("head > link[rel='icon']") %>%
       rvest::html_elements("link") %>%
       rvest::html_attr("href"),
     app_favicon

diff --git a/tests/testthat/test-shinytest2-modules.R b/tests/testthat/test-shinytest2-modules.R
@@ -78,8 +78,7 @@ testthat::test_that("e2e: filter panel is not displayed when datanames is NULL",
   app$wait_for_idle(timeout = default_idle_timeout)
 
   testthat::expect_identical(
-    app$get_html(".teal_secondary_col") %>%
-      rvest::read_html() %>%
+    app$get_html_rvest(".teal_secondary_col") %>%
       rvest::html_element("div") %>%
       rvest::html_attr("style"),
     "display: none;"

diff --git a/tests/testthat/test-shinytest2-reporter.R b/tests/testthat/test-shinytest2-reporter.R
@@ -4,8 +4,7 @@ testthat::test_that("e2e: reporter tab is created when a module has reporter", {
     modules = report_module(label = "Module with Reporter")
   )
 
-  teal_tabs <- app$get_html(selector = "#teal-main_ui-root-active_tab") %>%
-    rvest::read_html() %>%
+  teal_tabs <- app$get_html_rvest(selector = "#teal-main_ui-root-active_tab") %>%
     rvest::html_elements("a")
   tab_names <- setNames(
     rvest::html_attr(teal_tabs, "data-value"),
@@ -24,8 +23,7 @@ testthat::test_that("e2e: reporter tab is not created when a module has no repor
     data = simple_teal_data(),
     modules = example_module(label = "Example Module")
   )
-  teal_tabs <- app$get_html(selector = "#teal-main_ui-root-active_tab") %>%
-    rvest::read_html() %>%
+  teal_tabs <- app$get_html_rvest(selector = "#teal-main_ui-root-active_tab") %>%
     rvest::html_elements("a")
   tab_names <- setNames(
     rvest::html_attr(teal_tabs, "data-value"),

diff --git a/tests/testthat/test-shinytest2-utils.R b/tests/testthat/test-shinytest2-utils.R
@@ -5,8 +5,7 @@ testthat::test_that("e2e: show/hide hamburger works as expected", {
   )
 
   get_class_attributes <- function(app, selector) {
-    element <- app$get_html(selector = selector) %>%
-      rvest::read_html() %>%
+    element <- app$get_html_rvest(selector = selector) %>%
       rvest::html_elements(selector)
     list(
       class = rvest::html_attr(element, "class"),