如何用testthat测试调用usethis::use_template的R包,解决测试时模板找不到问题
解决
usethis::use_template在testthat测试中找不到模板的问题 我之前碰过一模一样的问题,确实和devtools::load_all()在测试环境下的包路径处理逻辑有关——交互式运行时,usethis能正确识别当前包的inst/templates目录,但testthat测试时,包的加载上下文有差异,导致路径识别出错。下面给你几个亲测有效的解决方案:
1. 显式指定模板所属的包
这是最简单直接的方法,调用use_template时明确加上package参数,指定你的包名。比如:
# 你的包函数里的代码 my_template_function <- function() { usethis::use_template( "my_template.txt", save_as = "output_file.txt", package = "your_package_name" # 替换成你的包名 ) }
这样不管是交互式运行还是测试,usethis都会直接从包的开发/安装路径里查找inst/templates下的模板,不会受加载方式影响。
2. 在测试中手动设置包根目录
如果不想修改函数代码,可以在测试用例开头,用usethis::proj_set()指定包的根目录,帮usethis定位到正确的结构:
test_that("my template function works correctly", { # 用here包定位包根目录,或者直接写绝对路径 usethis::proj_set(here::here()) # 执行测试逻辑 result <- my_template_function() expect_true(file.exists(result)) })
这里依赖here包的话,记得在测试环境里安装它,或者直接用system.file()来获取包路径:usethis::proj_set(system.file(package = "your_package_name"))。
3. Mock usethis的内部路径检测函数
如果上面两种方法都不适用,可以用testthat的mock功能,替换usethis内部的template_path函数,让它直接指向你本地的模板目录:
test_that("my function uses the template properly", { testthat::with_mock( # 替换usethis的内部路径函数 `usethis:::template_path` = function(template, package = NULL) { file.path(here::here(), "inst", "templates", template) }, { # 调用你的函数 my_template_function() # 验证结果 expect_true(file.exists("output_file.txt")) } ) })
这个方法相当于绕过usethis默认的路径检测逻辑,直接告诉它模板在哪里,适合复杂的测试场景。
优先试试第一种方法,亲测最省心,基本能解决90%的问题。如果还是有问题,再尝试后面的方案调整测试环境的路径识别。
内容的提问来源于stack exchange,提问作者Jonah
相关产品推荐
相关产品推荐

