File: expect_success.Rd

package info (click to toggle)
r-cran-testthat 3.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,452 kB
  • sloc: cpp: 9,261; ansic: 37; sh: 14; makefile: 5
file content (43 lines) | stat: -rw-r--r-- 1,155 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/expect-self-test.R
\name{expect_success}
\alias{expect_success}
\alias{expect_no_success}
\alias{expect_failure}
\alias{expect_snapshot_failure}
\alias{expect_no_failure}
\alias{show_failure}
\title{Tools for testing expectations}
\usage{
expect_success(expr)

expect_no_success(expr)

expect_failure(expr, message = NULL, ...)

expect_snapshot_failure(expr)

expect_no_failure(expr)

show_failure(expr)
}
\arguments{
\item{expr}{Code to evalute}

\item{message}{Check that the failure message matches this regexp.}

\item{...}{Other arguments passed on to \code{\link[=expect_match]{expect_match()}}.}
}
\description{
\itemize{
\item \code{expect_sucess()} and \code{expect_failure()} check that there's at least
one success or failure respectively.
\item \code{expect_snapshot_failure()} records the failure message so that you can
manually check that it is informative.
\item \code{expect_no_success()} and \code{expect_no_failure()} check that are no
successes or failures.
}

Use \code{show_failure()} in examples to print the failure message without
throwing an error.
}