adding more helpful fallback messages

R/install-gitlab.R

@@ -59,6 +59,7 @@ gitlab_remote <- function(repo, subdir = NULL,
                        auth_token = gitlab_pat(), sha = NULL,
                        host = "gitlab.com", ..., 
                        git_fallback = getOption("remotes.gitlab_git_fallback", TRUE),
+                       credentials = NULL,
                        quiet = FALSE) {
 
   meta <- parse_git_repo(repo)
@@ -73,53 +74,69 @@ gitlab_remote <- function(repo, subdir = NULL,
     url <- paste0(build_url(host, repo), ".git")
     url_has_token <- grepl("^(.*://)?[^@/]+@", url)
     has_access_token <- !is.null(auth_token) && nchar(auth_token) > 0L
-    has_credentials <- !is.null(list(...)$credentials)
+    has_credentials <- !is.null(credentials)
+    use_git2r <- !is_standalone() && pkg_installed("git2r")
 
+    if (!quiet) {
+      message(wrap(exdent = 2L, paste0("auth_token does not have scopes ", 
+        "'read-repository' and 'api' for host '", host, "' required to ",
+        "install using gitlab_remote.")))
+    }
+
+    # for basic http auth, 
+    #   - in GitLab CI using job account, username must be "gitlab-ci-token"
+    #   - for Project Access Tokens, username must be "<project-name>"
+    #   - for Personal Acccess Tokens, username is ignored
+    # choose to use "gitlab-ci-token" for most general default behavior
+    # https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
     if (has_access_token && !url_has_token && !has_credentials) {
-      # for basic http auth, 
-      #   - in GitLab CI using job account, username must be "gitlab-ci-token"
-      #   - for Project Access Tokens, username must be "<project-name>"
-      #   - for Personal Acccess Tokens, username is ignored
-      # choose to use "gitlab-ci-token" for most general default behavior
-      # https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
-      url_protocol <- gsub("((.*)://)?.*", "\\1", url)
-      url_path     <- gsub("((.*)://)?", "", url)
-
-      if (!quiet) {
-        message("auth_token does not have scopes 'read-repository' and 'api' ",
-          "for host '", host, "' required to install using gitlab_remote.\n",
-          "Attempting git_remote using ",
-          sprintf("url=%sgitlab-ci-token:<auth_token>@%s", url_protocol, url_path))
+      if (use_git2r) {
+        credentials <- getExportedValue("git2r", "cred_user_pass")(
+          username = "gitlab-ci-token",
+          password = auth_token
+        )
+
+        if (!quiet) {
+          message(wrap(exdent = 2L, paste0("Attempting git_remote using ",
+            "credentials: username='gitlab-ci-token', password=<auth_token>")))
+        }
+
+      } else {
+        url_protocol <- gsub("((.*)://)?.*", "\\1", url)
+        url_path     <- gsub("((.*)://)?", "", url)
+
+        if (!quiet) {
+          message(wrap(exdent = 2L, paste0("Attempting git_remote using ",
+            sprintf("url=%sgitlab-ci-token:<auth_token>@%s", url_protocol, url_path))))
+        }
+
+        url <- paste0(url_protocol, "gitlab-ci-token:", auth_token, "@", url_path)
       }
-
-      url <- paste0(url_protocol, "gitlab-ci-token:", auth_token, "@", url_path)
     } else if (has_credentials && !quiet) {
-      message("auth_token does not have scopes 'read-repository' and 'api' ",
-        "for host '", host, "' required to install using gitlab_remote.\n",
-        "Attempting git_remote using provided credentials for authentication.")
+      message(wrap(exdent = 2L, paste0("Attempting git_remote using provided ",
+        "credentials for authentication.")))
     } else if (!quiet) {
-      message("auth_token does not have scopes 'read-repository' and 'api' ",
-        "for host '", host, "' required to install using gitlab_remote.\n",
-        "Attempting using git_remote.")
+      message(wrap(exdent = 2L, "Attempting using git_remote."))
     }
 
-    git_remote(
+    return(git_remote(
       url = url,
       subdir = subdir,
       ref = sha %||% meta$ref,
+      credentials = credentials,
       ...
-    )
-  } else {
-    remote("gitlab",
-      host = host,
-      repo = paste(c(meta$repo, meta$subdir), collapse = "/"),
-      subdir = subdir,
-      username = meta$username,
-      ref = meta$ref,
-      sha = sha,
-      auth_token = auth_token
-    )
+    ))
   }
+
+  remote("gitlab",
+    host = host,
+    repo = paste(c(meta$repo, meta$subdir), collapse = "/"),
+    subdir = subdir,
+    username = meta$username,
+    ref = meta$ref,
+    sha = sha,
+    auth_token = auth_token
+  )
 }
 
 #' @export