Add: Add async GitHub API to create teams

Author: bjoernricks

pontos/github/api/teams.py

@@ -15,12 +15,18 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from typing import Iterable
+from enum import Enum
+from typing import Iterable, Optional
 
 from pontos.github.api.client import GitHubAsyncREST
 from pontos.github.api.helper import JSON_OBJECT
 
 
+class TeamPrivacy(Enum):
+    SECRET = "secret"
+    CLOSED = "closed"
+
+
 class GitHubAsyncRESTTeams(GitHubAsyncREST):
     async def get_all(self, organization: str) -> Iterable[JSON_OBJECT]:
         """
@@ -46,3 +52,60 @@ async def get_all(self, organization: str) -> Iterable[JSON_OBJECT]:
             teams.extend(response.json())
 
         return teams
+
+    async def create(
+        self,
+        organization: str,
+        name: str,
+        *,
+        description: Optional[str] = None,
+        maintainers: Optional[Iterable[str]] = None,
+        repo_names: Optional[Iterable[str]] = None,
+        privacy: Optional[TeamPrivacy] = None,
+        parent_team_id: Optional[str] = None,
+    ) -> JSON_OBJECT:
+        """
+        Create a new team in an organization
+
+        https://docs.github.com/en/rest/teams/teams#create-a-team
+
+        Args:
+            organization: GitHub organization to use
+            name: The name of the new team.
+            description: The description of the team.
+            maintainers: List GitHub IDs for organization members who will
+                become team maintainers.
+            repo_names: The full name (e.g., "organization-name/repository-name"
+                ) of repositories to add the team to.
+            privacy: The level of privacy this team should have. The options
+                are:
+                For a non-nested team:
+                    * secret - only visible to organization owners and members
+                        of this team.
+                    * closed - visible to all members of this organization.
+                Default: secret
+
+                For a parent or child team:
+                    * closed - visible to all members of this organization.
+                Default for child team: closed
+            parent_team_id: The ID of a team to set as the parent team.
+
+        Raises:
+            `httpx.HTTPStatusError` if there was an error in the request
+        """
+        api = f"/orgs/{organization}/teams"
+        data = {"name": name}
+        if description:
+            data["description"] = description
+        if maintainers:
+            data["maintainers"] = list(maintainers)
+        if repo_names:
+            data["repo_names"] = list(repo_names)
+        if privacy:
+            data["privacy"] = privacy.value
+        if parent_team_id:
+            data["parent_team_id"] = parent_team_id
+
+        response = await self._client.post(api, data=data)
+        response.raise_for_status()
+        return response.json()

tests/github/api/test_teams.py

@@ -14,8 +14,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+from unittest.mock import MagicMock
 
-from pontos.github.api.teams import GitHubAsyncRESTTeams
+import httpx
+
+from pontos.github.api.teams import GitHubAsyncRESTTeams, TeamPrivacy
 from tests import AsyncIteratorMock
 from tests.github.api import GitHubAsyncRESTTestCase, create_response
 
@@ -42,3 +45,58 @@ async def test_get_all(self):
             "/orgs/foo/teams",
             params={"per_page": "100"},
         )
+
+    async def test_create(self):
+        response = create_response()
+        self.client.post.return_value = response
+
+        await self.api.create(
+            "foo",
+            "bar",
+            description="A description",
+            maintainers=["foo", "bar"],
+            repo_names=["foo/bar", "foo/baz"],
+            privacy=TeamPrivacy.CLOSED,
+            parent_team_id="123",
+        )
+
+        self.client.post.assert_awaited_once_with(
+            "/orgs/foo/teams",
+            data={
+                "name": "bar",
+                "description": "A description",
+                "maintainers": ["foo", "bar"],
+                "repo_names": ["foo/bar", "foo/baz"],
+                "privacy": "closed",
+                "parent_team_id": "123",
+            },
+        )
+
+    async def test_create_failure(self):
+        response = create_response()
+        self.client.post.side_effect = httpx.HTTPStatusError(
+            "404", request=MagicMock(), response=response
+        )
+
+        with self.assertRaises(httpx.HTTPStatusError):
+            await self.api.create(
+                "foo",
+                "bar",
+                description="A description",
+                maintainers=["foo", "bar"],
+                repo_names=["foo/bar", "foo/baz"],
+                privacy=TeamPrivacy.CLOSED,
+                parent_team_id="123",
+            )
+
+        self.client.post.assert_awaited_once_with(
+            "/orgs/foo/teams",
+            data={
+                "name": "bar",
+                "description": "A description",
+                "maintainers": ["foo", "bar"],
+                "repo_names": ["foo/bar", "foo/baz"],
+                "privacy": "closed",
+                "parent_team_id": "123",
+            },
+        )