arcade-github 0.0.13__py3-none-any.whl

arcade_github/tests/test_activity.py

@@ -0,0 +1,55 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from arcade_github.tools.activity import set_starred
+from httpx import Response
+
+from arcade.core.errors import ToolExecutionError
+
+
+@pytest.fixture
+def mock_context():
+    context = AsyncMock()
+    context.authorization.token = "mock_token"  # noqa: S105
+    return context
+
+
+@pytest.fixture
+def mock_client():
+    with patch("arcade_github.tools.activity.httpx.AsyncClient") as client:
+        yield client.return_value.__aenter__.return_value
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "starred,expected_message",
+    [
+        (True, "Successfully starred the repository owner/repo"),
+        (False, "Successfully unstarred the repository owner/repo"),
+    ],
+)
+async def test_set_starred_success(mock_context, mock_client, starred, expected_message):
+    mock_client.put.return_value = mock_client.delete.return_value = Response(204)
+
+    result = await set_starred(mock_context, "owner", "repo", starred)
+    assert result == expected_message
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "status_code,error_message,expected_error",
+    [
+        (403, "Forbidden", "Error accessing.*: Forbidden"),
+        (404, "Not Found", "Error accessing.*: Resource not found"),
+        (500, "Internal Server Error", "Error accessing.*: Failed to process request"),
+    ],
+)
+async def test_set_starred_errors(
+    mock_context, mock_client, status_code, error_message, expected_error
+):
+    mock_client.put.return_value = mock_client.delete.return_value = Response(
+        status_code, json={"message": error_message}
+    )
+
+    with pytest.raises(ToolExecutionError, match=expected_error):
+        await set_starred(mock_context, "owner", "repo", True)

arcade_github/tests/test_issues.py

@@ -0,0 +1,110 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from arcade_github.tools.issues import create_issue, create_issue_comment
+from httpx import Response
+
+from arcade.core.errors import ToolExecutionError
+
+
+@pytest.fixture
+def mock_context():
+    context = AsyncMock()
+    context.authorization.token = "mock_token"  # noqa: S105
+    return context
+
+
+@pytest.fixture
+def mock_client():
+    with patch("arcade_github.tools.issues.httpx.AsyncClient") as client:
+        yield client.return_value.__aenter__.return_value
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "status_code,error_message,expected_error,func,args",
+    [
+        (
+            422,
+            "Validation Failed",
+            "Error accessing.*: Validation failed",
+            create_issue,
+            ("owner", "repo", "title"),
+        ),
+        (
+            401,
+            "Unauthorized",
+            "Error accessing.*: Failed to process request",
+            create_issue_comment,
+            ("owner", "repo", 1, "body"),
+        ),
+        (
+            403,
+            "API rate limit exceeded",
+            "Error accessing.*: Forbidden",
+            create_issue_comment,
+            ("owner", "repo", 1, "body"),
+        ),
+        (
+            401,
+            "Bad credentials",
+            "Error accessing.*: Failed to process request",
+            create_issue,
+            ("owner", "repo", "title"),
+        ),
+    ],
+)
+async def test_issue_errors(
+    mock_context, mock_client, status_code, error_message, expected_error, func, args
+):
+    mock_client.post.return_value = Response(status_code, json={"message": error_message})
+
+    with pytest.raises(ToolExecutionError, match=expected_error):
+        await func(mock_context, *args)
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "func,args,response_json,expected_assertions",
+    [
+        (
+            create_issue,
+            ("owner", "repo", "Test Issue", "This is a test issue"),
+            {
+                "id": 1,
+                "url": "https://api.github.com/repos/owner/repo/issues/1",
+                "title": "Test Issue",
+                "body": "This is a test issue",
+                "state": "open",
+                "html_url": "https://github.com/owner/repo/issues/1",
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-01T12:00:00Z",
+                "user": {"login": "testuser"},
+                "assignees": [],
+                "labels": [],
+            },
+            ["Test Issue", "https://github.com/owner/repo/issues/1"],
+        ),
+        (
+            create_issue_comment,
+            ("owner", "repo", 1, "This is a test comment"),
+            {
+                "id": 1,
+                "url": "https://api.github.com/repos/owner/repo/issues/comments/1",
+                "body": "This is a test comment",
+                "user": {"login": "testuser"},
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-01T12:00:00Z",
+            },
+            ["This is a test comment", "https://api.github.com/repos/owner/repo/issues/comments/1"],
+        ),
+    ],
+)
+async def test_issue_success(
+    mock_context, mock_client, func, args, response_json, expected_assertions
+):
+    mock_client.post.return_value = Response(201, json=response_json)
+
+    result = await func(mock_context, *args)
+    for assertion in expected_assertions:
+        assert assertion in result

