feat(init): allow user to select which type of pre commit hooks to install

See more: https://commitizen-tools.github.io/commitizen/#integrating-with-pre-commit

Author: Bogay

commitizen/commands/init.py

@@ -1,6 +1,6 @@
 import os
 import shutil
-from typing import Any, Dict
+from typing import Any, Dict, List, Optional
 
 import questionary
 import yaml
@@ -42,8 +42,15 @@ def __call__(self):
         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():
-            if not self._install_pre_commit_hook():
+        hook_types = questionary.checkbox(
+            "What types of pre-commit hook you want to install? (Leave blank if you don't want to install)",
+            choices=[
+                questionary.Choice("commit-msg", checked=True),
+                questionary.Choice("pre-push", checked=True),
+            ],
+        ).ask()
+        if hook_types:
+            if not self._install_pre_commit_hook(hook_types):
                 raise InitFailedError(
                     "Installation failed. See error outputs for more information."
                 )
@@ -116,8 +123,12 @@ def _ask_tag_format(self, latest_tag) -> str:
     def _search_pre_commit(self):
         return shutil.which("pre-commit") is not None
 
-    def _exec_install_pre_commit_hook(self):
-        cmd_str = "pre-commit install --hook-type commit-msg"
+    def _exec_install_pre_commit_hook(self, hook_types: List[str]):
+        if not hook_types:
+            raise ValueError("At least 1 hook type should be provided.")
+        cmd_str = "pre-commit install " + "".join(
+            f"--hook-type {ty}" for ty in hook_types
+        )
         c = cmd.run(cmd_str)
         if c.return_code != 0:
             out.error(f"Error running {cmd_str}. Outputs are attached below:")
@@ -126,12 +137,15 @@ def _exec_install_pre_commit_hook(self):
             return False
         return True
 
-    def _install_pre_commit_hook(self) -> bool:
+    def _install_pre_commit_hook(self, hook_types: Optional[List[str]] = None) -> bool:
         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"}],
+            "hooks": [
+                {"id": "commitizen"},
+                {"id": "commitizen-branch", "stages": ["push"]},
+            ],
         }
 
         config_data = {}
@@ -162,7 +176,9 @@ def _install_pre_commit_hook(self) -> bool:
             out.error("pre-commit is not installed in current environement.")
             return False
 
-        if not self._exec_install_pre_commit_hook():
+        if hook_types is None:
+            hook_types = ["commit-msg", "pre-push"]
+        if not self._exec_install_pre_commit_hook(hook_types):
             return False
 
         out.write("commitizen pre-commit hook is now installed in your '.git'\n")

tests/commands/test_init_command.py

@@ -1,5 +1,6 @@
 import json
 import os
+from typing import Any, Dict, List
 
 import pytest
 import yaml
@@ -22,7 +23,10 @@ def ask(self):
 cz_hook_config = {
     "repo": "https://github.com/commitizen-tools/commitizen",
     "rev": f"v{__version__}",
-    "hooks": [{"id": "commitizen"}],
+    "hooks": [
+        {"id": "commitizen"},
+        {"id": "commitizen-branch", "stages": ["push"]},
+    ],
 }
 
 expected_config = (
@@ -51,7 +55,8 @@ def test_init_without_setup_pre_commit_hook(tmpdir, mocker: MockFixture, config)
     )
     mocker.patch("questionary.confirm", return_value=FakeQuestion(True))
     mocker.patch("questionary.text", return_value=FakeQuestion("$version"))
-    mocker.patch("questionary.confirm", return_value=FakeQuestion(False))
+    # Return None to skip hook installation
+    mocker.patch("questionary.checkbox", return_value=FakeQuestion(None))
 
     with tmpdir.as_cwd():
         commands.Init(config)()
@@ -118,51 +123,55 @@ def default_choice(request, mocker: MockFixture):
     )
     mocker.patch("questionary.confirm", return_value=FakeQuestion(True))
     mocker.patch("questionary.text", return_value=FakeQuestion("$version"))
+    mocker.patch(
+        "questionary.checkbox",
+        return_value=FakeQuestion(["commit-msg", "pre-push"]),
+    )
     yield request.param
 
 
+def check_cz_config(config: str):
+    """
+    Cehck the content of commitizen config is as expected
+
+    Args:
+        config: The config path
+    """
+    with open(config, "r") as file:
+        if "json" in config:
+            assert json.load(file) == EXPECTED_DICT_CONFIG
+        elif "yaml" in config:
+            assert yaml.load(file, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG
+        else:
+            config_data = file.read()
+            assert config_data == expected_config
+
+
+def check_pre_commit_config(expected: List[Dict[str, Any]]):
+    """
+    Check the content of pre-commit config is as expected
+    """
+    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": expected}
+
+
 @pytest.mark.usefixtures("pre_commit_installed")
 class TestPreCommitCases:
     def test_no_existing_pre_commit_conifg(_, default_choice, tmpdir, config):
         with tmpdir.as_cwd():
             commands.Init(config)()
-
-            with open(default_choice, "r") as file:
-                if "json" in default_choice:
-                    assert json.load(file) == EXPECTED_DICT_CONFIG
-                elif "yaml" in default_choice:
-                    assert (
-                        yaml.load(file, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG
-                    )
-                else:
-                    config_data = 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]}
+            check_cz_config(default_choice)
+            check_pre_commit_config([cz_hook_config])
 
     def test_empty_pre_commit_config(_, default_choice, tmpdir, config):
         with tmpdir.as_cwd():
             p = tmpdir.join(pre_commit_config_filename)
             p.write("")
 
             commands.Init(config)()
-
-            with open(default_choice, "r") as file:
-                if "json" in default_choice:
-                    assert json.load(file) == EXPECTED_DICT_CONFIG
-                elif "yaml" in default_choice:
-                    assert (
-                        yaml.load(file, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG
-                    )
-                else:
-                    config_data = 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]}
+            check_cz_config(default_choice)
+            check_pre_commit_config([cz_hook_config])
 
     def test_pre_commit_config_without_cz_hook(_, default_choice, tmpdir, config):
         existing_hook_config = {
@@ -176,47 +185,18 @@ def test_pre_commit_config_without_cz_hook(_, default_choice, tmpdir, config):
             p.write(yaml.safe_dump({"repos": [existing_hook_config]}))
 
             commands.Init(config)()
-
-            with open(default_choice, "r") as file:
-                if "json" in default_choice:
-                    assert json.load(file) == EXPECTED_DICT_CONFIG
-                elif "yaml" in default_choice:
-                    assert (
-                        yaml.load(file, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG
-                    )
-                else:
-                    config_data = 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]
-            }
+            check_cz_config(default_choice)
+            check_pre_commit_config([existing_hook_config, cz_hook_config])
 
     def test_cz_hook_exists_in_pre_commit_config(_, default_choice, 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(default_choice, "r") as file:
-                if "json" in default_choice:
-                    assert json.load(file) == EXPECTED_DICT_CONFIG
-                elif "yaml" in default_choice:
-                    assert (
-                        yaml.load(file, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG
-                    )
-                else:
-                    config_data = 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_cz_config(default_choice)
             # check that config is not duplicated
-            assert pre_commit_config_data == {"repos": [cz_hook_config]}
+            check_pre_commit_config([cz_hook_config])
 
 
 class TestNoPreCommitInstalled: