tests/testthat/test-rstudio-markers.R

In goodpractice: Advice on R Package Building

bad1 <- system.file("bad1", package = "goodpractice")
gp_obj <- gp(bad1, checks = "r_file_extension")

test_that("get_marker returns NULL for passing checks", {
  passing <- gp("good", checks = "description_bugreports")
  result <- get_marker(passing, "description_bugreports")
  expect_null(result)
})

test_that("get_marker returns NULL when no positions field", {
  state <- gp_obj
  state$checks$r_file_extension <- FALSE
  result <- get_marker(state, "r_file_extension")
  expect_null(result)
})

test_that("get_marker returns position list for failing check", {
  result <- get_marker(gp_obj, "r_file_extension")
  expect_type(result, "list")
  expect_gt(length(result), 0)
  expect_true(all(
    c("type", "file", "line", "column", "message") %in%
      names(result[[1]])
  ))
})

test_that("get_marker handles NA line_number and column_number", {
  state <- gp_obj
  state$checks$r_file_extension$positions[[1]]$line_number <- NA
  state$checks$r_file_extension$positions[[1]]$column_number <- NA
  result <- get_marker(state, "r_file_extension")
  expect_identical(result[[1]]$line, 1L)
  expect_identical(result[[1]]$column, 1L)
})

test_that("get_markers collects markers from all failing checks", {
  markers <- get_markers(gp_obj)
  expect_type(markers, "list")
  expect_gt(length(markers), 0)
})

test_that("get_markers returns empty for all-pass results", {
  passing <- gp("good", checks = "description_bugreports")
  markers <- get_markers(passing)
  expect_length(markers, 0)
})

test_that("rstudio_source_markers calls callFun", {
  called <- FALSE
  local_mocked_bindings(
    callFun = function(...) {
      called <<- TRUE
    }
  )
  rstudio_source_markers(gp_obj)
  expect_true(called)
})

test_that("rstudio_source_markers returns early with no markers", {
  passing <- gp("good", checks = "description_bugreports")
  called <- FALSE
  local_mocked_bindings(
    callFun = function(...) {
      called <<- TRUE
    }
  )
  rstudio_source_markers(passing)
  expect_false(called)
})