Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions commitizen/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ def _try_decode(bytes_: bytes) -> str:


def run(cmd: str, env: Mapping[str, str] | None = None) -> Command:
"""Run a command in a subprocess and capture stdout and stderr

Args:
cmd: The command to run
env: Extra environment variables to define in the subprocess. Defaults to None.

Returns:
Command: _description_
"""
if env is not None:
env = {**os.environ, **env}
process = subprocess.Popen(
Expand All @@ -55,3 +64,18 @@ def run(cmd: str, env: Mapping[str, str] | None = None) -> Command:
stderr,
return_code,
)


def run_interactive(cmd: str, env: Mapping[str, str] | None = None) -> int:
"""Run a command in a subprocess 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
9 changes: 2 additions & 7 deletions commitizen/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(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")


Expand Down
8 changes: 4 additions & 4 deletions tests/test_bump_hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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", cmd_run_mock)
cmd_run_mock.return_value = 0
mocker.patch.object(cmd, "run_interactive", cmd_run_mock)

hooks.run(bump_hooks)

Expand All @@ -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", 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)
Expand Down
Loading