Add gitea list all repos CLI (#3)

Author: Muscaw

gitea_github_sync/cli.py

@@ -3,7 +3,7 @@
 import click
 from rich import print
 
-from . import github, repository
+from . import gitea, github, repository
 
 
 @click.group()
@@ -37,3 +37,11 @@ def list_all_github_repositories(stats: bool) -> None:
     gh = github.get_github()
     repos = github.list_all_repositories(gh)
     print_repositories(repos, stats)
+
+
+@click.option("--stats", is_flag=True)
+@cli.command()
+def list_all_gitea_repositories(stats: bool) -> None:
+    gt = gitea.get_gitea()
+    repos = gt.get_repos()
+    print_repositories(repos, stats)

gitea_github_sync/config.py

@@ -8,6 +8,7 @@
 
 class Config(BaseModel):
     github_token: str
+    gitea_api_url: str
     gitea_token: str
 
 

gitea_github_sync/gitea.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any, Dict, List, Optional
+
+import requests
+
+from gitea_github_sync import config
+
+from .repository import Repository, Visibility
+
+
+@dataclass(frozen=True)
+class Gitea:
+    api_url: str
+    api_token: str
+
+    def _get_authorization_header(self) -> Dict[str, str]:
+        return {"Authorization": f"token {self.api_token}"}
+
+    def _get_all_pages(self, path: str) -> List[Dict[str, Any]]:
+        output = []
+        url: Optional[str] = f"{self.api_url}{path}"
+        while url is not None:
+            auth = self._get_authorization_header()
+            result = requests.get(url, headers=auth)
+            result.raise_for_status()
+            data = result.json()
+            output.extend(data)
+
+            url = result.links["next"]["url"] if "next" in result.links else None
+        return output
+
+    def get_repos(self) -> List[Repository]:
+
+        repos = self._get_all_pages("/user/repos")
+        return [
+            Repository(
+                repo["full_name"],
+                visibility=Visibility.PRIVATE if repo["private"] else Visibility.PUBLIC,
+            )
+            for repo in repos
+        ]
+
+
+def get_gitea(conf: Optional[config.Config] = None) -> Gitea:
+    if conf is None:
+        conf = config.load_config()
+    return Gitea(api_url=conf.gitea_api_url, api_token=conf.gitea_token)

poetry.lock

@@ -19,6 +19,7 @@ click = "^8.1.3"
 piny = "^0.6.0"
 pydantic = "^1.10.4"
 rich = "^13.0.0"
+requests = "^2.28.1"
 
 
 [tool.poetry.group.dev]
@@ -32,6 +33,7 @@ isort = "^5.11.4"
 mypy = "^0.991"
 tox = "^4.1.1"
 pytest-cov = "^4.0.0"
+responses = "^0.22.0"
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -23,7 +23,7 @@ def repositories_fixture() -> List[Repository]:
 @patch("gitea_github_sync.cli.print_repositories", autospec=True)
 @patch("gitea_github_sync.cli.github.get_github", autospec=True)
 @patch("gitea_github_sync.cli.github.list_all_repositories", autospec=True)
-def test_list_all_github_repositories_with_stats(
+def test_list_all_github_repositories(
     mock_list_all_repositories: MagicMock,
     mock_get_github: MagicMock,
     mock_print_repositories: MagicMock,
@@ -46,6 +46,31 @@ def test_list_all_github_repositories_with_stats(
     mock_print_repositories.assert_called_once_with(repositories_fixture, expected_stat)
 
 
+@pytest.mark.parametrize("expected_stat", [True, False])
+@patch("gitea_github_sync.cli.print_repositories", autospec=True)
+@patch("gitea_github_sync.cli.gitea.get_gitea", autospec=True)
+def test_list_all_gitea_repositories(
+    mock_get_gitea: MagicMock,
+    mock_print_repositories: MagicMock,
+    expected_stat: bool,
+    repositories_fixture: List[Repository],
+) -> None:
+    mock_gitea = MagicMock()
+    mock_get_gitea.return_value = mock_gitea
+    mock_gitea.get_repos.return_value = repositories_fixture
+
+    runner = CliRunner()
+    command = (
+        ["list-all-gitea-repositories", "--stats"]
+        if expected_stat
+        else ["list-all-gitea-repositories"]
+    )
+    result = runner.invoke(cli, command)
+
+    assert result.exit_code == 0
+    mock_print_repositories.assert_called_once_with(repositories_fixture, expected_stat)
+
+
 @patch("sys.stdout", new_callable=StringIO)
 def test_print_repositories_without_stats(
     stdout: StringIO,

tests/test_cli.py

@@ -8,10 +8,15 @@
 
 VALID_CONFIG_FILE = """
 github_token: some-github-token
+gitea_api_url: https://some-gitea-url.com
 gitea_token: some-gitea-token
 """
 
-VALID_CONFIG = Config(github_token="some-github-token", gitea_token="some-gitea-token")
+VALID_CONFIG = Config(
+    github_token="some-github-token",
+    gitea_api_url="https://some-gitea-url.com",
+    gitea_token="some-gitea-token",
+)
 
 DEFAULT_CONFIG_FILE_PATH = config_file_location()
 

tests/test_config.py

@@ -0,0 +1,127 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+import responses
+from responses import matchers
+
+from gitea_github_sync.config import Config
+from gitea_github_sync.gitea import Gitea, get_gitea
+from gitea_github_sync.repository import Repository, Visibility
+
+GITEA_BASE_API_URL = "https://gitea.yourinstance.com/api/v1"
+GITEA_TOKEN = "your-gitea-token"
+
+
+@pytest.fixture
+def conf_fixture() -> Config:
+    return Config(
+        github_token="some-token", gitea_api_url=GITEA_BASE_API_URL, gitea_token=GITEA_TOKEN
+    )
+
+
+@pytest.fixture
+def gitea_fixture(conf_fixture: Config) -> Gitea:
+    return Gitea(api_url=conf_fixture.gitea_api_url, api_token=conf_fixture.gitea_token)
+
+
+@responses.activate
+def test_get_repos(gitea_fixture: Gitea) -> None:
+
+    json = [
+        {"full_name": "some-team/a-repo", "private": True},
+        {"full_name": "some-team/b-repo", "private": False},
+    ]
+
+    expected_repos = [
+        Repository(full_repo_name="some-team/a-repo", visibility=Visibility.PRIVATE),
+        Repository(full_repo_name="some-team/b-repo", visibility=Visibility.PUBLIC),
+    ]
+    responses.get(
+        f"{GITEA_BASE_API_URL}/user/repos",
+        match=[matchers.header_matcher({"Authorization": f"token {GITEA_TOKEN}"})],
+        json=json,
+    )
+
+    result = gitea_fixture.get_repos()
+    assert expected_repos == result
+
+
+@responses.activate
+def test_get_repos_multiple_pages(gitea_fixture: Gitea) -> None:
+
+    json_1 = [
+        {"full_name": "some-team/a-repo", "private": True},
+        {"full_name": "some-team/b-repo", "private": False},
+    ]
+    json_2 = [
+        {"full_name": "some-team/c-repo", "private": True},
+        {"full_name": "some-team/d-repo", "private": False},
+    ]
+    json_3 = [
+        {"full_name": "some-team/e-repo", "private": True},
+        {"full_name": "some-team/f-repo", "private": False},
+    ]
+
+    expected_repos = [
+        Repository(full_repo_name="some-team/a-repo", visibility=Visibility.PRIVATE),
+        Repository(full_repo_name="some-team/b-repo", visibility=Visibility.PUBLIC),
+        Repository(full_repo_name="some-team/c-repo", visibility=Visibility.PRIVATE),
+        Repository(full_repo_name="some-team/d-repo", visibility=Visibility.PUBLIC),
+        Repository(full_repo_name="some-team/e-repo", visibility=Visibility.PRIVATE),
+        Repository(full_repo_name="some-team/f-repo", visibility=Visibility.PUBLIC),
+    ]
+    responses.get(
+        f"{GITEA_BASE_API_URL}/user/repos",
+        match=[matchers.header_matcher({"Authorization": f"token {GITEA_TOKEN}"})],
+        json=json_1,
+        headers={
+            "link": (
+                f'<{GITEA_BASE_API_URL}/user/repos?page=2>; rel="next",'
+                + f'<{GITEA_BASE_API_URL}/user/repos?page=3>; rel="last"'
+            )
+        },
+    )
+    responses.get(
+        f"{GITEA_BASE_API_URL}/user/repos?page=2",
+        match=[matchers.header_matcher({"Authorization": f"token {GITEA_TOKEN}"})],
+        json=json_2,
+        headers={
+            "link": (
+                f'<{GITEA_BASE_API_URL}/user/repos?page=3>; rel="next",'
+                + f'<{GITEA_BASE_API_URL}/user/repos?page=3>; rel="last",'
+                + f'<{GITEA_BASE_API_URL}/user/repos?page=1>; rel="first",'
+                + f'<{GITEA_BASE_API_URL}/user/repos?page=1>; rel="prev"'
+            )
+        },
+    )
+    responses.get(
+        f"{GITEA_BASE_API_URL}/user/repos?page=3",
+        match=[matchers.header_matcher({"Authorization": f"token {GITEA_TOKEN}"})],
+        json=json_3,
+        headers={
+            "link": (
+                f'<{GITEA_BASE_API_URL}/user/repos?page=1>; rel="first",'
+                + f'<{GITEA_BASE_API_URL}/user/repos?page=1>; rel="prev"'
+            )
+        },
+    )
+
+    result = gitea_fixture.get_repos()
+    assert expected_repos == result
+
+
+def test_gitea(gitea_fixture: Gitea, conf_fixture: Config) -> None:
+    gt = get_gitea(conf_fixture)
+
+    assert gt == gitea_fixture
+
+
+@patch("gitea_github_sync.gitea.config.load_config", autospec=True)
+def test_gitea_default_value(
+    mock_load_config: MagicMock, gitea_fixture: Gitea, conf_fixture: Config
+) -> None:
+    mock_load_config.return_value = conf_fixture
+    gt = get_gitea()
+
+    assert gt == gitea_fixture
+    mock_load_config.assert_called_once()

tests/test_gitea.py

@@ -9,10 +9,12 @@
 from gitea_github_sync.github import get_github, list_all_repositories
 from gitea_github_sync.repository import Repository, Visibility
 
+from .test_config import VALID_CONFIG
+
 
 @pytest.fixture
 def conf_fixture() -> Config:
-    return Config(github_token="some-github-token", gitea_token="some-gitea-token")
+    return VALID_CONFIG
 
 
 @pytest.mark.parametrize(