arcade_github/tests/test_pull_requests.py

@@ -0,0 +1,359 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from arcade_github.tools.models import (
+    DiffSide,
+    ReviewCommentSubjectType,
+)
+from arcade_github.tools.pull_requests import (
+    create_reply_for_review_comment,
+    create_review_comment,
+    get_pull_request,
+    list_pull_request_commits,
+    list_pull_requests,
+    list_review_comments_on_pull_request,
+    update_pull_request,
+)
+from httpx import Response
+
+from arcade.core.errors import RetryableToolError, ToolExecutionError
+
+
+@pytest.fixture
+def mock_context():
+    context = AsyncMock()
+    context.authorization.token = "mock_token"  # noqa: S105
+    return context
+
+
+@pytest.fixture
+def mock_client():
+    with patch("arcade_github.tools.pull_requests.httpx.AsyncClient") as client:
+        yield client.return_value.__aenter__.return_value
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "func,args,status_code,json_response,expected_result,error_message",
+    [
+        (list_pull_requests, ("owner", "repo"), 200, [], '{"pull_requests": []}', None),
+        (
+            get_pull_request,
+            ("owner", "repo", 1),
+            404,
+            {"message": "Not Found"},
+            None,
+            "Error accessing.*: Resource not found",
+        ),
+        (
+            update_pull_request,
+            ("owner", "repo", 1, "New Title"),
+            409,
+            {"message": "Conflict"},
+            None,
+            "Error accessing.*: Failed to process request",
+        ),
+        (
+            list_pull_request_commits,
+            ("owner", "repo", 1),
+            500,
+            {"message": "Internal Server Error"},
+            None,
+            "Error accessing.*: Failed to process request",
+        ),
+        (
+            list_review_comments_on_pull_request,
+            ("owner", "repo", 1),
+            403,
+            {"message": "API rate limit exceeded"},
+            None,
+            "Error accessing.*: Forbidden",
+        ),
+    ],
+)
+async def test_pull_request_functions(
+    mock_context,
+    mock_client,
+    func,
+    args,
+    status_code,
+    json_response,
+    expected_result,
+    error_message,
+):
+    mock_client.get.return_value = mock_client.post.return_value = (
+        mock_client.patch.return_value
+    ) = Response(status_code, json=json_response)
+
+    if error_message:
+        with pytest.raises(ToolExecutionError, match=error_message):
+            await func(mock_context, *args)
+    else:
+        result = await func(mock_context, *args)
+        assert result == expected_result
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "func,args,json_response,expected_assertions",
+    [
+        (
+            list_pull_requests,
+            ("owner", "repo"),
+            [
+                {
+                    "number": 1,
+                    "title": "Test PR",
+                    "body": "This is a test PR",
+                    "state": "open",
+                    "html_url": "https://github.com/owner/repo/pull/1",
+                    "created_at": "2023-05-01T12:00:00Z",
+                    "updated_at": "2023-05-01T12:00:00Z",
+                    "user": {"login": "testuser"},
+                    "base": {"ref": "main"},
+                    "head": {"ref": "feature-branch"},
+                }
+            ],
+            ["Test PR", "https://github.com/owner/repo/pull/1"],
+        ),
+        (
+            update_pull_request,
+            ("owner", "repo", 1, "Updated PR Title", "Updated PR body"),
+            {
+                "number": 1,
+                "title": "Updated PR Title",
+                "body": "Updated PR body",
+                "state": "open",
+                "html_url": "https://github.com/owner/repo/pull/1",
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-02T12:00:00Z",
+                "user": {"login": "testuser"},
+            },
+            ["Updated PR Title", "Updated PR body"],
+        ),
+        (
+            list_pull_request_commits,
+            ("owner", "repo", 1),
+            [
+                {
+                    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+                    "commit": {
+                        "author": {
+                            "name": "Test Author",
+                            "email": "author@example.com",
+                            "date": "2023-05-01T12:00:00Z",
+                        },
+                        "message": "Test commit message",
+                    },
+                }
+            ],
+            ["6dcb09b5b57875f334f61aebed695e2e4193db5e", "Test commit message"],
+        ),
+        (
+            create_reply_for_review_comment,
+            ("owner", "repo", 1, 42, "Thanks for the suggestion."),
+            {
+                "id": 123,
+                "body": "Thanks for the suggestion.",
+                "user": {"login": "testuser"},
+                "created_at": "2023-05-02T12:00:00Z",
+                "updated_at": "2023-05-02T12:00:00Z",
+            },
+            ["Thanks for the suggestion.", "testuser"],
+        ),
+        (
+            list_review_comments_on_pull_request,
+            ("owner", "repo", 1),
+            [
+                {
+                    "id": 1,
+                    "body": "Great changes!",
+                    "user": {"login": "reviewer1"},
+                    "created_at": "2023-05-01T12:00:00Z",
+                    "updated_at": "2023-05-01T12:00:00Z",
+                    "path": "file1.txt",
+                    "line": 5,
+                }
+            ],
+            ["Great changes!", "reviewer1", "file1.txt"],
+        ),
+        (
+            get_pull_request,
+            ("owner", "repo", 1, False, False),
+            {
+                "number": 1,
+                "title": "Test PR",
+                "body": "This is a test PR",
+                "state": "open",
+                "html_url": "https://github.com/owner/repo/pull/1",
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-01T12:00:00Z",
+                "user": {"login": "testuser"},
+                "base": {"ref": "main"},
+                "head": {"ref": "feature-branch"},
+            },
+            ["Test PR", "https://github.com/owner/repo/pull/1"],
+        ),
+        (
+            get_pull_request,
+            ("owner", "repo", 1, True, False),
+            {
+                "number": 1,
+                "title": "Test PR",
+                "body": "This is a test PR",
+                "state": "open",
+                "html_url": "https://github.com/owner/repo/pull/1",
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-01T12:00:00Z",
+                "user": {"login": "testuser"},
+                "base": {"ref": "main"},
+                "head": {"ref": "feature-branch"},
+                "diff_content": "Sample diff content",
+            },
+            ["Test PR", "https://github.com/owner/repo/pull/1", "diff_content"],
+        ),
+        (
+            create_review_comment,
+            (
+                "owner",
+                "repo",
+                1,
+                "Great changes!",
+                "file1.txt",
+                "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+                1,
+                2,
+                DiffSide.RIGHT,
+                None,
+                ReviewCommentSubjectType.LINE,
+            ),
+            {
+                "id": 1,
+                "body": "Great changes!",
+                "path": "file1.txt",
+                "line": 2,
+                "side": "RIGHT",
+                "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+                "user": {"login": "testuser"},
+                "created_at": "2023-05-01T12:00:00Z",
+                "updated_at": "2023-05-01T12:00:00Z",
+                "html_url": "https://github.com/owner/repo/pull/1#discussion_r1",
+            },
+            ["Great changes!", "file1.txt", "6dcb09b5b57875f334f61aebed695e2e4193db5e"],
+        ),
+    ],
+)
+async def test_pull_request_functions_success(
+    mock_context, mock_client, func, args, json_response, expected_assertions
+):
+    mock_client.get.return_value = mock_client.post.return_value = (
+        mock_client.patch.return_value
+    ) = Response(200, json=json_response)
+
+    result = await func(mock_context, *args)
+    for assertion in expected_assertions:
+        assert assertion in result
+
+
+@pytest.mark.asyncio
+async def test_create_review_comment_file_subject_type(mock_context, mock_client):
+    mock_client.post.return_value = Response(
+        200,
+        json={
+            "id": 1,
+            "body": "File comment",
+            "path": "file1.txt",
+            "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+            "user": {"login": "testuser"},
+            "created_at": "2023-05-01T12:00:00Z",
+            "updated_at": "2023-05-01T12:00:00Z",
+            "html_url": "https://github.com/owner/repo/pull/1#discussion_r1",
+        },
+    )
+
+    result = await create_review_comment(
+        mock_context,
+        "owner",
+        "repo",
+        1,
+        "File comment",
+        "file1.txt",
+        "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+        subject_type=ReviewCommentSubjectType.FILE,
+    )
+
+    assert "File comment" in result
+    assert "file1.txt" in result
+    assert "6dcb09b5b57875f334f61aebed695e2e4193db5e" in result
+    assert "start_line" not in mock_client.post.call_args[1]["json"]
+    assert "end_line" not in mock_client.post.call_args[1]["json"]
+
+
+@pytest.mark.asyncio
+async def test_create_review_comment_missing_commit_id(mock_context, mock_client):
+    mock_client.get.return_value = Response(
+        200,
+        json=[{"sha": "latest_commit_sha"}],
+    )
+    mock_client.post.return_value = Response(
+        200,
+        json={
+            "id": 1,
+            "body": "Comment with auto-fetched commit ID",
+            "path": "file1.txt",
+            "commit_id": "latest_commit_sha",
+            "user": {"login": "testuser"},
+            "created_at": "2023-05-01T12:00:00Z",
+            "updated_at": "2023-05-01T12:00:00Z",
+            "html_url": "https://github.com/owner/repo/pull/1#discussion_r1",
+        },
+    )
+
+    result = await create_review_comment(
+        mock_context,
+        "owner",
+        "repo",
+        1,
+        "Comment with auto-fetched commit ID",
+        "file1.txt",
+        start_line=1,
+        end_line=2,
+    )
+
+    assert "Comment with auto-fetched commit ID" in result
+    assert "latest_commit_sha" in result
+    assert mock_client.get.called
+    assert mock_client.post.called
+
+
+@pytest.mark.asyncio
+async def test_create_review_comment_invalid_input(mock_context, mock_client):
+    with pytest.raises(
+        RetryableToolError, match="'start_line' and 'end_line' parameters are required"
+    ):
+        await create_review_comment(
+            mock_context,
+            "owner",
+            "repo",
+            1,
+            "Invalid comment",
+            "file1.txt",
+            subject_type=ReviewCommentSubjectType.LINE,
+        )
+
+
+@pytest.mark.asyncio
+async def test_create_review_comment_no_commits(mock_context, mock_client):
+    mock_client.get.return_value = Response(200, json=[])
+
+    with pytest.raises(RetryableToolError, match="Failed to get the latest commit SHA"):
+        await create_review_comment(
+            mock_context,
+            "owner",
+            "repo",
+            1,
+            "Comment with no commits",
+            "file1.txt",
+            start_line=1,
+            end_line=2,
+        )

