test: testing functions

Author: ColinFay

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: pw
 Title: Test your 'golem' Apps with 'Playwright'
-Version: 0.0.0.9004
+Version: 0.0.0.9005
 Authors@R:
     person("Colin", "Fay", , "contact@colinfay.me", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0001-7343-1846"))
@@ -16,6 +16,6 @@ Imports:
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
-Suggests: 
+Suggests:
     testthat (>= 3.0.0)
 Config/testthat/edition: 3

R/npx-is-available.R

@@ -1,3 +1,6 @@
+# For mocking purpose
+sys_which <- Sys.which
+cli__abort <- cli::cli_abort
 #' Check if 'npx' is available in the system PATH
 #'
 #' @return TRUE if 'npx' is available, FALSE otherwise
@@ -14,7 +17,7 @@ npx_is_available <- function() {
 #' @rdname npx-is-available
 stop_if_npx_not_available <- function() {
   if (!npx_is_available()) {
-    cli_abort(
+    cli__abort(
       "npx is not installed. Please install Node.js to use Playwright."
     )
   }

R/pw-init.R

@@ -25,11 +25,11 @@ pw_init <- function(
   with_dir(
     where,
     {
-      if (!file.exists(here("app.R"))) {
-        add_positconnect_file(open = FALSE)
+      if (!file.exists(fs::path(where, "app.R"))) {
+        add_positconnect_file(pkg = where, open = FALSE)
       }
       if (!dir_exists("tests")) {
-        cli_abort(
+        cli__abort(
           "No tests folder found. Please run `usethis::use_testthat()` first."
         )
       }

R/utils.R

@@ -7,12 +7,12 @@ stop_if_playwright_skeleton_not_present <- function(
   where = golem::get_golem_wd()
 ) {
   error_msg <- "Playwright skeleton not found. Please run `pw::pw_init()` first."
-  if (!fs::dir_exists(path(where, "tests", "playwright"))) {
+  if (!fs::dir_exists(fs::path(where, "tests", "playwright"))) {
     cli_abort(
       error_msg
     )
   }
-  if (!file.exists(path(where, "tests", "playwright", "playwright.config.ts"))) {
+  if (!file.exists(fs::path(where, "tests", "playwright", "playwright.config.ts"))) {
     cli_abort(
       error_msg
     )

tests/testthat.R

@@ -0,0 +1,12 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
+library(testthat)
+library(pw)
+
+test_check("pw")

tests/testthat/test-npx-is-available.R

@@ -0,0 +1,20 @@
+test_that("npx_is_available works as expected", {
+  testthat::with_mocked_bindings(
+    sys_which = function(...) {
+      return("npx")
+    },
+    expect_true(npx_is_available())
+  )
+  testthat::with_mocked_bindings(
+    npx_is_available = function(...) {
+      return(FALSE)
+    },
+    cli__abort = function(...){
+      stop()
+    },
+    {
+      expect_false(npx_is_available())
+      expect_error(stop_if_npx_not_available())
+    }
+  )
+})

tests/testthat/test-pw-init-test.R

@@ -0,0 +1,75 @@
+test_that("multiplication works", {
+  skip_if_not(
+    npx_is_available()
+  )
+  temp_golem <- file.path(tempdir(), "golem")
+  on.exit({
+    unlink(temp_golem, recursive = TRUE)
+  })
+  options("usethis.quiet" = TRUE)
+  res <- golem::create_golem(
+    path = temp_golem,
+    package_name = "pwtest",
+    open = FALSE,
+    overwrite = TRUE
+  )
+
+  testthat::with_mocked_bindings(
+    cli__abort = function(...) {
+      stop()
+    },
+    {
+      expect_error(
+        pw_init(where = temp_golem)
+      )
+    }
+  )
+  dir.create(
+    file.path(
+      temp_golem,
+      "tests/testthat"
+    ),
+    recursive = TRUE
+  )
+  pw_init(temp_golem, "--quiet")
+  expect_true(
+    file.exists(
+      file.path(
+        temp_golem,
+        "tests/playwright"
+      )
+    )
+  )
+  expect_true(
+    file.exists(
+      file.path(
+        temp_golem,
+        "tests/playwright/playwright.config.ts"
+      )
+    )
+  )
+  expect_true(
+    file.exists(
+      file.path(
+        temp_golem,
+        "tests/playwright/tests/default.test.ts"
+      )
+    )
+  )
+  expect_true(
+    file.exists(
+      file.path(
+        temp_golem,
+        "tests/testthat/test-playwright.R"
+      )
+    )
+  )
+  withr::with_dir(
+    temp_golem,
+    {
+      expect_silent(
+        pw_test(where = ".")
+      )
+    }
+  )
+})

tests/testthat/test-utils.R

@@ -0,0 +1,40 @@
+test_that("pw_sys_files returns the correct paths", {
+  result <- pw_sys_files("DESCRIPTION")
+  expect_true(file.exists(result), info = "The DESCRIPTION file should exist in the package directory.")
+
+  result <- pw_sys_files("non_existent_file.txt")
+  expect_equal(result, "", info = "A non-existent file should return an empty string.")
+
+  result <- pw_sys_files()
+  expect_true(dir.exists(result), info = "Calling without arguments should return the root of the package.")
+})
+
+test_that("stop_if_playwright_skeleton_not_present works as expected", {
+  mock_golem_wd <- tempdir()
+  on.exit({
+    unlink(file.path(mock_golem_wd, "tests", "playwright"), recursive = TRUE)
+  })
+  dir.create(file.path(mock_golem_wd, "tests", "playwright"), recursive = TRUE)
+  file.create(file.path(mock_golem_wd, "tests", "playwright", "playwright.config.ts"))
+
+  # Test when the Playwright skeleton is present
+  expect_silent(stop_if_playwright_skeleton_not_present(where = mock_golem_wd))
+
+  # Test when the Playwright skeleton directory is missing
+  unlink(file.path(mock_golem_wd, "tests", "playwright"), recursive = TRUE)
+  expect_error(
+    stop_if_playwright_skeleton_not_present(where = mock_golem_wd),
+    "Playwright skeleton not found. Please run `pw::pw_init()` first.",
+    fixed = TRUE
+  )
+
+  # Test when the Playwright configuration file is missing
+  dir.create(file.path(mock_golem_wd, "tests", "playwright"), recursive = TRUE)
+  unlink(file.path(mock_golem_wd, "tests", "playwright", "playwright.config.ts"))
+  expect_error(
+    stop_if_playwright_skeleton_not_present(where = mock_golem_wd),
+    "Playwright skeleton not found. Please run `pw::pw_init()` first.",
+    fixed = TRUE
+  )
+})
+