github-org-manager 0.5.6__tar.gz → 0.6.0__tar.gz

{github_org_manager-0.5.6 → github_org_manager-0.6.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: github-org-manager
-Version: 0.5.6
+Version: 0.6.0
 Summary: Manage a GitHub Organization, its teams, repository permissions, and more
-Home-page: https://github.com/OpenRailAssociation/github-org-manager
 License: Apache-2.0
 Keywords: github,github-management,permissions,access-control
 Author: Max Mehl
@@ -77,7 +76,7 @@ Afterwards, the tool is executable with the command `gh-org-mgr`. The `--help` f
 
 Inside [`config/example`](./config/example), you can find an example configuration that shall help you to understand the structure:
 
-* `app.yaml`: Configuration necessary to run this tool
+* `app.yaml`: Configuration necessary to run this tool and controlling some behaviour
 * `org.yaml`: Organization-wide configuration
 * `teams/*.yaml`: Configuration concerning the teams of your organization.
 

{github_org_manager-0.5.6 → github_org_manager-0.6.0}/README.md

@@ -48,7 +48,7 @@ Afterwards, the tool is executable with the command `gh-org-mgr`. The `--help` f
 
 Inside [`config/example`](./config/example), you can find an example configuration that shall help you to understand the structure:
 
-* `app.yaml`: Configuration necessary to run this tool
+* `app.yaml`: Configuration necessary to run this tool and controlling some behaviour
 * `org.yaml`: Organization-wide configuration
 * `teams/*.yaml`: Configuration concerning the teams of your organization.
 

{github_org_manager-0.5.6 → github_org_manager-0.6.0}/gh_org_mgr/_gh_org.py

@@ -15,10 +15,12 @@ from github import (
     GithubIntegration,
     UnknownObjectException,
 )
+from github.GithubException import BadCredentialsException
 from github.NamedUser import NamedUser
 from github.Organization import Organization
 from github.Repository import Repository
 from github.Team import Team
+from jwt.exceptions import InvalidKeyError
 
 from ._gh_api import get_github_secrets_from_env, run_graphql_query
 
@@ -65,6 +67,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         # supported, or multiple spaces etc.
         return team.replace(" ", "-")
 
+    # amazonq-ignore-next-line
     def login(
         self, orgname: str, token: str = "", app_id: str | int = "", app_private_key: str = ""
     ) -> None:
@@ -81,7 +84,11 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
             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)
             app = GithubIntegration(auth=auth)
-            installation = app.get_org_installation(org=orgname)
+            try:
+                installation = app.get_org_installation(org=orgname)
+            except InvalidKeyError:
+                logging.critical("Invalid private key provided for GitHub App")
+                sys.exit(1)
             self.gh = installation.get_github_for_installation()
             logging.debug("Logged in via app installation %s", installation.id)
 
@@ -90,7 +97,11 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         elif self.gh_token:
             logging.debug("Logging in as user with PAT")
             self.gh = Github(auth=Auth.Token(self.gh_token))
-            logging.debug("Logged in as %s", self.gh.get_user().login)
+            try:
+                logging.debug("Logged in as %s", self.gh.get_user().login)
+            except BadCredentialsException:
+                logging.critical("Invalid GitHub token provided")
+                sys.exit(1)
         else:
             logging.error("No GitHub token or App ID+private key provided")
             sys.exit(1)
@@ -539,6 +550,10 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         open_invitations = [user.login.lower() for user in self.org.invitations()]
 
         for team, team_attrs in self.current_teams.items():
+            # Ignore any team not being configured locally, will be handled later
+            if team.name not in self.configured_teams:
+                continue
+
             # Update current team members with dict[NamedUser, str (role)]
             team_attrs["members"] = self._get_current_team_members(team)
 
@@ -548,15 +563,6 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                 user.login.lower(): role for user, role in team_attrs["members"].items()
             }
 
-            # Handle the team not being configured locally
-            if team.name not in self.configured_teams:
-                logging.warning(
-                    "Team '%s' does not seem to be configured locally. "
-                    "Taking no action about this team at all",
-                    team.name,
-                )
-                continue
-
             # Get configuration from current team
             if team_configuration := self.configured_teams.get(team.name):
                 pass
