Support using GITLAB_PAT for authentication
#674
Conversation
|
I haven’t found any historical reference to GitLab ever allowing basic password auth in its API, even going back into old issues and StackOverflow posts. I wondered if I was missing some search term. The original implementation was tested against a public repo and followed the Bitbucket implementation (Bitbucket does use username and password). I think it's likely that GitLab has never supported basic auth with username and password, and that this feature has just never been exercised properly due to @aronatkins , do you think it makes sense to remove the |
|
@aronatkins I removed
Removing it from Packrat will avoid sending users down a dead end. |
toph-allen
force-pushed
the
toph-gitlab-pat
branch
from
89c2466 to
79c6f5f
Compare
| gitlab_pwd <- function(quiet = FALSE) { | ||
| pwd <- Sys.getenv("GITLAB_PASSWORD") | ||
| if (nzchar(pwd)) { | ||
| gitlab_pat <- function(quiet = FALSE) { |
There was a problem hiding this comment.
I just realized that the bitbucket and gitlab accessor functions are exported by packrat. I don't think that it was our intent to allow packrat::gitlab_pat. That said, it's out in the wild. :(
CC @kevinushey
There was a problem hiding this comment.
I don't think they are actually exported! They don't have the @export keyword, they don't appear in NAMESPACE, and you need to use ::: to access them.
There was a problem hiding this comment.
They do have documentation generated, but it isn't included in the index, because they include @keyword internal in a roxygen2 comment.
There was a problem hiding this comment.
Right, that's correct -- they're documented but not exported.
|
CI is failing on |
Intent
Fix source downloads from private GitLab repositories by preferentially using
GITLAB_PATfor authentication.Fixes #673
Approach
The GitLab downloader now checks for a
GITLAB_PAT. If that exists, instead of creating the username/password auth, it addsPrivate-Tokento the request's headers.GITLAB_USERNAMEandGITLAB_PASSWORDwere removed. See this comment for why.Automated Tests
There were no automated tests for GitLab download functionality before. There is one test that is skipped unless run manually.
This PR adds no tests.
QA Notes
I validated this against a private repo on my GitLab account. Validation is tricky, requiring a Packrat lock file that restores from a GitLab repository.
To validate:
GITLAB_PAT.packratsubdirectory. Runpackrat::restore(). The environment should restore correctly.We should also confirm:
GITLAB_PATenvironment variable is missing, an error message is displayed.GITLAB_USERNAMEandGITLAB_PASSWORDvariables are present andGITLAB_PATis absent, the same error message aboutGITLAB_PATis displayed.Checklist