Learn R Programming

⚠️There's a newer version (3.3.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("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

732,279

Version

3.0.1

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

December 17th, 2020

Functions in testthat (3.0.1)

Test reporter: start recovery.

RStudioReporter

Test reporter: RStudio

ProgressReporter

Test reporter: interactive progress bar of errors.

Multi reporter: combine several reporters in one.

MinimalReporter

Test reporter: minimal.

Check reporter: 13 line summary of problems

Test reporter: fail at end.

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

Test reporter: summary of errors in jUnit XML format.

LocationReporter

Test reporter: location

SummaryReporter

Test reporter: summary of errors.

Test reporter: stop on error.

default_reporter

Retrieve the default reporter

capture_condition

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

Compare two directory states.

Provide human-readable comparison of two objects

context_start_file

Start test context from a file name

Does an object inherit from a given class?

Manage test reporting

expect_known_output

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

equality-expectations

Does code return the expected value?

The building block of all expect_ functions

Capture output to console

Test reporter: gather all errors silently.

Does code print output to the console?

describe: a BDD testing language

Capture the state of a directory.

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

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

Does code return a vector with the specified length?

expect_equivalent

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

expect_less_than

Deprecated numeric comparison functions

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

Does code return NULL?

expect_output_file

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

Default expectations that always succeed or fail.

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

Use Catch for C++ Unit Testing

expect_snapshot

Snapshot testing

Negate an expectation

expect_reference

Does code return a reference to the expected object?

Find reporter object given name or object.

Old-style expectations.

expect_snapshot_file

Snapshot testing for whole files

expect_cpp_tests_pass

Do C++ tests past?

Does a string match a regular expression?

reporter-accessors

Get and set active reporter.

expect_setequal

Does code return a vector containing the expected values?

Does code execute silently?

Determine testing status

Does code return a vector with (given) names?

is_informative_error

Is an error informative?

TeamcityReporter

Test reporter: Teamcity format.

Test reporter: TAP format.

Quasi-labelling

find_test_scripts

Find test files

comparison-expectations

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

evaluate_promise

Evaluate a promise, capturing all types of output.

Locate file in testing directory.

Objects exported from other packages

Run code before/after tests

takes_less_than

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

snapshot_accept

Snapshot management

inheritance-expectations

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

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

Describe the context of a set of tests.

expect_invisible

Does code return a visible or invisible object?

local_snapshotter

Instantiate local snapshotting context

Expect that a condition holds.

Tools for testing expectations

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

logical-expectations

Does code return TRUE or FALSE?

Construct an expectation object

Temporarily change the active testthat edition

local_test_context

Locally set options for maximal test reproducibility

Run all tests in a single file

local_test_directory

Locally set test directory options

Run all tests in a package

Test package examples

Generate default testing environment.

testthat-package

An R package to make testing fun!

make_expectation

Make an equality test.

Run code after all test files

testthat_examples

Retrieve paths to built-in example test files

Mock functions in a package.

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

testthat_results

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

Run all tests in a directory

Try evaluating an expressing multiple times until it succeeds.