github-org-manager 0.5.0__tar.gz → 0.5.2__tar.gz

{github_org_manager-0.5.0 → github_org_manager-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: github-org-manager
-Version: 0.5.0
+Version: 0.5.2
 Summary: Manage a GitHub Organization, its teams, repository permissions, and more
 Home-page: https://github.com/OpenRailAssociation/github-org-manager
 License: Apache-2.0
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Version Control :: Git
 Classifier: Topic :: Utilities
 Requires-Dist: pygithub (>=2.3.0,<3.0.0)

{github_org_manager-0.5.0 → github_org_manager-0.5.2}/gh_org_mgr/_gh_api.py

@@ -39,7 +39,22 @@ def run_graphql_query(query, variables, token):
         headers=headers,
         timeout=10,
     )
-    if request.status_code == 200:
-        return request.json()
 
-    sys.exit(f"Query failed to run by returning code of {query}: {request.status_code}")
+    # Get JSON result
+    json_return = "No valid JSON return"
+    try:
+        json_return = request.json()
+    except requests.exceptions.JSONDecodeError:
+        pass
+
+    if request.status_code == 200:
+        return json_return
+
+    # Debug information in case of errors
+    print(
+        f"Query failed with HTTP error code '{request.status_code}' when running "
+        f"this query: {query}\n"
+        f"Return: {json_return}\n"
+        f"Headers: {request.headers}"
+    )
+    sys.exit(1)

{github_org_manager-0.5.0 → github_org_manager-0.5.2}/gh_org_mgr/_gh_org.py

@@ -30,6 +30,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
     org_members: list[NamedUser] = field(default_factory=list)
     current_teams: dict[Team, dict] = field(default_factory=dict)
     configured_teams: dict[str, dict | None] = field(default_factory=dict)
+    newly_added_users: list[NamedUser] = field(default_factory=list)
     current_repos_teams: dict[Repository, dict[Team, str]] = field(default_factory=dict)
     current_repos_collaborators: dict[Repository, dict[str, str]] = field(default_factory=dict)
     configured_repos_collaborators: dict[str, dict[str, str]] = field(default_factory=dict)
@@ -197,6 +198,112 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
 
             logging.debug("Configuration for team '%s' consolidated to: %s", team_name, team_config)
 
+    # --------------------------------------------------------------------------
+    # Owners
+    # --------------------------------------------------------------------------
+    def _get_current_org_owners(self) -> None:
+        """Get all owners of the org"""
+        # Reset the user list, then build up new list
+        self.current_org_owners = []
+        for member in self.org.get_members(role="admin"):
+            self.current_org_owners.append(member)
+
+    def _check_configured_org_owners(self) -> bool:
+        """Check configured owners and make them lower-case for better
+        comparison. Returns True if owners are well configured."""
+        # Add configured owners if they are a list
+        if isinstance(self.configured_org_owners, list):
+            # Make all configured users lower-case
+            self.configured_org_owners = [user.lower() for user in self.configured_org_owners]
+        else:
+            logging.warning(
+                "The organisation owners are not configured as a proper list. Will not handle them."
+            )
+            self.configured_org_owners = []
+
+        if not self.configured_org_owners:
+            logging.warning(
+                "No owners for your GitHub organisation configured. Will not make any "
+                "change regarding the ownership, and continue with the current owners: %s",
+                ", ".join([user.login for user in self.current_org_owners]),
+            )
+            return False
+
+        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
+        return False
+
+    def sync_org_owners(self, dry: bool = False, force: bool = False) -> None:
+        """Synchronise the organization owners"""
+        # Get current and configured owners
+        self._get_current_org_owners()
+
+        # Abort owner synchronisation if no owners are configured, or badly
+        if not self._check_configured_org_owners():
+            return
+
+        # Get differences between the current and configured owners
+        owners_remove, owners_ok, owners_add = self.compare_two_lists(
+            self.configured_org_owners, [user.login for user in self.current_org_owners]
+        )
+        # Compare configured (lower-cased) owners with lower-cased list of current owners
+        if not owners_remove and not owners_add:
+            logging.info("Organization owners are in sync, no changes")
+            return
+
+        logging.debug(
+            "Organization owners are not in sync. Config: '%s' vs. Current: '%s'",
+            self.configured_org_owners,
+            self.current_org_owners,
+        )
+        logging.debug(
+            "Will remove %s, will not change %s, will add %s", owners_remove, owners_ok, owners_add
+        )
+
+        # Add the missing owners
+        for user in owners_add:
+            if gh_user := self._resolve_gh_username(user, "<org owners>"):
+                logging.info("Adding user '%s' as organization owner", gh_user.login)
+                if not dry:
+                    self.org.add_to_members(gh_user, "admin")
+
+        # Remove the surplus owners
+        for user in owners_remove:
+            if gh_user := self._resolve_gh_username(user, "<org owners>"):
+                logging.info(
+                    "User '%s' is not configured as organization owners. "
+                    "Will make them a normal member",
+                    gh_user.login,
+                )
+                # Handle authenticated user being the same as the one you want to degrade
+                if self._is_user_authenticated_user(gh_user):
+                    logging.warning(
+                        "The user '%s' you want to remove from owners is the one you "
+                        "authenticated with. This may disrupt all further operations. "
+                        "Unless you run the program with --force, "
+                        "this operation will not be executed.",
+                        gh_user.login,
+                    )
+                    # Check if user forced this operation
+                    if force:
+                        logging.info(
+                            "You called the program with --force, "
+                            "so it will remove yourself from the owners"
+                        )
+                    else:
+                        continue
+
+                # Execute the degradation of the owner
+                if not dry:
+                    self.org.add_to_members(gh_user, "member")
+
+        # Update the current organisation owners
+        self._get_current_org_owners()
+
     # --------------------------------------------------------------------------
     # Teams
     # --------------------------------------------------------------------------
