• Stars
    star
    99
  • Rank 343,315 (Top 7 %)
  • Language
    R
  • License
    Other
  • Created over 8 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A mocking library for R.

mockery

Lifecycle: superseded CRAN version R-CMD-check Codecov test coverage

A mocking library for R.

This package is superseded and we no longer recommend that you use it for new tests. We instead recommend testthat::local_mocked_bindings().

Installation

To install the latest CRAN release:

install.packages('mockery')

To install directly from the source code in this GitHub repository:

# install.packages('pak')
pak::pak('r-lib/mockery')

Testing

Mockery provides the capacity for stubbing out functions and for verifying function calls during testing.

Stubbing

Mockery's stub function will let you stub out a function with another function or simply a return value. Note that if you choose to replace the function with another function, the signatures of the two functions should be compatible.

Examples
g = function(y) y
f = function(x) g(x) + 1
test_that('demonstrate stubbing', {
    # replaces 'g' with a function that always returns 100
    # but only when called from f
    stub(f, 'g', 100)

    # this can also be written
    stub(f, 'g', function(...) 100)
    expect_equal(f(1), 101)
})

Stubbing works with classes of all descriptions and namespaced functions:

# this stubs the 'request_perform' function, but only
# for httr::get, and only when it is called from within this
# test function
stub(httr::GET, 'request_perform', 'some html')
        
# it is also possible to stub out a namespaced function call
stub(some_function, 'namespace::function', 'some return value')

This also works with R6 classes and methods.

Depth

It's possible to specify the depth of stubbing. This is useful if you want to stub a function that isn't called directly by the function you call in your test, but is instead called by a function that that function calls.

In the example below, the function g is both called directly from r, which we call from the test, and from f, which r calls. By specifying a depth of 2, we tell mockery to stub g in both places.

g = function(y) y
f = function(x) g(x) + 1
r = function(x) g(x) + f(x)
test_that('demonstrate stubbing', {
    stub(r, 'g', 100, depth=2)
    expect_equal(r(1), 201)
})

For more examples, please see the test code contained in this repository.

Comparison to with_mock

Mockery's stub function has similar functionality to testthat's with_mock.

There are several use cases in which mockery's stub function will work, but testthat's with_mock will not.

First, unlike with_mock, it seamlessly allows for mocking out primitives.

Second, it is easy to stub out functions from base R packages with mockery's stub. Because of how with_mock works, you can get into trouble if you mock such functions that the JIT compiler might try to use. These kinds of problems are avoided by stub's design. As of version 2.0.0 of testthat, it will be impossible to mock functions from base R packages with_mock.

The functionality of stub is just slightly different than that of with_mock. Instead of mocking out the object of interest for the duration of some code block, it mocks it out only when it is called from a specified function.

Mocking

Mock objects allow you to specify the behavior of the function you've stubbed out while also verifying how that function was used.

g = function(y) y
f = function(x) g(x) + 1
test_that('demonstrate mock object usage', {
    # mocks can specify behavior
    mock = mock(100)
    stub(f, 'g', mock)
    result = f(5)
    expect_equal(result, 101)

    # and allow you to make assertions on the mock was treated
    expect_called(mock, 1)
    expect_args(mock, 1, 5)
})

You can also specify multiple return values

mock = mock(1, "a", sqrt(3))

and access the arguments with which it was called.

mock <- mock()
mock(x = 1)
mock(y = 2)

expect_equal(length(mock), 2)
args <- mock_args(mock)

expect_equal(args[[1]], list(x = 1))
expect_equal(args[[2]], list(y = 2))

Please report bugs and feature requests through github issues.

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,392
star
2

lintr

Static Code Analysis for R
R
1,193
star
3

httr

httr: a friendly http package for R
R
984
star
4

actions

GitHub Actions for the R community
TypeScript
948
star
5

testthat

An R πŸ“¦ to make testing πŸ˜€
R
875
star
6

usethis

Set up commonly used πŸ“¦ components
R
842
star
7

pkgdown

Generate static html documentation for an R package
R
716
star
8

styler

Non-invasive pretty printing of R code
R
706
star
9

pak

A fresh approach to package installation
C
652
star
10

cli

Tools for making beautiful & useful command line interfaces
R
635
star
11

rig

The R Installation Manager
Rust
609
star
12

roxygen2

Generate R package documentation from inline R comments
R
590
star
13

rlang

Low-level API for programming with R
R
498
star
14

progress

Progress bar in your R terminal
R
463
star
15

here

A simpler way to find your files
R
410
star
16

R6

Encapsulated object-oriented programming for R
R
405
star
17

scales

Tools for ggplot2 scales
R
392
star
18

fs

