tests/testthat/test-git_tools.R

In openpharma/staged.dependencies: Install R packages from Particular Git Branches

# See the related tests in 'test-git_tools_mocking.R' which do not require access to GitHub

# ---- get_authtoken_envvar ----
test_that("get_authtoken_envvar works", {
  withr::with_options(list(
    staged.dependencies.token_mapping = list("https://github.com" = "GITHUB_PAT")
  ), {
    expect_error(
      get_authtoken_envvar("github.com"),
      regexp = "unknown host", fixed = TRUE
    )
    expect_equal(get_authtoken_envvar("https://github.com"), "GITHUB_PAT")
  })
})

# ---- get_repo_url ----
test_that("get_repo_url works", {
  expect_identical(
    get_repo_url("testOrg/testRepo", "https://github.com"),
    "https://github.com/testOrg/testRepo.git"
  )
})

# ---- checkout_repo ----
test_that("checkout_repo works (requires Internet access)", {
  expect_silent({
    # check error when dir is not a git repo
    existing_dir <- tempfile()
    dir.create(existing_dir)
    expect_error(
      checkout_repo(existing_dir, "https://github.com/openpharma/stageddeps.water.git",
        function(...) structure("main", type = "branch"),
        token_envvar = NULL
      ),
      regex = "not in a git repository", fixed = TRUE
    )
    unlink(existing_dir, recursive = TRUE)

    # inexistant branch to checkout
    repo_dir <- tempfile()
    expect_error(
      checkout_repo(repo_dir, "https://github.com/openpharma/stageddeps.water.git",
        function(...) structure("inexistantBranch", type = "branch"),
        token_envvar = NULL, must_work = TRUE
      ),
      regex = "ref inexistantBranch is unavailable for this repo", fixed = TRUE
    )
    # checkout existing branch
    x <- checkout_repo(repo_dir, "https://github.com/openpharma/stageddeps.water.git",
      function(...) structure("main", type = "branch"),
      token_envvar = NULL
    )
    # do not test SHA equality, just that it is there
    x$sha <- "test"
    expect_equal(
      x,
      list(dir = repo_dir, ref = structure("main", type = "branch"), sha = "test", accessible = TRUE)
    )
    unlink(repo_dir, recursive = TRUE)

    repo_dir <- tempfile()
    withr::with_envvar(list(INCORRECT_TOKEN = "adfs"), {
      expect_error(
        checkout_repo(repo_dir, "https://github.com/inexistentOrg/inexistentRepo.git",
          function(...) structure("main", type = "branch"),
          token_envvar = "INCORRECT_TOKEN", must_work = TRUE
        ),
        regexp = "Bad credentials", fixed = TRUE
      )
    })
  })
})