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 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
|
#' @rdname tinytests
#' @param object a \code{tinytests} object
#' @return For \code{summary} a \code{\link{table}} object
#' @export
summary.tinytests <- function(object, ...){
if (length(object)==0){
return(
as.table(array(0, dim=c(1,3),
dimnames=list(File="Total", c("Results", "fails","passes"))))
)
}
result <- factor(sapply(object, c)
, levels=c(FALSE, TRUE, NA)
, labels=c("fails","passes","sidefx")
, exclude=character(0))
file <- sapply(object, function(x) attr(x,"file"))
if (length(object) > 0) file <- basename(file)
tab <- table(File = file, result)
tab <- cbind(tab, Results = rowSums(tab))
tab <- rbind(tab, Total = colSums(tab))
tab <- as.table(tab[,c(4,1:3),drop=FALSE])
# remove side-effect column if it has only zeros
if ( sum(tab[,4]) == 0 ) tab <- tab[,-4]
n <- dimnames(tab)
names(n) <- c("File","")
tab <- as.table(tab)
dimnames(tab) <- n
tab
}
#' @rdname tinytests
#' @return For \code{all_pass}, \code{any_pass}, \code{all_fail}, \code{any_fail}:
#' a single \code{logical}
#' @export
all_pass <- function(x){
stopifnot(inherits(x,'tinytests'))
all( sapply(x, function(d) isTRUE(d) || is.na(d)) )
}
#' @rdname tinytests
#' @export
any_pass <- function(x){
stopifnot(inherits(x,'tinytests'))
any( sapply(x, function(d) isTRUE(d) || is.na(d)) )
}
#' @rdname tinytests
#' @export
all_fail <- function(x){
stopifnot(inherits(x,'tinytests'))
all( sapply(x, function(d) isFALSE(d) || is.na(d)) )
}
#' @rdname tinytests
#' @export
any_fail <- function(x){
stopifnot(inherits(x,'tinytests'))
any( sapply(x, function(d) isFALSE(d) || is.na(d)) )
}
#' Tinytests object
#'
#' An object of class \code{tinytests} (note: plural) results
#' from running multiple tests from script. E.g. by running
#' \code{\link{run_test_file}}.
#'
#'
#' @aliases tinytests
#'
#' @param i an index
#' @param x a \code{tinytests} object
#'
#' @return For \code{`[.tinytests`} a \code{tinytests} object.
#'
#' @export
#' @rdname tinytests
`[.tinytests` <- function(x,i){
structure(unclass(x)[i], class="tinytests", duration=NULL)
}
#' @param passes \code{[logical]} Toggle: print passing tests?
#' @param sidefx \code{[logical]} Toggle: print side effects?
#' @param limit \code{[numeric]} Max number of results to print
#' @param nlong \code{[numeric]} First \code{nlong} results are printed in long format.
#' @param ... passed to \code{\link{format.tinytest}}
#'
#' @section Details:
#'
#' By default, the first 3 failing test results are printed in long form,
#' the next 7 failing test results are printed in short form and all other
#' failing tests are not printed. These defaults can be changed by passing options
#' to \code{print.tinytest}, or by setting one or more of the following global
#' options:
#' \itemize{
#' \item{\code{tt.pr.passes} Set to \code{TRUE} to print output of non-failing tests.}
#' \item{\code{tt.pr.limit} Max number of results to print (e.g. \code{Inf})}
#' \item{\code{tt.pr.nlong} The number of results to print in long format (e.g. \code{Inf}).}
#' }
#'
#' For example, set \code{options(tt.pr.limit=Inf)} to print all test results.
#' Furthermore, there is the option
#' \itemize{
#' \item{\code{tt.pr.color},}
#' }
#' which determines whether colored output is printed.
#' If R is running in a dumb terminal (detected by comparing
#' environment variable \code{"TERM"} to \code{"dumb"}), then
#' this option is set to \code{FALSE} when the package is loaded.
#'
#' @rdname tinytests
#' @export
print.tinytests <- function(x
, passes=getOption("tt.pr.passes", FALSE)
, sidefx=getOption("tt.pr.sidefx", TRUE)
, limit =getOption("tt.pr.limit", 7)
, nlong =getOption("tt.pr.nlong", 3),...){
nrslt <- length(x)
ifail <- if (nrslt > 0) sapply(x, isFALSE) else logical(0)
iside <- if (nrslt > 0) sapply(x, is.na) else logical(0)
ipass <- if (nrslt > 0) sapply(x, isTRUE) else logical(0)
duration <- attr(x,"duration")
duration_str <- if( is.null(duration) ) "fubar!"
else sprintf("(%s)", humanize(duration, color=FALSE))
iprn <- ifail
if (passes) iprn <- iprn | ipass
if (sidefx) iprn <- iprn | iside
x <- x[iprn]
if (sum(iprn)==0){
cat(sprintf("All ok, %d results %s\n",nrslt, duration_str))
return(invisible(NULL))
}
limit <- min(length(x), limit)
nlong <- min(nlong, limit)
nshort <- max(limit - nlong,0)
x <- x[seq_len(limit)]
type <- c( rep("long",nlong)
, rep("short",nshort) )
str <- sapply(seq_along(x), function(i) format.tinytest(x[[i]], type=type[i]))
cat(paste0(str,"\n"), "\n")
if (nrslt > length(str)){
pr1 <- sprintf("Showing %d out of %d results: ", length(x), nrslt)
pr2 <- sprintf("%d fails, %d passes", sum(ifail), sum(ipass))
pr3 <- if( any(iside) ) sprintf(", %s side effects", sum(iside)) else ""
cat(pr1, pr2, pr3," ", duration_str, "\n",sep="")
}
}
#' @return For \code{as.data.frame.} a data frame.
#' @family test-files
#'
#' @examples
#' # create a test file in tempdir
#' tests <- "
#' addOne <- function(x) x + 2
#'
#' expect_true(addOne(0) > 0)
#' expect_equal(2, addOne(1))
#' "
#' testfile <- tempfile(pattern="test_", fileext=".R")
#' write(tests, testfile)
#'
#' # extract testdir
#' testdir <- dirname(testfile)
#' # run all files starting with 'test' in testdir
#' out <- run_test_dir(testdir)
#' #
#' # print results
#' print(out)
#' summary(out)
#' dat <- as.data.frame(out)
#' out[1]
#'
#' @rdname tinytests
#' @export
as.data.frame.tinytests <- function(x, ...){
L <- lapply(x, attributes)
data.frame(
result = sapply(x, c)
, call = sapply(L, function(y) gsub(" +"," ",paste0(capture.output(print(y$call)),collapse=" ")) )
, diff = sapply(L, `[[`, "diff")
, short = sapply(L, `[[`, "short")
, file = sapply(L, `[[`, "file")
, first = sapply(L, `[[`, "fst")
, last = sapply(L, `[[`, "lst")
, stringsAsFactors=FALSE
)
}
|