feat:repo to team collaborator transformer (#26)

* add a repo to team collaborator transformer

* chore:lint & poetry

Author: jbristow

nodestream_github/client/githubclient.py

@@ -599,3 +599,21 @@ async def fetch_user(self, *, username: str) -> types.GithubUser | None:
         except httpx.HTTPError as e:
             _fetch_problem(f"full user info for {username}", e)
             return None
+
+    async def fetch_teams_for_repo(self, *, owner_login: str, repo_name: str):
+        """
+        Lists the teams that have access to the specified repository and that
+        are also visible to the authenticated user.
+
+        For a public repository, a team is listed only if that team added the
+        public repository explicitly.
+
+        https://docs.github.com/en/[email protected]/rest/repos/repos?apiVersion=2022-11-28#list-repository-teams
+        """
+        try:
+            async for team in self._get_paginated(
+                f"repos/{owner_login}/{repo_name}/teams"
+            ):
+                yield team
+        except httpx.HTTPError as e:
+            _fetch_problem(f"teams for repo {owner_login}/{repo_name}", e)

nodestream_github/transformer/repo.py

@@ -1,4 +1,5 @@
 import logging
+from abc import ABC
 from collections.abc import AsyncGenerator
 from typing import Any
 
@@ -13,7 +14,7 @@
 logger = get_plugin_logger(__name__)
 
 
-class RepoToCollaboratorsTransformer(Transformer):
+class RepoFullNameTransformer(Transformer, ABC):
     def __init__(
         self,
         *,
@@ -38,6 +39,14 @@ async def transform_record(
         else:
             logging.info("No full_name key found in record %s", record)
 
+    def _transform(self, full_name: str, simplified_repo: types.SimplifiedRepo):
+        raise NotImplementedError
+
+
+class RepoToUserCollaboratorsTransformer(RepoFullNameTransformer):
+    def __init__(self, *, full_name_key: str = "full_name", **kwargs: Any):
+        super().__init__(full_name_key=full_name_key, **kwargs)
+
     async def _transform(
         self,
         full_name: str,
@@ -66,3 +75,22 @@ async def _transform(
                 "repository": simplified_repo,
                 "affiliation": CollaboratorAffiliation.OUTSIDE,
             }
+
+
+class RepoToTeamCollaboratorsTransformer(RepoFullNameTransformer):
+    async def _transform(
+        self,
+        full_name: str,
+        simplified_repo: types.SimplifiedRepo,
+    ) -> AsyncGenerator[types.GithubTeam]:
+        (repo_owner, repo_name) = full_name.split("/")
+
+        logging.debug("Transforming repo %s/%s", repo_owner, repo_name)
+
+        async for collaborator in self.client.fetch_teams_for_repo(
+            owner_login=repo_owner, repo_name=repo_name
+        ):
+            logging.debug("Found team %s", collaborator)
+            yield collaborator | {
+                "repository": simplified_repo,
+            }

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nodestream-plugin-github"
-version = "0.14.1-beta.6"
+version = "0.14.2"
 description = ""
 authors = [
     "Jon Bristow <[email protected]>",
@@ -13,20 +13,20 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-nodestream = "^0.14"
-limits = "5.2.0"
+nodestream = "^0.14.14"
+limits = "^5.5.0"
 tenacity = "^9.0.0"
 httpx = ">=0.27,<0.28"
-freezegun = "^1.5.4"
+freezegun = "^1.5.5"
 
 [tool.poetry.group.dev.dependencies]
-ruff = "^0.11.0"
+ruff = "^0.12.10"
 black = "^25.1.0"
 isort = "^6.0.0"
-pytest = "^8.3.4"
-pytest-asyncio = "^0.26.0"
+pytest = "^8.4.1"
+pytest-asyncio = "^1.1.0"
 pytest-httpx = "^0.34.0"
-pytest-cov = "^6.0.0"
+pytest-cov = "^6.2.1"
 pytest-github-actions-annotate-failures = "^0.3.0"
 
 [build-system]

pyproject.toml

@@ -198,3 +198,10 @@ def get_enterprise_audit_logs(self, *, search_phrase: Optional[str], **kwargs: A
         if search_phrase:
             url += f"&phrase={search_phrase}"
         self.add_response(url=url, **kwargs)
+
+    def get_teams_for_repo(self, *, owner_login: str, repo_name: str, **kwargs: Any):
+        path = f"/repos/{owner_login}/{repo_name}/teams?per_page={self.per_page}"
+        self.add_response(
+            url=f"{self.base_url}{path}",
+            **kwargs,
+        )

tests/mocks/githubrest.py

@@ -0,0 +1,88 @@
+import pytest
+
+from nodestream_github.interpretations.relationship.repository import simplify_repo
+from nodestream_github.transformer.repo import RepoToTeamCollaboratorsTransformer
+from tests.data.repos import HELLO_WORLD_REPO
+from tests.data.teams import JUSTICE_LEAGUE_TEAM_SUMMARY
+from tests.mocks.githubrest import DEFAULT_HOSTNAME, DEFAULT_PER_PAGE, GithubHttpxMock
+
+REPO_TEAM_SUMMARY = {
+    "id": 1,
+    "node_id": "MDQ6VGVhbTE=",
+    "url": "https://HOSTNAME/teams/1",
+    "html_url": "https://github.com/orgs/github/teams/justice-league",
+    "name": "Justice League",
+    "slug": "justice-league",
+    "description": "A great team.",
+    "privacy": "closed",
+    "notification_setting": "notifications_enabled",
+    "permission": "admin",
+    "members_url": "https://HOSTNAME/teams/1/members{/member}",
+    "repositories_url": "https://HOSTNAME/teams/1/repos",
+    "parent": None,
+}
+
+
+@pytest.mark.asyncio
+async def test_transform_records(gh_rest_mock: GithubHttpxMock):
+    transformer = RepoToTeamCollaboratorsTransformer(
+        auth_token="test-token",
+        github_hostname=DEFAULT_HOSTNAME,
+        user_agent="test-agent",
+        max_retries=0,
+        per_page=DEFAULT_PER_PAGE,
+    )
+
+    gh_rest_mock.get_teams_for_repo(
+        owner_login="octocat",
+        repo_name="Hello-World",
+        json=[REPO_TEAM_SUMMARY],
+    )
+    repo_summary = simplify_repo(HELLO_WORLD_REPO)
+
+    response = [r async for r in transformer.transform_record(HELLO_WORLD_REPO)]
+
+    assert response == [JUSTICE_LEAGUE_TEAM_SUMMARY | {"repository": repo_summary}]
+
+
+@pytest.mark.asyncio
+async def test_transform_records_alt_key(gh_rest_mock: GithubHttpxMock):
+    transformer = RepoToTeamCollaboratorsTransformer(
+        full_name_key="nameWithOwner",
+        auth_token="test-token",
+        github_hostname=DEFAULT_HOSTNAME,
+        user_agent="test-agent",
+        max_retries=0,
+        per_page=DEFAULT_PER_PAGE,
+    )
+
+    gh_rest_mock.get_teams_for_repo(
+        owner_login="octocat",
+        repo_name="Hello-World",
+        json=[JUSTICE_LEAGUE_TEAM_SUMMARY],
+    )
+
+    modified_repo = HELLO_WORLD_REPO | {"nameWithOwner": "octocat/Hello-World"}
+    del modified_repo["full_name"]
+    repo_summary = simplify_repo(modified_repo)
+
+    response = [r async for r in transformer.transform_record(modified_repo)]
+
+    assert response == [JUSTICE_LEAGUE_TEAM_SUMMARY | {"repository": repo_summary}]
+
+
+@pytest.mark.asyncio
+async def test_no_full_name_key():
+    transformer = RepoToTeamCollaboratorsTransformer(
+        full_name_key="full_name",
+        auth_token="test-token",
+        github_hostname=DEFAULT_HOSTNAME,
+        user_agent="test-agent",
+        max_retries=0,
+        per_page=DEFAULT_PER_PAGE,
+    )
+    modified_repo = HELLO_WORLD_REPO.copy()
+    del modified_repo["full_name"]
+
+    response = [r async for r in transformer.transform_record(modified_repo)]
+    assert response == []

tests/transformer/test_repo_team_collab.py

@@ -1,7 +1,7 @@
 import pytest
 
 from nodestream_github.interpretations.relationship.repository import simplify_repo
-from nodestream_github.transformer.repo import RepoToCollaboratorsTransformer
+from nodestream_github.transformer.repo import RepoToUserCollaboratorsTransformer
 from nodestream_github.types.enums import CollaboratorAffiliation
 from tests.data.repos import HELLO_WORLD_REPO
 from tests.data.users import OCTOCAT_USER_SHORT, TURBO_USER_SHORT
@@ -10,7 +10,7 @@
 
 @pytest.mark.asyncio
 async def test_transform_records(gh_rest_mock: GithubHttpxMock):
-    transformer = RepoToCollaboratorsTransformer(
+    transformer = RepoToUserCollaboratorsTransformer(
         auth_token="test-token",
         github_hostname=DEFAULT_HOSTNAME,
         user_agent="test-agent",
@@ -43,7 +43,7 @@ async def test_transform_records(gh_rest_mock: GithubHttpxMock):
 
 @pytest.mark.asyncio
 async def test_transform_records_alt_key(gh_rest_mock: GithubHttpxMock):
-    transformer = RepoToCollaboratorsTransformer(
+    transformer = RepoToUserCollaboratorsTransformer(
         full_name_key="nameWithOwner",
         auth_token="test-token",
         github_hostname=DEFAULT_HOSTNAME,
@@ -79,7 +79,7 @@ async def test_transform_records_alt_key(gh_rest_mock: GithubHttpxMock):
 
 @pytest.mark.asyncio
 async def test_no_full_name_key():
-    transformer = RepoToCollaboratorsTransformer(
+    transformer = RepoToUserCollaboratorsTransformer(
         full_name_key="full_name",
         auth_token="test-token",
         github_hostname=DEFAULT_HOSTNAME,