arcade_github/tests/test_repositories.py

@@ -0,0 +1,73 @@
+from unittest.mock import AsyncMock, patch
+
+import pytest
+from arcade_github.tools.models import RepoType
+from arcade_github.tools.repositories import (
+    count_stargazers,
+    get_repository,
+    list_org_repositories,
+    list_repository_activities,
+    list_review_comments_in_a_repository,
+)
+from httpx import Response
+
+from arcade.core.errors import ToolExecutionError
+
+
+@pytest.fixture
+def mock_context():
+    context = AsyncMock()
+    context.authorization.token = "mock_token"  # noqa: S105
+    return context
+
+
+@pytest.fixture
+def mock_client():
+    with patch("arcade_github.tools.repositories.httpx.AsyncClient") as client:
+        yield client.return_value.__aenter__.return_value
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "status_code,error_message,expected_error",
+    [
+        (422, "Validation Failed", "Error accessing.*: Validation failed"),
+        (301, "Moved Permanently", "Error accessing.*: Moved permanently"),
+        (404, "Not Found", "Error accessing.*: Resource not found"),
+        (503, "Service Unavailable", "Error accessing.*: Service unavailable"),
+        (410, "Gone", "Error accessing.*: Gone"),
+    ],
+)
+async def test_error_responses(
+    mock_context, mock_client, status_code, error_message, expected_error
+):
+    mock_client.get.return_value = Response(status_code, json={"message": error_message})
+    mock_client.post.return_value = Response(status_code, json={"message": error_message})
+
+    with pytest.raises(ToolExecutionError, match=expected_error):
+        if status_code == 422:
+            await list_org_repositories(mock_context, "org", repo_type=RepoType.ALL)
+        elif status_code == 301:
+            await count_stargazers(mock_context, "owner", "repo")
+        elif status_code == 404:
+            await list_org_repositories(mock_context, "non_existent_org")
+        elif status_code == 503:
+            await get_repository(mock_context, "owner", "repo")
+        elif status_code == 410:
+            await list_review_comments_in_a_repository(mock_context, "owner", "repo")
+
+
+@pytest.mark.asyncio
+async def test_list_repository_activities_invalid_cursor(mock_context, mock_client):
+    mock_client.get.return_value = Response(422, json={"message": "Validation Failed"})
+
+    with pytest.raises(ToolExecutionError, match="Error accessing.*: Validation failed"):
+        await list_repository_activities(mock_context, "owner", "repo", before="invalid_cursor")
+
+
+@pytest.mark.asyncio
+async def test_count_stargazers_success(mock_context, mock_client):
+    mock_client.get.return_value = Response(200, json={"stargazers_count": 42})
+
+    result = await count_stargazers(mock_context, "owner", "repo")
+    assert result == 42

