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

467,612

Version

3.0.4

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

July 1st, 2021

Functions in testthat (3.0.4)

Check reporter: 13 line summary of problems

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

Test reporter: fail at end.

Test reporter: summary of errors in jUnit XML format.

LocationReporter

Test reporter: location

Test reporter: TAP format.

TeamcityReporter

Test reporter: Teamcity format.

Provide human-readable comparison of two objects

Test reporter: start recovery.

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

SummaryReporter

Test reporter: summary of errors.

Compare two directory states.

Manage test reporting

capture_condition

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

expect_invisible

Does code return a visible or invisible object?

comparison-expectations

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

Describe the context of a set of tests.

Test reporter: gather all errors silently.

Capture output to console

Does an object inherit from a given class?

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?

The building block of all expect_ functions

describe: a BDD testing language

default_reporter

Retrieve the default reporter

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

expect_equivalent

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

Capture the state of a directory.

Construct an expectation object

expect_setequal

Does code return a vector containing the expected values?

expect_snapshot

Snapshot testing

local_test_context

Locally set options for maximal test reproducibility

Does code execute silently?

local_test_directory

Locally set test directory options

is_informative_error

Is an error informative?

Tools for testing expectations

Test package examples

expect_snapshot_file

Snapshot testing for whole files

inheritance-expectations

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

find_test_scripts

Find test files

Generate default testing environment.

Locate file in testing directory.

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

Expect that a condition holds.

reporter-accessors

Get and set active reporter.

expect_less_than

Deprecated numeric comparison functions

Does code return a vector with the specified length?

Does code return NULL?

Determine testing status

Use Catch for C++ Unit Testing

snapshot_accept

Snapshot management

Old-style expectations.

Does code print output to the console?

Negate an expectation

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

Run code after all test files

expect_cpp_tests_pass

Do C++ tests past?

Default expectations that always succeed or fail.

MinimalReporter

Test reporter: minimal.

testthat-package

An R package to make testing fun!

Run all tests in a directory

Quasi-labelling

Run all tests in a package

Run all tests in a single file

Multi reporter: combine several reporters in one.

Find reporter object given name or object.

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

Objects exported from other packages

testthat_examples

Retrieve paths to built-in example test files

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

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?

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

Mock functions in a package.

Does code return a vector with (given) names?

expect_output_file

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

expect_reference

Does code return a reference to the expected object?

Temporarily change the active testthat edition

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?

make_expectation

Make an equality test.

Run code before/after tests

Try evaluating an expressing multiple times until it succeeds.

testthat_results

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

ProgressReporter

Test reporter: interactive progress bar of errors.

Test reporter: stop on error.

RStudioReporter

Test reporter: RStudio