summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2020-04-22 23:01:55 +0200
committerNejc Habjan <hab.nejc@gmail.com>2020-04-22 23:31:35 +0200
commitdc382fe3443a797e016f8c5f6eac68b7b69305ab (patch)
tree3f8bb49ffad00924720ebbe5ca6baaebe1fd0ef9
parent9d66cb3ccc8d9edac68380b4b8ff285a9782e698 (diff)
downloadgitlab-dc382fe3443a797e016f8c5f6eac68b7b69305ab.tar.gz
chore: bring commit signatures up to date with 12.10
-rw-r--r--docs/cli.rst2
-rw-r--r--docs/gl_objects/commits.rst2
-rw-r--r--gitlab/v4/objects.py4
-rwxr-xr-xtools/cli_test_v4.sh6
-rw-r--r--tools/python_test_v4.py4
5 files changed, 9 insertions, 9 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index aeff276..4261d0e 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -258,7 +258,7 @@ Get a specific project commit by its SHA id:
$ gitlab project-commit get --project-id 2 --id a43290c
-Get the GPG signature of a signed commit:
+Get the signature (e.g. GPG or x509) of a signed commit:
.. code-block:: console
diff --git a/docs/gl_objects/commits.rst b/docs/gl_objects/commits.rst
index e6bdfd8..a1d878c 100644
--- a/docs/gl_objects/commits.rst
+++ b/docs/gl_objects/commits.rst
@@ -82,7 +82,7 @@ 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)::
+Get the signature of the commit (if the commit was signed, e.g. with GPG or x509)::
commit.signature()
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
index f6c09d9..42b2bf4 100644
--- a/gitlab/v4/objects.py
+++ b/gitlab/v4/objects.py
@@ -2299,7 +2299,7 @@ class ProjectCommit(RESTObject):
@cli.register_custom_action("ProjectCommit")
@exc.on_http_error(exc.GitlabGetError)
def signature(self, **kwargs):
- """Get the GPG signature of the commit.
+ """Get the signature of the commit.
Args:
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -2309,7 +2309,7 @@ class ProjectCommit(RESTObject):
GitlabGetError: If the signature could not be retrieved
Returns:
- dict: The commit's GPG signature data
+ dict: The commit's signature data
"""
path = "%s/%s/signature" % (self.manager.path, self.get_id())
return self.manager.gitlab.http_get(path, **kwargs)
diff --git a/tools/cli_test_v4.sh b/tools/cli_test_v4.sh
index 395289a..ac43837 100755
--- a/tools/cli_test_v4.sh
+++ b/tools/cli_test_v4.sh
@@ -113,11 +113,11 @@ testcase "revert commit" '
--id "$COMMIT_ID" --branch master
'
-# Test commit GPG signature
-testcase "attempt to get GPG signature of unsigned commit" '
+# Test commit signature
+testcase "attempt to get 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"
+ echo "$OUTPUT" | grep -q "404 Signature Not Found"
'
# Test project labels
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
index 7145bc1..7276e6e 100644
--- a/tools/python_test_v4.py
+++ b/tools/python_test_v4.py
@@ -500,13 +500,13 @@ commit = admin_project.commits.list()[0]
# assert commit.refs()
# assert commit.merge_requests()
-# commit GPG signature (for unsigned commits)
+# commit 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"
+assert error_message == "404 Signature Not Found"
# commit comment
commit.comments.create({"note": "This is a commit comment"})