@@ -342,112 +449,6 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
             else:
                 logging.info("Team '%s' settings are in sync, no changes", team.name)
 
-    # --------------------------------------------------------------------------
-    # Owners
-    # --------------------------------------------------------------------------
-    def _get_current_org_owners(self) -> None:
-        """Get all owners of the org"""
-        # Reset the user list, then build up new list
-        self.current_org_owners = []
-        for member in self.org.get_members(role="admin"):
-            self.current_org_owners.append(member)
-
-    def _check_configured_org_owners(self) -> bool:
-        """Check configured owners and make them lower-case for better
-        comparison. Returns True if owners are well configured."""
-        # Add configured owners if they are a list
-        if isinstance(self.configured_org_owners, list):
-            # Make all configured users lower-case
-            self.configured_org_owners = [user.lower() for user in self.configured_org_owners]
-        else:
-            logging.warning(
-                "The organisation owners are not configured as a proper list. Will not handle them."
-            )
-            self.configured_org_owners = []
-
-        if not self.configured_org_owners:
-            logging.warning(
-                "No owners for your GitHub organisation configured. Will not make any "
-                "change regarding the ownership, and continue with the current owners: %s",
-                ", ".join([user.login for user in self.current_org_owners]),
-            )
-            return False
-
-        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
-        return False
-
-    def sync_org_owners(self, dry: bool = False, force: bool = False) -> None:
-        """Synchronise the organization owners"""
-        # Get current and configured owners
-        self._get_current_org_owners()
-
-        # Abort owner synchronisation if no owners are configured, or badly
-        if not self._check_configured_org_owners():
-            return
-
-        # Get differences between the current and configured owners
-        owners_remove, owners_ok, owners_add = self.compare_two_lists(
-            self.configured_org_owners, [user.login for user in self.current_org_owners]
-        )
-        # Compare configured (lower-cased) owners with lower-cased list of current owners
-        if not owners_remove and not owners_add:
-            logging.info("Organization owners are in sync, no changes")
-            return
-
-        logging.debug(
-            "Organization owners are not in sync. Config: '%s' vs. Current: '%s'",
-            self.configured_org_owners,
-            self.current_org_owners,
-        )
-        logging.debug(
-            "Will remove %s, will not change %s, will add %s", owners_remove, owners_ok, owners_add
-        )
-
-        # Add the missing owners
-        for user in owners_add:
-            if gh_user := self._resolve_gh_username(user, "<org owners>"):
-                logging.info("Adding user '%s' as organization owner", gh_user.login)
-                if not dry:
-                    self.org.add_to_members(gh_user, "admin")
-
-        # Remove the surplus owners
-        for user in owners_remove:
-            if gh_user := self._resolve_gh_username(user, "<org owners>"):
-                logging.info(
-                    "User '%s' is not configured as organization owners. "
-                    "Will make them a normal member",
-                    gh_user.login,
-                )
-                # Handle authenticated user being the same as the one you want to degrade
-                if self._is_user_authenticated_user(gh_user):
-                    logging.warning(
-                        "The user '%s' you want to remove from owners is the one you "
-                        "authenticated with. This may disrupt all further operations. "
-                        "Unless you run the program with --force, "
-                        "this operation will not be executed.",
-                        gh_user.login,
-                    )
-                    # Check if user forced this operation
-                    if force:
-                        logging.info(
-                            "You called the program with --force, "
-                            "so it will remove yourself from the owners"
-                        )
-                    else:
-                        continue
-
-                # Execute the degradation of the owner
-                if not dry:
-                    self.org.add_to_members(gh_user, "member")
-
-        # Update the current organisation owners
-        self._get_current_org_owners()
-
     # --------------------------------------------------------------------------
     # Members
     # --------------------------------------------------------------------------
