tests/testthat/test.R

In fhirschmann/knitron: Brings IPython and matplotlib to knitr

run_knit <- function(code, echo = FALSE, strip = TRUE, latex = FALSE, ft = FALSE, profile = "knitr", ...) {
  tmp <- tempfile(pattern = "knitron.test.")
  dir.create(tmp)
  opts_knit$set(base.dir = tmp)
  on.exit(unlink(tmp, recursive = TRUE))

  options <- list(..., echo = echo, knitron.profile = profile)
  args <- if (length(options) == 0)
    ""
  else
    paste(", ", paste(names(options),
                      sapply(options,
                             function(x) ifelse(is.character(x),
                                                paste("'", x, "'", sep=""), x)),
                      sep = "=", collapse = ","), sep = "")

  text <- if (latex)
    paste("<<engine = 'ipython'", args, ">>=\n", code, "\n", "@", sep="")
  else
    paste("```{r, engine = 'ipython'", args, "}\n", code, "\n```", sep="")

  # Set quiet to FALSE when something goes wrong
  out <- knit(text = text, quiet = TRUE)
  files <- list.files(tmp, recursive = TRUE)

  res <- list(out = out, files = files)
  if (strip)
    res$out <- gsub("\n```", "", gsub("\n```\n## ", "", out))
  
  if (ft)
    res$file_types <- sapply(file.path(tmp, files), function(f) system2("file", c("-b", f), stdout = TRUE),
                             USE.NAMES = FALSE)

  res
}

test_that("engine starts and stops", {
  expect_false(knitron.is_running("knitr_test_ss"))
  knitron.start(profile="knitr_test_ss")
  expect_true(knitron.is_running("knitr_test_ss"))
  knitron.stop(profile="knitr_test_ss")
  expect_false(knitron.is_running("knitr_test_ss"))
})

test_that("[markdown] Matplotlib is loaded", {
  expect_equal(run_knit("import sys; 'matplotlib' in sys.modules")$out, "True")
})

test_that("[markdown] Pyplot is loaded", {
  expect_equal(run_knit("import sys; 'matplotlib.pyplot' in sys.modules")$out, "True")
})

test_that("[markdown] Waiting for code exeuction", {
  expect_equal(run_knit("from time import sleep; sleep(4); 4")$out, "4")
})

test_that("[markdown] Implicit printing: automatic", {
  expect_equal(run_knit(4, echo = TRUE), list(out = "python\n4\n4", files = character(0)))
  expect_equal(run_knit(4, echo = FALSE), list(out = "4", files = character(0)))
})

test_that("[markdown] Implicit printing: off", {
  expect_equal(run_knit(4, echo = FALSE, knitron.autoprint = FALSE), list(out = "4", files = character(0)))
})

test_that("[markdown] Empty input outputs empty output", {
  expect_equal(run_knit(""), list(out = "", files = character(0)))
})

test_that("[markdown] Plot is created", {
  res <- run_knit("plt.plot([1, 2, 3])")
  expect_equal(res$out, "![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-1.png)")
  expect_equal(res$files, "figure/unnamed-chunk-1-1.png")
})

test_that("[latex] Plot is created", {
  res <- run_knit("plt.plot([1, 2, 3])", latex = TRUE)
  expect_match(res$out, "includegraphics.*figure/unnamed-chunk-1-1")
  expect_equal(res$files, "figure/unnamed-chunk-1-1.pdf")
})

test_that("[markdown] Two plots are created", {
  res <- run_knit(paste("x = plt.figure(); x1 = x.add_subplot(111); x1.plot([1, 2, 3])",
                    "y = plt.figure(); y1 = y.add_subplot(111); y1.plot([5, 6])", sep="\n"))
  expect_equal(res$out, paste("![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-1.png)",
                              "![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-2.png)", sep = "\n"))
  expect_equal(res$files, c("figure/unnamed-chunk-1-1.png", "figure/unnamed-chunk-1-2.png"))
})

test_that("[latex] Two plots are created", {
  res <- run_knit(paste("x = plt.figure(); x1 = x.add_subplot(111); x1.plot([1, 2, 3])",
                        "y = plt.figure(); y1 = y.add_subplot(111); y1.plot([5, 6])", sep="\n"),
                  latex = TRUE)
  expect_match(res$out, "includegraphics.*figure/unnamed-chunk-1-1.*includegraphics.*figure/unnamed-chunk-1-2")
  expect_equal(res$files, c("figure/unnamed-chunk-1-1.pdf", "figure/unnamed-chunk-1-2.pdf"))
})

test_that("profiles are distinct", {
  run_knit("x = 1", profile="knitr_test_1")
  run_knit("x = 2", profile="knitr_test_2")
  expect_equal(run_knit("x", profile="knitr_test_1")$out, "1")
  expect_equal(run_knit("x", profile="knitr_test_2")$out, "2")
})

test_that("[cairo png] image is created", {
  res <- run_knit("plt.plot([1, 2, 3])", ft = TRUE)
  expect_equal(res$out, "![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-1.png)")
  expect_equal(res$files, "figure/unnamed-chunk-1-1.png")
  expect_match(res$file_types, ".*PNG image.*")
})

test_that("[cairo jpeg] image is created", {
  skip("Not available on travis")
  res <- run_knit("plt.plot([1, 2, 3])", ft = TRUE, dev = "CairoJPEG")
  expect_equal(res$out, "![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-1.jpeg)")
  expect_equal(res$files, "figure/unnamed-chunk-1-1.jpeg")
  expect_match(res$file_types, ".*JPEG image.*")
})

test_that("[svg] image is created", {
  res <- run_knit("plt.plot([1, 2, 3])", ft = TRUE, dev = "svg")
  expect_equal(res$out, "![plot of chunk unnamed-chunk-1](figure/unnamed-chunk-1-1.svg)")
  expect_equal(res$files, "figure/unnamed-chunk-1-1.svg")
  expect_match(res$file_types, ".*SVG Scalable Vector.*")
})