如何为建议的包编写单元测试？

Question

R 中的包可以对其他包有不同类型的依赖。其中一些类型表示硬要求，即Depends、Imports 和LinkingTo。

但是，还有第二个类别表示更软的依赖关系，即Suggests 和Enhances。在这两种情况下，如果建议的/增强的包可用，包会提供额外的功能。

这是一个具体的例子：包checkpoint 导入knitr 因为knitr 帮助checkpoint 解析rmarkdown 文件。

但现在我正在考虑将 knitr 更改为 Suggests 依赖项，即仅在实际安装了 knitr 时才提供此功能。

为了进行正确的单元测试，这意味着我必须同时测试两种情况：

1. 如果knitr 可用，则执行操作。
2. 如果knitr不可用，则发出警告并且什么都不做。

实际的R代码很简单：

if(require(knitr)) {
  do_stuff()
} else {
  message("blah")
}

问题

但是如何为这两种场景设置单元测试呢？

在我看来，检查require(knitr) 的简单事实将加载knitr 包（如果它在本地库中可用）。

所以，要测试案例 1，我必须在本地安装 knitr，这意味着我无法测试案例 2。

有没有办法为此用例配置testthat（或任何其他单元测试框架）？

Answer 1

tl;博士

要测试使用require(knitr) 失败时遵循的分支，请使用trace() 临时修改require()，使其找不到knitr，即使它存在于.libPaths() .具体来说，在require() 的主体中，将lib.loc= 的值重置为指向R.home()——一个不包含knitr 包的现有目录。

这似乎在包中和在运行以下命令的交互式会话中一样有效：

find.package("knitr")

trace("require", quote(lib.loc <- R.home()), at=1)
isTRUE(suppressMessages(suppressWarnings(require(knitr))))

untrace("require")
isTRUE(suppressMessages(suppressWarnings(require(knitr))))

---

据我了解，您有一个具有两个分支的函数，一个在 require(knitr) 成功的 R 会话中执行，另一个在失败的会话中执行。然后，您希望从 knitr 实际上位于 .libPaths() 的单个 R 实例“双向”测试此功能。

所以基本上你需要一些方法来暂时将require(knitr) 的呼叫蒙蔽到 knitr 的实际存在。完全暂时重置.libPaths() 返回的值看起来很有希望，但似乎不可能。

另一个有希望的途径是以某种方式将require() 调用中的lib.loc 的默认值从NULL （这意味着“使用.libPaths() 的值”）重置到knitr 不可用。您不能通过覆盖base::require() 来实现此目的，也不能（在包中）通过使用所需值lib.loc 定义require() 的本地掩码版本来实现此目的。

不过，看起来您可以使用trace() 临时修改require() （通过设置lib.loc=R.home() 使其不知道knitr 的可用性）。然后执行untrace() 将require() 恢复为原版版本，然后继续查找knitr。

这是我测试过的虚拟包中的样子。首先是一个 R 函数，它允许我们沿两个分支测试是否成功

## $PKG_SRC/R/hello.R

hello <- function(x=1) {
    if(require(knitr)) {
        x==2
    } else {
        x==3
    }
}

然后是几个测试，每个分支一个：

## $PKG_SRC/inst/tests/testme.R

## Test the second branch, run when require(knitr) fails
trace("require", quote(lib.loc <- R.home()), at=1)
stopifnot(hello(3))
untrace("require")

## Test the first branch, run when require(knitr) succeeds
stopifnot(hello(2))

为了测试这一点，我使用pkgKitten::kitten("dummy")设置了一个源目录，复制到这两个文件中，将Suggests: knitr添加到DESCRIPTION文件中，然后从相应目录运行devtools::install()和devtools::check() .软件包安装得很好，并通过了所有检查。