Merge pull request #7543 from tdesveaux/git/http-credentials

Git steps: implement auth by user/password
buildbot · May 14, 2024 · 97fb9c3 · 97fb9c3
2 parents e298cb7 + f7982af
commit 97fb9c3
Show file tree

Hide file tree

Showing 12 changed files with 832 additions and 55 deletions.
diff --git a/master/buildbot/steps/source/git.py b/master/buildbot/steps/source/git.py
@@ -13,6 +13,10 @@
 #
 # Copyright Buildbot Team Members
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from twisted.internet import defer
 from twisted.internet import reactor
 from twisted.python import log
@@ -25,6 +29,12 @@
 from buildbot.steps.worker import CompositeStepMixin
 from buildbot.util.git import RC_SUCCESS
 from buildbot.util.git import GitStepMixin
+from buildbot.util.git_credential import GitCredentialOptions
+from buildbot.util.git_credential import add_user_password_to_credentials
+
+if TYPE_CHECKING:
+    from buildbot.interfaces import IRenderable
+
 
 GIT_HASH_LENGTH = 40
 
@@ -89,6 +99,8 @@ def __init__(
         sshPrivateKey=None,
         sshHostKey=None,
         sshKnownHosts=None,
+        auth_credentials: tuple[IRenderable | str, IRenderable | str] | None = None,
+        git_credentials: GitCredentialOptions | None = None,
         **kwargs,
     ):
         if not getDescription and not isinstance(getDescription, dict):
@@ -115,7 +127,19 @@ def __init__(
         super().__init__(**kwargs)
 
         self.setupGitStep()
-        self.setup_git_auth(sshPrivateKey, sshHostKey, sshKnownHosts)
+        if auth_credentials is not None:
+            git_credentials = add_user_password_to_credentials(
+                auth_credentials,
+                repourl,
+                git_credentials,
+            )
+
+        self.setup_git_auth(
+            sshPrivateKey,
+            sshHostKey,
+            sshKnownHosts,
+            git_credentials,
+        )
 
         if isinstance(self.mode, str):
             if not self._hasAttrGroupMember('mode', self.mode):
@@ -596,6 +620,8 @@ def __init__(
         sshPrivateKey=None,
         sshHostKey=None,
         sshKnownHosts=None,
+        auth_credentials: tuple[IRenderable | str, IRenderable | str] | None = None,
+        git_credentials: GitCredentialOptions | None = None,
         config=None,
         **kwargs,
     ):
@@ -611,7 +637,19 @@ def __init__(
         super().__init__(**kwargs)
 
         self.setupGitStep()
-        self.setup_git_auth(sshPrivateKey, sshHostKey, sshKnownHosts)
+        if auth_credentials is not None:
+            git_credentials = add_user_password_to_credentials(
+                auth_credentials,
+                repourl,
+                git_credentials,
+            )
+
+        self.setup_git_auth(
+            sshPrivateKey,
+            sshHostKey,
+            sshKnownHosts,
+            git_credentials,
+        )
 
         if not self.branch:
             bbconfig.error('GitPush: must provide branch')