Learn R Programming

⚠️There's a newer version (3.2.3) 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("devtools")
devtools::install_github("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

578,511

Version

3.1.7

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

March 12th, 2023

Functions in testthat (3.1.7)

capture_condition

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

Capture output to console

Test reporter: TAP format.

Capture the state of a directory.

describe: a BDD testing language

equality-expectations

Does code return the expected value?

TeamcityReporter

Test reporter: Teamcity format.

comparison-expectations

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

Describe the context of a set of tests.

evaluate_promise

Evaluate a promise, capturing all types of output.

default_reporter

Retrieve the default reporter

context_start_file

Start test context from a file name

Provide human-readable comparison of two objects

Compare two directory states.

The building block of all expect_ functions

Does code return a vector with the specified length?

Does an object inherit from a given class?

expect_known_output

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

expect_less_than

Deprecated numeric comparison functions

expect_no_error

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

expect_invisible

Does code return a visible or invisible object?

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

expect_setequal

Does code return a vector containing the expected values?

expect_reference

Does code return a reference to the expected object?

expect_equivalent

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

Does code return NULL?

expect_snapshot

Snapshot testing

expect_snapshot_file

Snapshot testing for whole files

Does code execute silently?

Does code print output to the console?

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

Does code return a vector with (given) names?

Determine testing status

inheritance-expectations

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

expect_snapshot_output

Snapshot helpers

expect_output_file

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

Expect that a condition holds.

expect_snapshot_value

Snapshot testing for values

Default expectations that always succeed or fail.

Does a string match a regular expression?

Tools for testing expectations

Construct an expectation object

Old-style expectations.

Find reporter object given name or object.

find_test_scripts

Find test files

Negate an expectation

Temporarily change the active testthat edition

local_mocked_bindings

reporter-accessors

Get and set active reporter.

is_informative_error

Is an error informative?

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

expect_cpp_tests_pass

Do C++ tests past?

logical-expectations

Does code return TRUE or FALSE?

local_snapshotter

Instantiate local snapshotting context

takes_less_than

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

Run code before/after tests

make_expectation

Make an equality test.

snapshot_accept

Snapshot management

Run code after all test files

Run all tests in a package

Generate default testing environment.

local_test_context

Locally set options for maximal test reproducibility

Test package examples

Run all tests in a single file

Quasi-labelling

Set maximum number of test failures allowed before aborting the run

Compute a digest of a filename, returning NA if the file doesn't exist.

Mock functions in a package.

Objects exported from other packages

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

local_test_directory

Locally set test directory options

Use Catch for C++ Unit Testing

testthat-package

An R package to make testing fun!

Try evaluating an expressing multiple times until it succeeds.

Locate file in testing directory.

testthat_results

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

testthat_examples

Retrieve paths to built-in example test files

Run all tests in a directory

ProgressReporter

Test reporter: interactive progress bar of errors.

LocationReporter

Test reporter: location

Check reporter: 13 line summary of problems

Test reporter: start recovery.

Test reporter: summary of errors in jUnit XML format.

MinimalReporter

Test reporter: minimal.

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

RStudioReporter

Test reporter: RStudio

Multi reporter: combine several reporters in one.

Test reporter: fail at end.

SummaryReporter

Test reporter: summary of errors.

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

Test reporter: stop on error

Test reporter: gather all errors silently.

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

Manage test reporting