测试写入磁盘的包函数

Question

我正在尝试为 R 中的包函数编写测试。

假设我们有一个函数，它使用 writeLines() 简单地将字符串 x 写入磁盘：

exporting_function <- function(x, file) {

 writeLines(x, con = file)

 invisible(NULL)
}

测试它的一种方法是检查文件是否存在。通常，它一开始不应该存在，但在导出函数运行后它应该存在。此外，您可能希望测试文件大小是否大于 0：

library(testthat)

test_that("file is written to disk", {
 file = 'output.txt'
 expect_false(file.exists(file))

 exporting_function("This is a test",
                    file = file)


 expect_true(file.exists(file))

 expect_gt(file.info('output.txt')$size, 0)
})

这是测试它的好方法吗？在CRAN Repository Policy 中声明Packages should not write in the user’s home filespace (including clipboards), nor anywhere else on the file system apart from the R session’s temporary directory。这个测试会违反这个约束吗？

有一个expect_output_file 函数。从文档和示例中，我不确定这是否是测试该功能的更合适的期望。它需要 a.o.一个object 参数，它应该是object to test。在我的情况下要测试的对象是什么？

Answer 1

这看起来好像违反了 CRAN 政策。为什么不简单地写入临时目录，使用

file <-  tempfile()

代替

file = 'output.txt'

?

至于它是否是一个好的测试：尝试重新读取文件并确认读取的内容与写入的内容匹配不是更好吗？在您的玩具示例中这很容易。在实际中可能会更难，但是将导入函数与导出函数配对始终是一个好主意。