41

我想知道如何测试产生图形的功能。我有一个简单的绘图功能img

img <- function() {
  plot(1:10)
}

在我的包中,我喜欢使用testthat. 因为plot和它在基础图形中的朋友只是返回NULL一个简单 expect_identical的不起作用:

library("testthat")

## example for a successful test
expect_identical(plot(1:10), img()) ## equal (as expected)

## example for a test failure
expect_identical(plot(1:10, col="red"), img()) ## DOES NOT FAIL!
# (because both return NULL)

首先,我考虑将绘图写入文件并比较 md5 校验和以确保函数的输出相等:

md5plot <- function(expr) {
  file <- tempfile(fileext=".pdf")
  on.exit(unlink(file))
  pdf(file)
  expr
  dev.off()
  unname(tools::md5sum(file))
}

## example for a successful test
expect_identical(md5plot(img()),
                 md5plot(plot(1:10))) ## equal (as expected)

## example for a test failure
expect_identical(md5plot(img()),
                 md5plot(plot(1:10, col="red"))) ## not equal (as expected)

这在 Linux 上运行良好,但在 Windows 上却不行。令人惊讶 的是md5plot(plot(1:10)),每次调用都会产生一个新的 md5sum。除了这个问题,我需要创建很多临时文件。

接下来我使用recordPlot(首先创建一个空设备,调用绘图函数并记录其输出)。这按预期工作:

recPlot <- function(expr) {
  pdf(NULL)
  on.exit(dev.off())
  dev.control(displaylist="enable")
  expr
  recordPlot()
}

## example for a successful test
expect_identical(recPlot(plot(1:10)),
                 recPlot(img())) ## equal (as expected)

## example for a test failure
expect_identical(recPlot(plot(1:10, col="red")),
                 recPlot(img())) ## not equal (as expected)

有人知道测试函数图形输出的更好方法吗?

编辑:关于@josilber 在他的评论中提出的观点。

虽然该recordPlot方法效果很好,但您必须在单元测试中重写整个绘图功能。对于复杂的绘图功能,这变得很复杂。如果有一种方法可以存储包含图像的文件(*.RData或,...),您可以在以后的测试中进行比较。*.pdfmd5sum方法不起作用,因为 md5sum 在不同平台上有所不同。通过recordPlot您可以创建一个*.RData文件,但您不能依赖它的格式(来自recordPlot手册页):

记录图的格式可能会在 R 版本之间发生变化。记录的绘图不能用作 R 绘图的永久存储格式。

也许可以存储图像文件(*.png,*.bmp等),将其导入并逐个像素进行比较...

EDIT2:以下代码说明了使用 svg 作为输出的所需参考文件方法。首先需要的辅助函数:

## plot to svg and return file contant as character
plot_image <- function(expr) {
  file <- tempfile(fileext=".svg")
  on.exit(unlink(file))
  svg(file)
  expr
  dev.off()
  readLines(file)
}

## the IDs differ at each `svg` call, that's why we simple remove them
ignore_svg_id <- function(lines) {
  gsub(pattern = "(xlink:href|id)=\"#?([a-z0-9]+)-?(?<![0-9])[0-9]+\"",
       replacement = "\\1=\"\\2\"", x = lines, perl = TRUE)
}

## compare svg character vs reference
expect_image_equal <- function(object, expected, ...) {
  stopifnot(is.character(expected) && file.exists(expected))
  expect_equal(ignore_svg_id(plot_image(object)),
               ignore_svg_id(readLines(expected)), ...)
}

## create reference image
create_reference_image <- function(expr, file) {
  svg(file)
  expr
  dev.off()
}

测试将是:

create_reference_image(img(), "reference.svg")

## create tests
library("testthat")

expect_image_equal(img(), "reference.svg") ## equal (as expected)
expect_image_equal(plot(1:10, col="red"), "reference.svg") ## not equal (as expected)

可悲的是,这不适用于不同的平台。svg 元素的顺序(和名称)在 Linux 和 Windows 上完全不同。

pngjpeg也存在类似问题recordPlot。生成的文件在所有平台上都不同。

目前唯一可行的解​​决方案是上述recPlot方法。但因此我需要在我的单元测试中重写整个绘图函数。


PS:我对 Windows 上的不同 md5sum 感到完全困惑。似乎它们取决于临时文件的创建时间:

# on Windows
table(sapply(1:100, function(x)md5plot(plot(1:10))))
#4693c8bcf6b6cb78ce1fc7ca41831353 51e8845fead596c86a3f0ca36495eacb
#                              40                               60
4

2 回答 2

14

Mango Solutions 已经发布了一个开源包,visualTest它对绘图进行模糊匹配,以解决这个用例。

包在github 上,所以安装使用:

devtools::install_github("MangoTheCat/visualTest")
library(visualTest)

然后使用函数getFingerprint()为每个图提取指纹,并使用函数进行比较isSimilar(),指定合适的阈值。

首先,在文件中创建一些图:

png(filename = "test1.png")
img()
dev.off()

png(filename = "test2.png")
plot(1:11, col="red")
dev.off()

指纹是一个数值向量:

> getFingerprint(file = "test1.png")
 [1]  4  7  4  4 10  4  7  7  4  7  7  4  7  4  5  9  4  7  7  5  6  7  4  7  4  4 10
[28]  4  7  7  4  7  7  4  7  4  3  7  4  4  3  4  4  5  5  4  7  4  7  4  7  7  7  4
[55]  7  7  4  7  4  7  5  6  7  7  4  8  6  4  7  4  7  4  7  7  7  4  4 10  4  7  4

> getFingerprint(file = "test2.png")
 [1]  7  7  4  4 17  4  7  4  7  4  7  7  4  5  9  4  7  7  5  6  7  4  7  7 11  4  7
[28]  7  5  6  7  4  7  4 14  4  3  4  7 11  7  4  7  5  6  7  7  4  7 11  7  4  7  5
[55]  6  7  7  4  8  6  4  7  7  4  4  7  7  4 10 11  4  7  7

比较使用isSimilar()

> isSimilar(file = "test2.png",
+           fingerprint = getFingerprint(file = "test1.png"),
+           threshold = 0.1
+ )
[1] FALSE

您可以在http://www.mango-solutions.com/wp/products-services/r-services/r-packages/visualtest/阅读有关该软件包的更多信息

于 2015-05-17T11:51:07.113 回答
7

值得注意的是vdiffr包还支持比较图。一个不错的功能是它与 testthat 包集成——它实际上用于在 ggplot2 中进行测试——并且它有一个 RStudio 插件来帮助管理你的测试套件。

于 2017-07-08T21:02:29.227 回答