# test_porcelain .py -- Tests for dulwich.porcelain/CGit compatibility
# Copyright (C) 2010 Google, Inc.
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as public by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# for a copy of the GNU General Public License
# and for a copy of the Apache
# License, Version 2.0.
#
"""Compatibility tests for dulwich.porcelain."""
import os
from unittest import skipIf
from dulwich import porcelain
from dulwich.tests.utils import build_commit_graph
from ..test_porcelain import PorcelainGpgTestCase
from .utils import CompatTestCase, run_git_or_fail
try:
import gpgme
except ImportError:
gpgme = None
@skipIf(
gpgme is None,
"gpgme not available, skipping tests that require GPG signing",
)
class TagCreateSignTestCase(PorcelainGpgTestCase, CompatTestCase):
def test_sign(self) -> None:
# Test that dulwich signatures can be verified by CGit
c1, c2, c3 = build_commit_graph(
self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
)
self.repo.refs[b"HEAD"] = c3.id
cfg = self.repo.get_config()
cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
self.import_default_key()
porcelain.tag_create(
self.repo.path,
b"tryme",
b"foo ",
b"bar",
annotated=True,
sign=True,
)
run_git_or_fail(
[f"--git-dir={self.repo.controldir()}", "tag", "-v", "tryme"],
env={"GNUPGHOME": os.environ["GNUPGHOME"]},
)
def test_verify(self) -> None:
# Test that CGit signatures can be verified by dulwich
c1, c2, c3 = build_commit_graph(
self.repo.object_store, [[1], [2, 1], [3, 1, 2]]
)
self.repo.refs[b"HEAD"] = c3.id
self.import_default_key()
run_git_or_fail(
[
f"--git-dir={self.repo.controldir()}",
"tag",
"-u",
PorcelainGpgTestCase.DEFAULT_KEY_ID,
"-m",
"foo",
"verifyme",
],
env={
"GNUPGHOME": os.environ["GNUPGHOME"],
"GIT_COMMITTER_NAME": "Joe Example",
"GIT_COMMITTER_EMAIL": "joe@example.com",
},
)
tag = self.repo[b"refs/tags/verifyme"]
self.assertNotEqual(tag.signature, None)
tag.verify()
@skipIf(
gpgme is None,
"gpgme not available, skipping tests that require GPG signing",
)
class CommitCreateSignTestCase(PorcelainGpgTestCase, CompatTestCase):
def test_sign(self):
# Test that dulwich signatures can be verified by CGit
cfg = self.repo.get_config()
cfg.set(("user",), "signingKey", PorcelainGpgTestCase.DEFAULT_KEY_ID)
self.import_default_key()
porcelain.commit(
self.repo.path,
b"messy message messiah",
b"foo ",
signoff=True,
)
run_git_or_fail(
[f"--git-dir={self.repo.controldir()}", "verify-commit", "-v", "HEAD"],
env={"GNUPGHOME": os.environ["GNUPGHOME"]},
)
def test_verify(self):
# Test that CGit signatures can be verified by dulwich
self.import_default_key()
run_git_or_fail(
[
f"--git-dir={self.repo.controldir()}",
"commit",
"--allow-empty",
"-S" + PorcelainGpgTestCase.DEFAULT_KEY_ID,
"-m",
"foo",
],
env={
"GNUPGHOME": os.environ["GNUPGHOME"],
"GIT_COMMITTER_NAME": "Joe Example",
"GIT_COMMITTER_EMAIL": "joe@example.com",
},
)
commit = self.repo[b"HEAD"]
self.assertNotEqual(commit.gpgsig, None)
commit.verify()
def test_verify_with_empty_message(self):
# Test that CGit signatures can be verified by dulwich
self.import_default_key()
run_git_or_fail(
[
f"--git-dir={self.repo.controldir()}",
"commit",
"--allow-empty",
"-S" + PorcelainGpgTestCase.DEFAULT_KEY_ID,
"--allow-empty-message",
"-m",
"",
],
env={
"GNUPGHOME": os.environ["GNUPGHOME"],
"GIT_COMMITTER_NAME": "Joe Example",
"GIT_COMMITTER_EMAIL": "joe@example.com",
},
)
commit = self.repo[b"HEAD"]
self.assertNotEqual(commit.gpgsig, None)
commit.verify()