Merge pull request #249 from MagicRB/use_installation_token_for_chang…

…e_hook Use installation tokens for GitHub change hooks
nix-community · Aug 12, 2024 · e0bd56e · e0bd56e
2 parents 5f030db + e18e41e
commit e0bd56e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 8 deletions.
diff --git a/buildbot_nix/github_projects.py b/buildbot_nix/github_projects.py
@@ -291,7 +291,7 @@ def get_general_token(self) -> RepoToken:
         pass
 
     @abstractmethod
-    def get_repo_token(self, repo: RepoData) -> RepoToken:
+    def get_repo_token(self, repo_full_name: str) -> RepoToken:
         pass
 
     @abstractmethod
@@ -354,7 +354,7 @@ def __init__(self, auth_type: GitHubLegacyConfig) -> None:
     def get_general_token(self) -> RepoToken:
         return self.token
 
-    def get_repo_token(self, repo: RepoData) -> RepoToken:
+    def get_repo_token(self, repo_full_name: str) -> RepoToken:
         return self.token
 
     def create_secret_providers(self) -> list[SecretProviderBase]:
@@ -436,9 +436,9 @@ def __init__(self, auth_type: GitHubAppConfig) -> None:
     def get_general_token(self) -> RepoToken:
         return self.jwt_token
 
-    def get_repo_token(self, repo: RepoData) -> RepoToken:
-        assert repo.installation_id is not None, f"Missing installation_id in {repo}"
-        return self.installation_tokens[repo.installation_id]
+    def get_repo_token(self, repo_full_name: str) -> RepoToken:
+        installation_id = self.project_id_map[repo_full_name]
+        return self.installation_tokens[installation_id]
 
     def create_secret_providers(self) -> list[SecretProviderBase]:
         return [GitHubAppSecretService(self.installation_tokens, self.jwt_token)]
@@ -585,10 +585,15 @@ def create_reporter(self) -> ReporterBase:
         return self.auth_backend.create_reporter()
 
     def create_change_hook(self) -> dict[str, Any]:
+        def get_github_token(props: Properties) -> str:
+            return self.auth_backend.get_repo_token(
+                props.getProperty("full_name")
+            ).get()
+
         return {
             "secret": self.webhook_secret,
             "strict": True,
-            "token": self.auth_backend.get_general_token().get(),
+            "token": WithProperties("%(github_token)s", github_token=get_github_token),
             "github_property_whitelist": ["github.base.sha", "github.head.sha"],
         }
 
@@ -638,7 +643,7 @@ def load_projects(self) -> list["GitProject"]:
         )
         return [
             GithubProject(
-                self.auth_backend.get_repo_token(repo),
+                self.auth_backend.get_repo_token(repo.full_name),
                 self.config,
                 self.webhook_secret,
                 RepoData.model_validate(repo),

diff --git a/nix/master.nix b/nix/master.nix
@@ -681,7 +681,14 @@ in
         dbUrl = config.services.buildbot-nix.master.dbUrl;
 
         package = cfg.buildbotNixpkgs.buildbot.overrideAttrs (old: {
-          patches = old.patches ++ [ ./0001-master-reporters-github-render-token-for-each-reques.patch ];
+          patches = old.patches ++ [
+            ./0001-master-reporters-github-render-token-for-each-reques.patch
+            (pkgs.fetchpatch {
+              name = "give-access-to-full-name-in-the-git-hub-hook-properties.patch";
+              url = "https://github.com/buildbot/buildbot/commit/27eb8c311c0beeb35c9b0c21be437684744dce21.patch";
+              hash = "sha256-VPH7EoDVZXwx6oc6rzkUcsNEq+nGLcTNmNMlrrW6Mog=";
+            })
+          ];
         });
         pythonPackages =
           let