diff options
| -rw-r--r-- | docs/cli.rst | 12 | ||||
| -rw-r--r-- | docs/gl_objects/commits.rst | 4 | ||||
| -rw-r--r-- | gitlab/tests/objects/test_commits.py | 27 | ||||
| -rw-r--r-- | gitlab/v4/objects.py | 18 | ||||
| -rwxr-xr-x | tools/cli_test_v4.sh | 7 | ||||
| -rw-r--r-- | tools/python_test_v4.py | 8 |
6 files changed, 76 insertions, 0 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index 3207902..b4a6c5e 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -236,6 +236,18 @@ Create a snippet: $ gitlab project-snippet create --project-id 2 --title "the title" \ --file-name "the name" --code "the code" +Get a specific project commit by its SHA id: + +.. code-block:: console + + $ gitlab project-commit get --project-id 2 --id a43290c + +Get the GPG signature of a signed commit: + +.. code-block:: console + + $ gitlab project-commit signature --project-id 2 --id a43290c + Define the status of a commit (as would be done from a CI tool for example): .. code-block:: console diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst index abfedc8..e6bdfd8 100644 --- a/docs/gl_objects/commits.rst +++ b/docs/gl_objects/commits.rst @@ -82,6 +82,10 @@ Get the references the commit has been pushed to (branches and tags):: commit.refs('tag') # only tags commit.refs('branch') # only branches +Get the GPG signature of the commit (if the commit was signed):: + + commit.signature() + List the merge requests related to a commit:: commit.merge_requests() diff --git a/gitlab/tests/objects/test_commits.py b/gitlab/tests/objects/test_commits.py index 3247d60..23a4285 100644 --- a/gitlab/tests/objects/test_commits.py +++ b/gitlab/tests/objects/test_commits.py @@ -48,6 +48,26 @@ def resp_revert_commit(url, request): return response(200, content, headers, None, 5, request) +@urlmatch( + scheme="http", + netloc="localhost", + path="/api/v4/projects/1/repository/commits/6b2257ea/signature", + method="get", +) +def resp_get_commit_gpg_signature(url, request): + """Mock for commit GPG signature GET response.""" + content = """{ + "gpg_key_id": 1, + "gpg_key_primary_keyid": "8254AAB3FBD54AC9", + "gpg_key_user_name": "John Doe", + "gpg_key_user_email": "johndoe@example.com", + "verification_status": "verified", + "gpg_key_subkey_id": null + }""" + content = content.encode("utf-8") + return response(200, content, headers, None, 5, request) + + class TestCommit(TestProject): """ Base class for commit tests. Inherits from TestProject, @@ -77,3 +97,10 @@ class TestCommit(TestProject): revert_commit = commit.revert(branch="master") self.assertEqual(revert_commit["short_id"], "8b090c1b") self.assertEqual(revert_commit["title"], 'Revert "Initial commit"') + + @with_httmock(resp_get_commit_gpg_signature) + def test_get_commit_gpg_signature(self): + commit = self.project.commits.get("6b2257ea", lazy=True) + signature = commit.signature() + self.assertEqual(signature["gpg_key_primary_keyid"], "8254AAB3FBD54AC9") + self.assertEqual(signature["verification_status"], "verified") diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py index 9da9adf..96327b2 100644 --- a/gitlab/v4/objects.py +++ b/gitlab/v4/objects.py @@ -2172,6 +2172,24 @@ class ProjectCommit(RESTObject): post_data = {"branch": branch} return self.manager.gitlab.http_post(path, post_data=post_data, **kwargs) + @cli.register_custom_action("ProjectCommit") + @exc.on_http_error(exc.GitlabGetError) + def signature(self, **kwargs): + """Get the GPG signature of the commit. + + Args: + **kwargs: Extra options to send to the server (e.g. sudo) + + Raises: + GitlabAuthenticationError: If authentication is not correct + GitlabGetError: If the signature could not be retrieved + + Returns: + dict: The commit's GPG signature data + """ + path = "%s/%s/signature" % (self.manager.path, self.get_id()) + return self.manager.gitlab.http_get(path, **kwargs) + class ProjectCommitManager(RetrieveMixin, CreateMixin, RESTManager): _path = "/projects/%(project_id)s/repository/commits" diff --git a/tools/cli_test_v4.sh b/tools/cli_test_v4.sh index cf157f4..b916705 100755 --- a/tools/cli_test_v4.sh +++ b/tools/cli_test_v4.sh @@ -113,6 +113,13 @@ testcase "revert commit" ' --id "$COMMIT_ID" --branch master ' +# Test commit GPG signature +testcase "attempt to get GPG signature of unsigned commit" ' + OUTPUT=$(GITLAB project-commit signature --project-id "$PROJECT_ID" \ + --id "$COMMIT_ID" 2>&1 || exit 0) + echo "$OUTPUT" | grep -q "404 GPG Signature Not Found" +' + # Test project labels testcase "create project label" ' OUTPUT=$(GITLAB -v project-label create --project-id $PROJECT_ID \ diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py index fad8c69..69b0d31 100644 --- a/tools/python_test_v4.py +++ b/tools/python_test_v4.py @@ -473,6 +473,14 @@ commit = admin_project.commits.list()[0] # assert commit.refs() # assert commit.merge_requests() +# commit GPG signature (for unsigned commits) +# TODO: reasonable tests for signed commits? +try: + signature = commit.signature() +except gitlab.GitlabGetError as e: + error_message = e.error_message +assert error_message == "404 GPG Signature Not Found" + # commit comment commit.comments.create({"note": "This is a commit comment"}) # assert len(commit.comments.list()) == 1 |