tests/test_mdweave.R

In djvanderlaan/tinymarkdown: Simple Engine for Generating Reports using R

# mdweave a couple of documents and check if the output is the
# same as the corresponding reference documents

library(simplermarkdown)

if (simplermarkdown:::has_pandoc()) {

  # We only want to check if the output of mdweave matches the reference if the
  # pandoc version matches that which generated the reference. Otherwise there
  # is a large chance that the output does not match
  pandoc_version <- system("pandoc --version", intern = TRUE)
  #correct_pandoc_version <- c("pandoc 2.5",
  #  "Compiled with pandoc-types 1.17.5.4, texmath 0.11.2.2, skylighting 0.7.7")
  correct_pandoc_version <- "pandoc 2.17.1.1"
  is_correct_pandoc_version <- all(pandoc_version[1] == correct_pandoc_version)


  # Create tempdir
  dir <- tempdir()
  dir.create(dir, recursive = TRUE, showWarnings = FALSE)
  oldwd <- setwd(dir)

  # When running tests the environment variable R_TESTS is set. This
  # causes issues when running a second R instance as mdweave does. Therefore
  # we unser it.
  old_env <- Sys.getenv("R_TESTS")
  Sys.setenv("R_TESTS" = "")

  # =============================================================================
  message("Checking iris.md")
  md <- "iris.md"

  message("Weave file")
  fn <- system.file(file.path("examples", md), package = "simplermarkdown")
  mdweave(fn)

  message("Check if result generated")
  stopifnot(file.exists(md))

  if (is_correct_pandoc_version) {
    message("Compare to reference")
    lines <- readLines(md)
    fn_ref <- system.file(file.path("examples_output", md), 
      package = "simplermarkdown")
    lines_ref <- readLines(fn_ref)
    print(all.equal(lines, lines_ref))
    system(paste0("diff ", md, " ", fn_ref))
    writeLines(lines)
    stopifnot(isTRUE(all.equal(lines, lines_ref)))
  }

  message("Check images")
  # We don't check if the images are exactly the same; this probably 
  # depends on the exact output device used; versions etc.
  stopifnot(file.exists("figures/iris.png"))

  message("Cleanup")
  #unlink(md)
  unlink("figures")

  # =============================================================================
  message("Checking iris.md with format_copypaste")
  md <- "iris_copypaste.md"

  message("Weave file")
  fn <- system.file(file.path("examples", md), package = "simplermarkdown")
  mdweave(fn)

  message("Check if result generated")
  stopifnot(file.exists(md))

  if (is_correct_pandoc_version) {
    message("Compare to reference")
    lines <- readLines(md)
    fn_ref <- system.file(file.path("examples_output", md), 
      package = "simplermarkdown")
    lines_ref <- readLines(fn_ref)
    print(all.equal(lines, lines_ref))
    system(paste0("diff ", md, " ", fn_ref))
    writeLines(lines)
    stopifnot(isTRUE(all.equal(lines, lines_ref)))
  }

  message("Check images")
  # We don't check if the images are exactly the same; this probably 
  # depends on the exact output device used; versions etc.
  stopifnot(file.exists("figures/iris.png"))

  message("Cleanup")
  #unlink(md)
  unlink("figures")

  # =============================================================================
  message("Checking example1.md")
  md <- "example1.md"

  message("Weave file")
  fn <- system.file(file.path("examples", md), package = "simplermarkdown")
  mdweave(fn)

  message("Check if result generated")
  stopifnot(file.exists(md))

  if (is_correct_pandoc_version) {
    message("Compare to reference")
    lines <- readLines(md)
    fn_ref <- system.file(file.path("examples_output", md), 
      package = "simplermarkdown")
    lines_ref <- readLines(fn_ref)
    print(all.equal(lines, lines_ref))
    system(paste0("diff ", md, " ", fn_ref))
    stopifnot(isTRUE(all.equal(lines, lines_ref)))
  }

  message("Check images")
  # We don't check if the images are exactly the same; this probably 
  # depends on the exact output device used; versions etc.
  stopifnot(file.exists("figures/foo.png"))
  stopifnot(file.exists("figures/test.pdf"))

  message("Cleanup")
  unlink(md)
  unlink("figures")


  # =============================================================================
  # An markdown file without a header block gave an error with version 0.0.3. 
  # Regression test
  fn <- tempfile(fileext=".md")
  writeLines("# Introduction", fn)
  fn2 <- tempfile(fileext=".md")
  mdweave(fn, fn2)
  unlink(fn)
  unlink(fn2)

  
  # =============================================================================
  # END
  Sys.setenv("R_TESTS" = old_env)
  setwd(oldwd)
}