@@ -655,8 +661,35 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                             team.name,
                         )
 
-    def get_members_without_team(self) -> None:
-        """Get all organisation members without any team membership"""
+    def get_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)
+
+        if unconfigured_teams:
+            if delete_unconfigured_teams:
+                for team in unconfigured_teams:
+                    logging.info("Deleting team '%s' as it is not configured locally", team.name)
+                    if not dry:
+                        team.delete()
+            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),
+                )
+
+    def get_members_without_team(
+        self, dry: bool = False, remove_members_without_team: bool = False
+    ) -> None:
+        """Get all organisation members without any team membership, and
+        optionally remove them"""
         # Combine org owners and org members
         all_org_members = set(self.org_members + self.current_org_owners)
 
@@ -665,18 +698,30 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         for _, team_attrs in self.current_teams.items():
             for member in team_attrs.get("members", {}):
                 all_team_members_lst.append(member)
-        # Also add users that have just been added to a team, and unify them
-        all_team_members: set[NamedUser] = set(all_team_members_lst + self.newly_added_users)
+        # Also add org owners and users that have just been added to a team, and unify them
+        all_team_members: set[NamedUser] = set(
+            all_team_members_lst + self.newly_added_users + self.current_org_owners
+        )
 
         # Find members that are in org_members but not team_members
         members_without_team = all_org_members.difference(all_team_members)
 
         if members_without_team:
-            members_without_team_str = [user.login for user in members_without_team]
-            logging.warning(
-                "The following members of your GitHub organisation are not member of any team: %s",
-                ", ".join(members_without_team_str),
-            )
+            if remove_members_without_team:
+                for user in members_without_team:
+                    logging.info(
+                        "Removing user '%s' from organisation as they are not member of any team",
+                        user.login,
+                    )
+                    if not dry:
+                        self.org.remove_from_membership(user)
+            else:
+                members_without_team_str = [user.login for user in members_without_team]
+                logging.warning(
+                    "The following members of your GitHub organisation are not "
+                    "member of any team: %s",
+                    ", ".join(members_without_team_str),
+                )
 
     # --------------------------------------------------------------------------
     # Repos

{github_org_manager-0.5.6 → github_org_manager-0.6.0}/gh_org_mgr/manage.py

@@ -129,8 +129,16 @@ def main():
         org.sync_current_teams_settings(dry=args.dry)
         # Synchronise the team memberships
         org.sync_teams_members(dry=args.dry)
-        # Report about organisation members that do not belong to any team
-        org.get_members_without_team()
+        # Report and act on teams that are not configured locally
+        org.get_unconfigured_teams(
+            dry=args.dry,
+            delete_unconfigured_teams=cfg_app.get("delete_unconfigured_teams", False),
+        )
+        # Report and act on organisation members that do not belong to any team
+        org.get_members_without_team(
+            dry=args.dry,
+            remove_members_without_team=cfg_app.get("remove_members_without_team", False),
+        )
         # Synchronise the permissions of teams for all repositories
         org.sync_repo_permissions(dry=args.dry, ignore_archived=args.ignore_archived)
         # Remove individual collaborator permissions if they are higher than the one

{github_org_manager-0.5.6 → github_org_manager-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [tool.poetry]
 name = "github-org-manager"
-version = "0.5.6"
+version = "0.6.0"
 description = "Manage a GitHub Organization, its teams, repository permissions, and more"
 authors = ["Max Mehl <max.mehl@deutschebahn.com>"]
 readme = "README.md"
@@ -33,13 +33,13 @@ requests = "^2.32.3"
 python-slugify = "^8.0.4"
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.3.0"
-isort = "^5.13.2"
+black = "^25.1.0"
+isort = ">=5.13.2,<7.0.0"
 mypy = "^1.9.0"
 pylint = "^3.1.0"
 types-pyyaml = "^6.0.12.20240311"
 types-requests = "^2.32.0.20240712"
-bump-my-version = "^0.26.0"
+bump-my-version = "^0.32.0"
 
 [build-system]
 requires = ["poetry-core"]