@@ -485,6 +486,13 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
 
         return current_users
 
+    def _add_or_update_user_in_team(self, team: Team, user: NamedUser, role: str):
+        """Add or update membership of a user in a team"""
+        team.add_membership(member=user, role=role)
+        # Document that the user has just been added to a team. Relevant when we
+        # will later find users without team membership
+        self.newly_added_users.append(user)
+
     def sync_teams_members(self, dry: bool = False) -> None:  # pylint: disable=too-many-branches
         """Check the configured members of each team, add missing ones and delete unconfigured"""
         logging.debug("Starting to sync team members")
@@ -571,7 +579,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                         config_role,
                     )
                     if not dry:
-                        team.add_membership(member=gh_user, role=config_role)
+                        self._add_or_update_user_in_team(team=team, user=gh_user, role=config_role)
 
                 # Update roles if they differ from old role
                 elif config_role != current_team_members.get(config_user, ""):
@@ -585,7 +593,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                         config_role,
                     )
                     if not dry:
-                        team.add_membership(member=gh_user, role=config_role)
+                        self._add_or_update_user_in_team(team=team, user=gh_user, role=config_role)
 
             # Loop through all current members. Remove them if they are not configured
             for current_user in current_team_members:
@@ -618,11 +626,12 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
         all_org_members = set(self.org_members + self.current_org_owners)
 
         # Get all members of all teams
-        all_team_members_lst = []
+        all_team_members_lst: list[NamedUser] = []
         for _, team_attrs in self.current_teams.items():
             for member in team_attrs.get("members", {}):
                 all_team_members_lst.append(member)
-        all_team_members = set(all_team_members_lst)
+        # 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)
 
         # Find members that are in org_members but not team_members
         members_without_team = all_org_members.difference(all_team_members)
@@ -867,6 +876,8 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
 
                 # Add team member to repo with their repo permissions
                 for team_member in team_members:
+                    # Lower-case team member
+                    team_member = team_member.lower()
                     # Check if permissions already exist
                     if self.configured_repos_collaborators[repo].get(team_member, {}):
                         logging.debug(
@@ -882,7 +893,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes, too-many-lines
                             )
                         )
                     else:
-                        self.configured_repos_collaborators[repo][team_member.lower()] = perm
+                        self.configured_repos_collaborators[repo][team_member] = perm
 
     def _convert_graphql_perm_to_rest(self, permission: str) -> str:
         """Convert a repo permission coming from the GraphQL API to the ones

{github_org_manager-0.5.0 → github_org_manager-0.5.2}/pyproject.toml

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

{github_org_manager-0.5.0 → github_org_manager-0.5.2}/gh_org_mgr/manage.py

@@ -116,12 +116,12 @@ def main():
         # Get current rate limit
         org.ratelimit()
 
+        # Synchronise organisation owners
+        org.sync_org_owners(dry=args.dry, force=args.force)
         # Create teams that aren't present at Github yet
         org.create_missing_teams(dry=args.dry)
         # Configure general settings of teams
         org.sync_current_teams_settings(dry=args.dry)
-        # Synchronise organisation owners
-        org.sync_org_owners(dry=args.dry, force=args.force)
         # Synchronise the team memberships
         org.sync_teams_members(dry=args.dry)
         # Report about organisation members that do not belong to any team