Learn R Programming

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

442,445

Version

3.1.4

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

April 26th, 2022

Functions in testthat (3.1.4)

Check reporter: 13 line summary of problems

LocationReporter

Test reporter: location

MinimalReporter

Test reporter: minimal.

ProgressReporter

Test reporter: interactive progress bar of errors.

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

Multi reporter: combine several reporters in one.

Test reporter: start recovery.

Test reporter: fail at end.

RStudioReporter

Test reporter: RStudio

Test reporter: summary of errors in jUnit XML format.

capture_condition

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

TeamcityReporter

Test reporter: Teamcity format.

Test reporter: TAP format.

Manage test reporting

describe: a BDD testing language

Test reporter: gather all errors silently.

Capture the state of a directory.

Provide human-readable comparison of two objects

Compare two directory states.

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

Capture output to console

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

context_start_file

Start test context from a file name

default_reporter

Retrieve the default reporter

Does code return a vector with (given) names?

Does a string match a regular expression?

expect_output_file

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

expect_reference

Does code return a reference to the expected object?

SummaryReporter

Test reporter: summary of errors.

Describe the context of a set of tests.

Test reporter: stop on error

comparison-expectations

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

The building block of all expect_ functions

expect_invisible

Does code return a visible or invisible object?

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

Tools for testing expectations

is_informative_error

Is an error informative?

Does code return a vector with the specified length?

Does code print output to the console?

Does code return NULL?

expect_less_than

Deprecated numeric comparison functions

expect_snapshot

Snapshot testing

Determine testing status

expect_equivalent

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

reporter-accessors

Get and set active reporter.

local_snapshotter

Instantiate local snapshotting context

Quasi-labelling

Expect that a condition holds.

Temporarily change the active testthat edition

snapshot_accept

Snapshot management

equality-expectations

Does code return the expected value?

Objects exported from other packages

Default expectations that always succeed or fail.

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

expect_cpp_tests_pass

Do C++ tests past?

Old-style expectations.

Negate an expectation

testthat_examples

Retrieve paths to built-in example test files

testthat-package

An R package to make testing fun!

logical-expectations

Does code return TRUE or FALSE?

find_test_scripts

Find test files

expect_snapshot_file

Snapshot testing for whole files

inheritance-expectations

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

takes_less_than

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

expect_known_output

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

evaluate_promise

Evaluate a promise, capturing all types of output.

Does an object inherit from a given class?

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

Does code execute silently?

expect_setequal

Does code return a vector containing the expected values?

Find reporter object given name or object.

make_expectation

Make an equality test.

Construct an expectation object

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

Run code after all test files

testthat_results

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

Locate file in testing directory.

Generate default testing environment.

Try evaluating an expressing multiple times until it succeeds.

Test package examples

Run all tests in a directory

Run all tests in a single file

Run code before/after tests

Run all tests in a package

local_test_directory

Locally set test directory options

local_test_context

Locally set options for maximal test reproducibility

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

Mock functions in a package.

Use Catch for C++ Unit Testing