arcade_github/tools/activity.py

@@ -0,0 +1,41 @@
+from typing import Annotated
+
+import httpx
+
+from arcade.core.schema import ToolContext
+from arcade.sdk import tool
+from arcade.sdk.auth import GitHub
+from arcade_github.tools.utils import get_github_json_headers, get_url, handle_github_response
+
+
+# Implements https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#star-a-repository-for-the-authenticated-user and https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#unstar-a-repository-for-the-authenticated-user
+# Example `arcade chat` usage: "star the vscode repo owned by microsoft"
+@tool(requires_auth=GitHub())
+async def set_starred(
+    context: ToolContext,
+    owner: Annotated[str, "The owner of the repository"],
+    name: Annotated[str, "The name of the repository"],
+    starred: Annotated[bool, "Whether to star the repository or not"],
+) -> Annotated[
+    str, "A message indicating whether the repository was successfully starred or unstarred"
+]:
+    """
+    Star or un-star a GitHub repository.
+    For example, to star microsoft/vscode, you would use:
+    ```
+    set_starred(owner="microsoft", name="vscode", starred=True)
+    ```
+    """
+    url = get_url("user_starred", owner=owner, repo=name)
+    headers = get_github_json_headers(context.authorization.token)
+
+    async with httpx.AsyncClient() as client:
+        if starred:
+            response = await client.put(url, headers=headers)
+        else:
+            response = await client.delete(url, headers=headers)
+
+    handle_github_response(response, url)
+
+    action = "starred" if starred else "unstarred"
+    return f"Successfully {action} the repository {owner}/{name}"

arcade_github/tools/constants.py

@@ -0,0 +1,19 @@
+# Base URL for GitHub API
+GITHUB_API_BASE_URL = "https://api.github.com"
+
+# Endpoint patterns
+ENDPOINTS = {
+    "repo": "/repos/{owner}/{repo}",
+    "org_repos": "/orgs/{org}/repos",
+    "repo_activity": "/repos/{owner}/{repo}/activity",
+    "repo_pulls_comments": "/repos/{owner}/{repo}/pulls/comments",
+    "repo_issues": "/repos/{owner}/{repo}/issues",
+    "repo_issue_comments": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
+    "repo_pulls": "/repos/{owner}/{repo}/pulls",
+    "repo_pull": "/repos/{owner}/{repo}/pulls/{pull_number}",
+    "repo_pull_commits": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
+    "repo_pull_comments": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
+    "repo_pull_comment_replies": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies",
+    "user_starred": "/user/starred/{owner}/{repo}",
+    "repo_stargazers": "/repos/{owner}/{repo}/stargazers",
+}