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.0.0

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

October 31st, 2020

Functions in testthat (3.0.0)

Check reporter: 13 line summary of problems

MinimalReporter

Test reporter: minimal.

ProgressReporter

Test reporter: interactive progress bar of errors.

Test reporter: summary of errors in jUnit XML format.

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

Multi reporter: combine several reporters in one.

Test reporter: start recovery.

Manage test reporting

Test reporter: fail at end.

RstudioReporter

Test reporter: RStudio

capture_condition

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

Test reporter: TAP format.

The building block of all expect_ functions

Determine testing status

expect_equivalent

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

TeamcityReporter

Test reporter: Teamcity format.

Does code return a vector with the specified length?

comparison-expectations

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

Temporarily change the active testthat edition

Describe the context of a set of tests.

expect_less_than

Deprecated numeric comparison functions

Does code return NULL?

Capture output to console

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

LocationReporter

Test reporter: location

describe: a BDD testing language

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

context_start_file

Start test context from a file name

Test reporter: stop on error.

SummaryReporter

Test reporter: summary of errors.

default_reporter

Retrieve the default reporter

Capture the state of a directory.

expect_cpp_tests_pass

Do C++ tests past?

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

Does a string match a regular expression?

Expect that a condition holds.

Find reporter object given name or object.

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

Does code return a vector with (given) names?

logical-expectations

Does code return TRUE or FALSE?

local_test_directory

Locally set test directory options

find_test_scripts

Find test files

Run all tests in a single file

Test package examples

Provide human-readable comparison of two objects

Compare two directory states.

expect_invisible

Does code return a visible or invisible object?

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

testthat_examples

Retrieve paths to built-in example test files

testthat_results

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

Does code print output to the console?

Default expectations that always succeed or fail.

takes_less_than

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

Test reporter: gather all errors silently.

expect_known_output

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

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

Does an object inherit from a given class?

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

Construct an expectation object

expect_reference

Does code return a reference to the expected object?

evaluate_promise

Evaluate a promise, capturing all types of output.

equality-expectations

Does code return the expected value?

expect_snapshot_file

Snapshot testing for whole files

Does code execute silently?

Objects exported from other packages

Run all tests in a directory

expect_setequal

Does code return a vector containing the expected values?

Generate default testing environment.

reporter-accessors

Get and set active reporter.

Use Catch for C++ Unit Testing

testthat-package

An R package to make testing fun!

Mock functions in a package.

Try evaluating an expressing multiple times until it succeeds.

expect_snapshot

Snapshot testing

local_test_context

Locally set options for maximal test reproducibility

local_snapshotter

Instantiate local snapshotting context

snapshot_accept

Snapshot management

Quasi-labelling

inheritance-expectations

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

is_informative_error

Is an error informative?

Tools for testing expectations

Old-style expectations.

make_expectation

Make an equality test.

Negate an expectation

Run code before/after tests

Run code after all test files

Locate file in testing directory.

Run all tests in a package