Provide cross platform file operations based on libuv.
C
362
star
19

rex

Friendly regular expressions for R.
R
331
star
20

covr

Test coverage reports for R
R
331
star
21

crayon

πŸ–οΈ R package for colored terminal output β€” now superseded by cli
R
325
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
325
star
23

memoise

Easy memoisation for R
R
315
star
24

lobstr

Understanding complex R objects with tools similar to str()
R
301
star
25

profvis

Visualize R profiling data
JavaScript
297
star
26

callr

Call R from R
R
295
star
27

slider

Sliding Window Functions
R
295
star
28

vctrs

Generic programming with typed R vectors
C
284
star
29

waldo

Find differences between R objects
R
275
star
30

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
253
star
31

conflicted

An alternative conflict resolution strategy for R
R
244
star
32

bench

High Precision Timing of R Expressions
R
241
star
33

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
232
star
34

gmailr

Access the Gmail RESTful API from R.
R
229
star
35

processx

Execute and Control Subprocesses from R
R
229
star
36

asciicast

Turn R scripts into terminal screencasts
R
224
star
37

xml2

Bindings to libxml2
R
218
star
38

gh

Minimalistic GitHub API client in R
R
218
star
39

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
199
star
40

keyring

πŸ” Access the system credential store from R
R
191
star
41

vdiffr

Visual regression testing and graphical diffing with testthat
C++
182
star
42

svglite

A lightweight svg graphics device for R
C++
181
star
43

pillar

Format columns with colour
R
179
star
44

withr

Methods For Temporarily Modifying Global State
R
173
star
45

ragg

Graphic Devices Based on AGG
C++
172
star
46

hugodown

Make websites with hugo and RMarkdown
R
166
star
47

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
48

coro

Coroutines for R
R
153
star
49

rprojroot

Finding files in project subdirectories
R
148
star
50

debugme

Easy and efficient debugging for R packages
R
146
star
51

available

Check if a package name is available to use
R
142
star
52

gert

Simple git client for R
C
142
star
53

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
142
star
54

ellipsis

Tools for Working with ...
R
141
star
55

later

Schedule an R function or formula to run after a specified period of time.
C++
137
star
56

itdepends

R
133
star
57

fastmap

Fast map implementation for R
C++
132
star
58

prettyunits

Pretty, human readable formatting of quantities
JavaScript
131
star
59

rray

Simple Arrays
R
130
star
60

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
61

tidyselect

A backend for functions taking tidyverse selections
R
123
star
62

desc

Manipulate DESCRIPTION files
R
121
star
63

evaluate

A version of eval for R that returns more information about what happened
R
118
star
64

gargle

Infrastructure for calling Google APIs from R, including auth
R
114
star
65

rcmdcheck

Run R CMD check from R and collect the results
R
113
star
66

tree-sitter-r

R
106
star
67

prettycode

Syntax highlight R code in the terminal
R
101
star
68

sloop

S language OOP ⛡️
R
101
star
69

clock

A Date-Time Library for R
R
100
star
70

revdepcheck

R package reverse dependency checking
R
99
star
71

pkgdepends

R Package Dependency Resolution
R
94
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
92
star
73

systemfonts

System Native Font Handling in R
C++
91
star
74

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
88
star
75

downlit

Syntax Highlighting and Automatic Linking
R
86
star
76

gtable

The layout packages that powers ggplot2
R
86
star
77

askpass

Password Entry for R, Git, and SSH
R
84
star
78

zip

Platform independent zip compression via miniz
C
83
star
79

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
82
star
80

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
79
star
81

marquee

Markdown Parser and Renderer for R Graphics
C
77
star
82

ps

R package to query, list, manipulate system processes
C
73
star
83

credentials

Tools for Managing SSH and Git Credentials
R
72
star
84

sessioninfo

Print Session Information
R
72
star
85

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
86

sodium

R bindings to libsodium
R
69
star
87

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
88

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
66
star
89

pkgbuild

Find tools needed to build R packages
R
65
star
90

webfakes

Fake web apps for HTTP testing R packages
C
63
star
91

generics

Common generic methods
R
61
star
92

cliapp

Rich Command Line Applications
R
61
star
93

diffviewer

HTML widget to visually compare files
JavaScript
58
star
94

pkgload

Simulate installing and loading a package
R
58
star
95

cachem

Key-value caches for R
R
57
star
96

liteq

Serverless R message queue using SQLite
R
56
star
97

brio

Basic R Input Output
R
53
star
98

carrier

Create standalone functions for remote execution
R
50
star
99

jose

Javascript Object Signing and Encryption for R
R
48
star
100

Rapp

Build CLI applications in R
R
46
star