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

478,343

Version

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

November 5th, 2019

Functions in testthat (2.3.0)

Test reporter: fail at end.

Manage test reporting

Multi reporter: combine several reporters in one.

Test reporter: start recovery.

Test reporter: summary of errors in jUnit XML format.

Check reporter: 13 line summary of problems

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

ProgressReporter

Test reporter: interactive progress bar of errors.

MinimalReporter

Test reporter: minimal.

RstudioReporter

Test reporter: RStudio

capture_condition

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

Expectation: does a vector have the specified length?

Default expectations that always succeed or fail.

Test reporter: gather all errors silently.

Provide human-readable comparison of two objects

Compare two directory states.

Construct an expectation object

expect_known_output

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

Test reporter: TAP format.

TeamcityReporter

Test reporter: Teamcity format.

Capture output to console

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

default_reporter

Retrieve the default reporter

comparison-expectations

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

expect_invisible

Expectation: does expression return visibily or invisibly?

Find reporter object given name or object.

Quasi-labelling

Describe the context of a set of tests.

Expectation: does the object inherit from a given class?

find_test_scripts

Find the test files.

Objects exported from other packages

takes_less_than

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

Run code on setup/teardown

evaluate_promise

Evaluate a promise, capturing all types of output.

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

The building block of all expect_ functions

Capture the state of a directory.

Use Catch for C++ Unit Testing

LocationReporter

Test reporter: location

Test reporter: stop on error.

expect_setequal

Expectation: do two vectors contain the same values?

reporter-accessors

Get and set active reporter.

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

Expectation: does code print output to the console?

inheritance-expectations

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

expect_cpp_tests_pass

Expectation: do C++ tests past?

Expectation: does code throw error or other condition?

equality-expectations

Expectation: is the object equal to a value?

describe: a BDD testing language

Expectation: does string match a regular expression?

SummaryReporter

Test reporter: summary of errors.

Expectation: does code produce warnings or messages?

Tools for testing expectations

is_informative_error

Is an error informative?

Expectation: is the code silent?

Expectation: does object have names?

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

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

Expectation: is an object NULL?

Negate an expectation

testthat-package

R package to make testing fun!

Test package examples

Run all tests in specified file

logical-expectations

Expectation: is the object true/false?

testthat_examples

Retrieve paths to built-in example test files

make_expectation

Make an equality test.

Expect that a condition holds.

Run all tests in directory or package

Expectation: does the object have vctr properties?

Old-style expectations.

Generate default testing environment.

Locate file in testing directory.

testthat_results

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

Try evaluating an expressing multiple times until it succeeds.

Mock functions in a package.