Learn R Programming

⚠️There's a newer version (3.2.1.1) of this package.Take me there.

testthat

Overview

Testing your code can be painful and tedious, but it greatly increases the quality of your code. testthat tries to make testing as fun as possible, so that you get a visceral satisfaction from writing tests. Testing should be addictive, so you do it all the time. To make that happen, testthat:

Provides functions that make it easy to describe what you expect a function to do, including catching errors, warnings, and messages.
Easily integrates in your existing workflow, whether it’s informal testing on the command line, building test suites, or using R CMD check.
Displays test progress visually, showing a pass, fail, or error for every expectation. If you’re using the terminal or a recent version of RStudio, it’ll even colour the output.

testthat draws inspiration from the xUnit family of testing packages, as well as from many of the innovative ruby testing libraries, like rspec, testy, bacon and cucumber.

testthat is the most popular unit testing package for R and is used by thousands of CRAN packages.

If you’re not familiar with testthat, the testing chapter in R packages gives a good overview, along with workflow advice and concrete examples.

Installation

# Install the released version from CRAN
install.packages("testthat")

# Or the development version from GitHub:
# install.packages("pak")
pak::pak("r-lib/testthat")

Usage

The easiest way to get started is with usethis. Assuming you’re in a package directory, just run usethis::use_test("name") to create a test file, and set up all the other infrastructure you need. If you’re using RStudio, press Cmd/Ctrl + Shift + T (or run devtools::test() if not) to run all the tests in a package.

Copy Link

Version

Install

install.packages('testthat')

Monthly Downloads

392,282

Version

3.2.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/r-lib/testthat

Homepage

https://testthat.r-lib.org

Maintainer

Last Published

December 2nd, 2023

Functions in testthat (3.2.1)

Provide human-readable comparison of two objects

comparison-expectations

Does code return a number greater/less than the expected value?

Does an object inherit from a given class?

describe: a BDD testing language

TeamcityReporter

Test reporter: Teamcity format.

The building block of all expect_ functions

Capture the state of a directory.

expect_equivalent

Is an object equal to the expected value, ignoring attributes?

context_start_file

Start test context from a file name

expect_known_output

Expectations: is the output or the value equal to a known good value?

default_reporter

Retrieve the default reporter

expect_invisible

Does code return a visible or invisible object?

Does code return a vector with the specified length?

expect_snapshot

Snapshot testing

Does code throw an error, warning, message, or other condition?

Describe the context of a set of tests.

Does code execute silently?

expect_less_than

Deprecated numeric comparison functions

Compare two directory states.

Does code return a vector with (given) names?

expect_no_error

Does code run without error, warning, message, or other condition?

Does code print output to the console?

Does a string match a regular expression?

Does code return NULL?

equality-expectations

Does code return the expected value?

evaluate_promise

Evaluate a promise, capturing all types of output.

expect_setequal

Does code return a vector containing the expected values?

Default expectations that always succeed or fail.

expect_snapshot_value

Snapshot testing for values

expect_reference

Does code return a reference to the expected object?

Construct an expectation object

expect_snapshot_file

Snapshot testing for whole files

expect_output_file

Expectations: is the output or the value equal to a known good value?

Find reporter object given name or object.

find_test_scripts

Find test files

logical-expectations

Does code return TRUE or FALSE?

make_expectation

Make an equality test.

Quasi-labelling

expect_snapshot_output

Snapshot helpers

Does code return a vector with the expected size and/or prototype?

Determine testing status

snapshot_accept

Snapshot management

local_snapshotter

Instantiate local snapshotting context

Tools for testing expectations

Source a file, directory of files, or various important subsets

local_mocked_bindings

Expect that a condition holds.

Temporarily change the active testthat edition

set_state_inspector

State inspected

Run code after all test files

Locate a file in the testing directory

Run all tests in a directory

Old-style expectations.

Set maximum number of test failures allowed before aborting the run

Objects exported from other packages

Negate an expectation

Superseded skip functions

takes_less_than

Does code take less than the expected amount of time to run?

inheritance-expectations

Does code return an object inheriting from the expected base type, S3 class, or S4 class?

Mock functions in a package.

Run tests in a single file

Run all tests in a package

Generate default testing environment.

local_test_context

Locally set options for maximal test reproducibility

is_informative_error

Is an error informative?

local_test_directory

Locally set test directory options

Run code before/after tests

Watch a directory for changes (additions, deletions & modifications).

expect_cpp_tests_pass

Do C++ tests past?

testthat_examples

Retrieve paths to built-in example test files

reporter-accessors

Get and set active reporter.

testthat_tolerance

Default numeric tolerance

testthat-package

An R package to make testing fun!

Test package examples

testthat_results

Create a testthat_results object from the test results as stored in the ListReporter results field.

Use Catch for C++ Unit Testing

Try evaluating an expressing multiple times until it succeeds.

RStudioReporter

Test reporter: RStudio

MinimalReporter

Test reporter: minimal.

List reporter: gather all test results along with elapsed time and file information.

Check reporter: 13 line summary of problems

Multi reporter: combine several reporters in one.

Test reporter: summary of errors in jUnit XML format.

Test reporter: start recovery.

Test reporter: fail at end.

LocationReporter

Test reporter: location

ProgressReporter

Test reporter: interactive progress bar of errors.

capture_condition

Capture conditions, including messages, warnings, expectations, and errors.

Capture output to console

Test reporter: TAP format.

Test reporter: stop on error

SummaryReporter

Test reporter: summary of errors.

Test reporter: gather all errors silently.

Manage test reporting

Watches code and tests for changes, rerunning tests as appropriate.

auto_test_package

Watches a package for changes, rerunning tests as appropriate.