Learn R Programming

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

732,279

Version

3.1.5

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Repository

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

Homepage

https://testthat.r-lib.org

Maintainer

Hadley Wickham

Last Published

October 8th, 2022

Functions in testthat (3.1.5)

TeamcityReporter

Test reporter: Teamcity format.

capture_condition

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

Test reporter: gather all errors silently.

Test reporter: TAP format.

Test reporter: stop on error

SummaryReporter

Test reporter: summary of errors.

Capture output to console

Manage test reporting

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

describe: a BDD testing language

auto_test_package

Watches a package for changes, rerunning tests as appropriate.

comparison-expectations

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

equality-expectations

Does code return the expected value?

context_start_file

Start test context from a file name

evaluate_promise

Evaluate a promise, capturing all types of output.

Describe the context of a set of tests.

default_reporter

Retrieve the default reporter

The building block of all expect_ functions

Does a string match a regular expression?

Does code return a vector with (given) names?

expect_no_error

Does code run without error, warning, message, or other condition?

Does code return a vector with the specified length?

Capture the state of a directory.

expect_less_than

Deprecated numeric comparison functions

Provide human-readable comparison of two objects

expect_equivalent

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

Does code execute silently?

expect_snapshot

Snapshot testing

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

inheritance-expectations

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

is_informative_error

Is an error informative?

Does an object inherit from a given class?

Compare two directory states.

expect_known_output

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

Does code return NULL?

expect_snapshot_file

Snapshot testing for whole files

expect_invisible

Does code return a visible or invisible object?

expect_snapshot_output

Snapshot helpers

expect_reference

Does code return a reference to the expected object?

Old-style expectations.

Does code print output to the console?

Quasi-labelling

reporter-accessors

Get and set active reporter.

Find reporter object given name or object.

Objects exported from other packages

find_test_scripts

Find test files

make_expectation

Make an equality test.

Negate an expectation

expect_snapshot_value

Snapshot testing for values

local_test_context

Locally set options for maximal test reproducibility

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

expect_output_file

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

Set maximum number of test failures allowed before aborting the run

Run all tests in a single file

Tools for testing expectations

Expect that a condition holds.

local_snapshotter

Instantiate local snapshotting context

Determine testing status

expect_setequal

Does code return a vector containing the expected values?

Temporarily change the active testthat edition

local_test_directory

Locally set test directory options

logical-expectations

Does code return TRUE or FALSE?

expect_cpp_tests_pass

Do C++ tests past?

takes_less_than

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

Use Catch for C++ Unit Testing

Run all tests in a package

Run code before/after tests

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

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

testthat-package

An R package to make testing fun!

testthat_examples

Retrieve paths to built-in example test files

Mock functions in a package.

Default expectations that always succeed or fail.

snapshot_accept

Snapshot management

Locate file in testing directory.

Test package examples

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

Generate default testing environment.

Construct an expectation object

Run code after all test files

Run all tests in a directory

Try evaluating an expressing multiple times until it succeeds.

testthat_results

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

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.

LocationReporter

Test reporter: location

Multi reporter: combine several reporters in one.

Test reporter: summary of errors in jUnit XML format.

Test reporter: fail at end.

RStudioReporter

Test reporter: RStudio

Check reporter: 13 line summary of problems

Test reporter: start recovery.