-
Notifications
You must be signed in to change notification settings - Fork 36
/
test-CreatePackageVignette.R
224 lines (196 loc) · 7.01 KB
/
test-CreatePackageVignette.R
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
context("CreatePackageVignette Tests")
rm(list = ls())
##### TESTS #####
# baseballstats source path
sourcePath <- system.file("baseballstats"
, package = "pkgnet"
, lib.loc = Sys.getenv('PKGNET_TEST_LIB')
)
.CreateSourceCopy <- function(sourcePath) {
tempDirectory <- tempfile()
dir.create(tempDirectory)
file.copy(from = sourcePath
, to = tempDirectory
, recursive = TRUE
)
return(file.path(tempDirectory, basename(sourcePath)))
}
test_that("Test that CreatePackageVignette runs end-to-end with default inputs", {
pkgPath <- .CreateSourceCopy(sourcePath)
originalWD <- getwd()
setwd(pkgPath)
on.exit(expr = {
setwd(originalWD)
unlink(pkgPath, recursive = TRUE)
})
dir.create(file.path(pkgPath, "vignettes"))
vignettePath <- file.path("vignettes", "pkgnet-report.Rmd")
outputPath <- tempfile(pattern = "vignette", fileext = ".html")
expect_true({
CreatePackageVignette()
TRUE
})
# Valid Rmd file was produced successfully
expect_true(file.exists(vignettePath))
expect_true(file.info(vignettePath)[["size"]] > 0)
expect_true({
rmarkdown::render(
input = vignettePath
, output_file = basename(outputPath)
, output_dir = dirname(outputPath)
, quiet = TRUE
)
TRUE
})
expect_true(file.exists(outputPath))
expect_true(file.info(outputPath)[["size"]] > 0)
})
test_that("Test that CreatePackageVignette runs end-to-end with specified dir", {
pkgPath <- .CreateSourceCopy(sourcePath)
on.exit(expr = unlink(pkgPath, recursive = TRUE))
dir.create(file.path(pkgPath, "vignettes"))
vignettePath <- file.path(
pkgPath
, "vignettes"
, "vignette_file.Rmd"
)
outputPath <- tempfile(pattern = "vignette", fileext = ".html")
expect_true({
CreatePackageVignette(pkg = pkgPath
, vignette_path = vignettePath
)
TRUE
})
# Valid Rmd file was produced successfully
expect_true(file.exists(vignettePath))
expect_true(file.info(vignettePath)[["size"]] > 0)
expect_true({
rmarkdown::render(
input = vignettePath
, output_file = basename(outputPath)
, output_dir = dirname(outputPath)
, quiet = TRUE
)
TRUE
})
expect_true(file.exists(outputPath))
expect_true(file.info(outputPath)[["size"]] > 0)
})
test_that("Test that CreatePackageVignette runs end-to-end with non-default reporters", {
pkgPath <- .CreateSourceCopy(sourcePath)
on.exit(expr = unlink(pkgPath, recursive = TRUE))
dir.create(file.path(pkgPath, "vignettes"))
vignettePath <- file.path(
pkgPath
, "vignettes"
, "vignette_file.Rmd"
)
outputPath <- tempfile(pattern = "vignette", fileext = ".html")
# using :: to avoid masking by testthat::SummaryReporter
expect_true({
CreatePackageVignette(pkg = pkgPath
, pkg_reporters = list(
pkgnet::SummaryReporter$new()
, DependencyReporter$new()
)
, vignette_path = vignettePath
)
TRUE
})
# Valid Rmd file was produced successfully
expect_true(file.exists(vignettePath))
expect_true(file.info(vignettePath)[["size"]] > 0)
expect_true({
rmarkdown::render(
input = vignettePath
, output_file = basename(outputPath)
, output_dir = dirname(outputPath)
, quiet = TRUE
)
TRUE
})
expect_true(file.exists(outputPath))
expect_true(file.info(outputPath)[["size"]] > 0)
})
test_that("Test that CreatePackageVignette errors for bad inputs", {
pkgPath <- .CreateSourceCopy(sourcePath)
on.exit(expr = unlink(pkgPath, recursive = TRUE))
vignettePath <- tempfile(pattern = "vignette", fileext = ".Rmd")
# pkg doesn't point to a package root
notPkgPath <- tempfile()
dir.create(notPkgPath)
on.exit(unlink(notPkgPath, recursive = TRUE))
expect_error(
CreatePackageVignette(pkg = notPkgPath)
, regexp = "We can't find your DESCRIPTION file"
, fixed = TRUE
)
# Non-existent vignette_path directory
expect_error(
CreatePackageVignette(
pkg = pkgPath
, vignette_path = file.path(
dirname(vignettePath)
, 'notarealdir'
, basename(vignettePath)
)
)
, regexp = paste(
"Directory"
, file.path(dirname(vignettePath), 'notarealdir')
, "does not exist, please create it before running"
, "CreatePackageVignette"
)
, fixed = TRUE
)
# Generator passed into pkg_reporters
expect_error(
CreatePackageVignette(pkg = pkgPath
, vignette_path = vignettePath
, pkg_reporters = list(DependencyReporter$new()
, FunctionReporter)
)
, regexp = paste("At least one of pkg_reporters is an R6 class"
, "generator. This function expects initialized"
, "reporter objects.")
, fixed = TRUE
)
})
test_that("CreatePackageVignette warns if vignette_path seems wrong", {
pkgPath <- .CreateSourceCopy(sourcePath)
on.exit(expr = unlink(pkgPath, recursive = TRUE))
# In a vignettes directory that isn't in a package root
vignettesDir <- file.path(tempdir(), "vignettes")
dir.create(vignettesDir)
expect_warning(
CreatePackageVignette(pkg = pkgPath
, vignette_path = file.path(vignettesDir
, "pkgnet_report.Rmd")
)
, regexp = paste("not inside a package root directory")
, fixed = TRUE
)
# Clean up
unlink(file.path(tempdir(), "vignettes"), recursive = TRUE)
# If in root of a different package
suppressWarnings({
utils::package.skeleton(name = "basketballstats", path = tempdir())
})
dir.create(file.path(tempdir(), "basketballstats", "vignettes"))
expect_warning(
CreatePackageVignette(pkg = pkgPath
, vignette_path = file.path(tempdir()
, "basketballstats"
, "vignettes"
, "pkgnet_report.Rmd")
)
, regexp = paste("You are writing a report for baseballstats to the"
, "vignettes directory for basketballstats")
, fixed = TRUE
)
# Clean up
unlink(file.path(tempdir(), "basketballstats"), recursive = TRUE)
})
##### TEST TEAR DOWN #####
rm(list = ls())
closeAllConnections()