tests: adds test with RequestsMock for create_pull_request unit tests (…

…#99) * test: add test with RequestsMock for create_pull_request in test_gitlab.py Signed-off-by: Jennifer Power <[email protected]> * docs: update E2E test docs Signed-off-by: Jennifer Power <[email protected]> * test: adds JSON test data for example GitHub API responses Signed-off-by: Jennifer Power <[email protected]> * test: add test with RequestsMock for create_pull_request in test_github.py Signed-off-by: Jennifer Power <[email protected]> * fix: removes regexp for urls in test_gitlab.py and test_github.py files Signed-off-by: Jennifer Power <[email protected]> --------- Signed-off-by: Jennifer Power <[email protected]>
RedHatProductSecurity · Dec 8, 2023 · 3f39772 · 3f39772
1 parent 9ac6acb
commit 3f39772
Show file tree

Hide file tree

Showing 7 changed files with 595 additions and 51 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,6 +45,8 @@ pre-commit = "^3.4.0"
 pytest = "^7.3.2"
 pytest-cov = "^4.1.0"
 pytest-skip-slow = "^0.0.5"
+responses = "^0.24.1"
+
 
 [tool.coverage.run]
 branch = true

diff --git a/tests/data/json/github_example_pull_response.json b/tests/data/json/github_example_pull_response.json
diff --git a/tests/data/json/github_example_repo_response.json b/tests/data/json/github_example_repo_response.json
@@ -0,0 +1,114 @@
+{
+    "id": 654286523,
+    "node_id": "R_kgDOJv-euw",
+    "name": "repo",
+    "full_name": "owner/repo",
+    "private": false,
+    "owner": {
+      "login": "owner",
+      "id": 8826520,
+      "node_id": "MDEyOk9yZ2FuaXphdGlvbjg4MjY1MjA=",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8826520?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/owner",
+      "html_url": "https://github.com/owner",
+      "followers_url": "https://api.github.com/users/owner/followers",
+      "following_url": "https://api.github.com/users/owner/following{/other_user}",
+      "gists_url": "https://api.github.com/users/owner/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/owner/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/owner/subscriptions",
+      "organizations_url": "https://api.github.com/users/owner/orgs",
+      "repos_url": "https://api.github.com/users/owner/repos",
+      "events_url": "https://api.github.com/users/owner/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/owner/received_events",
+      "type": "Organization",
+      "site_admin": false
+    },
+    "html_url": "https://github.com/owner/repo",
+    "description": "An example project",
+    "fork": false,
+    "url": "https://api.github.com/repos/owner/repo",
+    "forks_url": "https://api.github.com/repos/owner/repo/forks",
+    "keys_url": "https://api.github.com/repos/owner/repo/keys{/key_id}",
+    "collaborators_url": "https://api.github.com/repos/owner/repo/collaborators{/collaborator}",
+    "teams_url": "https://api.github.com/repos/owner/repo/teams",
+    "hooks_url": "https://api.github.com/repos/owner/repo/hooks",
+    "issue_events_url": "https://api.github.com/repos/owner/repo/issues/events{/number}",
+    "events_url": "https://api.github.com/repos/owner/repo/events",
+    "assignees_url": "https://api.github.com/repos/owner/repo/assignees{/user}",
+    "branches_url": "https://api.github.com/repos/owner/repo/branches{/branch}",
+    "tags_url": "https://api.github.com/repos/owner/repo/tags",
+    "blobs_url": "https://api.github.com/repos/owner/repo/git/blobs{/sha}",
+    "git_tags_url": "https://api.github.com/repos/owner/repo/git/tags{/sha}",
+    "git_refs_url": "https://api.github.com/repos/owner/repo/git/refs{/sha}",
+    "trees_url": "https://api.github.com/repos/owner/repo/git/trees{/sha}",
+    "statuses_url": "https://api.github.com/repos/owner/repo/statuses/{sha}",
+    "languages_url": "https://api.github.com/repos/owner/repo/languages",
+    "stargazers_url": "https://api.github.com/repos/owner/repo/stargazers",
+    "contributors_url": "https://api.github.com/repos/owner/repo/contributors",
+    "subscribers_url": "https://api.github.com/repos/owner/repo/subscribers",
+    "subscription_url": "https://api.github.com/repos/owner/repo/subscription",
+    "commits_url": "https://api.github.com/repos/owner/repo/commits{/sha}",
+    "git_commits_url": "https://api.github.com/repos/owner/repo/git/commits{/sha}",
+    "comments_url": "https://api.github.com/repos/owner/repo/comments{/number}",
+    "issue_comment_url": "https://api.github.com/repos/owner/repo/issues/comments{/number}",
+    "contents_url": "https://api.github.com/repos/owner/repo/contents/{+path}",
+    "compare_url": "https://api.github.com/repos/owner/repo/compare/{base}...{head}",
+    "merges_url": "https://api.github.com/repos/owner/repo/merges",
+    "archive_url": "https://api.github.com/repos/owner/repo/{archive_format}{/ref}",
+    "downloads_url": "https://api.github.com/repos/owner/repo/downloads",
+    "issues_url": "https://api.github.com/repos/owner/repo/issues{/number}",
+    "pulls_url": "https://api.github.com/repos/owner/repo/pulls{/number}",
+    "milestones_url": "https://api.github.com/repos/owner/repo/milestones{/number}",
+    "notifications_url": "https://api.github.com/repos/owner/repo/notifications{?since,all,participating}",
+    "labels_url": "https://api.github.com/repos/owner/repo/labels{/name}",
+    "releases_url": "https://api.github.com/repos/owner/repo/releases{/id}",
+    "deployments_url": "https://api.github.com/repos/owner/repo/deployments",
+    "created_at": "2023-06-15T19:44:03Z",
+    "updated_at": "2023-10-30T20:55:12Z",
+    "pushed_at": "2023-12-07T15:36:41Z",
+    "git_url": "git://github.com/owner/repo.git",
+    "ssh_url": "[email protected]:owner/repo.git",
+    "clone_url": "https://github.com/owner/repo.git",
+    "svn_url": "https://github.com/owner/repo",
+    "homepage": "",
+    "size": 673,
+    "stargazers_count": 4,
+    "watchers_count": 4,
+    "language": "Python",
+    "has_issues": true,
+    "has_projects": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "has_pages": false,
+    "has_discussions": true,
+    "forks_count": 3,
+    "mirror_url": null,
+    "archived": false,
+    "disabled": false,
+    "open_issues_count": 10,
+    "allow_forking": true,
+    "is_template": false,
+    "web_commit_signoff_required": false,
+    "topics": [],
+    "visibility": "public",
+    "forks": 3,
+    "open_issues": 10,
+    "watchers": 4,
+    "default_branch": "main",
+    "permissions": {},
+    "allow_squash_merge": true,
+    "allow_merge_commit": true,
+    "allow_rebase_merge": true,
+    "allow_auto_merge": true,
+    "delete_branch_on_merge": false,
+    "allow_update_branch": true,
+    "use_squash_pr_title_as_default": false,
+    "squash_merge_commit_message": "COMMIT_MESSAGES",
+    "squash_merge_commit_title": "COMMIT_OR_PR_TITLE",
+    "merge_commit_message": "PR_TITLE",
+    "merge_commit_title": "MERGE_MESSAGE",
+    "network_count": 3,
+    "subscribers_count": 6
+  }
+
diff --git a/tests/e2e/README.md b/tests/e2e/README.md
@@ -55,8 +55,4 @@ To run the end-to-end tests, follow these steps:
   export TRESTLEBOT_IMAGE=quay.io/continuouscompliance/trestle-bot:latest
   ```
 
-- When created tests that push to a branch, ensure the name is "test". This is because the mock API server is configured to only allow pushes to a branch named "test".
-
-## Future Improvements
-- Create endpoints that mock GitHub and GitLab API calls for pull request creation.
-- Add more end-to-end tests to cover more use cases.
+- When created tests that push to a branch, ensure the name is "test". This is because the mock API server is configured to only allow pushes to a branch named "test".
diff --git a/tests/trestlebot/test_github.py b/tests/trestlebot/test_github.py
@@ -16,13 +16,15 @@
 
 """Test for GitHub provider logic"""
 
-from typing import Tuple
+import json
+from typing import Generator, Tuple
 from unittest.mock import patch
 
 import pytest
 from git.repo import Repo
+from responses import GET, POST, RequestsMock
 
-from tests.testutils import clean
+from tests.testutils import JSON_TEST_DATA_PATH, clean
 from trestlebot.github import GitHub
 from trestlebot.provider import GitProviderException
 
@@ -73,6 +75,42 @@ def test_parse_repository_with_incorrect_name() -> None:
         gh.parse_repository("https://notgithub.com/owner/repo.git")
 
 
+@pytest.fixture
+def resp_merge_requests() -> Generator[RequestsMock, None, None]:
+    """Mock the GitHub API for pull request creation"""
+    repo_content = json.load(
+        open(JSON_TEST_DATA_PATH / "github_example_repo_response.json")
+    )
+    pr_content = json.load(
+        open(JSON_TEST_DATA_PATH / "github_example_pull_response.json")
+    )
+    with RequestsMock() as rsps:
+        rsps.add(
+            method=POST,
+            url="https://api.github.com/repos/owner/repo/pulls",
+            json=pr_content,
+            content_type="application/json",
+            status=201,
+        )
+        rsps.add(
+            method=GET,
+            url="https://api.github.com/repos/owner/repo",
+            json=repo_content,
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+def test_create_pull_request(resp_merge_requests: RequestsMock) -> None:
+    """Test creating a pull request"""
+    gh = GitHub("fake")
+    pr_number = gh.create_pull_request(
+        "owner", "repo", "main", "test", "My PR", "Has Changes"
+    )
+    assert pr_number == 123
+
+
 def test_create_pull_request_invalid_repo() -> None:
     """Test triggering an error during pull request creation"""
     gh = GitHub("fake")

diff --git a/tests/trestlebot/test_gitlab.py b/tests/trestlebot/test_gitlab.py
@@ -16,12 +16,13 @@
 
 """Test for GitLab provider logic"""
 
-from typing import Callable, Tuple
+from typing import Callable, Generator, Tuple
 from unittest.mock import patch
 
 import pytest
 from git.repo import Repo
 from gitlab.exceptions import GitlabAuthenticationError, GitlabCreateError
+from responses import GET, POST, RequestsMock
 
 from tests.testutils import clean
 from trestlebot.gitlab import GitLab
@@ -111,6 +112,49 @@ def test_parse_repository_with_incorrect_name() -> None:
         gl.parse_repository("https://notgitlab.com/owner/repo.git")
 
 
+mr_content = {
+    "id": 123,
+    "title": "Example Merge Request",
+    "description": "This is an example merge request description.",
+    "state": "opened",
+    "created_at": "2023-12-06T08:30:00Z",
+    "updated_at": "2023-12-06T09:15:00Z",
+    "source_branch": "feature-branch",
+    "target_branch": "main",
+    "author": {"id": 789, "name": "Jane Doe", "username": "janedoe"},
+    "merge_status": "can_be_merged",
+}
+
+
+@pytest.fixture
+def resp_merge_requests() -> Generator[RequestsMock, None, None]:
+    with RequestsMock() as rsps:
+        rsps.add(
+            method=POST,
+            url="http://localhost/api/v4/projects/1/merge_requests",
+            json=mr_content,
+            content_type="application/json",
+            status=201,
+        )
+        rsps.add(
+            method=GET,
+            url="http://localhost/api/v4/projects/owner%2Frepo",
+            json={"name": "name", "id": 1},
+            content_type="application/json",
+            status=200,
+        )
+        yield rsps
+
+
+def test_create_pull_request(resp_merge_requests: RequestsMock) -> None:
+    """Test creating a pull request"""
+    gl = GitLab("fake", "http://localhost")
+    pr_number = gl.create_pull_request(
+        "owner", "repo", "main", "test", "My PR", "Has Changes"
+    )
+    assert pr_number == 123
+
+
 def create_side_effect(name: str) -> None:
     raise GitlabCreateError("example")