Learn R Programming

⚠️There's a newer version (3.2.2) 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

429,916

Version

3.0.3

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Homepage

https://testthat.r-lib.org

Maintainer

Last Published

June 16th, 2021

Functions in testthat (3.0.3)

Multi reporter: combine several reporters in one.

RStudioReporter

Test reporter: RStudio

LocationReporter

Test reporter: location

Test reporter: start recovery.

Check reporter: 13 line summary of problems

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

MinimalReporter

Test reporter: minimal.

ProgressReporter

Test reporter: interactive progress bar of errors.

Test reporter: fail at end.

Manage test reporting

Test reporter: TAP format.

Capture output to console

default_reporter

Retrieve the default reporter

context_start_file

Start test context from a file name

capture_condition

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

Test reporter: summary of errors in jUnit XML format.

evaluate_promise

Evaluate a promise, capturing all types of output.

equality-expectations

Does code return the expected value?

The building block of all expect_ functions

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

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

Test reporter: gather all errors silently.

comparison-expectations

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

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

expect_equivalent

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

Provide human-readable comparison of two objects

Does code return a vector with (given) names?

TeamcityReporter

Test reporter: Teamcity format.

Compare two directory states.

expect_reference

Does code return a reference to the expected object?

Does a string match a regular expression?

expect_output_file

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

Tools for testing expectations

Default expectations that always succeed or fail.

Expect that a condition holds.

Describe the context of a set of tests.

Test reporter: stop on error.

SummaryReporter

Test reporter: summary of errors.

expect_known_output

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

Does code print output to the console?

logical-expectations

Does code return TRUE or FALSE?

Does code return NULL?

Does an object inherit from a given class?

Find reporter object given name or object.

make_expectation

Make an equality test.

Temporarily change the active testthat edition

local_snapshotter

Instantiate local snapshotting context

Does code return a vector with the specified length?

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

describe: a BDD testing language

local_test_context

Locally set options for maximal test reproducibility

is_informative_error

Is an error informative?

Capture the state of a directory.

Construct an expectation object

local_test_directory

Locally set test directory options

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

expect_invisible

Does code return a visible or invisible object?

Locate file in testing directory.

Does code execute silently?

inheritance-expectations

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

expect_less_than

Deprecated numeric comparison functions

expect_setequal

Does code return a vector containing the expected values?

find_test_scripts

Find test files

testthat-package

An R package to make testing fun!

testthat_examples

Retrieve paths to built-in example test files

Determine testing status

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

expect_snapshot

Snapshot testing

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

snapshot_accept

Snapshot management

takes_less_than

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

reporter-accessors

Get and set active reporter.

Run all tests in a single file

Run all tests in a package

Run code before/after tests

Objects exported from other packages

expect_cpp_tests_pass

Do C++ tests past?

Quasi-labelling

Generate default testing environment.

Test package examples

expect_snapshot_file

Snapshot testing for whole files

Old-style expectations.

Run code after all test files

Negate an expectation

testthat_results

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

Run all tests in a directory

Mock functions in a package.

Try evaluating an expressing multiple times until it succeeds.

Use Catch for C++ Unit Testing