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

2.1.1

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 23rd, 2019

Functions in testthat (2.1.1)

MinimalReporter

Test reporter: minimal.

Check reporter: 13 line summary of problems

Test reporter: start recovery.

Test reporter: TAP format.

TeamcityReporter

Test reporter: Teamcity format.

Expectation: does a vector have the specified length?

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

Expectation: does string match a regular expression?

make_expectation

Make an equality test.

ProgressReporter

Test reporter: interactive progress bar of errors.

Negate an expectation

Test reporter: stop on error.

takes_less_than

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

Test package examples

Run code on setup/teardown

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

Manage test reporting

capture_condition

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

Run all tests in specified file

LocationReporter

Test reporter: location

evaluate_promise

Evaluate a promise, capturing all types of output.

Capture output to console

default_reporter

Retrieve the default reporter

SummaryReporter

Test reporter: summary of errors.

Provide human-readable comparison of two objects

The building block of all expect_ functions

describe: a BDD testing language

Compare two directory states.

Expectation: does the object inherit from a given class?

inheritance-expectations

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

logical-expectations

Expectation: is the object true/false?

Capture the state of a directory.

Expectation: does object have names?

equality-expectations

Expectation: is the object equal to a value?

testthat_results

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

expect_setequal

Expectation: do two vectors contain the same values?

expect_known_output

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

Find reporter object given name or object.

Try evaluating an expressing multiple times until it succeeds.

Expectation: is an object NULL?

Expect that a condition holds.

Expectation: does the object have vctr properties?

Mock functions in a package.

reporter-accessors

Get and set active reporter.

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

Test reporter: fail at end.

find_test_scripts

Find the test files.

Locate file in testing directory.

Quasi-labelling

Objects exported from other packages

Test reporter: summary of errors in jUnit XML format.

Tools for testing expectations

testthat-package

R package to make testing fun!

RstudioReporter

Test reporter: RStudio

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

testthat_examples

Retrieve paths to built-in example test files

Use Catch for C++ Unit Testing

comparison-expectations

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

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

Test reporter: gather all errors silently.

Describe the context of a set of tests.

expect_cpp_tests_pass

Test Compiled Code in a Package

expect_invisible

Expectation: does expression return visibily or invisibly?

Construct an expectation object

Default expectations that alway succeed or fail.

Old-style expectations.

output-expectations

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

Run all tests in directory or package

Generate default testing environment.

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

Multi reporter: combine several reporters in one.