feat(init): enable setting up pre-commit hook through "cz init"

Author: Lee-W

commitizen/commands/init.py

@@ -1,7 +1,11 @@
+import os
+
 import questionary
+import yaml
 from packaging.version import Version
 
-from commitizen import factory, out
+from commitizen import cmd, factory, out
+from commitizen.__version__ import __version__
 from commitizen.config import BaseConfig, TomlConfig
 from commitizen.cz import registry
 from commitizen.defaults import config_files
@@ -20,7 +24,6 @@ def __call__(self):
         # No config for commitizen exist
         if not self.config.path:
             config_path = self._ask_config_path()
-
             if "toml" in config_path:
                 self.config = TomlConfig(data="", path=config_path)
 
@@ -31,6 +34,10 @@ def __call__(self):
             values_to_add["version"] = Version(tag).public
             values_to_add["tag_format"] = self._ask_tag_format(tag)
             self._update_config_file(values_to_add)
+
+            if questionary.confirm("Do you want to install pre-commit hook?").ask():
+                self._install_pre_commit_hook()
+
             out.write("You can bump the version and create changelog running:\n")
             out.info("cz bump --changelog")
             out.success("The configuration are all set.")
@@ -98,6 +105,50 @@ def _ask_tag_format(self, latest_tag) -> str:
                 tag_format = "$version"
         return tag_format
 
+    def _install_pre_commit_hook(self):
+        pre_commit_config_filename = ".pre-commit-config.yaml"
+        cz_hook_config = {
+            "repo": "https://github.com/commitizen-tools/commitizen",
+            "rev": f"v{__version__}",
+            "hooks": [{"id": "commitizen", "stages": ["commit-msg"]}],
+        }
+
+        config_data = {}
+        if not os.path.isfile(pre_commit_config_filename):
+            # .pre-commit-config does not exist
+            config_data["repos"] = [cz_hook_config]
+        else:
+            # breakpoint()
+            with open(pre_commit_config_filename) as config_file:
+                yaml_data = yaml.safe_load(config_file)
+                if yaml_data:
+                    config_data = yaml_data
+
+            if "repos" in config_data:
+                for pre_commit_hook in config_data["repos"]:
+                    if "commitizen" in pre_commit_hook["repo"]:
+                        out.write("commitizen already in pre-commit config")
+                        break
+                else:
+                    config_data["repos"].append(cz_hook_config)
+            else:
+                # .pre-commit-config exists but there's no "repos" key
+                config_data["repos"] = [cz_hook_config]
+
+        with open(pre_commit_config_filename, "w") as config_file:
+            yaml.safe_dump(config_data, stream=config_file)
+
+        c = cmd.run("pre-commit install --hook-type commit-msg")
+        if c.return_code == 127:
+            out.error(
+                "pre-commit is not installed in current environement.\n"
+                "Run 'pre-commit install --hook-type commit-msg' again after it's installed"
+            )
+        elif c.return_code != 0:
+            out.error(c.err)
+        else:
+            out.write("commitizen pre-commit hook is now installed in your '.git'\n")
+
     def _update_config_file(self, values):
         for key, value in values.items():
             self.config.set_key(key, value)

tests/commands/test_init_command.py

@@ -1,6 +1,10 @@
+import os
+
 import pytest
+import yaml
 
 from commitizen import commands
+from commitizen.__version__ import __version__
 from commitizen.exceptions import NoAnswersError
 
 
@@ -12,31 +16,42 @@ def ask(self):
         return self.expected_return
 
 
-def test_init(tmpdir, mocker, config):
+pre_commit_config_filename = ".pre-commit-config.yaml"
+cz_hook_config = {
+    "repo": "https://github.com/commitizen-tools/commitizen",
+    "rev": f"v{__version__}",
+    "hooks": [{"id": "commitizen", "stages": ["commit-msg"]}],
+}
+
+expected_config = (
+    "[tool.commitizen]\n"
+    'name = "cz_conventional_commits"\n'
+    'version = "0.0.1"\n'
+    'tag_format = "$version"\n'
+)
+
+
+def test_init_without_setup_pre_commit_hook(tmpdir, mocker, config):
     mocker.patch(
         "questionary.select",
         side_effect=[
             FakeQuestion("pyproject.toml"),
             FakeQuestion("cz_conventional_commits"),
         ],
     )
-    mocker.patch("questionary.confirm", return_value=FakeQuestion("y"))
-    mocker.patch("questionary.text", return_value=FakeQuestion("y"))
-    expected_config = (
-        "[tool.commitizen]\n"
-        'name = "cz_conventional_commits"\n'
-        'version = "0.0.1"\n'
-        'tag_format = "y"\n'
-    )
+    mocker.patch("questionary.confirm", return_value=FakeQuestion(True))
+    mocker.patch("questionary.text", return_value=FakeQuestion("$version"))
+    mocker.patch("questionary.confirm", return_value=FakeQuestion(False))
 
     with tmpdir.as_cwd():
         commands.Init(config)()
 
         with open("pyproject.toml", "r") as toml_file:
             config_data = toml_file.read()
