• Stars
    star
    98
  • Rank 338,184 (Top 7 %)
  • Language
    R
  • License
    Other
  • Created almost 8 years ago
  • Updated 8 months 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,360
star
2

lintr

Static Code Analysis for R
R
1,159
star
3

httr

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

actions

GitHub Actions for the R community
TypeScript
917
star
5

testthat

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

usethis

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

pkgdown

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

styler

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

pak

A fresh approach to package installation
C
630
star
10

cli

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

roxygen2

Generate R package documentation from inline R comments
R
579
star
12

rig

The R Installation Manager
Rust
555
star
13

rlang

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

progress

Progress bar in your R terminal
R
457
star
15

R6

Encapsulated object-oriented programming for R
R
402
star
16

here

A simpler way to find your files
R
401
star
17

scales

Tools for ggplot2 scales
R
388
star
18

fs

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

rex

Friendly regular expressions for R.
R
331
star
20

covr

Test coverage reports for R
R
329
star
21

crayon

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

remotes

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

memoise

Easy memoisation for R
R
314
star
24

lobstr

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

slider

Sliding Window Functions
R
290
star
26

callr

Call R from R
R
289
star
27

vctrs

Generic programming with typed R vectors
C
280
star
28

waldo

Find differences between R objects
R
275
star
29

zeallot

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

conflicted

An alternative conflict resolution strategy for R
R
243
star
31

bench

High Precision Timing of R Expressions
R
242
star
32

gmailr

Access the Gmail RESTful API from R.
R
230
star
33

processx

Execute and Control Subprocesses from R
R
227
star
34

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
223
star
35

asciicast

Turn R scripts into terminal screencasts
R
223
star
36

xml2

Bindings to libxml2
R
218
star
37

gh

Minimalistic GitHub API client in R
R
217
star
38

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
192
star
39

keyring

πŸ” Access the system credential store from R
R
188
star
40

vdiffr

Visual regression testing and graphical diffing with testthat
C++
181
star
41

svglite

A lightweight svg graphics device for R
C++
178
star
42

pillar

Format columns with colour
R
173
star
43

ragg

Graphic Devices Based on AGG
C++
170
star
44

withr

Methods For Temporarily Modifying Global State
R
169
star
45

hugodown

Make websites with hugo and RMarkdown
R
165
star
46

ymlthis

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

coro

Coroutines for R
R
150
star
48

rprojroot

Finding files in project subdirectories
R
147
star
49

debugme

Easy and efficient debugging for R packages
R
145
star
50

available

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

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
141
star
52

ellipsis

Tools for Working with ...
R
139
star
53

later

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

gert

Simple git client for R
C
136
star
55

itdepends

R
133
star
56

rray

Simple Arrays
R
130
star
57

isoband

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

prettyunits

Pretty, human readable formatting of quantities
JavaScript
128
star
59

fastmap

Fast map implementation for R
C++
127
star
60

desc

Manipulate DESCRIPTION files
R
121
star
61

tidyselect

A backend for functions taking tidyverse selections
R
121
star
62

gargle

Infrastructure for calling Google APIs from R, including auth
R
113
star
63

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
64

evaluate

A version of eval for R that returns more information about what happened
R
108
star
65

prettycode

Syntax highlight R code in the terminal
R
100
star
66

revdepcheck

R package reverse dependency checking
R
99
star
67

sloop

S language OOP ⛡️
R
99
star
68

tree-sitter-r

C
95
star
69

clock

A Date-Time Library for R
R
95
star
70

pkgdepends

R Package Dependency Resolution
R
93
star
71

systemfonts

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

lifecycle

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

gtable

The layout packages that powers ggplot2
R
85
star
74

askpass

Password Entry for R, Git, and SSH
R
83
star
75

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
76

zip

Platform independent zip compression via miniz
C
82
star
77

rappdirs

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

downlit

Syntax Highlighting and Automatic Linking
R
81
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
76
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

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

credentials

Tools for Managing SSH and Git Credentials
R
70
star
84

sodium

R bindings to libsodium
R
68
star
85

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

webfakes

Fake web apps for HTTP testing R packages
C
61
star
89

cliapp

Rich Command Line Applications
R
60
star
90

generics

Common generic methods
R
59
star
91

diffviewer

HTML widget to visually compare files
JavaScript
57
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

marquee

Markdown Parser and Renderer for R Graphics
C
49
star
98

jose

Javascript Object Signing and Encryption for R
R
48
star
99

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
100

pkgconfig

Private configuration for R packages
R
41
star