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

2.1.0

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Homepage

http://testthat.r-lib.org

Maintainer

Hadley Wickham

Last Published

April 22nd, 2019

Functions in testthat (2.1.0)

Manage test reporting

RstudioReporter

Test reporter: RStudio

evaluate_promise

Evaluate a promise, capturing all types of output.

Test reporter: gather all errors silently.

MinimalReporter

Test reporter: minimal.

Multi reporter: combine several reporters in one.

Test reporter: TAP format.

TeamcityReporter

Test reporter: Teamcity format.

Provide human-readable comparison of two objects

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

The building block of all expect_ functions

LocationReporter

Test reporter: location

expect_setequal

Expectation: do two vectors contain the same values?

comparison-expectations

Expectation: is returned value less or greater than specified value?

Tools for testing expectations

Describe the context of a set of tests.

Find reporter object given name or object.

find_test_scripts

Find the test files.

Expectation: does a vector have the specified length?

Compare two directory states.

Expectation: does string match a regular expression?

Expectation: is an object NULL?

Old-style expectations.

SummaryReporter

Test reporter: summary of errors.

Test reporter: stop on error.

Expectation: does the object inherit from a given class?

Quasi-labelling

Objects exported from other packages

expect_known_output

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

Run all tests in directory or package

output-expectations

Expectation: does code produce output/message/warning/error?

Test reporter: fail at end.

Generate default testing environment.

default_reporter

Retrieve the default reporter

Locate file in testing directory.

Construct an expectation object

describe: a BDD testing language

make_expectation

Make an equality test.

Default expectations that alway succeed or fail.

Test reporter: summary of errors in jUnit XML format.

Negate an expectation

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

inheritance-expectations

Expectation: does the object inherit from a S3 or S4 class, or is it a base type?

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

expect_cpp_tests_pass

Test Compiled Code in a Package

Test package examples

logical-expectations

Expectation: is the object true/false?

expect_invisible

Expectation: does expression return visibily or invisibly?

Run all tests in specified file

reporter-accessors

Get and set active reporter.

Expect that a condition holds.

Expectation: does the object have vctr properties?

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

takes_less_than

Expectation: does expression take less than a fixed amount of time to run?

testthat-package

R package to make testing fun!

Run code on setup/teardown

testthat_results

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

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

testthat_examples

Retrieve paths to built-in example test files

Try evaluating an expressing multiple times until it succeeds.

Mock functions in a package.

Use Catch for C++ Unit Testing

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

Check reporter: 13 line summary of problems

Test reporter: start recovery.

capture_condition

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

Capture output to console

ProgressReporter

Test reporter: interactive progress bar of errors.

Expectation: does object have names?

Capture the state of a directory.

equality-expectations

Expectation: is the object equal to a value?