feat(hooks): support interactive hooks scripts

Author: PhilipNelson5

commitizen/cmd.py

@@ -103,3 +103,43 @@ def run_shell(cmd: str, env: Mapping[str, str] | None = None) -> Command:
     https://github.com/commitizen-tools/commitizen/issues/1918
     """
     return _popen(cmd, shell=True, env=env)
+
+
+def run_interactive(
+    cmd: str | Sequence[str], env: Mapping[str, str] | None = None
+) -> int:
+    """Run a command safely without shell interpretation and without redirecting stdin, stdout, or stderr
+
+    Args:
+        cmd: The command to run
+        env: Extra environment variables to define in the subprocess. Defaults to None.
+
+    Returns:
+        subprocess returncode
+    """
+    if env is not None:
+        env = {**os.environ, **env}
+    if isinstance(cmd, str):
+        warnings.warn(
+            "Passing a string to cmd.run_interactive() is deprecated and will be removed in v5. "
+            "Use a list of arguments instead, or use cmd.run_interactive_shell() explicitly.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return subprocess.run(cmd, shell=True, env=env).returncode
+    return subprocess.run(cmd, shell=False, env=env).returncode
+
+
+def run_interactive_shell(cmd: str, env: Mapping[str, str] | None = None) -> int:
+    """Run a command without redirecting stdin, stdout, or stderr
+
+    Args:
+        cmd: The command to run
+        env: Extra environment variables to define in the subprocess. Defaults to None.
+
+    Returns:
+        subprocess returncode
+    """
+    if env is not None:
+        env = {**os.environ, **env}
+    return subprocess.run(cmd, shell=True, env=env).returncode

commitizen/hooks.py

@@ -17,14 +17,9 @@ def run(hooks: str | list[str], _env_prefix: str = "CZ_", **env: object) -> None
     for hook in hooks:
         out.info(f"Running hook '{hook}'")
 
-        c = cmd.run_shell(hook, env=_format_env(_env_prefix, env))
+        return_code = cmd.run_interactive(hook, env=_format_env(_env_prefix, env))
 
-        if c.out:
-            out.write(c.out)
-        if c.err:
-            out.error(c.err)
-
-        if c.return_code != 0:
+        if return_code != 0:
             raise RunHookError(f"Running hook '{hook}' failed")
 
 

tests/test_bump_hooks.py

@@ -12,8 +12,8 @@ def test_run(mocker: MockFixture):
     bump_hooks = ["pre_bump_hook", "pre_bump_hook_1"]
 
     cmd_run_mock = mocker.Mock()
-    cmd_run_mock.return_value.return_code = 0
-    mocker.patch.object(cmd, "run_shell", cmd_run_mock)
+    cmd_run_mock.return_value = 0
+    mocker.patch.object(cmd, "run_interactive", cmd_run_mock)
 
     hooks.run(bump_hooks)
 
@@ -29,8 +29,8 @@ def test_run_error(mocker: MockFixture):
     bump_hooks = ["pre_bump_hook", "pre_bump_hook_1"]
 
     cmd_run_mock = mocker.Mock()
-    cmd_run_mock.return_value.return_code = 1
-    mocker.patch.object(cmd, "run_shell", cmd_run_mock)
+    cmd_run_mock.return_value = 1
+    mocker.patch.object(cmd, "run_interactive", cmd_run_mock)
 
     with pytest.raises(RunHookError):
         hooks.run(bump_hooks)