tests/testthat/test-staticdocs.R

In ymd526442121/Rproject_shiny: Web Application Framework for R

context("staticdocs")

test_that("All man pages have an entry in staticdocs/index.r", {
  if (!all(file.exists(c('../../inst/staticdocs', '../../man')))) {
    # This test works only when run against a package directory
    return()
  }
  # Known not to be indexed
  known_unindexed <- c("shiny-package", "stacktrace", "knitr_methods", "knitr_methods_htmltools")

  indexed_topics <- local({
    result <- character(0)
    sd_section <- function(dummy1, dummy2, section_topics) {
      result <<- c(result, section_topics)
    }
    source("../../inst/staticdocs/index.r", local = TRUE)
    result
  })

  all_topics <- sub("\\.Rd", "", list.files("../../man", pattern = "*.Rd"))

  # This test ensures that every documented topic is included in
  # staticdocs/index.r, unless explicitly waived by specifying it
  # in the known_unindexed variable above.
  missing <- setdiff(sort(all_topics), sort(c(known_unindexed, indexed_topics)))
  unknown <- setdiff(sort(c(known_unindexed, indexed_topics)), sort(all_topics))
  expect_equal(length(missing), 0,
    info = paste("Functions missing from index:\n",
      paste("  ", missing, sep = "", collapse = "\n"),
      sep = ""))
  expect_equal(length(unknown), 0,
    info = paste("Unrecognized functions in index.r:\n",
      paste("  ", unknown, sep = "", collapse = "\n"),
      sep = ""))
})