-
         assert config_data == expected_config
 
+        assert not os.path.isfile(pre_commit_config_filename)
+
 
 def test_init_when_config_already_exists(config, capsys):
     # Set config path
@@ -67,3 +82,85 @@ def test_init_without_choosing_tag(config, mocker, tmpdir):
     with tmpdir.as_cwd():
         with pytest.raises(NoAnswersError):
             commands.Init(config)()
+
+
+class TestPreCommitCases:
+    @pytest.fixture(scope="function", autouse=True)
+    def default_choices(_, mocker):
+        mocker.patch(
+            "questionary.select",
+            side_effect=[
+                FakeQuestion("pyproject.toml"),
+                FakeQuestion("cz_conventional_commits"),
+            ],
+        )
+        mocker.patch("questionary.confirm", return_value=FakeQuestion(True))
+        mocker.patch("questionary.text", return_value=FakeQuestion("$version"))
+        mocker.patch("questionary.confirm", return_value=FakeQuestion(True))
+
+    def test_no_existing_pre_commit_conifg(_, tmpdir, config):
+        with tmpdir.as_cwd():
+            commands.Init(config)()
+
+            with open("pyproject.toml", "r") as toml_file:
+                config_data = toml_file.read()
+            assert config_data == expected_config
+
+            with open(pre_commit_config_filename, "r") as pre_commit_file:
+                pre_commit_config_data = yaml.safe_load(pre_commit_file.read())
+            assert pre_commit_config_data == {"repos": [cz_hook_config]}
+
+    def test_empty_pre_commit_config(_, tmpdir, config):
+        with tmpdir.as_cwd():
+            p = tmpdir.join(pre_commit_config_filename)
+            p.write("")
+
+            commands.Init(config)()
+
+            with open("pyproject.toml", "r") as toml_file:
+                config_data = toml_file.read()
+            assert config_data == expected_config
+
+            with open(pre_commit_config_filename, "r") as pre_commit_file:
+                pre_commit_config_data = yaml.safe_load(pre_commit_file.read())
+            assert pre_commit_config_data == {"repos": [cz_hook_config]}
+
+    def test_pre_commit_config_without_cz_hook(_, tmpdir, config):
+        existing_hook_config = {
+            "repo": "https://github.com/pre-commit/pre-commit-hooks",
+            "rev": "v1.2.3",
+            "hooks": [{"id", "trailing-whitespace"}],
+        }
+
+        with tmpdir.as_cwd():
+            p = tmpdir.join(pre_commit_config_filename)
+            p.write(yaml.safe_dump({"repos": [existing_hook_config]}))
+
+            commands.Init(config)()
+
+            with open("pyproject.toml", "r") as toml_file:
+                config_data = toml_file.read()
+            assert config_data == expected_config
+
+            with open(pre_commit_config_filename, "r") as pre_commit_file:
+                pre_commit_config_data = yaml.safe_load(pre_commit_file.read())
+            assert pre_commit_config_data == {
+                "repos": [existing_hook_config, cz_hook_config]
+            }
+
+    def test_cz_hook_exists_in_pre_commit_config(_, tmpdir, config):
+        with tmpdir.as_cwd():
+            p = tmpdir.join(pre_commit_config_filename)
+            p.write(yaml.safe_dump({"repos": [cz_hook_config]}))
+
+            commands.Init(config)()
+
+            with open("pyproject.toml", "r") as toml_file:
+                config_data = toml_file.read()
+            assert config_data == expected_config
+
+            with open(pre_commit_config_filename, "r") as pre_commit_file:
+                pre_commit_config_data = yaml.safe_load(pre_commit_file.read())
+
+            # check that config is not duplicated
+            assert pre_commit_config_data == {"repos": [cz_hook_config]}

tests/test_git.py

@@ -1,13 +1,7 @@
 import pytest
 
 from commitizen import git
-from tests.utils import create_file_and_commit
-
-
-class FakeCommand:
-    def __init__(self, out=None, err=None):
-        self.out = out
-        self.err = err
+from tests.utils import FakeCommand, create_file_and_commit
 
 
 def test_git_object_eq():

tests/utils.py

@@ -5,6 +5,13 @@
 from commitizen import cmd, git
 
 
+class FakeCommand:
+    def __init__(self, out=None, err=None, return_code=0):
+        self.out = out
+        self.err = err
+        self.return_code = return_code
+
+
 def create_file_and_commit(message: str, filename: Optional[str] = None):
     if not filename:
         filename = str(uuid.uuid4())