tests/testthat/test-print_all.R

In GegznaV/knitrContainer: Collect and Print Multiple Objects in a `Knitr` R Markdown Report

context("Function print_all()")


#  ------------------------------------------------------------------------
test_that("if `Command` is not converted to a string, a warning is arrises while trying to print with `print_all()`", {
    obj <- 2
    attributes(obj)$added_as <- "Command"
    obj <- as.knitrContainer(obj)
    expect_warning(print_all(obj))
})
#  ------------------------------------------------------------------------

# TODO: [!!!] The test is broken ad should be updated.

# test_that("print_all() prints htmlwidgets.", {
#
#
#
#     plotly_obj <- plotly::plot_ly(z = ~volcano, type = "surface")
#
#     # HTML tags were not collected
#     AS1 <- add_as_is(obj = plotly_obj)
#     out1 <- capture.output(print_all(AS1))
#
#     # HTML tags were collected
#     AS4 <- add_as_plotly_widget(obj = plotly_obj)
#     out4 <- capture.output(print_all(AS4))
#
#     # Test length
#     expect_length(out1, 4) # out1 = [1] "  " ""   ""   "  "
#     expect_length(out4, 5)
#
#     # Test some contents
#     expect_match(out4[2], "htmlwidget")
#     expect_match(out4[2], "plotly html-widget")
#     expect_match(out4[3], "htmlwidget")
#
# })

#  ------------------------------------------------------------------------

test_that("print_all() throws error where expected", {
 # No arguments
  expect_error(print_all())
 # Wrong class
  expect_error(print_all(list()))
 # Emplty container
  expect_warning(print_all(knitrContainer()))
})

#  ------------------------------------------------------------------------

test_that("print_all() and add_as_data() works correnctly", {

    # Capture name
    cont1 <- add_as_data(obj = mtcars)
    print_all(cont1)
    expect_true("mtcars" %in% ls())

    # Capture and correct the name
    cont2 <- add_as_data(obj = mtcars$cyl)
    print_all(cont2)
    expect_true("mtcars.cyl" %in% ls())

    # Capture and correct the name
    cont3 <- add_as_data(obj = mtcars, give.name = "NAME_1")
    print_all(cont3)
    expect_true("NAME_1" %in% ls())

    # Identical contents
    expect_identical(NAME_1, mtcars)
    expect_identical(mtcars$cyl, mtcars.cyl)

})

#  ------------------------------------------------------------------------

# test_that("print_all(), add_as_command() works correnctly", {
#
#
#     # Expr 1
#     cont1 <- add_as_command(obj = print(1+3))
#     #Empty line is aded, thus select just the 1st element
#     expect_equal(capture.output(print_all(cont1))[1],
#                  capture.output(print(4)))
#
#     # Expr 2
#     cont2 <- add_as_command(obj = print(mtcars))
#     expect_identical(capture.output(print_all(cont2))[1:10],
#                      capture.output(print(mtcars))[1:10])
#
#     # Expre 3
#     expect_false("OBJ" %in% ls())
#
#     cont3 <- add_as_command(obj = OBJ <- mtcars)
#     print_all(cont3)
#
#     expect_true("OBJ" %in% ls())
#     expect_identical(OBJ, mtcars)
#
# })

#  ------------------------------------------------------------------------


test_that("print_all() and add_as_cmd() works correnctly", {


    # Expr 1
    cont1 <- add_as_cmd(obj = print(1+3))
    #Empty line is aded, thus select just the 1st element
    expect_equal(capture.output(print_all(cont1))[1],
                 capture.output(print(4)))

    # Expr 2
    cont2 <- add_as_cmd(obj = print(mtcars))
    expect_identical(capture.output(print_all(cont2))[1:10],
                     capture.output(print(mtcars))[1:10])

    # Expre 3
    expect_false("OBJ" %in% ls())

    cont3 <- add_as_cmd(obj = OBJ <- mtcars)
    print_all(cont3)

    expect_true("OBJ" %in% ls())
    expect_identical(OBJ, mtcars)

})


#  ------------------------------------------------------------------------
test_that("print_all() and add_as_cmd_str() works correnctly", {

    # Icorrect classes of imput `obj`
    expect_error(add_as_cmd_str(obj = 1),          "`obj` is not a string.")
    expect_error(add_as_cmd_str(obj = sum(1)),     "`obj` is not a string.")
    expect_error(add_as_cmd_str(obj = as.name(1)), "`obj` is not a string.")

    # Expr 1
    cont1 <- add_as_cmd_str(obj = "print(1+3)")
    #Empty line is aded, thus select just the 1st element
    expect_equal(capture.output(print_all(cont1))[1],
                 capture.output(print(4)))

    # Expr 2
    cont2 <- add_as_cmd_str(obj = "print(mtcars)")
    expect_identical(capture.output(print_all(cont2))[1:10],
                     capture.output(print(mtcars))[1:10])

    # Expre 3
    expect_false("OBJ" %in% ls())

    cont3 <- add_as_cmd(obj = "OBJ <- mtcars")
    print_all(cont3)

    expect_true("OBJ" %in% ls())
    expect_identical(OBJ, mtcars)

})


#  ------------------------------------------------------------------------

test_that("text added with `add_as_text()` and `add_as_is()` is printed with `print_all()`", {
    cont <- add_as_text(obj = "TEST")
    cont <- add_as_is(cont, obj = "TEST")
    OUTPUT  <- capture.output(print_all(cont))
    expect_match(OUTPUT[2], "TEST")
})

#  ------------------------------------------------------------------------

# test_that("ggplot as-is output of print_all() is correct.", {
#
#    file = "test-add_as_plotly_widget"
#    writeLines(c(
#            "```{r setup, include=FALSE}",
#            "knitr::opts_chunk$set(echo = TRUE)",
#            "library(plotly)",
#            "library(ggplot2)",
#            "library(magrittr)",
#            "library(knitrContainer)",
#            "```",
#            "",
#            "```{r, results='asis', echo = FALSE}",
#            "container <- knitrContainer()",
#            "for (i in 1:2) container  %<>%",
#            "    add_as_plotly_widget(obj = ggplotly(qplot(1:5,1:5)))",
#            "print_all(container)",
#            "```"),
#         file)
#    knit2html(file, quiet = TRUE)
#    readLines(con = paste0(file, ".html"))
#
#    file.remove(dir(pattern = file))
# })