OpenParable
Skip to content
← Back to skills

Golem Run Tests

Testing & Quality
golem-run-tests

Golem Run Tests is an Agent Skill for testing & quality published in the ThinkR-open/golem repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Run tests for a golem Shiny application. Triggers on: - "run the tests" - "test my golem app" - "run devtools test" Do not trigger on: - when the user is not working inside a golem app

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ThinkR-open/golem/blob/HEAD/inst/agent-skills/skills/golem-run-tests/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/golem-run-tests, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Run Tests

You are helping a user run tests for their golem Shiny application.

Running Tests

Run the following command to execute all tests:

Rscript -e "devtools::test()"

Testing Structure

Tests are organized in tests/testthat/:

  • Test files mirror R/ files: test-<filename>.R
  • Use test_that("description", { ... }) blocks
  • Each test should be independent and hermetic

Test Best Practices

Hermetic Tests

  • Each test_that() block should set up its own data inline
  • Minimize top-level code outside test_that() blocks
  • Tests should pass in any order and in isolation

Temporary State

  • Use withr::local_*() for temporary changes:
    • withr::local_options()
    • withr::local_envvar()
    • withr::local_dir()
  • Use withr::local_tempfile() or withr::local_tempdir() for temporary files
  • Never write directly to home or working directories

Test Data

  • Store static test data in tests/testthat/fixtures/
  • Load with readRDS(test_path("fixtures", "file.rds"))
  • Keep fixtures organized and documented

Testing Reactive Code

  • Test business logic outside of Shiny context when possible
  • Use testServer() for testing Shiny modules
  • Mock external dependencies when needed

Assertions

Use testthat functions:

  • expect_true(), expect_false()
  • expect_equal(), expect_identical()
  • expect_error() with class = "error_class" parameter
  • expect_warning(), expect_message()
  • expect_silent()

Skipping Tests

For slow or network-dependent tests:

test_that("slow test", {
  skip_on_cran()
  # test code
})

Test Coverage

Aim for high code coverage:

  • Run covr::report() to see coverage
  • Test both happy path and error cases
  • Test boundary conditions
  • Test interaction between modules

Command Line Options

Run specific test files:

Rscript -e "devtools::test(filter = 'mod_name')"

Run tests with coverage:

Rscript -e "covr::report()"