github-org-manager 0.3.0__tar.gz → 0.3.1__tar.gz

{github_org_manager-0.3.0 → github_org_manager-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: github-org-manager
-Version: 0.3.0
+Version: 0.3.1
 Summary: Manage a GitHub Organization, its teams, repository permissions, and more
 Home-page: https://github.com/OpenRailAssociation/github-org-manager
 License: Apache-2.0

{github_org_manager-0.3.0 → github_org_manager-0.3.1}/gh_org_mgr/_gh_org.py

@@ -23,6 +23,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
     gh: Github = None  # type: ignore
     org: Organization = None  # type: ignore
     gh_token: str = ""
+    default_repository_permission: str = ""
     org_owners: list[NamedUser] = field(default_factory=list)
     org_members: list[NamedUser] = field(default_factory=list)
     current_teams: dict[Team, dict] = field(default_factory=dict)
@@ -59,6 +60,18 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
         """Convert the dataclass to a JSON string"""
         d = asdict(self)
 
+        # Censor sensible fields
+        def censor_half_string(string: str) -> str:
+            """Censor 50% of a string (rounded up)"""
+            half1 = int(len(string) / 2)
+            half2 = len(string) - half1
+            return string[:half1] + "*" * (half2)
+
+        sensible_keys = ["gh_token"]
+        for key in sensible_keys:
+            d[key] = censor_half_string(d.get(key, ""))
+
+        # Print dict nicely
         def pretty(d, indent=0):
             string = ""
             for key, value in d.items():
@@ -75,9 +88,8 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
     # --------------------------------------------------------------------------
     # Teams
     # --------------------------------------------------------------------------
-    def get_current_teams(self):
+    def _get_current_teams(self):
         """Get teams of the existing organisation"""
-
         for team in list(self.org.get_teams()):
             self.current_teams[team] = {"members": {}, "repos": {}}
 
@@ -85,7 +97,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
         """Find out which teams are configured but not part of the org yet"""
 
         # Get list of current teams
-        self.get_current_teams()
+        self._get_current_teams()
 
         # Get the names of the existing teams
         existent_team_names = [team.name for team in self.current_teams]
@@ -108,7 +120,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
                 logging.debug("Team '%s' already exists", team)
 
         # Re-scan current teams as new ones may have been created
-        self.get_current_teams()
+        self._get_current_teams()
 
     # --------------------------------------------------------------------------
     # Members
@@ -474,13 +486,55 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
 
         return ""
 
+    def _get_direct_repo_permissions_of_team(self, team_dict: dict) -> tuple[dict[str, str], str]:
+        """Get a list of directly configured repo permissions for a team, and
+        whether the team has a parent"""
+        repo_perms: dict[str, str] = {}
+        # Direct permissions
+        for repo, perm in team_dict.get("repos", {}).items():
+            repo_perms[repo] = perm
+
+        # Parent team
+        parent = team_dict.get("parent", "")
+
+        return repo_perms, parent
+
+    def _get_all_repo_permissions_for_team_and_parents(self, team_name: str, team_dict: dict):
+        """Get a list of all configured repo permissions for a team, also those
+        inherited by parent teams"""
+        all_repo_perms, parent = self._get_direct_repo_permissions_of_team(team_dict=team_dict)
+        # If parents have been found, iterate and merge them
+        while parent:
+            logging.debug(
+                "Checking for repository permissions of %s's parent team %s", team_name, parent
+            )
+            parent_team_dict = self.configured_teams[parent]
+
+            # Handle empty parent dict
+            if not parent_team_dict:
+                break
+
+            # Get repo permissions and potential parent, and add it
+            repo_perm, parent = self._get_direct_repo_permissions_of_team(
+                team_dict=parent_team_dict
+            )
+            for repo, perm in repo_perm.items():
+                # Add (highest) repo permission
+                all_repo_perms[repo] = self._get_highest_permission(
+                    perm, all_repo_perms.get(repo, "")
+                )
+
+        return all_repo_perms
+
     def _get_configured_repos_and_user_perms(self):
         """
         Get a list of repos with a list of individuals and their permissions,
         based on their team memberships
         """
-        for _, team_attrs in self.configured_teams.items():
-            for repo, perm in team_attrs.get("repos", {}).items():
+        for team_name, team_attrs in self.configured_teams.items():
+            logging.debug("Getting configured repository permissions for team %s", team_name)
+            repo_perms = self._get_all_repo_permissions_for_team_and_parents(team_name, team_attrs)
+            for repo, perm in repo_perms.items():
                 # Create repo if non-exist
                 if repo not in self.configured_repos_collaborators:
                     self.configured_repos_collaborators[repo] = {}
@@ -513,14 +567,15 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
         """Convert a repo permission coming from the GraphQL API to the ones
         coming from the REST API"""
         perm_conversion = {
-            "READ": "pull",
-            "TRIAGE": "triage",
-            "WRITE": "push",
-            "MAINTAIN": "maintain",
-            "ADMIN": "admin",
+            "none": "",
+            "read": "pull",
+            "triage": "triage",
+            "write": "push",
+            "maintain": "maintain",
+            "admin": "admin",
         }
-        if permission in perm_conversion:
-            replacement = perm_conversion.get(permission, "")
+        if permission.lower() in perm_conversion:
+            replacement = perm_conversion.get(permission.lower(), "")
             return replacement
 
         return permission
@@ -528,20 +583,22 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
     def _fetch_collaborators_of_repo(self, repo: Repository):
         """Get all collaborators (individuals) of a GitHub repo with their
         permissions using the GraphQL API"""
+        # TODO: Consider doing this for all repositories at once, but calculate
+        # costs beforehand
         query = """
             query($owner: String!, $name: String!, $cursor: String) {
-            repository(owner: $owner, name: $name) {
-                collaborators(first: 20, after: $cursor) {
-                edges {
-                    node {
-                        login
-                    }
-                    permission
-                }
-                pageInfo {
-                    endCursor
-                    hasNextPage
-                }
+                repository(owner: $owner, name: $name) {
+                    collaborators(first: 100, after: $cursor) {
+                        edges {
+                            node {
+                                login
+                            }
+                            permission
+                        }
+                        pageInfo {
+                            endCursor
+                            hasNextPage
+                        }
                 }
             }
         }
@@ -554,6 +611,7 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
         has_next_page = True
 
         while has_next_page:
+            logging.debug("Requesting collaborators for %s", repo.name)
             result = run_graphql_query(query, variables, self.gh_token)
             try:
                 collaborators.extend(result["data"]["repository"]["collaborators"]["edges"])
@@ -586,6 +644,27 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
             # Get users for this repo
             self._fetch_collaborators_of_repo(repo)
 
+    def _get_default_repository_permission(self):
+        """Get the default repository permission for all users. Convert to
+        admin/maintain/push/triage/pull scheme that the REST API provides"""
+        self.default_repository_permission = self._convert_graphql_perm_to_rest(
+            self.org.default_repository_permission
+        )
+
+    def _permission1_higher_than_permission2(self, permission1: str, permission2: str) -> bool:
+        """Check whether permission 1 is higher than permission 2"""
+        perms_ranking = ["admin", "maintain", "push", "triage", "pull", ""]
+
+        def get_rank(permission):
+            return perms_ranking.index(permission) if permission in perms_ranking else 99
+
+        rank_permission1 = get_rank(permission1)
+        rank_permission2 = get_rank(permission2)
+
+        # The lower the index, the higher the permission. If lower than
+        # permission2, return True
+        return rank_permission1 < rank_permission2
+
     def sync_repo_collaborator_permissions(self, dry: bool = False):
         """Compare the configured with the current repo permissions for all
         repositories' collaborators"""
@@ -595,9 +674,13 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
         # The resulting structure is:
         # - configured_repos_collaborators: dict[Repository, dict[username, permission]]
         # - current_repos_collaborators: dict[Repository, dict[username, permission]]
+        logging.debug("Starting to sync collaborator/individual permissions")
         self._get_configured_repos_and_user_perms()
         self._get_current_repos_and_user_perms()
 
+        # Get and convert the default permission for all members so we can check for it
+        self._get_default_repository_permission()
+
         # Loop over all factually existing repositories. This will be a one-way
         # sync. Team permissions have been set before, we are now removing
         # surplus permissions. As no individual permissions are allowed, these
@@ -607,17 +690,21 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
                 # Get configured user permissions for this repo
                 try:
                     config_perm = self.configured_repos_collaborators[repo.name][username]
-                # There is no configured permission for this user in this repo
+                # There is no configured permission for this user in this repo,
+                # so we assume the default permission
                 except KeyError:
-                    config_perm = ""
+                    config_perm = self.default_repository_permission
 
-                if current_perm != config_perm:
+                # Evaluate whether current permission is higher than configured
+                # permission
+                if self._permission1_higher_than_permission2(current_perm, config_perm):
                     # Find out whether user has these unconfigured permissions
                     # due to being member of an unconfigured team. Check whether
                     # these are the same permissions as the team would get them.
                     unconfigured_team_repo_permission = self.unconfigured_team_repo_permissions.get(
                         repo.name, {}
                     ).get(username, "")
+
                     if unconfigured_team_repo_permission:
                         if current_perm == unconfigured_team_repo_permission:
                             logging.info(
@@ -640,6 +727,9 @@ class GHorg:  # pylint: disable=too-many-instance-attributes
                             current_perm,
                         )
 
+                    # Remove person from repo, but only if their repository also
+                    # diverges from the default repository permission given by
+                    # the organization
                     logging.info(
                         "Remove %s from %s. They have '%s' there but should only have '%s'.",
                         username,

{github_org_manager-0.3.0 → github_org_manager-0.3.1}/pyproject.toml

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