summaryrefslogtreecommitdiffstats
path: root/qa
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 09:49:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 09:49:10 +0000
commita85f3954a8fe112640c2c35da3228be29b17c97c (patch)
tree7ee43f79639ee53903e7ca389e548974e1497c3a /qa
parentInitial commit. (diff)
downloadgitlint-a85f3954a8fe112640c2c35da3228be29b17c97c.tar.xz
gitlint-a85f3954a8fe112640c2c35da3228be29b17c97c.zip
Adding upstream version 0.18.0.upstream/0.18.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'qa')
-rw-r--r--qa/__init__.py0
-rw-r--r--qa/base.py214
-rw-r--r--qa/expected/test_commits/test_csv_hash_list_111
-rw-r--r--qa/expected/test_commits/test_ignore_commits_113
-rw-r--r--qa/expected/test_commits/test_lint_head_18
-rw-r--r--qa/expected/test_commits/test_lint_staged_msg_filename_196
-rw-r--r--qa/expected/test_commits/test_lint_staged_stdin_198
-rw-r--r--qa/expected/test_commits/test_violations_17
-rw-r--r--qa/expected/test_config/test_config_from_env_1103
-rw-r--r--qa/expected/test_config/test_config_from_env_292
-rw-r--r--qa/expected/test_config/test_config_from_file_15
-rw-r--r--qa/expected/test_config/test_config_from_file_debug_1100
-rw-r--r--qa/expected/test_config/test_set_rule_option_13
-rw-r--r--qa/expected/test_config/test_verbosity_13
-rw-r--r--qa/expected/test_config/test_verbosity_23
-rw-r--r--qa/expected/test_contrib/test_contrib_rules_13
-rw-r--r--qa/expected/test_contrib/test_contrib_rules_with_config_13
-rw-r--r--qa/expected/test_gitlint/test_commit_binary_file_194
-rw-r--r--qa/expected/test_gitlint/test_msg_filename_13
-rw-r--r--qa/expected/test_gitlint/test_msg_filename_no_tty_13
-rw-r--r--qa/expected/test_gitlint/test_violations_13
-rw-r--r--qa/expected/test_named_rules/test_named_rule_15
-rw-r--r--qa/expected/test_named_rules/test_named_user_rule_19
-rw-r--r--qa/expected/test_stdin/test_stdin_file_13
-rw-r--r--qa/expected/test_stdin/test_stdin_pipe_13
-rw-r--r--qa/expected/test_stdin/test_stdin_pipe_empty_13
-rw-r--r--qa/expected/test_user_defined/test_user_defined_rules_examples_15
-rw-r--r--qa/expected/test_user_defined/test_user_defined_rules_examples_24
-rw-r--r--qa/expected/test_user_defined/test_user_defined_rules_examples_with_config_16
-rw-r--r--qa/expected/test_user_defined/test_user_defined_rules_extra_19
-rw-r--r--qa/requirements.txt4
-rw-r--r--qa/samples/config/gitlintconfig13
-rw-r--r--qa/samples/config/ignore-release-commits7
-rw-r--r--qa/samples/config/named-rules8
-rw-r--r--qa/samples/config/named-user-rules15
-rw-r--r--qa/samples/user_rules/extra/extra_rules.py72
-rw-r--r--qa/samples/user_rules/incorrect_linerule/my_line_rule.py8
-rw-r--r--qa/shell.py89
-rw-r--r--qa/test_commits.py272
-rw-r--r--qa/test_config.py135
-rw-r--r--qa/test_contrib.py32
-rw-r--r--qa/test_gitlint.py267
-rw-r--r--qa/test_hooks.py180
-rw-r--r--qa/test_named_rules.py23
-rw-r--r--qa/test_stdin.py53
-rw-r--r--qa/test_user_defined.py58
-rw-r--r--qa/utils.py62
47 files changed, 2210 insertions, 0 deletions
diff --git a/qa/__init__.py b/qa/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/qa/__init__.py
diff --git a/qa/base.py b/qa/base.py
new file mode 100644
index 0000000..ce66fbf
--- /dev/null
+++ b/qa/base.py
@@ -0,0 +1,214 @@
+# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return,
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+
+import os
+import platform
+import shutil
+import sys
+import tempfile
+from datetime import datetime
+from uuid import uuid4
+from unittest import TestCase
+
+import arrow
+
+
+from qa.shell import git, gitlint, RunningCommand
+from qa.utils import DEFAULT_ENCODING
+
+
+class BaseTestCase(TestCase):
+ """Base class of which all gitlint integration test classes are derived.
+ Provides a number of convenience methods."""
+
+ # In case of assert failures, print the full error message
+ maxDiff = None
+ tmp_git_repo = None
+
+ GITLINT_USE_SH_LIB = os.environ.get("GITLINT_USE_SH_LIB", "[NOT SET]")
+ GIT_CONTEXT_ERROR_CODE = 254
+ GITLINT_USAGE_ERROR = 253
+
+ def setUp(self):
+ """Sets up the integration tests by creating a new temporary git repository"""
+ self.tmpfiles = []
+ self.tmp_git_repos = []
+ self.tmp_git_repo = self.create_tmp_git_repo()
+
+ def tearDown(self):
+ # Clean up temporary files and repos
+ for tmpfile in self.tmpfiles:
+ os.remove(tmpfile)
+ for repo in self.tmp_git_repos:
+ shutil.rmtree(repo)
+
+ def assertEqualStdout(self, output, expected): # pylint: disable=invalid-name
+ self.assertIsInstance(output, RunningCommand)
+ output = output.stdout.decode(DEFAULT_ENCODING)
+ output = output.replace("\r", "")
+ self.assertMultiLineEqual(output, expected)
+
+ @staticmethod
+ def generate_temp_path():
+ timestamp = datetime.now().strftime("%Y%m%d-%H%M%S-%f")
+ return os.path.realpath(f"/tmp/gitlint-test-{timestamp}")
+
+ def create_tmp_git_repo(self):
+ """Creates a temporary git repository and returns its directory path"""
+ tmp_git_repo = self.generate_temp_path()
+ self.tmp_git_repos.append(tmp_git_repo)
+
+ git("init", "--initial-branch", "main", tmp_git_repo)
+ # configuring name and email is required in every git repot
+ git("config", "user.name", "gitlint-test-user", _cwd=tmp_git_repo)
+ git("config", "user.email", "gitlint@test.com", _cwd=tmp_git_repo)
+
+ # Git does not by default print unicode paths, fix that by setting core.quotePath to false
+ # http://stackoverflow.com/questions/34549040/git-not-displaying-unicode-file-names
+ # ftp://www.kernel.org/pub/software/scm/git/docs/git-config.html
+ git("config", "core.quotePath", "false", _cwd=tmp_git_repo)
+
+ # Git on mac doesn't like unicode characters by default, so we need to set this option
+ # http://stackoverflow.com/questions/5581857/git-and-the-umlaut-problem-on-mac-os-x
+ git("config", "core.precomposeunicode", "true", _cwd=tmp_git_repo)
+
+ return tmp_git_repo
+
+ @staticmethod
+ def create_file(parent_dir, content=None):
+ """Creates a file inside a passed directory. Returns filename."""
+ test_filename = "test-fïle-" + str(uuid4())
+ full_path = os.path.join(parent_dir, test_filename)
+
+ if content:
+ if isinstance(content, bytes):
+ open_kwargs = {"mode": "wb"}
+ else:
+ open_kwargs = {"mode": "w", "encoding": DEFAULT_ENCODING}
+
+ with open(full_path, **open_kwargs) as f: # pylint: disable=unspecified-encoding
+ f.write(content)
+ else:
+ # pylint: disable=consider-using-with
+ open(full_path, "a", encoding=DEFAULT_ENCODING).close()
+
+ return test_filename
+
+ @staticmethod
+ def create_environment(envvars=None):
+ """Creates a copy of the current os.environ and adds/overwrites a given set of variables to it"""
+ environment = os.environ.copy()
+ if envvars:
+ environment.update(envvars)
+ return environment
+
+ def create_tmp_git_config(self, contents):
+ """Creates an environment with the GIT_CONFIG variable set to a file with the given contents."""
+ tmp_config = self.create_tmpfile(contents)
+ return self.create_environment({"GIT_CONFIG": tmp_config})
+
+ def create_simple_commit(
+ self, message, *, file_contents=None, out=None, ok_code=None, env=None, git_repo=None, tty_in=False
+ ):
+ """Creates a simple commit with an empty test file.
+ :param message: Commit message for the commit."""
+
+ git_repo = self.tmp_git_repo if git_repo is None else git_repo
+
+ # Let's make sure that we copy the environment in which this python code was executed as environment
+ # variables can influence how git runs.
+ # This was needed to fix https://github.com/jorisroovers/gitlint/issues/15 as we need to make sure to use
+ # the PATH variable that contains the virtualenv's python binary.
+ environment = self.create_environment(env)
+
+ # Create file and add to git
+ test_filename = self.create_file(git_repo, file_contents)
+ git("add", test_filename, _cwd=git_repo)
+ # https://amoffat.github.io/sh/#interactive-callbacks
+ if not ok_code:
+ ok_code = [0]
+
+ git(
+ "commit",
+ "-m",
+ message,
+ _cwd=git_repo,
+ _err_to_out=True,
+ _out=out,
+ _tty_in=tty_in,
+ _ok_code=ok_code,
+ _env=environment,
+ )
+ return test_filename
+
+ def create_tmpfile(self, content):
+ """Utility method to create temp files. These are cleaned at the end of the test"""
+ # Not using a context manager to avoid unnecessary indentation in test code
+ tmpfile, tmpfilepath = tempfile.mkstemp()
+ self.tmpfiles.append(tmpfilepath)
+
+ if isinstance(content, bytes):
+ open_kwargs = {"mode": "wb"}
+ else:
+ open_kwargs = {"mode": "w", "encoding": DEFAULT_ENCODING}
+
+ with open(tmpfile, **open_kwargs) as f: # pylint: disable=unspecified-encoding
+ f.write(content)
+
+ return tmpfilepath
+
+ @staticmethod
+ def get_example_path(filename=""):
+ examples_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "../examples")
+ return os.path.join(examples_dir, filename)
+
+ @staticmethod
+ def get_sample_path(filename=""):
+ samples_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "samples")
+ return os.path.join(samples_dir, filename)
+
+ def get_last_commit_short_hash(self, git_repo=None):
+ git_repo = self.tmp_git_repo if git_repo is None else git_repo
+ return git("rev-parse", "--short", "HEAD", _cwd=git_repo, _err_to_out=True).replace("\n", "")
+
+ def get_last_commit_hash(self, git_repo=None):
+ git_repo = self.tmp_git_repo if git_repo is None else git_repo
+ return git("rev-parse", "HEAD", _cwd=git_repo, _err_to_out=True).replace("\n", "")
+
+ @staticmethod
+ def get_expected(filename="", variable_dict=None):
+ """Utility method to read an 'expected' file and return it as a string. Optionally replace template variables
+ specified by variable_dict."""
+ expected_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "expected")
+ expected_path = os.path.join(expected_dir, filename)
+ with open(expected_path, encoding=DEFAULT_ENCODING) as file:
+ expected = file.read()
+
+ if variable_dict:
+ expected = expected.format(**variable_dict)
+ return expected
+
+ @staticmethod
+ def get_system_info_dict():
+ """Returns a dict with items related to system values logged by `gitlint --debug`"""
+ expected_gitlint_version = gitlint("--version").replace("gitlint, version ", "").strip()
+ expected_git_version = git("--version").strip()
+ return {
+ "platform": platform.platform(),
+ "python_version": sys.version,
+ "git_version": expected_git_version,
+ "gitlint_version": expected_gitlint_version,
+ "GITLINT_USE_SH_LIB": BaseTestCase.GITLINT_USE_SH_LIB,
+ "DEFAULT_ENCODING": DEFAULT_ENCODING,
+ }
+
+ def get_debug_vars_last_commit(self, git_repo=None):
+ """Returns a dict with items related to `gitlint --debug` output for the last commit."""
+ target_repo = git_repo if git_repo else self.tmp_git_repo
+ commit_sha = self.get_last_commit_hash(git_repo=target_repo)
+ expected_date = git("log", "-1", "--pretty=%ai", _tty_out=False, _cwd=target_repo)
+ expected_date = arrow.get(str(expected_date), "YYYY-MM-DD HH:mm:ss Z").format("YYYY-MM-DD HH:mm:ss Z")
+
+ expected_kwargs = self.get_system_info_dict()
+ expected_kwargs.update({"target": target_repo, "commit_sha": commit_sha, "commit_date": expected_date})
+ return expected_kwargs
diff --git a/qa/expected/test_commits/test_csv_hash_list_1 b/qa/expected/test_commits/test_csv_hash_list_1
new file mode 100644
index 0000000..bbd9f51
--- /dev/null
+++ b/qa/expected/test_commits/test_csv_hash_list_1
@@ -0,0 +1,11 @@
+Commit {commit_sha2}:
+1: T3 Title has trailing punctuation (.): "Sïmple title2."
+3: B6 Body message is missing
+
+Commit {commit_sha1}:
+1: T3 Title has trailing punctuation (.): "Sïmple title1."
+3: B6 Body message is missing
+
+Commit {commit_sha4}:
+1: T3 Title has trailing punctuation (.): "Sïmple title4."
+3: B6 Body message is missing
diff --git a/qa/expected/test_commits/test_ignore_commits_1 b/qa/expected/test_commits/test_ignore_commits_1
new file mode 100644
index 0000000..01cf8bd
--- /dev/null
+++ b/qa/expected/test_commits/test_ignore_commits_1
@@ -0,0 +1,13 @@
+WARNING: I1 - ignore-by-title: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-by-title.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search
+WARNING: I2 - ignore-by-body: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-by-body.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search
+Commit {commit_sha0}:
+1: T3 Title has trailing punctuation (.): "Sïmple title4."
+
+Commit {commit_sha1}:
+1: T5 Title contains the word 'WIP' (case-insensitive): "Sïmple WIP title3."
+
+Commit {commit_sha2}:
+3: B5 Body message is too short (5<20): "Short"
+
+Commit {commit_sha3}:
+1: T3 Title has trailing punctuation (.): "Sïmple title."
diff --git a/qa/expected/test_commits/test_lint_head_1 b/qa/expected/test_commits/test_lint_head_1
new file mode 100644
index 0000000..d7ca594
--- /dev/null
+++ b/qa/expected/test_commits/test_lint_head_1
@@ -0,0 +1,8 @@
+Commit {commit_sha0}:
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Sïmple title"
+
+Commit {commit_sha1}:
+3: B6 Body message is missing
+
+Commit {commit_sha2}:
+1: T3 Title has trailing punctuation (.): "Sïmple title."
diff --git a/qa/expected/test_commits/test_lint_staged_msg_filename_1 b/qa/expected/test_commits/test_lint_staged_msg_filename_1
new file mode 100644
index 0000000..f2ab49e
--- /dev/null
+++ b/qa/expected/test_commits/test_lint_staged_msg_filename_1
@@ -0,0 +1,96 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: None
+[GENERAL]
+extra-path: None
+contrib: []
+ignore:
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: False
+staged: True
+fail-without-commits: False
+regex-style-search: False
+verbosity: 3
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=72
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=80
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+
+DEBUG: gitlint.cli Fetching additional meta-data from staged commit
+DEBUG: gitlint.cli Using --msg-filename.
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.lint Linting commit [SHA UNKNOWN]
+DEBUG: gitlint.git ('diff', '--staged', '--numstat', '-r')
+DEBUG: gitlint.git ('config', '--get', 'user.name')
+DEBUG: gitlint.git ('config', '--get', 'user.email')
+DEBUG: gitlint.git ('rev-parse', '--abbrev-ref', 'HEAD')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+WIP: from fïle test.
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {staged_date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: {changed_files}
+Changed Files Stats:
+ {changed_files_stats}
+-----------------------
+1: T3 Title has trailing punctuation (.): "WIP: from fïle test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: from fïle test."
+3: B6 Body message is missing
+DEBUG: gitlint.cli Exit Code = 3
diff --git a/qa/expected/test_commits/test_lint_staged_stdin_1 b/qa/expected/test_commits/test_lint_staged_stdin_1
new file mode 100644
index 0000000..cf34b8b
--- /dev/null
+++ b/qa/expected/test_commits/test_lint_staged_stdin_1
@@ -0,0 +1,98 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: None
+[GENERAL]
+extra-path: None
+contrib: []
+ignore:
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: False
+staged: True
+fail-without-commits: False
+regex-style-search: False
+verbosity: 3
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=72
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=80
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+
+DEBUG: gitlint.cli Fetching additional meta-data from staged commit
+DEBUG: gitlint.cli Stdin data: 'WIP: Pïpe test.
+'
+DEBUG: gitlint.cli Stdin detected and not ignored. Using as input.
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.lint Linting commit [SHA UNKNOWN]
+DEBUG: gitlint.git ('diff', '--staged', '--numstat', '-r')
+DEBUG: gitlint.git ('config', '--get', 'user.name')
+DEBUG: gitlint.git ('config', '--get', 'user.email')
+DEBUG: gitlint.git ('rev-parse', '--abbrev-ref', 'HEAD')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+WIP: Pïpe test.
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {staged_date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: {changed_files}
+Changed Files Stats:
+ {changed_files_stats}
+-----------------------
+1: T3 Title has trailing punctuation (.): "WIP: Pïpe test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Pïpe test."
+3: B6 Body message is missing
+DEBUG: gitlint.cli Exit Code = 3
diff --git a/qa/expected/test_commits/test_violations_1 b/qa/expected/test_commits/test_violations_1
new file mode 100644
index 0000000..6f3f9e2
--- /dev/null
+++ b/qa/expected/test_commits/test_violations_1
@@ -0,0 +1,7 @@
+Commit {commit_sha2}:
+1: T3 Title has trailing punctuation (.): "Sïmple title3."
+3: B6 Body message is missing
+
+Commit {commit_sha1}:
+1: T3 Title has trailing punctuation (.): "Sïmple title2."
+3: B6 Body message is missing
diff --git a/qa/expected/test_config/test_config_from_env_1 b/qa/expected/test_config/test_config_from_env_1
new file mode 100644
index 0000000..38fba21
--- /dev/null
+++ b/qa/expected/test_config/test_config_from_env_1
@@ -0,0 +1,103 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: None
+[GENERAL]
+extra-path: None
+contrib: ['CC1', 'CT1']
+ignore: T1,T2
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: True
+staged: False
+fail-without-commits: True
+regex-style-search: False
+verbosity: 2
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=72
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=80
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+ CC1: contrib-body-requires-signed-off-by
+ CT1: contrib-title-conventional-commits
+ types=fix,feat,chore,docs,style,refactor,perf,test,revert,ci,build
+
+DEBUG: gitlint.cli No --msg-filename flag, no or empty data passed to stdin. Using the local repo.
+DEBUG: gitlint.git ('rev-list', '{commit_sha}')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.git ('log', '{commit_sha}', '-1', '--pretty=%aN%x00%aE%x00%ai%x00%P%n%B')
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.lint Linting commit {commit_sha}
+DEBUG: gitlint.git ('diff-tree', '--no-commit-id', '--numstat', '-r', '--root', '{commit_sha}')
+DEBUG: gitlint.git ('branch', '--contains', '{commit_sha}')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+WIP: Thïs is a title thåt is a bit longer.
+Content on the second line
+This line of the body is here because we need it
+
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {commit_date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: {changed_files}
+Changed Files Stats:
+ {changed_files_stats}
+-----------------------
+1: CC1 Body does not contain a 'Signed-off-by' line
+1: CT1 Title does not start with one of fix, feat, chore, docs, style, refactor, perf, test, revert, ci, build
+1: T3 Title has trailing punctuation (.)
+1: T5 Title contains the word 'WIP' (case-insensitive)
+2: B4 Second line is not empty
+DEBUG: gitlint.cli Exit Code = 5
diff --git a/qa/expected/test_config/test_config_from_env_2 b/qa/expected/test_config/test_config_from_env_2
new file mode 100644
index 0000000..50d1e3f
--- /dev/null
+++ b/qa/expected/test_config/test_config_from_env_2
@@ -0,0 +1,92 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: None
+[GENERAL]
+extra-path: None
+contrib: []
+ignore:
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: False
+staged: True
+fail-without-commits: False
+regex-style-search: False
+verbosity: 0
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=72
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=80
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+
+DEBUG: gitlint.cli Fetching additional meta-data from staged commit
+DEBUG: gitlint.cli Using --msg-filename.
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.lint Linting commit [SHA UNKNOWN]
+DEBUG: gitlint.git ('diff', '--staged', '--numstat', '-r')
+DEBUG: gitlint.git ('config', '--get', 'user.name')
+DEBUG: gitlint.git ('config', '--get', 'user.email')
+DEBUG: gitlint.git ('rev-parse', '--abbrev-ref', 'HEAD')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+WIP: msg-fïlename test.
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: []
+Changed Files Stats: {{}}
+-----------------------
+DEBUG: gitlint.cli Exit Code = 3
diff --git a/qa/expected/test_config/test_config_from_file_1 b/qa/expected/test_config/test_config_from_file_1
new file mode 100644
index 0000000..6fe434a
--- /dev/null
+++ b/qa/expected/test_config/test_config_from_file_1
@@ -0,0 +1,5 @@
+1: T1 Title exceeds max length (42>20)
+1: T5 Title contains the word 'WIP' (case-insensitive)
+1: T5 Title contains the word 'thåt' (case-insensitive)
+2: B4 Second line is not empty
+3: B1 Line exceeds max length (48>30)
diff --git a/qa/expected/test_config/test_config_from_file_debug_1 b/qa/expected/test_config/test_config_from_file_debug_1
new file mode 100644
index 0000000..39bdf52
--- /dev/null
+++ b/qa/expected/test_config/test_config_from_file_debug_1
@@ -0,0 +1,100 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: {config_path}
+[GENERAL]
+extra-path: None
+contrib: []
+ignore: title-trailing-punctuation,B2
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: False
+staged: False
+fail-without-commits: False
+regex-style-search: False
+verbosity: 2
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=20
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP,thåt
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=30
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+
+DEBUG: gitlint.cli No --msg-filename flag, no or empty data passed to stdin. Using the local repo.
+DEBUG: gitlint.git ('log', '-1', '--pretty=%H')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.git ('log', '{commit_sha}', '-1', '--pretty=%aN%x00%aE%x00%ai%x00%P%n%B')
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.lint Linting commit {commit_sha}
+DEBUG: gitlint.git ('diff-tree', '--no-commit-id', '--numstat', '-r', '--root', '{commit_sha}')
+DEBUG: gitlint.git ('branch', '--contains', '{commit_sha}')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+WIP: Thïs is a title thåt is a bit longer.
+Content on the second line
+This line of the body is here because we need it
+
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {commit_date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: {changed_files}
+Changed Files Stats:
+ {changed_files_stats}
+-----------------------
+1: T1 Title exceeds max length (42>20)
+1: T5 Title contains the word 'WIP' (case-insensitive)
+1: T5 Title contains the word 'thåt' (case-insensitive)
+2: B4 Second line is not empty
+3: B1 Line exceeds max length (48>30)
+DEBUG: gitlint.cli Exit Code = 5
diff --git a/qa/expected/test_config/test_set_rule_option_1 b/qa/expected/test_config/test_set_rule_option_1
new file mode 100644
index 0000000..10b5e50
--- /dev/null
+++ b/qa/expected/test_config/test_set_rule_option_1
@@ -0,0 +1,3 @@
+1: T1 Title exceeds max length (16>5): "This ïs a title."
+1: T3 Title has trailing punctuation (.): "This ïs a title."
+3: B6 Body message is missing
diff --git a/qa/expected/test_config/test_verbosity_1 b/qa/expected/test_config/test_verbosity_1
new file mode 100644
index 0000000..0202072
--- /dev/null
+++ b/qa/expected/test_config/test_verbosity_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.)
+1: T5 Title contains the word 'WIP' (case-insensitive)
+2: B4 Second line is not empty
diff --git a/qa/expected/test_config/test_verbosity_2 b/qa/expected/test_config/test_verbosity_2
new file mode 100644
index 0000000..5a54082
--- /dev/null
+++ b/qa/expected/test_config/test_verbosity_2
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: Thïs is a title."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Thïs is a title."
+2: B4 Second line is not empty: "Contënt on the second line"
diff --git a/qa/expected/test_contrib/test_contrib_rules_1 b/qa/expected/test_contrib/test_contrib_rules_1
new file mode 100644
index 0000000..6ab7512
--- /dev/null
+++ b/qa/expected/test_contrib/test_contrib_rules_1
@@ -0,0 +1,3 @@
+1: CC1 Body does not contain a 'Signed-off-by' line
+1: CT1 Title does not follow ConventionalCommits.org format 'type(optional-scope): description': "WIP Thi$ is å title"
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP Thi$ is å title"
diff --git a/qa/expected/test_contrib/test_contrib_rules_with_config_1 b/qa/expected/test_contrib/test_contrib_rules_with_config_1
new file mode 100644
index 0000000..6ab7512
--- /dev/null
+++ b/qa/expected/test_contrib/test_contrib_rules_with_config_1
@@ -0,0 +1,3 @@
+1: CC1 Body does not contain a 'Signed-off-by' line
+1: CT1 Title does not follow ConventionalCommits.org format 'type(optional-scope): description': "WIP Thi$ is å title"
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP Thi$ is å title"
diff --git a/qa/expected/test_gitlint/test_commit_binary_file_1 b/qa/expected/test_gitlint/test_commit_binary_file_1
new file mode 100644
index 0000000..6bc119b
--- /dev/null
+++ b/qa/expected/test_gitlint/test_commit_binary_file_1
@@ -0,0 +1,94 @@
+DEBUG: gitlint.cli To report issues, please visit https://github.com/jorisroovers/gitlint/issues
+DEBUG: gitlint.cli Platform: {platform}
+DEBUG: gitlint.cli Python version: {python_version}
+DEBUG: gitlint.git ('--version',)
+DEBUG: gitlint.cli Git version: {git_version}
+DEBUG: gitlint.cli Gitlint version: {gitlint_version}
+DEBUG: gitlint.cli GITLINT_USE_SH_LIB: {GITLINT_USE_SH_LIB}
+DEBUG: gitlint.cli DEFAULT_ENCODING: {DEFAULT_ENCODING}
+DEBUG: gitlint.cli Configuration
+config-path: None
+[GENERAL]
+extra-path: None
+contrib: []
+ignore:
+ignore-merge-commits: True
+ignore-fixup-commits: True
+ignore-fixup-amend-commits: True
+ignore-squash-commits: True
+ignore-revert-commits: True
+ignore-stdin: False
+staged: False
+fail-without-commits: False
+regex-style-search: False
+verbosity: 3
+debug: True
+target: {target}
+[RULES]
+ I1: ignore-by-title
+ ignore=all
+ regex=None
+ I2: ignore-by-body
+ ignore=all
+ regex=None
+ I3: ignore-body-lines
+ regex=None
+ I4: ignore-by-author-name
+ ignore=all
+ regex=None
+ T1: title-max-length
+ line-length=72
+ T2: title-trailing-whitespace
+ T6: title-leading-whitespace
+ T3: title-trailing-punctuation
+ T4: title-hard-tab
+ T5: title-must-not-contain-word
+ words=WIP
+ T7: title-match-regex
+ regex=None
+ T8: title-min-length
+ min-length=5
+ B1: body-max-line-length
+ line-length=80
+ B5: body-min-length
+ min-length=20
+ B6: body-is-missing
+ ignore-merge-commits=True
+ B2: body-trailing-whitespace
+ B3: body-hard-tab
+ B4: body-first-line-empty
+ B7: body-changed-file-mention
+ files=
+ B8: body-match-regex
+ regex=None
+ M1: author-valid-email
+ regex=^[^@ ]+@[^@ ]+\.[^@ ]+
+
+DEBUG: gitlint.cli No --msg-filename flag, no or empty data passed to stdin. Using the local repo.
+DEBUG: gitlint.git ('log', '-1', '--pretty=%H')
+DEBUG: gitlint.cli Linting 1 commit(s)
+DEBUG: gitlint.git ('log', '{commit_sha}', '-1', '--pretty=%aN%x00%aE%x00%ai%x00%P%n%B')
+DEBUG: gitlint.git ('config', '--get', 'core.commentchar')
+DEBUG: gitlint.lint Linting commit {commit_sha}
+DEBUG: gitlint.git ('diff-tree', '--no-commit-id', '--numstat', '-r', '--root', '{commit_sha}')
+DEBUG: gitlint.git ('branch', '--contains', '{commit_sha}')
+DEBUG: gitlint.lint Commit Object
+--- Commit Message ----
+Sïmple commit
+
+--- Meta info ---------
+Author: gitlint-test-user <gitlint@test.com>
+Date: {commit_date}
+is-merge-commit: False
+is-fixup-commit: False
+is-fixup-amend-commit: False
+is-squash-commit: False
+is-revert-commit: False
+Parents: []
+Branches: ['main']
+Changed Files: {changed_files}
+Changed Files Stats:
+ {changed_files_stats}
+-----------------------
+3: B6 Body message is missing
+DEBUG: gitlint.cli Exit Code = 1
diff --git a/qa/expected/test_gitlint/test_msg_filename_1 b/qa/expected/test_gitlint/test_msg_filename_1
new file mode 100644
index 0000000..d01b23b
--- /dev/null
+++ b/qa/expected/test_gitlint/test_msg_filename_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: msg-fïlename test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: msg-fïlename test."
+3: B6 Body message is missing
diff --git a/qa/expected/test_gitlint/test_msg_filename_no_tty_1 b/qa/expected/test_gitlint/test_msg_filename_no_tty_1
new file mode 100644
index 0000000..4785e28
--- /dev/null
+++ b/qa/expected/test_gitlint/test_msg_filename_no_tty_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: msg-fïlename NO TTY test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: msg-fïlename NO TTY test."
+3: B6 Body message is missing
diff --git a/qa/expected/test_gitlint/test_violations_1 b/qa/expected/test_gitlint/test_violations_1
new file mode 100644
index 0000000..7e55eda
--- /dev/null
+++ b/qa/expected/test_gitlint/test_violations_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: This ïs a title."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: This ïs a title."
+2: B4 Second line is not empty: "Content on the sëcond line"
diff --git a/qa/expected/test_named_rules/test_named_rule_1 b/qa/expected/test_named_rules/test_named_rule_1
new file mode 100644
index 0000000..e5a380c
--- /dev/null
+++ b/qa/expected/test_named_rules/test_named_rule_1
@@ -0,0 +1,5 @@
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: thåt dûr bår"
+1: T5 Title contains the word 'thåt' (case-insensitive): "WIP: thåt dûr bår"
+1: T5:even$more%wôrds Title contains the word 'bår' (case-insensitive): "WIP: thåt dûr bår"
+1: T5:extra-wôrds Title contains the word 'dûr' (case-insensitive): "WIP: thåt dûr bår"
+3: B5 Body message is too short (18<20): "Sïmple commit body"
diff --git a/qa/expected/test_named_rules/test_named_user_rule_1 b/qa/expected/test_named_rules/test_named_user_rule_1
new file mode 100644
index 0000000..3cd18b4
--- /dev/null
+++ b/qa/expected/test_named_rules/test_named_user_rule_1
@@ -0,0 +1,9 @@
+1: UC4 int-öption: 2
+1: UC4 str-öption: föo
+1: UC4 list-öption: ['foo', 'bar']
+1: UC4:bår int-öption: 2
+1: UC4:bår str-öption: bår
+1: UC4:bår list-öption: ['bar', 'list']
+1: UC4:föo int-öption: 3
+1: UC4:föo str-öption: föo
+1: UC4:föo list-öption: ['foo', 'bar']
diff --git a/qa/expected/test_stdin/test_stdin_file_1 b/qa/expected/test_stdin/test_stdin_file_1
new file mode 100644
index 0000000..ea7fad2
--- /dev/null
+++ b/qa/expected/test_stdin/test_stdin_file_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: STDIN ïs a file test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: STDIN ïs a file test."
+3: B6 Body message is missing
diff --git a/qa/expected/test_stdin/test_stdin_pipe_1 b/qa/expected/test_stdin/test_stdin_pipe_1
new file mode 100644
index 0000000..8714533
--- /dev/null
+++ b/qa/expected/test_stdin/test_stdin_pipe_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: Pïpe test."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Pïpe test."
+3: B6 Body message is missing
diff --git a/qa/expected/test_stdin/test_stdin_pipe_empty_1 b/qa/expected/test_stdin/test_stdin_pipe_empty_1
new file mode 100644
index 0000000..7e55eda
--- /dev/null
+++ b/qa/expected/test_stdin/test_stdin_pipe_empty_1
@@ -0,0 +1,3 @@
+1: T3 Title has trailing punctuation (.): "WIP: This ïs a title."
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: This ïs a title."
+2: B4 Second line is not empty: "Content on the sëcond line"
diff --git a/qa/expected/test_user_defined/test_user_defined_rules_examples_1 b/qa/expected/test_user_defined/test_user_defined_rules_examples_1
new file mode 100644
index 0000000..e675d7b
--- /dev/null
+++ b/qa/expected/test_user_defined/test_user_defined_rules_examples_1
@@ -0,0 +1,5 @@
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Thi$ is å title"
+1: UC2 Body does not contain a 'Signed-off-by' line
+1: UC3 Branch name 'main' does not start with one of ['feature/', 'hotfix/', 'release/']
+1: UL1 Title contains the special character '$': "WIP: Thi$ is å title"
+2: B4 Second line is not empty: "Content on the second line"
diff --git a/qa/expected/test_user_defined/test_user_defined_rules_examples_2 b/qa/expected/test_user_defined/test_user_defined_rules_examples_2
new file mode 100644
index 0000000..9b96423
--- /dev/null
+++ b/qa/expected/test_user_defined/test_user_defined_rules_examples_2
@@ -0,0 +1,4 @@
+1: UC2 Body does not contain a 'Signed-off-by' line
+1: UC3 Branch name 'main' does not start with one of ['feature/', 'hotfix/', 'release/']
+1: UL1 Title contains the special character '$'
+2: B4 Second line is not empty
diff --git a/qa/expected/test_user_defined/test_user_defined_rules_examples_with_config_1 b/qa/expected/test_user_defined/test_user_defined_rules_examples_with_config_1
new file mode 100644
index 0000000..6e0d4cd
--- /dev/null
+++ b/qa/expected/test_user_defined/test_user_defined_rules_examples_with_config_1
@@ -0,0 +1,6 @@
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Thi$ is å title"
+1: UC1 Body contains too many lines (2 > 1)
+1: UC2 Body does not contain a 'Signed-off-by' line
+1: UC3 Branch name 'main' does not start with one of ['feature/', 'hotfix/', 'release/']
+1: UL1 Title contains the special character '$': "WIP: Thi$ is å title"
+2: B4 Second line is not empty: "Content on the second line"
diff --git a/qa/expected/test_user_defined/test_user_defined_rules_extra_1 b/qa/expected/test_user_defined/test_user_defined_rules_extra_1
new file mode 100644
index 0000000..77642dc
--- /dev/null
+++ b/qa/expected/test_user_defined/test_user_defined_rules_extra_1
@@ -0,0 +1,9 @@
+1: T5 Title contains the word 'WIP' (case-insensitive): "WIP: Thi$ is å title"
+1: UC1 GitContext.current_branch: main
+1: UC1 GitContext.commentchar: #
+1: UC2 GitCommit.branches: ['main']
+1: UC2 GitCommit.custom_prop: foöbar
+1: UC4 int-öption: 2
+1: UC4 str-öption: föo
+1: UC4 list-öption: ['foo', 'bar']
+4: B2 Line has trailing whitespace: "{repo-path} "
diff --git a/qa/requirements.txt b/qa/requirements.txt
new file mode 100644
index 0000000..cf6baa5
--- /dev/null
+++ b/qa/requirements.txt
@@ -0,0 +1,4 @@
+sh==1.14.3
+pytest==7.0.1;
+arrow==1.2.3;
+gitlint # no version as you want to test the currently installed version
diff --git a/qa/samples/config/gitlintconfig b/qa/samples/config/gitlintconfig
new file mode 100644
index 0000000..a5ecb84
--- /dev/null
+++ b/qa/samples/config/gitlintconfig
@@ -0,0 +1,13 @@
+[general]
+ignore=title-trailing-punctuation,B2
+verbosity = 2
+
+[title-max-length]
+line-length=20
+
+[B1]
+# B1 = body-max-line-length
+line-length=30
+
+[title-must-not-contain-word]
+words=WIP,thåt \ No newline at end of file
diff --git a/qa/samples/config/ignore-release-commits b/qa/samples/config/ignore-release-commits
new file mode 100644
index 0000000..5807c96
--- /dev/null
+++ b/qa/samples/config/ignore-release-commits
@@ -0,0 +1,7 @@
+[ignore-by-title]
+regex=^Release(.*)
+ignore=T5,T3
+
+[ignore-by-body]
+regex=(.*)relëase(.*)
+ignore=T3,B3 \ No newline at end of file
diff --git a/qa/samples/config/named-rules b/qa/samples/config/named-rules
new file mode 100644
index 0000000..f9bbdf5
--- /dev/null
+++ b/qa/samples/config/named-rules
@@ -0,0 +1,8 @@
+[title-must-not-contain-word]
+words=WIP,thåt
+
+[title-must-not-contain-word:extra-wôrds]
+words=hûr,dûr
+
+[title-must-not-contain-word: even$more%wôrds ]
+words=fôo,bår \ No newline at end of file
diff --git a/qa/samples/config/named-user-rules b/qa/samples/config/named-user-rules
new file mode 100644
index 0000000..ed811fb
--- /dev/null
+++ b/qa/samples/config/named-user-rules
@@ -0,0 +1,15 @@
+# Ignore other user-defined rules
+[general]
+ignore=UC1,UC2,UC3,configürable:ignöred
+
+[UC4:föo]
+int-öption=3
+str-öption=föo
+
+[configürable:bår]
+str-öption=bår
+list-öption=bar,list
+
+# The following rule will be ignored
+[configürable:ignöred]
+str-öption=foöbar \ No newline at end of file
diff --git a/qa/samples/user_rules/extra/extra_rules.py b/qa/samples/user_rules/extra/extra_rules.py
new file mode 100644
index 0000000..cad531b
--- /dev/null
+++ b/qa/samples/user_rules/extra/extra_rules.py
@@ -0,0 +1,72 @@
+from gitlint.rules import CommitRule, RuleViolation, ConfigurationRule
+from gitlint.options import IntOption, StrOption, ListOption
+
+
+class GitContextRule(CommitRule):
+ """Rule that tests whether we can correctly access certain gitcontext properties"""
+
+ name = "gïtcontext"
+ id = "UC1"
+
+ def validate(self, commit):
+ violations = [
+ RuleViolation(self.id, f"GitContext.current_branch: {commit.context.current_branch}", line_nr=1),
+ RuleViolation(self.id, f"GitContext.commentchar: {commit.context.commentchar}", line_nr=1),
+ ]
+
+ return violations
+
+
+class GitCommitRule(CommitRule):
+ """Rule that tests whether we can correctly access certain commit properties"""
+
+ name = "gïtcommit"
+ id = "UC2"
+
+ def validate(self, commit):
+ violations = [
+ RuleViolation(self.id, f"GitCommit.branches: {commit.branches}", line_nr=1),
+ RuleViolation(self.id, f"GitCommit.custom_prop: {commit.custom_prop}", line_nr=1),
+ ]
+
+ return violations
+
+
+class GitlintConfigurationRule(ConfigurationRule):
+ """Rule that tests whether we can correctly access the config as well as modify the commit message"""
+
+ name = "cönfigrule"
+ id = "UC3"
+
+ def apply(self, config, commit):
+ # We add a line to the commit message body that pulls a value from config, this proves we can modify the body
+ # and read the config contents
+ commit.message.body.append(f"{config.target} ") # trailing whitespace deliberate to trigger violation
+
+ # We set a custom property that we access in CommitRule, to prove we can add extra properties to the commit
+ commit.custom_prop = "foöbar"
+
+ # We also ignore some extra rules, proving that we can modify the config
+ config.ignore.append("B4")
+
+
+class ConfigurableCommitRule(CommitRule):
+ """Rule that tests that we can add configuration to user-defined rules"""
+
+ name = "configürable"
+ id = "UC4"
+
+ options_spec = [
+ IntOption("int-öption", 2, "int-öption description"),
+ StrOption("str-öption", "föo", "int-öption description"),
+ ListOption("list-öption", ["foo", "bar"], "list-öption description"),
+ ]
+
+ def validate(self, _):
+ violations = [
+ RuleViolation(self.id, f"int-öption: {self.options[u'int-öption'].value}", line_nr=1),
+ RuleViolation(self.id, f"str-öption: {self.options[u'str-öption'].value}", line_nr=1),
+ RuleViolation(self.id, f"list-öption: {self.options[u'list-öption'].value}", line_nr=1),
+ ]
+
+ return violations
diff --git a/qa/samples/user_rules/incorrect_linerule/my_line_rule.py b/qa/samples/user_rules/incorrect_linerule/my_line_rule.py
new file mode 100644
index 0000000..33e511f
--- /dev/null
+++ b/qa/samples/user_rules/incorrect_linerule/my_line_rule.py
@@ -0,0 +1,8 @@
+from gitlint.rules import LineRule
+
+
+class MyUserLineRule(LineRule):
+ id = "UC2"
+ name = "my-line-rule"
+
+ # missing validate method, missing target attribute
diff --git a/qa/shell.py b/qa/shell.py
new file mode 100644
index 0000000..44716c0
--- /dev/null
+++ b/qa/shell.py
@@ -0,0 +1,89 @@
+# This code is mostly duplicated from the `gitlint.shell` module. We consciously duplicate this code as to not depend
+# on gitlint internals for our integration testing framework.
+
+import subprocess
+from qa.utils import USE_SH_LIB, DEFAULT_ENCODING
+
+if USE_SH_LIB:
+ from sh import git, echo, gitlint # pylint: disable=unused-import,no-name-in-module,import-error
+
+ gitlint = gitlint.bake(_unify_ttys=True, _tty_in=True) # pylint: disable=invalid-name
+
+ # import exceptions separately, this makes it a little easier to mock them out in the unit tests
+ from sh import CommandNotFound, ErrorReturnCode, RunningCommand # pylint: disable=import-error
+else:
+
+ class CommandNotFound(Exception):
+ """Exception indicating a command was not found during execution"""
+
+ pass
+
+ class RunningCommand:
+ pass
+
+ class ShResult(RunningCommand):
+ """Result wrapper class. We use this to more easily migrate from using https://amoffat.github.io/sh/ to using
+ the builtin subprocess module."""
+
+ def __init__(self, full_cmd, stdout, stderr="", exitcode=0):
+ self.full_cmd = full_cmd
+ # TODO(jorisroovers): The 'sh' library by default will merge stdout and stderr. We mimic this behavior
+ # for now until we fully remove the 'sh' library.
+ self.stdout = stdout + stderr.decode(DEFAULT_ENCODING)
+ self.stderr = stderr
+ self.exit_code = exitcode
+
+ def __str__(self):
+ return self.stdout
+
+ class ErrorReturnCode(ShResult, Exception):
+ """ShResult subclass for unexpected results (acts as an exception)."""
+
+ pass
+
+ def git(*command_parts, **kwargs):
+ return run_command("git", *command_parts, **kwargs)
+
+ def echo(*command_parts, **kwargs):
+ return run_command("echo", *command_parts, **kwargs)
+
+ def gitlint(*command_parts, **kwargs):
+ return run_command("gitlint", *command_parts, **kwargs)
+
+ def run_command(command, *args, **kwargs):
+ args = [command] + list(args)
+ result = _exec(*args, **kwargs)
+ # If we reach this point and the result has an exit_code that is larger than 0, this means that we didn't
+ # get an exception (which is the default sh behavior for non-zero exit codes) and so the user is expecting
+ # a non-zero exit code -> just return the entire result
+ if hasattr(result, "exit_code") and result.exit_code > 0:
+ return result
+ return str(result)
+
+ def _exec(*args, **kwargs):
+ pipe = subprocess.PIPE
+ popen_kwargs = {"stdout": pipe, "stderr": pipe, "shell": kwargs.get("_tty_out", False)}
+ if "_cwd" in kwargs:
+ popen_kwargs["cwd"] = kwargs["_cwd"]
+ if "_env" in kwargs:
+ popen_kwargs["env"] = kwargs["_env"]
+
+ try:
+ with subprocess.Popen(args, **popen_kwargs) as p:
+ result = p.communicate()
+ except FileNotFoundError as exc:
+ raise CommandNotFound from exc
+
+ exit_code = p.returncode
+ stdout = result[0].decode(DEFAULT_ENCODING)
+ stderr = result[1] # 'sh' does not decode the stderr bytes to unicode
+ full_cmd = "" if args is None else " ".join(args)
+
+ # If not _ok_code is specified, then only a 0 exit code is allowed
+ ok_exit_codes = kwargs.get("_ok_code", [0])
+
+ if exit_code in ok_exit_codes:
+ return ShResult(full_cmd, stdout, stderr, exit_code)
+
+ # Unexpected error code => raise ErrorReturnCode
+ raise ErrorReturnCode(full_cmd, stdout, stderr, p.returncode)
diff --git a/qa/test_commits.py b/qa/test_commits.py
new file mode 100644
index 0000000..d40c211
--- /dev/null
+++ b/qa/test_commits.py
@@ -0,0 +1,272 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+import re
+
+import arrow
+
+from qa.shell import echo, git, gitlint
+from qa.base import BaseTestCase
+
+
+class CommitsTests(BaseTestCase):
+ """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"""
+ 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
+ )
+ self.assertEqualStdout(output, "")
+
+ def test_violations(self):
+ """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)
+
+ self.create_simple_commit("Sïmple title2.\n")
+ 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],
+ )
+
+ self.assertEqual(output.exit_code, 4)
+ 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."""
+ self.create_simple_commit("Sïmple title.\n")
+ self.create_simple_commit("Sïmple title2.\n")
+ commit_sha = self.get_last_commit_hash()
+ # git revspec -> 2 dots: <exclusive sha>..<inclusive sha> -> empty range when using same start and end sha
+ refspec = f"{commit_sha}..{commit_sha}"
+
+ # Regular gitlint invocation should run without issues
+ output = gitlint("--commits", refspec, _cwd=self.tmp_git_repo, _tty_in=True)
+ self.assertEqual(output.exit_code, 0)
+ 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],
+ )
+ self.assertEqual(output.exit_code, self.GITLINT_USAGE_ERROR)
+ self.assertEqualStdout(output, f'Error: No commits in range "{refspec}"\n')
+
+ def test_lint_single_commit(self):
+ """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")
+ commit_sha = self.get_last_commit_hash()
+ 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"
+
+ # Lint using --commit <commit sha>
+ output = gitlint("--commit", commit_sha, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2])
+ self.assertEqual(output.exit_code, 2)
+ self.assertEqualStdout(output, expected)
+
+ # Lint a single commit using --commits <refspec> pointing to the single commit
+ output = gitlint("--commits", refspec, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2])
+ self.assertEqual(output.exit_code, 2)
+ self.assertEqualStdout(output, expected)
+
+ # 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"
+ 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)
+
+ # Assert that indeed --commits <refspec> is not supported when <refspec> points the the first commit
+ refspec = f"{first_commit_sha}^...{first_commit_sha}"
+ output = gitlint("--commits", refspec, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[254])
+ 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
+ """
+ # Create a commit first, before we stage changes. This ensures the repo is properly initialized.
+ self.create_simple_commit("Sïmple title.\n")
+
+ # Add some files, stage them: they should show up in the debug output as changed file
+ filename1 = self.create_file(self.tmp_git_repo)
+ git("add", filename1, _cwd=self.tmp_git_repo)
+ 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],
+ )
+
+ # Determine variable parts of expected output
+ expected_kwargs = self.get_debug_vars_last_commit()
+ 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)
+ 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
+
+ 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
+ """
+ # Create a commit first, before we stage changes. This ensures the repo is properly initialized.
+ self.create_simple_commit("Sïmple title.\n")
+
+ # Add some files, stage them: they should show up in the debug output as changed file
+ filename1 = self.create_file(self.tmp_git_repo)
+ git("add", filename1, _cwd=self.tmp_git_repo)
+ filename2 = self.create_file(self.tmp_git_repo)
+ git("add", filename2, _cwd=self.tmp_git_repo)
+
+ 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],
+ )
+
+ # Determine variable parts of expected output
+ expected_kwargs = self.get_debug_vars_last_commit()
+ 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)
+ 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 = 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'"""
+ 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)
+ self.create_simple_commit("WIP: Sïmple title\n\nSimple bödy describing the commit", git_repo=tmp_git_repo)
+ 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],
+ }
+
+ 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"""
+ # 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)
+ # Normally, this commit will give T3 (trailing-punctuation), T5 (WIP) and B5 (bod-too-short) violations
+ # 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 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],
+ }
+ self.assertEqualStdout(output, self.get_expected("test_commits/test_ignore_commits_1", expected_kwargs))
diff --git a/qa/test_config.py b/qa/test_config.py
new file mode 100644
index 0000000..1225f6a
--- /dev/null
+++ b/qa/test_config.py
@@ -0,0 +1,135 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+
+import re
+
+from qa.shell import gitlint
+from qa.base import BaseTestCase
+from qa.utils import DEFAULT_ENCODING
+
+
+class ConfigTests(BaseTestCase):
+ """Integration tests for gitlint configuration and configuration precedence."""
+
+ def test_ignore_by_id(self):
+ self.create_simple_commit("WIP: Thïs is a title.\nContënt on the second line")
+ output = gitlint("--ignore", "T5,B4", _tty_in=True, _cwd=self.tmp_git_repo, _ok_code=[1])
+ expected = '1: T3 Title has trailing punctuation (.): "WIP: Thïs is a title."\n'
+ self.assertEqualStdout(output, expected)
+
+ def test_ignore_by_name(self):
+ self.create_simple_commit("WIP: Thïs is a title.\nContënt on the second line")
+ output = gitlint(
+ "--ignore",
+ "title-must-not-contain-word,body-first-line-empty",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[1],
+ )
+ expected = '1: T3 Title has trailing punctuation (.): "WIP: Thïs is a title."\n'
+ self.assertEqualStdout(output, expected)
+
+ def test_verbosity(self):
+ self.create_simple_commit("WIP: Thïs is a title.\nContënt on the second line")
+ output = gitlint("-v", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
+
+ expected = "1: T3\n1: T5\n2: B4\n"
+ self.assertEqualStdout(output, expected)
+
+ output = gitlint("-vv", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_config/test_verbosity_1"))
+
+ output = gitlint("-vvv", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_config/test_verbosity_2"))
+
+ # test silent mode
+ output = gitlint("--silent", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
+ self.assertEqualStdout(output, "")
+
+ def test_set_rule_option(self):
+ self.create_simple_commit("This ïs a title.")
+ output = gitlint("-c", "title-max-length.line-length=5", _tty_in=True, _cwd=self.tmp_git_repo, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_config/test_set_rule_option_1"))
+
+ def test_config_from_file(self):
+ commit_msg = (
+ "WIP: Thïs is a title thåt is a bit longer.\nContent on the second line\n"
+ "This line of the body is here because we need it"
+ )
+ self.create_simple_commit(commit_msg)
+ config_path = self.get_sample_path("config/gitlintconfig")
+ output = gitlint("--config", config_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[5])
+ self.assertEqualStdout(output, self.get_expected("test_config/test_config_from_file_1"))
+
+ def test_config_from_file_debug(self):
+ # Test both on existing and new repo (we've had a bug in the past that was unique to empty repos)
+ repos = [self.tmp_git_repo, self.create_tmp_git_repo()]
+ for target_repo in repos:
+ commit_msg = (
+ "WIP: Thïs is a title thåt is a bit longer.\nContent on the second line\n"
+ "This line of the body is here because we need it"
+ )
+ filename = self.create_simple_commit(commit_msg, git_repo=target_repo)
+ config_path = self.get_sample_path("config/gitlintconfig")
+ output = gitlint("--config", config_path, "--debug", _cwd=target_repo, _tty_in=True, _ok_code=[5])
+
+ expected_kwargs = self.get_debug_vars_last_commit(git_repo=target_repo)
+ expected_kwargs.update(
+ {
+ "config_path": config_path,
+ "changed_files": [filename],
+ "changed_files_stats": f"{filename}: 0 additions, 0 deletions",
+ }
+ )
+ self.assertEqualStdout(
+ output, self.get_expected("test_config/test_config_from_file_debug_1", expected_kwargs)
+ )
+
+ def test_config_from_env(self):
+ """Test for configuring gitlint from environment variables"""
+
+ # We invoke gitlint, configuring it via env variables, we can check whether gitlint picks these up correctly
+ # by comparing the debug output with what we'd expect
+ target_repo = self.create_tmp_git_repo()
+ commit_msg = (
+ "WIP: Thïs is a title thåt is a bit longer.\nContent on the second line\n"
+ "This line of the body is here because we need it"
+ )
+ filename = self.create_simple_commit(commit_msg, git_repo=target_repo)
+ env = self.create_environment(
+ {
+ "GITLINT_DEBUG": "1",
+ "GITLINT_VERBOSITY": "2",
+ "GITLINT_IGNORE": "T1,T2",
+ "GITLINT_CONTRIB": "CC1,CT1",
+ "GITLINT_FAIL_WITHOUT_COMMITS": "1",
+ "GITLINT_IGNORE_STDIN": "1",
+ "GITLINT_TARGET": target_repo,
+ "GITLINT_COMMITS": self.get_last_commit_hash(git_repo=target_repo),
+ }
+ )
+ output = gitlint(_env=env, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[5])
+ expected_kwargs = self.get_debug_vars_last_commit(git_repo=target_repo)
+ expected_kwargs.update(
+ {"changed_files": [filename], "changed_files_stats": f"{filename}: 0 additions, 0 deletions"}
+ )
+
+ self.assertEqualStdout(output, self.get_expected("test_config/test_config_from_env_1", expected_kwargs))
+
+ # For some env variables, we need a separate test ast they are mutually exclusive with the ones tested above
+ tmp_commit_msg_file = self.create_tmpfile("WIP: msg-fïlename test.")
+ env = self.create_environment(
+ {"GITLINT_DEBUG": "1", "GITLINT_TARGET": target_repo, "GITLINT_SILENT": "1", "GITLINT_STAGED": "1"}
+ )
+
+ output = gitlint(
+ "--msg-filename", tmp_commit_msg_file, _env=env, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3]
+ )
+
+ # Extract date from actual output to insert it into the expected output
+ # We have to do this since there's no way for us to deterministically know that date otherwise
+ p = re.compile("Date: (.*)\n", re.UNICODE | re.MULTILINE)
+ result = p.search(output.stdout.decode(DEFAULT_ENCODING))
+ date = result.group(1).strip()
+ expected_kwargs.update({"date": date})
+
+ self.assertEqualStdout(output, self.get_expected("test_config/test_config_from_env_2", expected_kwargs))
diff --git a/qa/test_contrib.py b/qa/test_contrib.py
new file mode 100644
index 0000000..129e576
--- /dev/null
+++ b/qa/test_contrib.py
@@ -0,0 +1,32 @@
+# pylint: disable=
+from qa.shell import gitlint
+from qa.base import BaseTestCase
+
+
+class ContribRuleTests(BaseTestCase):
+ """Integration tests for contrib rules."""
+
+ def test_contrib_rules(self):
+ self.create_simple_commit("WIP Thi$ is å title\n\nMy bödy that is a bit longer than 20 chars")
+ output = gitlint(
+ "--contrib", "contrib-title-conventional-commits,CC1", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3]
+ )
+ self.assertEqualStdout(output, self.get_expected("test_contrib/test_contrib_rules_1"))
+
+ def test_contrib_rules_with_config(self):
+ self.create_simple_commit("WIP Thi$ is å title\n\nMy bödy that is a bit longer than 20 chars")
+ output = gitlint(
+ "--contrib",
+ "contrib-title-conventional-commits,CC1",
+ "-c",
+ "contrib-title-conventional-commits.types=föo,bår",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[3],
+ )
+ self.assertEqualStdout(output, self.get_expected("test_contrib/test_contrib_rules_with_config_1"))
+
+ def test_invalid_contrib_rules(self):
+ self.create_simple_commit("WIP: test")
+ output = gitlint("--contrib", "föobar,CC1", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[255])
+ self.assertEqualStdout(output, "Config Error: No contrib rule with id or name 'föobar' found.\n")
diff --git a/qa/test_gitlint.py b/qa/test_gitlint.py
new file mode 100644
index 0000000..6c45196
--- /dev/null
+++ b/qa/test_gitlint.py
@@ -0,0 +1,267 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+import os
+from qa.shell import echo, git, gitlint
+from qa.base import BaseTestCase
+from qa.utils import DEFAULT_ENCODING
+
+
+class IntegrationTests(BaseTestCase):
+ """Simple set of integration tests for gitlint"""
+
+ def test_successful(self):
+ # Test for STDIN with and without a TTY attached
+ self.create_simple_commit("Sïmple title\n\nSimple bödy describing the commit")
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _err_to_out=True)
+ self.assertEqualStdout(output, "")
+
+ def test_successful_gitconfig(self):
+ """Test gitlint when the underlying repo has specific git config set.
+ In the past, we've had issues with gitlint failing on some of these, so this acts as a regression test."""
+
+ # Different commentchar (Note: tried setting this to a special unicode char, but git doesn't like that)
+ git("config", "--add", "core.commentchar", "$", _cwd=self.tmp_git_repo)
+ self.create_simple_commit("Sïmple title\n\nSimple bödy describing the commit\n$after commentchar\t ignored")
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _err_to_out=True)
+ self.assertEqualStdout(output, "")
+
+ def test_successful_merge_commit(self):
+ # Create branch on main
+ self.create_simple_commit("Cömmit on main\n\nSimple bödy")
+
+ # Create test branch, add a commit and determine the commit hash
+ git("checkout", "-b", "test-branch", _cwd=self.tmp_git_repo)
+ git("checkout", "test-branch", _cwd=self.tmp_git_repo)
+ commit_title = "Commit on test-brånch with a pretty long title that will cause issues when merging"
+ self.create_simple_commit(f"{commit_title}\n\nSïmple body")
+ hash = self.get_last_commit_hash()
+
+ # Checkout main and merge the commit
+ # We explicitly set the title of the merge commit to the title of the previous commit as this or similar
+ # behavior is what many tools do that handle merges (like github, gerrit, etc).
+ git("checkout", "main", _cwd=self.tmp_git_repo)
+ git("merge", "--no-ff", "-m", f"Merge '{commit_title}'", hash, _cwd=self.tmp_git_repo)
+
+ # Run gitlint and assert output is empty
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True)
+ self.assertEqualStdout(output, "")
+
+ # Assert that we do see the error if we disable the ignore-merge-commits option
+ output = gitlint("-c", "general.ignore-merge-commits=false", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1])
+ self.assertEqual(output.exit_code, 1)
+ self.assertEqualStdout(output, f"1: T1 Title exceeds max length (90>72): \"Merge '{commit_title}'\"\n")
+
+ def test_fixup_commit(self):
+ # Create a normal commit and assert that it has a violation
+ test_filename = self.create_simple_commit("Cömmit on WIP main\n\nSimple bödy that is long enough")
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1])
+ expected = "1: T5 Title contains the word 'WIP' (case-insensitive): \"Cömmit on WIP main\"\n"
+ self.assertEqualStdout(output, expected)
+
+ # Make a small modification to the commit and commit it using fixup commit
+ with open(os.path.join(self.tmp_git_repo, test_filename), "a", encoding=DEFAULT_ENCODING) as fh:
+ fh.write("Appending söme stuff\n")
+
+ git("add", test_filename, _cwd=self.tmp_git_repo)
+
+ git("commit", "--fixup", self.get_last_commit_hash(), _cwd=self.tmp_git_repo)
+
+ # Assert that gitlint does not show an error for the fixup commit
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True)
+ # No need to check exit code, the command above throws an exception on > 0 exit codes
+ self.assertEqualStdout(output, "")
+
+ # Make sure that if we set the ignore-fixup-commits option to false that we do still see the violations
+ output = gitlint("-c", "general.ignore-fixup-commits=false", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2])
+ expected = (
+ "1: T5 Title contains the word 'WIP' (case-insensitive): \"fixup! Cömmit on WIP main\"\n"
+ "3: B6 Body message is missing\n"
+ )
+
+ self.assertEqualStdout(output, expected)
+
+ def test_fixup_amend_commit(self):
+ # Create a normal commit and assert that it has a violation
+ test_filename = self.create_simple_commit("Cömmit on WIP main\n\nSimple bödy that is long enough")
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1])
+ expected = "1: T5 Title contains the word 'WIP' (case-insensitive): \"Cömmit on WIP main\"\n"
+ self.assertEqualStdout(output, expected)
+
+ # Make a small modification to the commit and commit it using fixup=amend commit
+ with open(os.path.join(self.tmp_git_repo, test_filename), "a", encoding=DEFAULT_ENCODING) as fh:
+ fh.write("Appending söme stuff\n")
+
+ git("add", test_filename, _cwd=self.tmp_git_repo)
+
+ # We have to use --no-edit to avoid git starting $EDITOR to modify the commit message that is being amended
+ git("commit", "--no-edit", f"--fixup=amend:{self.get_last_commit_hash()}", _cwd=self.tmp_git_repo)
+
+ # Assert that gitlint does not show an error for the fixup commit
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True)
+ # No need to check exit code, the command above throws an exception on > 0 exit codes
+ self.assertEqualStdout(output, "")
+
+ # Make sure that if we set the ignore-fixup-commits option to false that we do still see the violations
+ output = gitlint(
+ "-c", "general.ignore-fixup-amend-commits=false", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1]
+ )
+ expected = "1: T5 Title contains the word 'WIP' (case-insensitive): \"amend! Cömmit on WIP main\"\n"
+
+ self.assertEqualStdout(output, expected)
+
+ def test_revert_commit(self):
+ self.create_simple_commit("WIP: Cömmit on main.\n\nSimple bödy")
+ hash = self.get_last_commit_hash()
+ git("revert", hash, _cwd=self.tmp_git_repo)
+
+ # Run gitlint and assert output is empty
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True)
+ self.assertEqualStdout(output, "")
+
+ # Assert that we do see the error if we disable the ignore-revert-commits option
+ output = gitlint(
+ "-c", "general.ignore-revert-commits=false", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1]
+ )
+ self.assertEqual(output.exit_code, 1)
+ expected = '1: T5 Title contains the word \'WIP\' (case-insensitive): "Revert "WIP: Cömmit on main.""\n'
+ self.assertEqualStdout(output, expected)
+
+ def test_squash_commit(self):
+ # Create a normal commit and assert that it has a violation
+ test_filename = self.create_simple_commit("Cömmit on WIP main\n\nSimple bödy that is long enough")
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[1])
+ expected = "1: T5 Title contains the word 'WIP' (case-insensitive): \"Cömmit on WIP main\"\n"
+ self.assertEqualStdout(output, expected)
+
+ # Make a small modification to the commit and commit it using squash commit
+ with open(os.path.join(self.tmp_git_repo, test_filename), "a", encoding=DEFAULT_ENCODING) as fh:
+ # Wanted to write a unicode string, but that's obnoxious if you want to do it across Python 2 and 3.
+ # https://stackoverflow.com/questions/22392377/
+ # error-writing-a-file-with-file-write-in-python-unicodeencodeerror
+ # So just keeping it simple - ASCII will here
+ fh.write("Appending some stuff\n")
+
+ git("add", test_filename, _cwd=self.tmp_git_repo)
+
+ git("commit", "--squash", self.get_last_commit_hash(), "-m", "Töo short body", _cwd=self.tmp_git_repo)
+
+ # Assert that gitlint does not show an error for the fixup commit
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True)
+ # No need to check exit code, the command above throws an exception on > 0 exit codes
+ self.assertEqualStdout(output, "")
+
+ # Make sure that if we set the ignore-squash-commits option to false that we do still see the violations
+ output = gitlint(
+ "-c", "general.ignore-squash-commits=false", _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[2]
+ )
+ expected = (
+ "1: T5 Title contains the word 'WIP' (case-insensitive): \"squash! Cömmit on WIP main\"\n"
+ '3: B5 Body message is too short (14<20): "Töo short body"\n'
+ )
+
+ self.assertEqualStdout(output, expected)
+
+ def test_violations(self):
+ commit_msg = "WIP: This ïs a title.\nContent on the sëcond line"
+ self.create_simple_commit(commit_msg)
+ output = gitlint(_cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_gitlint/test_violations_1"))
+
+ def test_msg_filename(self):
+ tmp_commit_msg_file = self.create_tmpfile("WIP: msg-fïlename test.")
+ output = gitlint("--msg-filename", tmp_commit_msg_file, _tty_in=True, _cwd=self.tmp_git_repo, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_gitlint/test_msg_filename_1"))
+
+ def test_msg_filename_no_tty(self):
+ """Make sure --msg-filename option also works with no TTY attached"""
+ tmp_commit_msg_file = self.create_tmpfile("WIP: msg-fïlename NO TTY test.")
+
+ # We need to set _err_to_out explicitly for sh to merge stdout and stderr output in case there's
+ # no TTY attached to STDIN
+ # http://amoffat.github.io/sh/sections/special_arguments.html?highlight=_tty_in#err-to-out
+ # We need to pass some whitespace to _in as sh will otherwise hang, see
+ # https://github.com/amoffat/sh/issues/427
+ output = gitlint(
+ "--msg-filename",
+ tmp_commit_msg_file,
+ _cwd=self.tmp_git_repo,
+ _in=" ",
+ _tty_in=False,
+ _err_to_out=True,
+ _ok_code=[3],
+ )
+
+ self.assertEqualStdout(output, self.get_expected("test_gitlint/test_msg_filename_no_tty_1"))
+
+ def test_no_git_name_set(self):
+ """Ensure we print out a helpful message if user.name is not set"""
+ tmp_commit_msg_file = self.create_tmpfile("WIP: msg-fïlename NO name test.")
+ # Name is checked before email so this isn't strictly
+ # necessary but seems good for consistency.
+ env = self.create_tmp_git_config("[user]\n email = test-emåil@foo.com\n")
+ output = gitlint(
+ "--staged",
+ "--msg-filename",
+ tmp_commit_msg_file,
+ _ok_code=[self.GIT_CONTEXT_ERROR_CODE],
+ _env=env,
+ _cwd=self.tmp_git_repo,
+ )
+ expected = "Missing git configuration: please set user.name\n"
+ self.assertEqualStdout(output, expected)
+
+ def test_no_git_email_set(self):
+ """Ensure we print out a helpful message if user.email is not set"""
+ tmp_commit_msg_file = self.create_tmpfile("WIP: msg-fïlename NO email test.")
+ env = self.create_tmp_git_config("[user]\n name = test åuthor\n")
+ output = gitlint(
+ "--staged",
+ "--msg-filename",
+ tmp_commit_msg_file,
+ _ok_code=[self.GIT_CONTEXT_ERROR_CODE],
+ _env=env,
+ _cwd=self.tmp_git_repo,
+ )
+ expected = "Missing git configuration: please set user.email\n"
+ self.assertEqualStdout(output, expected)
+
+ def test_git_empty_repo(self):
+ # Repo has no commits: caused by `git log`
+ empty_git_repo = self.create_tmp_git_repo()
+ output = gitlint(_cwd=empty_git_repo, _tty_in=True, _ok_code=[self.GIT_CONTEXT_ERROR_CODE])
+
+ expected = "Current branch has no commits. Gitlint requires at least one commit to function.\n"
+ self.assertEqualStdout(output, expected)
+
+ def test_git_empty_repo_staged(self):
+ """When repo is empty, we can still use gitlint when using --staged flag and piping a message into it"""
+ empty_git_repo = self.create_tmp_git_repo()
+ expected = (
+ '1: T3 Title has trailing punctuation (.): "WIP: Pïpe test."\n'
+ "1: T5 Title contains the word 'WIP' (case-insensitive): \"WIP: Pïpe test.\"\n"
+ "3: B6 Body message is missing\n"
+ )
+
+ output = gitlint(
+ echo("WIP: Pïpe test."), "--staged", _cwd=empty_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3]
+ )
+ self.assertEqualStdout(output, expected)
+
+ def test_commit_binary_file(self):
+ """When committing a binary file, git shows somewhat different output in diff commands,
+ this test ensures gitlint deals with that correctly"""
+ binary_filename = self.create_simple_commit("Sïmple commit", file_contents=bytes([0x48, 0x00, 0x49, 0x00]))
+ output = gitlint(
+ "--debug",
+ _ok_code=1,
+ _cwd=self.tmp_git_repo,
+ )
+
+ expected_kwargs = self.get_debug_vars_last_commit()
+ expected_kwargs.update(
+ {
+ "changed_files": [binary_filename],
+ "changed_files_stats": (f"{binary_filename}: None additions, None deletions"),
+ }
+ )
+ expected = self.get_expected("test_gitlint/test_commit_binary_file_1", expected_kwargs)
+ self.assertEqualStdout(output, expected)
diff --git a/qa/test_hooks.py b/qa/test_hooks.py
new file mode 100644
index 0000000..19edeb2
--- /dev/null
+++ b/qa/test_hooks.py
@@ -0,0 +1,180 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+import os
+from qa.shell import git, gitlint
+from qa.base import BaseTestCase
+
+
+class HookTests(BaseTestCase):
+ """Integration tests for gitlint commitmsg hooks"""
+
+ VIOLATIONS = [
+ "gitlint: checking commit message...\n",
+ '1: T3 Title has trailing punctuation (.): "WIP: This ïs a title."\n',
+ "1: T5 Title contains the word 'WIP' (case-insensitive): \"WIP: This ïs a title.\"\n",
+ '2: B4 Second line is not empty: "Contënt on the second line"\n',
+ "3: B6 Body message is missing\n",
+ "-----------------------------------------------\n",
+ "gitlint: \x1b[31mYour commit message contains violations.\x1b[0m\n",
+ ]
+
+ def setUp(self):
+ super().setUp()
+ self.responses = []
+ self.response_index = 0
+ self.githook_output = []
+
+ # The '--staged' flag used in the commit-msg hook fetches additional information from the underlying
+ # git repo which means there already needs to be a commit in the repo
+ # (as gitlint --staged doesn't work against empty repos)
+ self.create_simple_commit("Commït Title\n\nCommit Body explaining commit.")
+
+ # install git commit-msg hook and assert output
+ output_installed = gitlint("install-hook", _cwd=self.tmp_git_repo)
+ expected_installed = (
+ f"Successfully installed gitlint commit-msg hook in {self.tmp_git_repo}/.git/hooks/commit-msg\n"
+ )
+
+ self.assertEqualStdout(output_installed, expected_installed)
+
+ def tearDown(self):
+ # uninstall git commit-msg hook and assert output
+ output_uninstalled = gitlint("uninstall-hook", _cwd=self.tmp_git_repo)
+ expected_uninstalled = (
+ f"Successfully uninstalled gitlint commit-msg hook from {self.tmp_git_repo}/.git/hooks/commit-msg\n"
+ )
+
+ self.assertEqualStdout(output_uninstalled, expected_uninstalled)
+ super().tearDown()
+
+ def _violations(self):
+ # Make a copy of the violations array so that we don't inadvertently edit it in the test (like I did :D)
+ return list(self.VIOLATIONS)
+
+ # callback function that captures git commit-msg hook output
+
+ def _interact(self, line, stdin):
+ self.githook_output.append(line)
+ # Answer 'yes' to question to keep violating commit-msg
+ if "Your commit message contains violations" in line:
+ response = self.responses[self.response_index]
+ stdin.put(f"{response}\n")
+ self.response_index = (self.response_index + 1) % len(self.responses)
+
+ def test_commit_hook_no_violations(self):
+ test_filename = self.create_simple_commit(
+ "This ïs a title\n\nBody contënt that should work", out=self._interact, tty_in=True
+ )
+
+ short_hash = self.get_last_commit_short_hash()
+ expected_output = [
+ "gitlint: checking commit message...\n",
+ "gitlint: \x1b[32mOK\x1b[0m (no violations in commit message)\n",
+ f"[main {short_hash}] This ïs a title\n",
+ " 1 file changed, 0 insertions(+), 0 deletions(-)\n",
+ f" create mode 100644 {test_filename}\n",
+ ]
+ for output, expected in zip(self.githook_output, expected_output):
+ self.assertMultiLineEqual(output.replace("\r", ""), expected.replace("\r", ""))
+
+ def test_commit_hook_continue(self):
+ self.responses = ["y"]
+ test_filename = self.create_simple_commit(
+ "WIP: This ïs a title.\nContënt on the second line", out=self._interact, tty_in=True
+ )
+
+ # Determine short commit-msg hash, needed to determine expected output
+ short_hash = self.get_last_commit_short_hash()
+
+ expected_output = self._violations()
+ expected_output += [
+ "Continue with commit anyways (this keeps the current commit message)? "
+ "[y(es)/n(no)/e(dit)] "
+ f"[main {short_hash}] WIP: This ïs a title. Contënt on the second line\n",
+ " 1 file changed, 0 insertions(+), 0 deletions(-)\n",
+ f" create mode 100644 {test_filename}\n",
+ ]
+
+ for output, expected in zip(self.githook_output, expected_output):
+ self.assertMultiLineEqual(output.replace("\r", ""), expected.replace("\r", ""))
+
+ def test_commit_hook_abort(self):
+ self.responses = ["n"]
+ test_filename = self.create_simple_commit(
+ "WIP: This ïs a title.\nContënt on the second line", out=self._interact, ok_code=1, tty_in=True
+ )
+ git("rm", "-f", test_filename, _cwd=self.tmp_git_repo)
+
+ # Determine short commit-msg hash, needed to determine expected output
+
+ expected_output = self._violations()
+ expected_output += [
+ "Continue with commit anyways (this keeps the current commit message)? "
+ "[y(es)/n(no)/e(dit)] "
+ "Commit aborted.\n",
+ "Your commit message: \n",
+ "-----------------------------------------------\n",
+ "WIP: This ïs a title.\n",
+ "Contënt on the second line\n",
+ "-----------------------------------------------\n",
+ ]
+
+ for output, expected in zip(self.githook_output, expected_output):
+ self.assertMultiLineEqual(output.replace("\r", ""), expected.replace("\r", ""))
+
+ def test_commit_hook_edit(self):
+ self.responses = ["e", "y"]
+ env = {"EDITOR": ":"}
+ test_filename = self.create_simple_commit(
+ "WIP: This ïs a title.\nContënt on the second line", out=self._interact, env=env, tty_in=True
+ )
+ git("rm", "-f", test_filename, _cwd=self.tmp_git_repo)
+
+ short_hash = git("rev-parse", "--short", "HEAD", _cwd=self.tmp_git_repo, _tty_in=True).replace("\n", "")
+
+ # Determine short commit-msg hash, needed to determine expected output
+
+ expected_output = self._violations()
+ expected_output += [
+ "Continue with commit anyways (this keeps the current commit message)? [y(es)/n(no)/e(dit)] "
+ + self._violations()[0]
+ ]
+ expected_output += self._violations()[1:]
+ expected_output += [
+ "Continue with commit anyways (this keeps the current commit message)? [y(es)/n(no)/e(dit)] "
+ f"[main {short_hash}] WIP: This ïs a title. Contënt on the second line\n",
+ " 1 file changed, 0 insertions(+), 0 deletions(-)\n",
+ f" create mode 100644 {test_filename}\n",
+ ]
+
+ for output, expected in zip(self.githook_output, expected_output):
+ self.assertMultiLineEqual(output.replace("\r", ""), expected.replace("\r", ""))
+
+ def test_commit_hook_worktree(self):
+ """Tests that hook installation and un-installation also work in git worktrees.
+ Test steps:
+ ```sh
+ git init <tmpdir>
+ cd <tmpdir>
+ git worktree add <worktree-tempdir>
+ cd <worktree-tempdir>
+ gitlint install-hook
+ gitlint uninstall-hook
+ ```
+ """
+ tmp_git_repo = self.create_tmp_git_repo()
+ self.create_simple_commit("Simple title\n\nContënt in the body", git_repo=tmp_git_repo)
+
+ worktree_dir = self.generate_temp_path()
+ self.tmp_git_repos.append(worktree_dir) # make sure we clean up the worktree afterwards
+
+ git("worktree", "add", worktree_dir, _cwd=tmp_git_repo, _tty_in=True)
+
+ output_installed = gitlint("install-hook", _cwd=worktree_dir)
+ expected_hook_path = os.path.join(tmp_git_repo, ".git", "hooks", "commit-msg")
+ expected_msg = f"Successfully installed gitlint commit-msg hook in {expected_hook_path}\r\n"
+ self.assertEqual(output_installed, expected_msg)
+
+ output_uninstalled = gitlint("uninstall-hook", _cwd=worktree_dir)
+ expected_hook_path = os.path.join(tmp_git_repo, ".git", "hooks", "commit-msg")
+ expected_msg = f"Successfully uninstalled gitlint commit-msg hook from {expected_hook_path}\r\n"
+ self.assertEqual(output_uninstalled, expected_msg)
diff --git a/qa/test_named_rules.py b/qa/test_named_rules.py
new file mode 100644
index 0000000..75cd9a1
--- /dev/null
+++ b/qa/test_named_rules.py
@@ -0,0 +1,23 @@
+from qa.shell import gitlint
+from qa.base import BaseTestCase
+
+
+class NamedRuleTests(BaseTestCase):
+ """Integration tests for named rules."""
+
+ def test_named_rule(self):
+ commit_msg = "WIP: thåt dûr bår\n\nSïmple commit body"
+ self.create_simple_commit(commit_msg)
+ config_path = self.get_sample_path("config/named-rules")
+ output = gitlint("--config", config_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[5])
+ self.assertEqualStdout(output, self.get_expected("test_named_rules/test_named_rule_1"))
+
+ def test_named_user_rule(self):
+ commit_msg = "Normal cömmit title\n\nSïmple commit message body"
+ self.create_simple_commit(commit_msg)
+ config_path = self.get_sample_path("config/named-user-rules")
+ extra_path = self.get_sample_path("user_rules/extra")
+ output = gitlint(
+ "--extra-path", extra_path, "--config", config_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[9]
+ )
+ self.assertEqualStdout(output, self.get_expected("test_named_rules/test_named_user_rule_1"))
diff --git a/qa/test_stdin.py b/qa/test_stdin.py
new file mode 100644
index 0000000..8ed4cb1
--- /dev/null
+++ b/qa/test_stdin.py
@@ -0,0 +1,53 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+import subprocess
+from qa.shell import echo, gitlint
+from qa.base import BaseTestCase
+from qa.utils import DEFAULT_ENCODING
+
+
+class StdInTests(BaseTestCase):
+ """Integration tests for various STDIN scenarios for gitlint"""
+
+ def test_stdin_pipe(self):
+ """Test piping input into gitlint.
+ This is the equivalent of doing:
+ $ echo "foo" | gitlint
+ """
+ # NOTE: There is no use in testing this with _tty_in=True, because if you pipe something into a command
+ # there never is a TTY connected to stdin (per definition). We're setting _tty_in=False here to be explicit
+ # but note that this is always true when piping something into a command.
+ output = gitlint(echo("WIP: Pïpe test."), _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
+ self.assertEqualStdout(output, self.get_expected("test_stdin/test_stdin_pipe_1"))
+
+ def test_stdin_pipe_empty(self):
+ """Test the scenario where no TTY is attached and nothing is piped into gitlint. This occurs in
+ CI runners like Jenkins and Gitlab, see https://github.com/jorisroovers/gitlint/issues/42 for details.
+ This is the equivalent of doing:
+ $ echo -n "" | gitlint
+ """
+ commit_msg = "WIP: This ïs a title.\nContent on the sëcond line"
+ self.create_simple_commit(commit_msg)
+
+ # We need to set _err_to_out explicitly for sh to merge stdout and stderr output in case there's
+ # no TTY attached to STDIN
+ # http://amoffat.github.io/sh/sections/special_arguments.html?highlight=_tty_in#err-to-out
+ output = gitlint(echo("-n", ""), _cwd=self.tmp_git_repo, _tty_in=False, _err_to_out=True, _ok_code=[3])
+
+ self.assertEqual(output, self.get_expected("test_stdin/test_stdin_pipe_empty_1"))
+
+ def test_stdin_file(self):
+ """Test the scenario where STDIN is a regular file (stat.S_ISREG = True)
+ This is the equivalent of doing:
+ $ gitlint < myfile
+ """
+ tmp_commit_msg_file = self.create_tmpfile("WIP: STDIN ïs a file test.")
+
+ with open(tmp_commit_msg_file, encoding=DEFAULT_ENCODING) as file_handle:
+ # We need to use subprocess.Popen() here instead of sh because when passing a file_handle to sh, it will
+ # deal with reading the file itself instead of passing it on to gitlint as a STDIN. Since we're trying to
+ # test for the condition where stat.S_ISREG == True that won't work for us here.
+ with subprocess.Popen(
+ "gitlint", stdin=file_handle, cwd=self.tmp_git_repo, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+ ) as p:
+ output, _ = p.communicate()
+ self.assertEqual(output.decode(DEFAULT_ENCODING), self.get_expected("test_stdin/test_stdin_file_1"))
diff --git a/qa/test_user_defined.py b/qa/test_user_defined.py
new file mode 100644
index 0000000..a003f3e
--- /dev/null
+++ b/qa/test_user_defined.py
@@ -0,0 +1,58 @@
+# pylint: disable=too-many-function-args,unexpected-keyword-arg
+from qa.shell import gitlint
+from qa.base import BaseTestCase
+
+
+class UserDefinedRuleTests(BaseTestCase):
+ """Integration tests for user-defined rules."""
+
+ def test_user_defined_rules_examples1(self):
+ """Test the user defined rules in the top-level `examples/` directory"""
+ extra_path = self.get_example_path()
+ commit_msg = "WIP: Thi$ is å title\nContent on the second line"
+ self.create_simple_commit(commit_msg)
+ output = gitlint("--extra-path", extra_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[5])
+ self.assertEqualStdout(output, self.get_expected("test_user_defined/test_user_defined_rules_examples_1"))
+
+ def test_user_defined_rules_examples2(self):
+ """Test the user defined rules in the top-level `examples/` directory"""
+ extra_path = self.get_example_path()
+ commit_msg = "Release: Thi$ is å title\nContent on the second line\n$This line is ignored \nThis isn't\t\n"
+ self.create_simple_commit(commit_msg)
+ output = gitlint("--extra-path", extra_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[4])
+ self.assertEqualStdout(output, self.get_expected("test_user_defined/test_user_defined_rules_examples_2"))
+
+ def test_user_defined_rules_examples_with_config(self):
+ """Test the user defined rules in the top-level `examples/` directory"""
+ extra_path = self.get_example_path()
+ commit_msg = "WIP: Thi$ is å title\nContent on the second line"
+ self.create_simple_commit(commit_msg)
+ output = gitlint(
+ "--extra-path",
+ extra_path,
+ "-c",
+ "body-max-line-count.max-line-count=1",
+ _cwd=self.tmp_git_repo,
+ _tty_in=True,
+ _ok_code=[6],
+ )
+ expected_path = "test_user_defined/test_user_defined_rules_examples_with_config_1"
+ self.assertEqualStdout(output, self.get_expected(expected_path))
+
+ def test_user_defined_rules_extra(self):
+ extra_path = self.get_sample_path("user_rules/extra")
+ commit_msg = "WIP: Thi$ is å title\nContent on the second line"
+ self.create_simple_commit(commit_msg)
+ output = gitlint("--extra-path", extra_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[9])
+ self.assertEqualStdout(
+ output,
+ self.get_expected("test_user_defined/test_user_defined_rules_extra_1", {"repo-path": self.tmp_git_repo}),
+ )
+
+ def test_invalid_user_defined_rules(self):
+ extra_path = self.get_sample_path("user_rules/incorrect_linerule")
+ self.create_simple_commit("WIP: test")
+ output = gitlint("--extra-path", extra_path, _cwd=self.tmp_git_repo, _tty_in=True, _ok_code=[255])
+ self.assertEqualStdout(
+ output, "Config Error: User-defined rule class 'MyUserLineRule' must have a 'validate' method\n"
+ )
diff --git a/qa/utils.py b/qa/utils.py
new file mode 100644
index 0000000..89292cd
--- /dev/null
+++ b/qa/utils.py
@@ -0,0 +1,62 @@
+# pylint: disable=bad-option-value,unidiomatic-typecheck,undefined-variable,no-else-return
+import platform
+import os
+
+import locale
+
+########################################################################################################################
+# PLATFORM_IS_WINDOWS
+
+
+def platform_is_windows():
+ return "windows" in platform.system().lower()
+
+
+PLATFORM_IS_WINDOWS = platform_is_windows()
+
+########################################################################################################################
+# USE_SH_LIB
+# Determine whether to use the `sh` library
+# On windows we won't want to use the sh library since it's not supported - instead we'll use our own shell module.
+# However, we want to be able to overwrite this behavior for testing using the GITLINT_QA_USE_SH_LIB env var.
+
+
+def use_sh_library():
+ gitlint_use_sh_lib_env = os.environ.get("GITLINT_QA_USE_SH_LIB", None)
+ if gitlint_use_sh_lib_env:
+ return gitlint_use_sh_lib_env == "1"
+ return not PLATFORM_IS_WINDOWS
+
+
+USE_SH_LIB = use_sh_library()
+
+########################################################################################################################
+# DEFAULT_ENCODING
+
+
+def getpreferredencoding():
+ """Modified version of local.getpreferredencoding() that takes into account LC_ALL, LC_CTYPE, LANG env vars
+ on windows and falls back to UTF-8."""
+ default_encoding = locale.getpreferredencoding() or "UTF-8"
+
+ # On Windows, we mimic git/linux by trying to read the LC_ALL, LC_CTYPE, LANG env vars manually
+ # (on Linux/MacOS the `getpreferredencoding()` call will take care of this).
+ # We fallback to UTF-8
+ if PLATFORM_IS_WINDOWS:
+ default_encoding = "UTF-8"
+ for env_var in ["LC_ALL", "LC_CTYPE", "LANG"]:
+ encoding = os.environ.get(env_var, False)
+ if encoding:
+ # Support dotted (C.UTF-8) and non-dotted (C or UTF-8) charsets:
+ # If encoding contains a dot: split and use second part, otherwise use everything
+ dot_index = encoding.find(".")
+ if dot_index != -1:
+ default_encoding = encoding[dot_index + 1 :]
+ else:
+ default_encoding = encoding
+ break
+
+ return default_encoding
+
+
+DEFAULT_ENCODING = getpreferredencoding()