summaryrefslogtreecommitdiffstats
path: root/qa/test_commits.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-19 14:52:50 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-19 14:53:01 +0000
commitf3b6c222fb11c96e2f8bbaa0622f46c8ec486874 (patch)
tree0f38497775e27d3e16b20573b36dd22aa5b24f3e /qa/test_commits.py
parentReleasing debian version 0.17.0-1. (diff)
downloadgitlint-f3b6c222fb11c96e2f8bbaa0622f46c8ec486874.tar.xz
gitlint-f3b6c222fb11c96e2f8bbaa0622f46c8ec486874.zip
Merging upstream version 0.18.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'qa/test_commits.py')
-rw-r--r--qa/test_commits.py161
1 files changed, 116 insertions, 45 deletions
diff --git a/qa/test_commits.py b/qa/test_commits.py
index 92e1087..d40c211 100644
--- a/qa/test_commits.py
+++ b/qa/test_commits.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# pylint: disable=too-many-function-args,unexpected-keyword-arg
import re
@@ -9,22 +8,22 @@ from qa.base import BaseTestCase
class CommitsTests(BaseTestCase):
- """ Integration tests for the --commits argument, i.e. linting multiple commits at once or linting specific commits
- """
+ """Integration tests for the --commits argument, i.e. linting multiple commits or linting specific commits"""
def test_successful(self):
- """ Test linting multiple commits without violations """
+ """Test linting multiple commits without violations"""
git("checkout", "-b", "test-branch-commits-base", _cwd=self.tmp_git_repo)
self.create_simple_commit("Sïmple title\n\nSimple bödy describing the commit")
git("checkout", "-b", "test-branch-commits", _cwd=self.tmp_git_repo)
self.create_simple_commit("Sïmple title2\n\nSimple bödy describing the commit2")
self.create_simple_commit("Sïmple title3\n\nSimple bödy describing the commit3")
- output = gitlint("--commits", "test-branch-commits-base...test-branch-commits",
- _cwd=self.tmp_git_repo, _tty_in=True)
+ output = gitlint(
+ "--commits", "test-branch-commits-base...test-branch-commits", _cwd=self.tmp_git_repo, _tty_in=True
+ )
self.assertEqualStdout(output, "")
def test_violations(self):
- """ Test linting multiple commits with violations """
+ """Test linting multiple commits with violations"""
git("checkout", "-b", "test-branch-commits-violations-base", _cwd=self.tmp_git_repo)
self.create_simple_commit("Sïmple title.\n")
git("checkout", "-b", "test-branch-commits-violations", _cwd=self.tmp_git_repo)
@@ -33,15 +32,46 @@ class CommitsTests(BaseTestCase):
commit_sha1 = self.get_last_commit_hash()[:10]
self.create_simple_commit("Sïmple title3.\n")
commit_sha2 = self.get_last_commit_hash()[:10]
- output = gitlint("--commits", "test-branch-commits-violations-base...test-branch-commits-violations",
- _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[4])
+ output = gitlint(
+ "--commits",
+ "test-branch-commits-violations-base...test-branch-commits-violations",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[4],
+ )
self.assertEqual(output.exit_code, 4)
- expected_kwargs = {'commit_sha1': commit_sha1, 'commit_sha2': commit_sha2}
+ expected_kwargs = {"commit_sha1": commit_sha1, "commit_sha2": commit_sha2}
self.assertEqualStdout(output, self.get_expected("test_commits/test_violations_1", expected_kwargs))
+ def test_csv_hash_list(self):
+ """Test linting multiple commits (comma-separated) with violations"""
+ git("checkout", "-b", "test-branch-commits-violations-base", _cwd=self.tmp_git_repo)
+ self.create_simple_commit("Sïmple title1.\n")
+ commit_sha1 = self.get_last_commit_hash()[:10]
+ git("checkout", "-b", "test-branch-commits-violations", _cwd=self.tmp_git_repo)
+
+ self.create_simple_commit("Sïmple title2.\n")
+ commit_sha2 = self.get_last_commit_hash()[:10]
+ self.create_simple_commit("Sïmple title3.\n")
+ self.create_simple_commit("Sïmple title4.\n")
+ commit_sha4 = self.get_last_commit_hash()[:10]
+
+ # Lint subset of the commits in a specific order, passed in via csv list
+ output = gitlint(
+ "--commits",
+ f"{commit_sha2},{commit_sha1},{commit_sha4}",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[6],
+ )
+
+ self.assertEqual(output.exit_code, 6)
+ expected_kwargs = {"commit_sha1": commit_sha1, "commit_sha2": commit_sha2, "commit_sha4": commit_sha4}
+ self.assertEqualStdout(output, self.get_expected("test_commits/test_csv_hash_list_1", expected_kwargs))
+
def test_lint_empty_commit_range(self):
- """ Tests `gitlint --commits <sha>^...<sha>` --fail-without-commits where the provided range is empty. """
+ """Tests `gitlint --commits <sha>^...<sha>` --fail-without-commits where the provided range is empty."""
self.create_simple_commit("Sïmple title.\n")
self.create_simple_commit("Sïmple title2.\n")
commit_sha = self.get_last_commit_hash()
@@ -54,13 +84,19 @@ class CommitsTests(BaseTestCase):
self.assertEqualStdout(output, "")
# Gitlint should fail when --fail-without-commits is used
- output = gitlint("--commits", refspec, "--fail-without-commits", _cwd=self.tmp_git_repo, _tty_in=True,
- _ok_code=[self.GITLINT_USAGE_ERROR])
+ output = gitlint(
+ "--commits",
+ refspec,
+ "--fail-without-commits",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[self.GITLINT_USAGE_ERROR],
+ )
self.assertEqual(output.exit_code, self.GITLINT_USAGE_ERROR)
- self.assertEqualStdout(output, f"Error: No commits in range \"{refspec}\"\n")
+ self.assertEqualStdout(output, f'Error: No commits in range "{refspec}"\n')
def test_lint_single_commit(self):
- """ Tests `gitlint --commits <sha>^...<same sha>` """
+ """Tests `gitlint --commits <sha>^...<same sha>`"""
self.create_simple_commit("Sïmple title.\n")
first_commit_sha = self.get_last_commit_hash()
self.create_simple_commit("Sïmple title2.\n")
@@ -68,8 +104,7 @@ class CommitsTests(BaseTestCase):
refspec = f"{commit_sha}^...{commit_sha}"
self.create_simple_commit("Sïmple title3.\n")
- expected = ("1: T3 Title has trailing punctuation (.): \"Sïmple title2.\"\n" +
- "3: B6 Body message is missing\n")
+ expected = '1: T3 Title has trailing punctuation (.): "Sïmple title2."\n' + "3: B6 Body message is missing\n"
# Lint using --commit <commit sha>
output = gitlint("--commit", commit_sha, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2])
@@ -83,8 +118,7 @@ class CommitsTests(BaseTestCase):
# Lint the first commit in the repository. This is a use-case that is not supported by --commits
# As <sha>^...<sha> is not correct refspec in case <sha> points to the initial commit (which has no parents)
- expected = ("1: T3 Title has trailing punctuation (.): \"Sïmple title.\"\n" +
- "3: B6 Body message is missing\n")
+ expected = '1: T3 Title has trailing punctuation (.): "Sïmple title."\n' + "3: B6 Body message is missing\n"
output = gitlint("--commit", first_commit_sha, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2])
self.assertEqual(output.exit_code, 2)
self.assertEqualStdout(output, expected)
@@ -95,10 +129,10 @@ class CommitsTests(BaseTestCase):
self.assertEqual(output.exit_code, 254)
def test_lint_staged_stdin(self):
- """ Tests linting a staged commit. Gitint should lint the passed commit message andfetch additional meta-data
- from the underlying repository. The easiest way to test this is by inspecting `--debug` output.
- This is the equivalent of doing:
- echo "WIP: Pïpe test." | gitlint --staged --debug
+ """Tests linting a staged commit. Gitint should lint the passed commit message andfetch additional meta-data
+ from the underlying repository. The easiest way to test this is by inspecting `--debug` output.
+ This is the equivalent of doing:
+ echo "WIP: Pïpe test." | gitlint --staged --debug
"""
# Create a commit first, before we stage changes. This ensures the repo is properly initialized.
self.create_simple_commit("Sïmple title.\n")
@@ -109,30 +143,45 @@ class CommitsTests(BaseTestCase):
filename2 = self.create_file(self.tmp_git_repo)
git("add", filename2, _cwd=self.tmp_git_repo)
- output = gitlint(echo("WIP: Pïpe test."), "--staged", "--debug",
- _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
+ output = gitlint(
+ echo("WIP: Pïpe test."),
+ "--staged",
+ "--debug",
+ _cwd=self.tmp_git_repo,
+ _tty_in=False,
+ _err_to_out=True,
+ _ok_code=[3],
+ )
# Determine variable parts of expected output
expected_kwargs = self.get_debug_vars_last_commit()
- expected_kwargs.update({'changed_files': sorted([filename1, filename2])})
+ filenames = sorted([filename1, filename2])
+ expected_kwargs.update(
+ {
+ "changed_files": filenames,
+ "changed_files_stats": (
+ f"{filenames[0]}: 0 additions, 0 deletions\n {filenames[1]}: 0 additions, 0 deletions"
+ ),
+ }
+ )
# It's not really possible to determine the "Date: ..." line that is part of the debug output as this date
# is not taken from git but instead generated by gitlint itself. As a workaround, we extract the date from the
# gitlint output using a regex, parse the date to ensure the format is correct, and then pass that as an
# expected variable.
- matches = re.search(r'^Date:\s+(.*)', str(output), re.MULTILINE)
+ matches = re.search(r"^Date:\s+(.*)", str(output), re.MULTILINE)
if matches:
expected_date = arrow.get(str(matches.group(1)), "YYYY-MM-DD HH:mm:ss Z").format("YYYY-MM-DD HH:mm:ss Z")
- expected_kwargs['staged_date'] = expected_date
+ expected_kwargs["staged_date"] = expected_date
self.assertEqualStdout(output, self.get_expected("test_commits/test_lint_staged_stdin_1", expected_kwargs))
self.assertEqual(output.exit_code, 3)
def test_lint_staged_msg_filename(self):
- """ Tests linting a staged commit. Gitint should lint the passed commit message andfetch additional meta-data
- from the underlying repository. The easiest way to test this is by inspecting `--debug` output.
- This is the equivalent of doing:
- gitlint --msg-filename /tmp/my-commit-msg --staged --debug
+ """Tests linting a staged commit. Gitint should lint the passed commit message andfetch additional meta-data
+ from the underlying repository. The easiest way to test this is by inspecting `--debug` output.
+ This is the equivalent of doing:
+ gitlint --msg-filename /tmp/my-commit-msg --staged --debug
"""
# Create a commit first, before we stage changes. This ensures the repo is properly initialized.
self.create_simple_commit("Sïmple title.\n")
@@ -145,28 +194,44 @@ class CommitsTests(BaseTestCase):
tmp_commit_msg_file = self.create_tmpfile("WIP: from fïle test.")
- output = gitlint("--msg-filename", tmp_commit_msg_file, "--staged", "--debug",
- _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
+ output = gitlint(
+ "--msg-filename",
+ tmp_commit_msg_file,
+ "--staged",
+ "--debug",
+ _cwd=self.tmp_git_repo,
+ _tty_in=False,
+ _err_to_out=True,
+ _ok_code=[3],
+ )
# Determine variable parts of expected output
expected_kwargs = self.get_debug_vars_last_commit()
- expected_kwargs.update({'changed_files': sorted([filename1, filename2])})
+ filenames = sorted([filename1, filename2])
+ expected_kwargs.update(
+ {
+ "changed_files": filenames,
+ "changed_files_stats": (
+ f"{filenames[0]}: 0 additions, 0 deletions\n {filenames[1]}: 0 additions, 0 deletions"
+ ),
+ }
+ )
# It's not really possible to determine the "Date: ..." line that is part of the debug output as this date
# is not taken from git but instead generated by gitlint itself. As a workaround, we extract the date from the
# gitlint output using a regex, parse the date to ensure the format is correct, and then pass that as an
# expected variable.
- matches = re.search(r'^Date:\s+(.*)', str(output), re.MULTILINE)
+ matches = re.search(r"^Date:\s+(.*)", str(output), re.MULTILINE)
if matches:
expected_date = arrow.get(str(matches.group(1)), "YYYY-MM-DD HH:mm:ss Z").format("YYYY-MM-DD HH:mm:ss Z")
- expected_kwargs['staged_date'] = expected_date
+ expected_kwargs["staged_date"] = expected_date
expected = self.get_expected("test_commits/test_lint_staged_msg_filename_1", expected_kwargs)
self.assertEqualStdout(output, expected)
self.assertEqual(output.exit_code, 3)
def test_lint_head(self):
- """ Testing whether we can also recognize special refs like 'HEAD' """
+ """Testing whether we can also recognize special refs like 'HEAD'"""
tmp_git_repo = self.create_tmp_git_repo()
self.create_simple_commit("Sïmple title.\n\nSimple bödy describing the commit", git_repo=tmp_git_repo)
self.create_simple_commit("Sïmple title", git_repo=tmp_git_repo)
@@ -174,13 +239,16 @@ class CommitsTests(BaseTestCase):
output = gitlint("--commits", "HEAD", _cwd=tmp_git_repo, _tty_in=True, _ok_code=[3])
revlist = git("rev-list", "HEAD", _tty_in=True, _cwd=tmp_git_repo).split()
- expected_kwargs = {"commit_sha0": revlist[0][:10], "commit_sha1": revlist[1][:10],
- "commit_sha2": revlist[2][:10]}
+ expected_kwargs = {
+ "commit_sha0": revlist[0][:10],
+ "commit_sha1": revlist[1][:10],
+ "commit_sha2": revlist[2][:10],
+ }
self.assertEqualStdout(output, self.get_expected("test_commits/test_lint_head_1", expected_kwargs))
def test_ignore_commits(self):
- """ Tests multiple commits of which some rules get ignored because of ignore-* rules """
+ """Tests multiple commits of which some rules get ignored because of ignore-* rules"""
# Create repo and some commits
tmp_git_repo = self.create_tmp_git_repo()
self.create_simple_commit("Sïmple title.\n\nSimple bödy describing the commit", git_repo=tmp_git_repo)
@@ -188,14 +256,17 @@ class CommitsTests(BaseTestCase):
# But in this case only B5 because T3 and T5 are being ignored because of config
self.create_simple_commit("Release: WIP tïtle.\n\nShort", git_repo=tmp_git_repo)
# In the following 2 commits, the T3 violations are as normal
- self.create_simple_commit(
- "Sïmple WIP title3.\n\nThis is \ta relëase commit\nMore info", git_repo=tmp_git_repo)
+ self.create_simple_commit("Sïmple WIP title3.\n\nThis is \ta relëase commit\nMore info", git_repo=tmp_git_repo)
self.create_simple_commit("Sïmple title4.\n\nSimple bödy describing the commit4", git_repo=tmp_git_repo)
revlist = git("rev-list", "HEAD", _tty_in=True, _cwd=tmp_git_repo).split()
config_path = self.get_sample_path("config/ignore-release-commits")
output = gitlint("--commits", "HEAD", "--config", config_path, _cwd=tmp_git_repo, _tty_in=True, _ok_code=[4])
- expected_kwargs = {"commit_sha0": revlist[0][:10], "commit_sha1": revlist[1][:10],
- "commit_sha2": revlist[2][:10], "commit_sha3": revlist[3][:10]}
+ expected_kwargs = {
+ "commit_sha0": revlist[0][:10],
+ "commit_sha1": revlist[1][:10],
+ "commit_sha2": revlist[2][:10],
+ "commit_sha3": revlist[3][:10],
+ }
self.assertEqualStdout(output, self.get_expected("test_commits/test_ignore_commits_1", expected_kwargs))