jumpingrivers / audit.connect

audit.connect

This checks that a variety of applications can be deployed to a Posit Connect Server.

Installation

To install the R package, run

install.packages("audit.connect")

For python based deployment, the python package, rsconnect-python is required

pip install rsconnect-python

Usage

Running the test is straightforward

library("audit.connect")
check(server = "https://www.connect.server.name/",
      token = "API_TOKEN")

Alternatively, you can set environmental variables, CONNECT_SERVER and CONNECT_API_KEY in your .Renviron file.

Config file

Experimental. You can skip deployment tests, by setting the appropriate value in config-uat.yml. This file can be auto-generated via

create_config()

If a test is missing in the config, the default value is TRUE.

Creating a test

Tests are R6 classes. To be automatically detected, the class name must start with check_. If you copy/paste the following code into R/example.R, when you run check(), the test is automatically detected and run. Likewise, create_config()

#' @export
check_example = R6::R6Class(
  "check_example",
  inherit = uatBase::base_check,
  # A function is passed to checker()
  # This runs the test, detects errors, and logs the result
  public = list(
    #' @description Runs a UAT check
    check = function(account = NULL) {
      private$checker(example_test())
      return(invisible(NULL))
    }
  ),
  # Multiple classes can have the same group.
  # But context/short should be unique
  private = list(
    context = "Human description",
    short = "config_variable",
    group = "config_group"
  )
)

example_test = function() {
  return(TRUE)
}