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

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

July 22nd, 2019

Functions in testthat (2.2.0)

Multi reporter: combine several reporters in one.

Test reporter: summary of errors in jUnit XML format.

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

ProgressReporter

Test reporter: interactive progress bar of errors.

Test reporter: fail at end.

MinimalReporter

Test reporter: minimal.

Check reporter: 13 line summary of problems

Manage test reporting

LocationReporter

Test reporter: location

Test reporter: start recovery.

Test reporter: TAP format.

Describe the context of a set of tests.

comparison-expectations

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

Test reporter: stop on error.

SummaryReporter

Test reporter: summary of errors.

default_reporter

Retrieve the default reporter

describe: a BDD testing language

expect_invisible

Expectation: does expression return visibily or invisibly?

expect_cpp_tests_pass

Test Compiled Code in a Package

Capture output to console

capture_condition

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

TeamcityReporter

Test reporter: Teamcity format.

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

Expectation: does object have names?

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?

Expectation: does the object inherit from a given class?

expect_known_output

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

make_expectation

Make an equality test.

evaluate_promise

Evaluate a promise, capturing all types of output.

The building block of all expect_ functions

Expectation: is an object NULL?

RstudioReporter

Test reporter: RStudio

Expect that a condition holds.

Expectation: does the object have vctr properties?

Run all tests in specified file

Run code on setup/teardown

Use Catch for C++ Unit Testing

Test package examples

takes_less_than

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

Test reporter: gather all errors silently.

Compare two directory states.

Provide human-readable comparison of two objects

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

expect_setequal

Expectation: do two vectors contain the same values?

equality-expectations

Expectation: is the object equal to a value?

Try evaluating an expressing multiple times until it succeeds.

Objects exported from other packages

Quasi-labelling

testthat_results

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

Capture the state of a directory.

Negate an expectation

output-expectations

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

Old-style expectations.

testthat-package

R package to make testing fun!

Tools for testing expectations

Expectation: does string match a regular expression?

Expectation: does a vector have the specified length?

Find reporter object given name or object.

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

Mock functions in a package.

testthat_examples

Retrieve paths to built-in example test files

Default expectations that always succeed or fail.

Construct an expectation object

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

Run all tests in directory or package

Generate default testing environment.

reporter-accessors

Get and set active reporter.

Locate file in testing directory.

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

find_test_scripts

Find the test files.