ci: rewrite Connect integration tests using with-connect Action (#884)

* Simplify connect test helpers to only use a single test user

* Move connect test helpers out of the package

* Update GHA workflow to use with-connect

* Add matrix, switch license secrets

* fix matrix yaml

* Move test helpers back into package

* gitignore .orig files

* Action is now in posit-dev

* Update R/board_connect.R

* Prefer PTD for testing

Author: nealrichardson

.github/setup-connect/add-users.sh

@@ -9,15 +9,21 @@ name: posit-connect
 jobs:
   posit-connect:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "jammy" # As long as we're building on ubuntu 22.04, this will track the latest release
+          - "2024.09.0" # jammy
+          - "2023.09.0" # jammy
+          - "2022.10.0" # bionic
+    name: Posit Connect ${{ matrix.version }}
+
     if: github.event_name == 'push' || github.event.pull_request.head.repo.fork == false
     env:
-      RSC_LICENSE: ${{ secrets.RSC_LICENSE }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v4
-
-      - name: run Connect
-        run: docker compose up -d --build
+      - uses: actions/checkout@v5
 
       - uses: r-lib/actions/setup-r@v2
         with:
@@ -26,38 +32,14 @@ jobs:
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
           extra-packages: |
-            any::rcmdcheck
-            rstudio/connectapi
-          needs: check
-
-      - name: create Connect users
-        run: |
-          curl -s --retry 10 --retry-connrefused http://localhost:3939
-          docker compose exec -T rsconnect bash < .github/setup-connect/add-users.sh
-
-      - name: initialize Connect users
-        shell: Rscript {0}
-        run: |
-          admin_key <- connectapi:::create_first_admin(url = "http://localhost:3939", user = "admin", password = "admin0", email = "admin@example.com")
-
-          susan_key <- connectapi:::create_first_admin(url = "http://localhost:3939", user = "susan", password = "susan", email = "susan@example.com")
-          derek_key <- connectapi:::create_first_admin(url = "http://localhost:3939", user = "derek", password = "derek", email = "derek@example.com")
-
-          saveRDS(
-            list(
-              admin_key = admin_key$api_key,
-              susan_key = susan_key$api_key,
-              derek_key = derek_key$api_key
-            ),
-            "tests/testthat/creds.rds"
-          )
-
-      - uses: r-lib/actions/check-r-package@v2
+            local::.
+
+      - name: Run Connect integration tests
+        uses: posit-dev/with-connect@main
         with:
-          upload-snapshots: true
+          # This license is valid until 2026-10-28
+          license: ${{ secrets.CONNECT_LICENSE }}
+          version: ${{ matrix.version }}
+          command: Rscript -e 'testthat::test_local(".", filter="board_connect")'
 
-      - name: shutdown Posit Connect
-        if: always()
-        run: |
-          docker compose down
 

.github/setup-connect/rstudio-connect.gcfg

@@ -9,3 +9,4 @@ docs
 inst/doc
 .Renviron
 google-pins.json
+*.orig

.github/setup-connect/users.txt

@@ -733,15 +733,26 @@ rsc_v1 <- function(...) {
 
 # Testing setup -----------------------------------------------------------
 
+# Connect testing: prefers using Posit's demo PTD server (if you've logged in
+# with rsconnect), else checks CONNECT_SERVER and CONNECT_API_KEY env vars,
+# and if neither are available, skips the tests.
 board_connect_test <- function(...) {
   if (connect_has_ptd()) {
-    board_connect_ptd(...)
+    board_connect(
+      ...,
+      server = "pub.demo.posit.team",
+      auth = "rsconnect",
+      cache = fs::file_temp()
+    )
+  } else if (nzchar(Sys.getenv("CONNECT_API_KEY"))) {
+    board_connect(auth = "envvar", ...)
   } else {
-    board_connect_susan(...)
+    testthat::skip(
+      "board_connect_test() requires CONNECT_API_KEY or Posit's demo PTD server"
+    )
   }
 }
 
-# Use demo.posit.team PTD for local testing
 connect_has_ptd <- function() {
   accounts <- rsconnect::accounts()
   if (is.null(accounts) || nrow(accounts) == 0) {
@@ -750,68 +761,3 @@ connect_has_ptd <- function() {
     "pub.demo.posit.team" %in% accounts$server
   }
 }
-
-board_connect_ptd <- function(...) {
-  if (!connect_has_ptd()) {
-    testthat::skip(
-      "board_connect_ptd() only works with Posit's demo PTD server"
-    )
-  }
-  board_connect(
-    ...,
-    server = "pub.demo.posit.team",
-    auth = "rsconnect",
-    cache = fs::file_temp()
-  )
-}
-
-board_connect_susan <- function(...) {
-  creds <- read_creds()
-  board_connect(
-    server = "http://localhost:3939",
-    account = "susan",
-    key = creds$susan_key
-  )
-}
-board_connect_derek <- function(...) {
-  creds <- read_creds()
-  board_connect(
-    server = "http://localhost:3939",
-    account = "derek",
-    key = creds$derek_key
-  )
-}
-read_creds <- function() {
-  path <- testthat::test_path("creds.rds")
-  if (!file.exists(path)) {
-    testthat::skip(glue("board_connect() tests requires `{path}`"))
-  }
-  readRDS(path)
-}
-add_another_user <- function(board, user_name, content_id) {
-  ## get user GUID for new owner from user_name
-  path <- glue("v1/users/")
-  path <- rsc_path(board, path)
-  auth <- rsc_auth(board, path, "GET")
-  query <- glue("prefix={user_name}")
-  resp <- httr::GET(board$url, path = path, query = query, auth)
-  httr::stop_for_status(resp)
-  res <- httr::content(resp)
-  principal_guid <- res$results[[1]]$guid
-
-  ## add user_name as owner for content at GUID
-  body <- glue(
-    '{{
-  "principal_guid": "{principal_guid}",
-  "principal_type": "user",
-  "role": "owner"
-  }}'
-  )
-
-  path <- glue("v1/content/{content_id}/permissions")
-  path <- rsc_path(board, path)
-  auth <- rsc_auth(board, path, "POST")
-  resp <- httr::POST(board$url, path = path, body = body, auth)
-  httr::stop_for_status(resp)
-  invisible(resp)
-}

.github/workflows/posit-connect.yaml

@@ -47,7 +47,7 @@ connect_auth_headers <- function(key = Sys.getenv("CONNECT_API_KEY")) {
   c(Authorization = paste("Key", key))
 }
 
-
+# Test helpers ------------------------------------------------------------
 vanity_url_test <- function(env = parent.frame()) {
   board <- board_connect_test()
   name <- pin_write(board, 1:10, random_pin_name())
@@ -71,25 +71,15 @@ vanity_url_test <- function(env = parent.frame()) {
 
 board_connect_url_test <- function(...) {
   if (connect_has_ptd()) {
-    board_connect_url_ptd(...)
+    board_connect_url(..., cache = fs::file_temp())
+  } else if (nzchar(Sys.getenv("CONNECT_API_KEY"))) {
+    board_connect_url(
+      ...,
+      headers = connect_auth_headers(Sys.getenv("CONNECT_API_KEY"))
+    )
   } else {
-    board_connect_url_susan(...)
-  }
-}
-
-board_connect_url_ptd <- function(...) {
-  if (!connect_has_ptd()) {
     testthat::skip(
-      "board_connect_url_ptd() only works with Posit's demo server"
+      "board_connect_url_test() requires CONNECT_API_KEY or Posit's demo PTD server"
     )
   }
-  board_connect_url(..., cache = fs::file_temp())
-}
-
-board_connect_url_susan <- function(...) {
-  creds <- read_creds()
-  board_connect_url(
-    ...,
-    headers = connect_auth_headers(creds$susan_key)
-  )
 }

.gitignore

@@ -42,18 +42,6 @@ test_that("can update access_type", {
   expect_equal(rsc_content_info(board, guid)$access_type, "logged_in")
 })
 
-test_that("can write pin created another user", {
-  board1 <- board_connect_susan()
-  name <- local_pin(board1, 1:5)
-  guid <- pin_meta(board1, name)$local$content_id
-  add_another_user(board1, "derek", guid)
-
-  board2 <- board_connect_derek()
-  pin_write(board2, 10:15, name)
-
-  expect_equal(pin_read(board1, name), 10:15)
-})
-
 test_that("can deparse", {
   board <- new_board_v1(
     "pins_board_connect",