File: is_testing.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 (36 lines) | stat: -rw-r--r-- 1,152 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/test-env.R
\name{is_testing}
\alias{is_testing}
\alias{is_parallel}
\alias{is_checking}
\alias{is_snapshot}
\alias{testing_package}
\title{Determine testing status}
\usage{
is_testing()

is_parallel()

is_checking()

is_snapshot()

testing_package()
}
\description{
These functions help you determine if you code is running in a particular
testing context:
\itemize{
\item \code{is_testing()} is \code{TRUE} inside a test.
\item \code{is_snapshot()} is \code{TRUE} inside a snapshot test
\item \code{is_checking()} is \code{TRUE} inside of \verb{R CMD check} (i.e. by \code{\link[=test_check]{test_check()}}).
\item \code{is_parallel()} is \code{TRUE} if the tests are run in parallel.
\item \code{testing_package()} gives name of the package being tested.
}

A common use of these functions is to compute a default value for a \code{quiet}
argument with \code{is_testing() && !is_snapshot()}. In this case, you'll
want to avoid an run-time dependency on testthat, in which case you should
just copy the implementation of these functions into a \code{utils.R} or similar.
}