github-org-manager 0.7.3__tar.gz → 0.7.4__tar.gz

{github_org_manager-0.7.3 → github_org_manager-0.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: github-org-manager
-Version: 0.7.3
+Version: 0.7.4
 Summary: Manage a GitHub Organization, its teams, repository permissions, and more
 License: Apache-2.0
 Keywords: github,github-management,permissions,access-control

{github_org_manager-0.7.3 → github_org_manager-0.7.4}/gh_org_mgr/_gh_org.py

@@ -8,14 +8,12 @@ import logging
 import sys
 from dataclasses import asdict, dataclass, field
 
-from github import (
-    Auth,
-    Github,
+from github import Auth, Github, GithubIntegration
+from github.GithubException import (
+    BadCredentialsException,
     GithubException,
-    GithubIntegration,
     UnknownObjectException,
 )
-from github.GithubException import BadCredentialsException
 from github.NamedUser import NamedUser
 from github.Organization import Organization
 from github.Repository import Repository
@@ -54,6 +52,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
     current_repos_collaborators: dict[Repository, dict[str, str]] = field(default_factory=dict)
     configured_repos_collaborators: dict[str, dict[str, str]] = field(default_factory=dict)
     archived_repos: list[Repository] = field(default_factory=list)
+    unconfigured_teams: list[Team] = field(default_factory=list)
     unconfigured_team_repo_permissions: dict[str, dict[str, str]] = field(default_factory=dict)
     stats: OrgChanges = field(default_factory=OrgChanges)
 
@@ -84,8 +83,9 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
 
         # Decide how to login. If app set, prefer this
         if self.gh_app_id and self.gh_app_private_key:
-            logging.debug("Logging in via app %s", self.gh_app_id)
-            auth = Auth.AppAuth(app_id=self.gh_app_id, private_key=self.gh_app_private_key)
+            gh_app_id_sanitized = str(self.gh_app_id).strip("'").strip('"')
+            logging.debug("Logging in via app %s", gh_app_id_sanitized)
+            auth = Auth.AppAuth(app_id=gh_app_id_sanitized, private_key=self.gh_app_private_key)
             app = GithubIntegration(auth=auth)
             try:
                 installation = app.get_org_installation(org=orgname)
@@ -202,9 +202,16 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         return True
 
     def _is_user_authenticated_user(self, user: NamedUser) -> bool:
-        """Check if a given NamedUser is the authenticated user"""
-        if user.login == self.gh.get_user().login:
-            return True
+        """Check if a given NamedUser is the authenticated user. If logging in via App, this will
+        always return False, as the authenticated user is the App itself"""
+        try:
+            if user.login == self.gh.get_user().login:
+                return True
+        except GithubException as e:
+            if e.status == 403 and "Resource not accessible by integration" in str(e):
+                logging.debug("Cannot check if user is authenticated, as this is an App login")
+                return False
+            raise
         return False
 
     def sync_org_owners(self, dry: bool = False, force: bool = False) -> None:
@@ -296,7 +303,18 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         for team, attributes in self.configured_teams.items():
             if team not in existent_team_names:
                 if parent := attributes.get("parent"):  # type: ignore
-                    parent_id = self.org.get_team_by_slug(sluggify_teamname(parent)).id
+                    try:
+                        parent_id = self.org.get_team_by_slug(sluggify_teamname(parent)).id
+                    except UnknownObjectException:
+                        if dry:
+                            logging.debug(
+                                "For team %s, the configured parent team's ('%s') ID wasn't found, "
+                                "probably because it should be created but it's a dry-run. "
+                                "We set a default ID of 424242",
+                                team,
+                                parent,
+                            )
+                            parent_id = 424242
 
                     logging.info("Creating team '%s' with parent ID '%s'", team, parent_id)
                     self.stats.create_team(team)
@@ -594,31 +612,38 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                             team.name,
                         )
 
-    def get_unconfigured_teams(
+    def get_and_delete_unconfigured_teams(
         self, dry: bool = False, delete_unconfigured_teams: bool = False
     ) -> None:
         """Get all teams that are not configured locally and optionally remove them"""
         # Get all teams that are not configured locally
-        unconfigured_teams: list[Team] = []
         for team in self.current_teams:
             if team.name not in self.configured_teams:
-                unconfigured_teams.append(team)
+                self.unconfigured_teams.append(team)
 
-        if unconfigured_teams:
+        if self.unconfigured_teams:
             if delete_unconfigured_teams:
-                for team in unconfigured_teams:
+                for team in self.unconfigured_teams:
                     logging.info("Deleting team '%s' as it is not configured locally", team.name)
                     self.stats.delete_team(team=team.name, deleted=True)
                     if not dry:
-                        team.delete()
+                        try:
+                            team.delete()
+                        except UnknownObjectException as e:
+                            logging.info(
+                                "Team '%s' could not be deleted, probably because it was already "
+                                "deleted as part of a parent team. "
+                                "Error: %s",
+                                team.name,
+                                e,
+                            )
             else:
-                unconfigured_teams_str = [team.name for team in unconfigured_teams]
                 logging.warning(
                     "The following teams of your GitHub organisation are not "
                     "configured locally: %s. Taking no action about these teams.",
-                    ", ".join(unconfigured_teams_str),
+                    ", ".join([team.name for team in self.unconfigured_teams]),
                 )
-                for team in unconfigured_teams:
+                for team in self.unconfigured_teams:
                     self.stats.delete_team(team=team.name, deleted=False)
 
     def get_members_without_team(

{github_org_manager-0.7.3 → github_org_manager-0.7.4}/gh_org_mgr/manage.py

@@ -145,7 +145,7 @@ def main():
         org.sync_teams_members(dry=args.dry)
         # Report and act on teams that are not configured locally
         log_progress("Checking for unconfigured teams...")
-        org.get_unconfigured_teams(
+        org.get_and_delete_unconfigured_teams(
             dry=args.dry,
             delete_unconfigured_teams=cfg_app.get("delete_unconfigured_teams", False),
         )

{github_org_manager-0.7.3 → github_org_manager-0.7.4}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [tool.poetry]
 name = "github-org-manager"
-version = "0.7.3"
+version = "0.7.4"
 description = "Manage a GitHub Organization, its teams, repository permissions, and more"
 authors = ["Max Mehl <max.mehl@deutschebahn.com>"]
 readme = "README.md"