fuzzr

fuzzr implements some simple "fuzz tests" for your R functions, passing in a wide array of inputs and returning a report on how your function reacts.

Installation

devtools::install_github("mdlincoln/fuzzr")

Usage

Tests are set by passing functions that return named lists of input values. These values will be passed as function arguments. Several default suites are provided with this package, such as test_char, however you may implement your own by passing a function that returns a similarly-formatted list.

library(fuzzr)
test_char()
#> $char_empty
#> character(0)
#> 
#> $char_single
#> [1] "a"
#> 
#> $char_single_blank
#> [1] ""
#> 
#> $char_multiple
#> [1] "a" "b" "c"
#> 
#> $char_multiple_blank
#> [1] "a" "b" "c" "" 
#> 
#> $char_with_na
#> [1] "a" "b" NA

Evaluate a function argument by supplying it's quoted name along with the tests to run to fuzz_function, along with any other required static values. fuzz_function returns a "fuzz_results" object that stores conditions raised by a function (message, warning, or error) along with any value returned by that function.

fuzz_results <- fuzz_function(fun = lm, arg_name = "subset", data = iris, 
                              formula = Sepal.Length ~ Petal.Width + Petal.Length, 
                              tests = test_all())

You can render these results as a data frame:

fuzz_df <- as.data.frame(fuzz_results)
knitr::kable(head(fuzz_df))

You can also access the value returned by any one test by calling the index that test with value_returned:

model <- fuzz_value(fuzz_results, which.max(fuzz_df$subset == "int_multiple"))
coefficients(model)
#>  (Intercept)  Petal.Width Petal.Length 
#>          0.8           NA          3.0

Multiple-argument tests

Specify multiple-argument tests with p_fuzz_function, passing a named list of arguments and tests to run on each. p_fuzz_function will test every combination of argument and variable.

fuzz_p <- p_fuzz_function(agrep, list(pattern = test_char(), x = test_char()))
knitr::kable(head(as.data.frame(fuzz_p)))

Matthew Lincoln