tests/testthat/test-gitr-checkout.R

In gitr: A Lightweight API for 'Git'

# Setup ----
skip_if_not(is_git())

# testthat snapshot consistency
skip_if_not(packageVersion("testthat") >= "3.2.1")

dir <- local_create_worktree()


# Testing ----
test_that("`gitr_checkout()` errors when params are bad", {
  expect_error(
    gitr_checkout(),
    "You must pass a either `branch` or a `file` to checkout."
  )
  expect_error(
    gitr_checkout("DESCRIPTION"),  # common error; param order
    "`branch` cannot have the same name as a tracked file."
  )
  expect_error(
    gitr_checkout("foo", "bar"),
    "You cannot pass *both* a `branch` and a `file` to checkout.",
    fixed = TRUE
  )
})

test_that("`gitr_checkout()` checks out a branch when asked", {
  new_br <- "feature-wip"
  withr::defer(git("branch -D", new_br)) # delete the 'new_br' branch
  gitr_checkout(new_br)
  expect_true(new_br %in% gitr_local_br())   # new br is created
  expect_equal(gitr_current_br(), new_br)    # switched to new br
  gitr_checkout("gitr-test-br")          # go back to default br
  expect_equal(gitr_current_br(), "gitr-test-br")
})

test_that("`gitr_checkout()` checks out a file when asked", {
  withr::local_options(list(gitr_echo_cmd = TRUE)) # turn on for snapshot
  # no changes; 0 paths updated from index
  expect_snapshot(gitr_checkout(file = "DESCRIPTION"))

  files <- c("NAMESPACE", "DESCRIPTION", "NEWS.md", "README.Rmd")
  unlink(files, force = TRUE)  # delete 4 files
  # 4 deletions; 4 paths updated from index
  expect_snapshot(gitr_checkout(file = files))
})