tests/testthat/test-obtain_existing_path.R

In jdblischak/workflowr: A Framework for Reproducible and Collaborative Data Science

context("obtain_existing_path")

# Function in R/utility.R

# Setup ------------------------------------------------------------------------

# Create and move to a temporary, nested directory
tmp_dir <- tempfile("test-obtain_existing_path-")
nested_dir <- file.path(tmp_dir, "nested")
cwd <- getwd()
on.exit(setwd(cwd))
on.exit(unlink(tmp_dir, recursive = TRUE, force = TRUE), add = TRUE)
fs::dir_create(nested_dir)
tmp_dir <- workflowr:::absolute(tmp_dir)
nested_dir <- workflowr:::absolute(nested_dir)
setwd(nested_dir)

# Test obtain_existing_path ----------------------------------------------------

test_that("obtain_existing_paths works with nested non-existing directories", {
  expect_identical(obtain_existing_path("x"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("x/"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("x/y"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("x/y/"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("x/y/z"), workflowr:::absolute("."))
})

test_that("obtain_existing_paths works with relative path to cwd", {
  expect_identical(obtain_existing_path("./x"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("./x/"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("./x/y"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("./x/y/"), workflowr:::absolute("."))
  expect_identical(obtain_existing_path("./x/y/z"), workflowr:::absolute("."))
})

test_that("obtain_existing_paths works with relative path to upstream", {
  expect_identical(obtain_existing_path("../x"), workflowr:::absolute(".."))
  expect_identical(obtain_existing_path("../x/"), workflowr:::absolute(".."))
  expect_identical(obtain_existing_path("../x/y"), workflowr:::absolute(".."))
  expect_identical(obtain_existing_path("../x/y/"), workflowr:::absolute(".."))
  expect_identical(obtain_existing_path("../x/y/z"), workflowr:::absolute(".."))
})

test_that("obtain_existing_paths works with relative path to two upstream", {
  expect_identical(obtain_existing_path("../../x"), workflowr:::absolute("../.."))
  expect_identical(obtain_existing_path("../../x/"), workflowr:::absolute("../.."))
  expect_identical(obtain_existing_path("../../x/y"), workflowr:::absolute("../.."))
  expect_identical(obtain_existing_path("../../x/y/"), workflowr:::absolute("../.."))
  expect_identical(obtain_existing_path("../../x/y/z"), workflowr:::absolute("../.."))
})

test_that("obtain_existing_paths works with relative path to home directory", {
  expect_identical(obtain_existing_path("~/x"), workflowr:::absolute("~"))
  expect_identical(obtain_existing_path("~/x/"), workflowr:::absolute("~"))
  expect_identical(obtain_existing_path("~/x/y"), workflowr:::absolute("~"))
  expect_identical(obtain_existing_path("~/x/y/"), workflowr:::absolute("~"))
  expect_identical(obtain_existing_path("~/x/y/z"), workflowr:::absolute("~"))
})

test_that("obtain_existing_paths works when the root is the upstream existing directory (unix-like)", {

  if (.Platform$OS.type == "windows") skip("Only relevant on Unix-like")

  # These tests only fail on CRAN macOS servers, so impossible to debug
  skip_on_cran()

  expect_identical(obtain_existing_path("/x"), workflowr:::absolute("/"))
  expect_identical(obtain_existing_path("/x/"), workflowr:::absolute("/"))
  expect_identical(obtain_existing_path("/x/y"), workflowr:::absolute("/"))
  expect_identical(obtain_existing_path("/x/y/"), workflowr:::absolute("/"))
  expect_identical(obtain_existing_path("/x/y/z"), workflowr:::absolute("/"))
})

test_that("obtain_existing_paths works when the root is the upstream existing directory (windows)", {

  if (.Platform$OS.type != "windows") skip("Only relevant on Windows")

  expect_identical(obtain_existing_path("C:/x"), workflowr:::absolute("C:/"))
  expect_identical(obtain_existing_path("C:/x/"), workflowr:::absolute("C:/"))
  expect_identical(obtain_existing_path("C:/x/y"), workflowr:::absolute("C:/"))
  expect_identical(obtain_existing_path("C:/x/y/"), workflowr:::absolute("C:/"))
  expect_identical(obtain_existing_path("C:/x/y/z"), workflowr:::absolute("C:/"))
})

test_that("obtain_existing_paths rejects invalid input", {
  expect_error(obtain_existing_path(1), "Invalid input")
  expect_error(obtain_existing_path(TRUE), "Invalid input")
  expect_error(obtain_existing_path(c("a", "b")), "Invalid input")
  expect_error(obtain_existing_path(NA), "Invalid input")
  expect_error(obtain_existing_path(NA_character_), "Invalid input")
  expect_error(obtain_existing_path(NULL), "Invalid input")
})