tests/testthat/test-roxygen_extension.R

In phuse-org/valtools: Automate Validated Package Creation

test_that("Roxygen can read in new tags - YYYY-MM-DD", {

  simple_test_function_text <- "
  #' @title simple title
  #' @description sample function
  #' @param pkg path to package
  #' @editor Sample Person
  #' @editDate 1900-01-01
  #' @coverage
  #' test1: req1, req2, req3
  #' @deprecate Deprecated in v1.2
  #' @export
  #' @aliases testing
  hello_world <- function(name = \"\"){
    paste(\"Hello,\",name)
  }
  "

  roxygen_block <- roxygen2::parse_text(simple_test_function_text)[[1]]

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("editor"))
  )

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("editDate"))
  )

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("coverage"))
  )

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("deprecate"))
  )


  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editor"),
    "Sample Person"
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editDate"),
    "1900-01-01"
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"coverage"),
    "test1: req1, req2, req3"
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block, "deprecate"),
    "Deprecated in v1.2"
  )

})

test_that("Roxygen can read in new tags - MM-DD-YYYY", {

  simple_test_function_text <- "
  #' @title simple title
  #' @description sample function
  #' @param pkg path to package
  #' @editor Sample Person
  #' @editDate 01-02-2010
  #' @export
  #' @aliases testing
  hello_world <- function(name = \"\"){
    paste(\"Hello,\",name)
  }
  "

  roxygen_block <- roxygen2::parse_text(simple_test_function_text)[[1]]

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("editor","editDate"))
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editor"),
    "Sample Person"
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editDate"),
    "2010-01-02"
  )

})

test_that("Roxygen can read in new tags - DD-MMMM-YYYY", {

  simple_test_function_text <- "
  #' @title simple title
  #' @description sample function
  #' @param pkg path to package
  #' @editor Sample Person
  #' @editDate 10-Jan-2021
  #' @export
  #' @aliases testing
  hello_world <- function(name = \"\"){
    paste(\"Hello,\",name)
  }
  "

  roxygen_block <- roxygen2::parse_text(simple_test_function_text)[[1]]

  expect_true(
    roxygen2::block_has_tags(roxygen_block, tags = c("editor","editDate"))
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editor"),
    "Sample Person"
  )

  expect_equal(
    roxygen2::block_get_tag_value(roxygen_block,"editDate"),
    "2021-01-10"
  )

})


test_that("formatting coverage section parses correctly", {
    # one test case
    cov_tag1 <- roxygen2::roxy_tag(tag = "coverage",
                                raw = "1.1: 1.1, 1.2")
    expect_s3_class(class = "roxy_tag_coverage",
                 format_coverage_text(cov_tag1))

    # multiple test cases
    cov_tag2 <- roxygen2::roxy_tag(tag = "coverage",
                                       raw = "\n1.1: 1.1, 1.2\n1.2: 1.2, 1.3\n1.3: 1.1, 1.3, 1.4",
                                       line = 4)
    expect_s3_class(class = "roxy_tag_coverage",
                    format_coverage_text(cov_tag2))


})

test_that("formatting risk assessment parses correctly", {
  # one test case
  risk_tag1 <- roxygen2::roxy_tag(tag = "riskAssessment",
                                 raw = "1.1: 1 Low Risk, unlikely to occur")
  expect_s3_class(class = "roxy_tag_riskAssessment",
                  format_coverage_text(risk_tag1))

  parsed_risk_tag1 <- roxygen2::roxy_tag_parse(risk_tag1)


  expect_equal(
    parsed_risk_tag1$riskAssessment,
    structure(
      list(data.frame(
        Requirement = "1.1",
        `Risk Assessment` = "1 Low Risk, unlikely to occur",
        stringsAsFactors = FALSE,
        check.names = FALSE
      )),
      class = "vt_req_risk_assessment"
    )
  )

  # multiple test cases
  risk_tag2 <- roxygen2::roxy_tag(tag = "riskAssessment",
                                 raw = "1.1: 1 Low Risk, unlikely to occur\n1.2: 10 Not likely, but huge impact if occurs",
                                 line = 4)
  expect_s3_class(class = "roxy_tag_riskAssessment",
                  format_coverage_text(risk_tag2))

  parsed_risk_tag2 <- roxygen2::roxy_tag_parse(risk_tag2)


  expect_equal(
    parsed_risk_tag2$riskAssessment,
    structure(
      list(data.frame(
        Requirement = "1.1",
        `Risk Assessment` = "1 Low Risk, unlikely to occur",
        stringsAsFactors = FALSE,
        check.names = FALSE
      ),
      data.frame(
        Requirement = "1.2",
        `Risk Assessment` = "10 Not likely, but huge impact if occurs",
        stringsAsFactors = FALSE,
        check.names = FALSE
      )),
      class = "vt_req_risk_assessment"
    )
  )

})