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
|
vcr_text <- list(
test_all = "library(\"testthat\")
test_check(\"%s\")\n",
config = "library(\"vcr\") # *Required* as vcr is set up on loading
invisible(vcr::vcr_configure(
dir = vcr::vcr_test_path(\"fixtures\")
))\nvcr::check_cassette_names()\n",
example_test = "# EXAMPLE VCR USAGE: RUN AND DELETE ME
foo <- function() crul::ok('https://httpbin.org/get')
test_that(\"foo works\", {
vcr::use_cassette(\"testing\", {
x <- foo()
})
expect_true(x)
})\n",
learn_more =
"Learn more about `vcr`: https://books.ropensci.org/http-testing",
gitattributes = "* text=auto
tests/fixtures/**/* -diff\n"
)
vcr_cat_line <- function(txt) {
bullet <- crayon::green(cli::symbol$tick)
cli::cat_line(paste(bullet, txt, " "))
}
vcr_cat_info <- function(txt) {
bullet <- cli::symbol$circle_filled
cli::cat_line(paste(bullet, txt, " "))
}
pkg_name <- function(dir) {
desc_path <- file.path(dir, "DESCRIPTION")
if (!file.exists(desc_path)) {
stop("'DESCRIPTION' not found; are you sure it's an R package?")
}
data.frame(read.dcf(desc_path),
stringsAsFactors = FALSE)[["Package"]]
}
suggest_vcr <- function(dir, verbose = TRUE) {
if (verbose) vcr_cat_line(sprintf("Adding %s to %s field in DESCRIPTION",
crayon::blue("vcr"),
crayon::red("Suggests")))
desc::desc_set_dep("vcr", "Suggests", file = dir)
invisible()
}
test_r_file_exists <- function(dir) {
ff <- setdiff(
list.files(file.path(dir, "tests"), full.names=TRUE, pattern = ".R|.r"),
list.dirs(file.path(dir, "tests"), recursive=FALSE))
if (length(ff) == 0) return(FALSE)
any(
vapply(ff, function(z) {
any(grepl("test_check", readLines(z)))
}, logical(1))
)
}
#' Setup vcr for a package
#'
#' @export
#' @param dir (character) path to package root. default's to
#' current directory
#' @param verbose (logical) print progress messages. default: `TRUE`
#' @return only messages about progress, returns invisible()
use_vcr <- function(dir = ".", verbose = TRUE) {
assert(dir, "character")
stopifnot(length(dir) == 1)
if (!dir.exists(dir)) stop("'dir' does not exist")
invisible(lapply(c("desc", "cli", "crayon"), check_for_a_pkg))
pkg <- pkg_name(dir)
if (verbose) vcr_cat_info(paste0("Using package: ", crayon::blue(pkg)))
# note: assuming fixtures directory
if (verbose) vcr_cat_info(paste0("assuming fixtures at: ",
crayon::blue("tests/fixtures")))
# add vcr to Suggests in DESCRIPTION file
suggest_vcr(dir, verbose)
# add tests/testthat.R if not present
if (!dir.exists(file.path(dir, "tests/testthat"))) {
if (verbose) vcr_cat_line(paste0("Creating directory: ",
file.path(dir, "tests/testthat")))
dir.create(file.path(dir, "tests/testthat"), recursive = TRUE)
}
if (verbose) vcr_cat_info("Looking for testthat.R file or similar")
tall <- file.path(dir, sprintf("tests/testthat.R", pkg))
if (!test_r_file_exists(dir)) {
if (verbose)
vcr_cat_line(paste0(crayon::blue("tests/testthat.R:" ), " added"))
file.create(tall, showWarnings = FALSE)
cat(sprintf(vcr_text$test_all, pkg), file = tall, append = TRUE)
} else {
if (verbose)
vcr_cat_info(paste0(crayon::blue("tests/testthat.R (or similar):" ),
" exists"))
}
# add helper-pkgname.R to tests/testthat/
hf <- file.path(dir, sprintf("tests/testthat/setup-%s.R", pkg))
if (!file.exists(hf)) {
file.create(hf, showWarnings = FALSE)
}
if (!any(grepl("vcr_configure", readLines(hf)))) {
if (verbose) vcr_cat_line(paste0("Adding vcr config to ",
crayon::blue(sprintf("tests/testthat/setup-%s.R", pkg))))
cat(vcr_text$config, file = hf, append = TRUE)
} else {
if (verbose) vcr_cat_info(paste0("vcr config appears to be already setup in ",
crayon::blue(sprintf("tests/testthat/setup-%s.R", pkg))))
}
# add dummy test file with example of use_cassette()
if (verbose) vcr_cat_line(paste0("Adding example test file ",
crayon::blue("tests/testthat/test-vcr_example.R")))
dummyfile <- file.path(dir, "tests/testthat/test-vcr_example.R")
cat(vcr_text$example_test, file = dummyfile)
# add .gitattributes file
gitattsfile <- file.path(dir, ".gitattributes")
if (!file.exists(gitattsfile)) {
if (verbose)
vcr_cat_line(paste0(crayon::blue(".gitattributes:" ), " added"))
cat(vcr_text$gitattributes, file = gitattsfile)
} else {
if (verbose)
vcr_cat_info(paste0(crayon::blue(".gitattributes:" ), " exists"))
txt <- readLines(gitattsfile)
if (
any(grepl("tests\\/fixtures\\/\\*\\*\\/\\* -diff", txt)) &&
any(grepl("* text=auto", txt))
) {
if (verbose)
vcr_cat_info(
paste0(crayon::blue(".gitattributes"),
" already setup to ignore cassette diffs"))
} else {
if (verbose)
vcr_cat_info(sprintf("appending lines to %s to ignore cassette diffs",
crayon::blue(".gitattributes")))
cat(vcr_text$gitattributes, file = gitattsfile, append = TRUE)
}
}
# done
if (verbose) vcr_cat_info(vcr_text$learn_more)
invisible()
}
|
