feat: with_test_id() adds a data-testid attribute to a shiny tag.

This is useful for testing with `getByTestId` in Playwright.

Author: ColinFay

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: pw
 Title: Test your 'golem' Apps with 'Playwright'
-Version: 0.0.0.9007
+Version: 0.0.0.9008
 Authors@R:
     person("Colin", "Fay", , "contact@colinfay.me", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-7343-1846"))

NAMESPACE

@@ -6,6 +6,7 @@ export(pw_init)
 export(pw_show_report)
 export(pw_test)
 export(stop_if_npx_not_available)
+export(with_test_id)
 importFrom(cli,cat_line)
 importFrom(cli,cli_abort)
 importFrom(cli,cli_alert_success)

NEWS.md

@@ -1,5 +1,7 @@
 # pw (development version)
 
+* `with_test_id()` adds a `data-testid` attribute to a shiny tag. This is useful for testing with `getByTestId` in Playwright.
+
 * `pw_show_report()` can be called to open the test report
 
 * `pw_codegen()` can be called to launch the code generator

R/with_test_id.R

@@ -0,0 +1,13 @@
+#' Add a data-testid attribute to a tag
+#'
+#' This function adds a data-testid attribute to a shiny tag. This is useful for testing with `getByTestId` in Playwright.
+#' @param tag A shiny tag
+#' @param test_id A string to use as the value of the data-testid attribute
+#' @return A shiny tag with the data-testid attribute added
+#' @export
+with_test_id <- function(tag, test_id){
+  shiny::tagAppendAttributes(
+    tag,
+    `data-testid` = test_id
+  )
+}

man/with_test_id.Rd

@@ -0,0 +1,9 @@
+test_that("with_test_id works", {
+  tag <- shiny::div()
+  test_id <- "test-id"
+  tag_with_test_id <- with_test_id(tag, test_id)
+  expect_equal(
+    tag_with_test_id$attribs$`data-testid`,
+    test_id
+  )
+})