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

478,343

Version

3.0.2

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Homepage

https://testthat.r-lib.org

Maintainer

Hadley Wickham

Last Published

February 14th, 2021

Functions in testthat (3.0.2)

Test reporter: fail at end.

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

Check reporter: 13 line summary of problems

RStudioReporter

Test reporter: RStudio

Test reporter: summary of errors in jUnit XML format.

Test reporter: start recovery.

LocationReporter

Test reporter: location

MinimalReporter

Test reporter: minimal.

ProgressReporter

Test reporter: interactive progress bar of errors.

Test reporter: stop on error.

Manage test reporting

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

describe: a BDD testing language

Capture the state of a directory.

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

Test reporter: TAP format.

Does code return a vector with the specified length?

TeamcityReporter

Test reporter: Teamcity format.

Multi reporter: combine several reporters in one.

capture_condition

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

expect_less_than

Deprecated numeric comparison functions

expect_output_file

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

Test reporter: gather all errors silently.

is_informative_error

Is an error informative?

Determine testing status

context_start_file

Start test context from a file name

Objects exported from other packages

default_reporter

Retrieve the default reporter

Quasi-labelling

expect_reference

Does code return a reference to the expected object?

Provide human-readable comparison of two objects

SummaryReporter

Test reporter: summary of errors.

equality-expectations

Does code return the expected value?

evaluate_promise

Evaluate a promise, capturing all types of output.

Does a string match a regular expression?

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

reporter-accessors

Get and set active reporter.

expect_cpp_tests_pass

Do C++ tests past?

Construct an expectation object

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

Does code return a vector with (given) names?

expect_invisible

Does code return a visible or invisible object?

Capture output to console

comparison-expectations

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

snapshot_accept

Snapshot management

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

testthat-package

An R package to make testing fun!

testthat_results

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

Describe the context of a set of tests.

testthat_examples

Retrieve paths to built-in example test files

The building block of all expect_ functions

expect_setequal

Does code return a vector containing the expected values?

Does code execute silently?

expect_equivalent

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

Does code print output to the console?

Try evaluating an expressing multiple times until it succeeds.

Does code return NULL?

Compare two directory states.

Default expectations that always succeed or fail.

Tools for testing expectations

Expect that a condition holds.

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

Find reporter object given name or object.

Does an object inherit from a given class?

Negate an expectation

Old-style expectations.

Temporarily change the active testthat edition

local_snapshotter

Instantiate local snapshotting context

takes_less_than

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

Run all tests in a single file

Run all tests in a package

make_expectation

Make an equality test.

expect_snapshot_file

Snapshot testing for whole files

logical-expectations

Does code return TRUE or FALSE?

expect_snapshot

Snapshot testing

find_test_scripts

Find test files

expect_known_output

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

Run code before/after tests

inheritance-expectations

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

Use Catch for C++ Unit Testing

local_test_directory

Locally set test directory options

Generate default testing environment.

local_test_context

Locally set options for maximal test reproducibility

Locate file in testing directory.

Run all tests in a directory

Run code after all test files

Test package examples

Mock functions in a package.

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