tests/testthat/test-variations.R

In doctest: Generate Tests from Examples Using 'roxygen' and 'testthat'

expect_roxygen2_output <- function(...) {
  if (packageVersion("roxygen2") > "7.2.3") {
    expect_message(...)
  } else {
    expect_warning(...)
  }
}

test_that("@examples tag", {
  examples_expectation <- "
                           #' @examples
                           #' 1
                           #' @doctest
                           #' @snap
                           #' sum(1, 1)
                           NULL
                          " |> dedent()

  expect_roxygen2_output({
    results <- roc_proc_text(dt_roclet(), examples_expectation)
  }, "@examples")
})


test_that("Tags outside @doctest", {
  outside_expectation <- "
                          #' @expect true()
                          #' TRUE
                          #' @doctest
                          NULL
                         " |> dedent()

  expect_roxygen2_output({
    results <- roc_proc_text(dt_roclet(), outside_expectation)
  }, "@doctest")
})


test_that("Empty @expect tag", {
  empty_expectation <- "
                        #' @doctest
                        #' @expect
                        #' TRUE
                        NULL
                       " |> dedent()

  expect_roxygen2_output({
    results <- roc_proc_text(dt_roclet(), empty_expectation)
  }, "@expect")
})


test_that("Empty @expectRaw tag", {
  empty_expectation <- "
                        #' @doctest
                        #' @expectRaw
                        #' TRUE
                        NULL
                       " |> dedent()

  expect_roxygen2_output({
    results <- roc_proc_text(dt_roclet(), empty_expectation)
  }, "@expectRaw")
})


test_that("Empty @testRaw tag", {
  empty_expectation <- "
                        #' @doctest
                        #' @testRaw
                        #' TRUE
                        NULL
                       " |> dedent()

  expect_roxygen2_output({
    results <- roc_proc_text(dt_roclet(), empty_expectation)
  }, "@testRaw")
})


test_that("assignment", {
  assignment_expectation <- "
                             #' @doctest
                             #' @expect equal(1)
                             #' x <- 1
                             NULL
                            " |> dedent()

  results <- roc_proc_text(dt_roclet(), assignment_expectation)
  expect_snapshot_output(
    roclet_output(dt_roclet(), results)
  )
})



test_that("assignment with dot", {
  assignment_dot_expectation <- "
                                 #' @doctest
                                 #' @expect equal(x <- ., rev(x))
                                 #' c('t', 'e', 'n', 'e', 't')
                                 NULL
                                " |> dedent()

  results <- roc_proc_text(dt_roclet(), assignment_dot_expectation)
  expect_snapshot_output(
    roclet_output(dt_roclet(), results)
  )
})


test_that("comment", {
  comment_expectation <- "
                          #' @doctest
                          #' @expect equal(4)
                          #' # comment in the way
                          #' 2 + 2
                          NULL
                         " |> dedent()

  results <- roc_proc_text(dt_roclet(), comment_expectation)
  expect_snapshot_output(
    roclet_output(dt_roclet(), results)
  )
})



test_that("Multiple @doctest tags", {
  multi_doctest_expectation <- "
                                #' @doctest
                                #' @expect equal(1)
                                #' x <- 1
                                #' @export
                                #' @doctest
                                #' @expect equal(4)
                                #' 2 + 2
                                NULL
                               " |> dedent()

  results <- roc_proc_text(dt_roclet(), multi_doctest_expectation)
  expect_snapshot_output(
    roclet_output(dt_roclet(), results)
  )
})



test_that("Multiple @doctest tags, invalid syntax", {
  bad_multi_doctest <- "
                        #' @doctest
                        #' if (TRUE) {
                        #' @expect equal(4)
                        #' 2 + 2
                        #' } else {
                        #' @doctest
                        #' @expect equal(4)
                        #' 2 + 2
                        #' }
                        NULL
                       " |> dedent()

  # We're fine with multiple warnings, so this just checks we got 1
  suppressWarnings(expect_warning(
    roc_proc_text(dt_roclet(), bad_multi_doctest)
  ))
})


test_that("Bad Rd syntax", {
  bad_rd_doctest <- "
                     #' @doctest
                     #' @expect equal(1)
                     #' 1
                     #' if (TRUE) {
                     NULL
                    " |> dedent()

  expect_warning(
    roc_proc_text(dt_roclet(), bad_rd_doctest)
  )
})


test_that("Bad Rd syntax with dontrun", {
  # expectation triggers create_expectations
  bad_dontrun_doctest <- "
                          #' @doctest
                          #' @expect equal(1)
                          #' 1
                          #' \\dontrun{
                          #' if (TRUE) {
                          NULL
                         " |> dedent()

  # We're fine with multiple warnings, so this just checks we got 1
  suppressWarnings(expect_warning(
    roc_proc_text(dt_roclet(), bad_dontrun_doctest)
  ))
})