test: remove unreachable code in pytest.raises block, fix some malformed tests

Author: bearomorphism

tests/commands/test_check_command.py

@@ -149,18 +149,12 @@ def test_check_conventional_commit_succeeds(
         ),
     ),
 )
-def test_check_no_conventional_commit(commit_msg, config, mocker: MockFixture, tmpdir):
-    with pytest.raises(InvalidCommitMessageError):
-        error_mock = mocker.patch("commitizen.out.error")
-
-        tempfile = tmpdir.join("temp_commit_file")
-        tempfile.write(commit_msg)
+def test_check_no_conventional_commit(commit_msg, config, tmpdir):
+    tempfile = tmpdir.join("temp_commit_file")
+    tempfile.write(commit_msg)
 
-        check_cmd = commands.Check(
-            config=config, arguments={"commit_msg_file": tempfile}
-        )
-        check_cmd()
-        error_mock.assert_called_once()
+    with pytest.raises(InvalidCommitMessageError):
+        commands.Check(config=config, arguments={"commit_msg_file": tempfile})()
 
 
 @pytest.mark.parametrize(
@@ -204,18 +198,14 @@ def test_check_a_range_of_git_commits(config, mocker: MockFixture):
 
 
 def test_check_a_range_of_git_commits_and_failed(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
     mocker.patch(
         "commitizen.git.get_commits",
         return_value=_build_fake_git_commits(["This commit does not follow rule"]),
     )
-    check_cmd = commands.Check(
-        config=config, arguments={"rev_range": "HEAD~10..master"}
-    )
 
-    with pytest.raises(InvalidCommitMessageError):
-        check_cmd()
-        error_mock.assert_called_once()
+    with pytest.raises(InvalidCommitMessageError) as excinfo:
+        commands.Check(config=config, arguments={"rev_range": "HEAD~10..master"})()
+    assert "This commit does not follow rule" in str(excinfo.value)
 
 
 def test_check_command_with_invalid_argument(config):
@@ -271,86 +261,54 @@ def test_check_command_with_valid_message(config, mocker: MockFixture):
     success_mock.assert_called_once()
 
 
-def test_check_command_with_invalid_message(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
-    check_cmd = commands.Check(config=config, arguments={"message": "bad commit"})
-
-    with pytest.raises(InvalidCommitMessageError):
-        check_cmd()
-        error_mock.assert_called_once()
-
-
-def test_check_command_with_empty_message(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
-    check_cmd = commands.Check(config=config, arguments={"message": ""})
-
+@pytest.mark.parametrize("message", ["bad commit", ""])
+def test_check_command_with_invalid_message(config, message):
     with pytest.raises(InvalidCommitMessageError):
-        check_cmd()
-        error_mock.assert_called_once()
+        commands.Check(config=config, arguments={"message": message})()
 
 
 def test_check_command_with_allow_abort_arg(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
-    check_cmd = commands.Check(
-        config=config, arguments={"message": "", "allow_abort": True}
-    )
-
-    check_cmd()
+    commands.Check(config=config, arguments={"message": "", "allow_abort": True})()
     success_mock.assert_called_once()
 
 
 def test_check_command_with_allow_abort_config(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
     config.settings["allow_abort"] = True
-    check_cmd = commands.Check(config=config, arguments={"message": ""})
-
-    check_cmd()
+    commands.Check(config=config, arguments={"message": ""})()
     success_mock.assert_called_once()
 
 
-def test_check_command_override_allow_abort_config(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
+def test_check_command_override_allow_abort_config(config):
     config.settings["allow_abort"] = True
-    check_cmd = commands.Check(
-        config=config, arguments={"message": "", "allow_abort": False}
-    )
-
     with pytest.raises(InvalidCommitMessageError):
-        check_cmd()
-        error_mock.assert_called_once()
+        commands.Check(config=config, arguments={"message": "", "allow_abort": False})()
 
 
 def test_check_command_with_allowed_prefixes_arg(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
-    check_cmd = commands.Check(
+    commands.Check(
         config=config,
         arguments={"message": "custom! test", "allowed_prefixes": ["custom!"]},
-    )
-
-    check_cmd()
+    )()
     success_mock.assert_called_once()
 
 
 def test_check_command_with_allowed_prefixes_config(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
     config.settings["allowed_prefixes"] = ["custom!"]
-    check_cmd = commands.Check(config=config, arguments={"message": "custom! test"})
-
-    check_cmd()
+    commands.Check(config=config, arguments={"message": "custom! test"})()
     success_mock.assert_called_once()
 
 
-def test_check_command_override_allowed_prefixes_config(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
+def test_check_command_override_allowed_prefixes_config(config):
     config.settings["allow_abort"] = ["fixup!"]
-    check_cmd = commands.Check(
-        config=config,
-        arguments={"message": "fixup! test", "allowed_prefixes": ["custom!"]},
-    )
-
     with pytest.raises(InvalidCommitMessageError):
-        check_cmd()
-        error_mock.assert_called_once()
+        commands.Check(
+            config=config,
+            arguments={"message": "fixup! test", "allowed_prefixes": ["custom!"]},
+        )()
 
 
 def test_check_command_with_pipe_message(
@@ -427,33 +385,25 @@ def test_check_conventional_commit_succeed_with_git_diff(
 def test_check_command_with_message_length_limit(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
     message = "fix(scope): some commit message"
-    check_cmd = commands.Check(
+    commands.Check(
         config=config,
         arguments={"message": message, "message_length_limit": len(message) + 1},
-    )
-
-    check_cmd()
+    )()
     success_mock.assert_called_once()
 
 
-def test_check_command_with_message_length_limit_exceeded(config, mocker: MockFixture):
-    error_mock = mocker.patch("commitizen.out.error")
+def test_check_command_with_message_length_limit_exceeded(config):
     message = "fix(scope): some commit message"
-    check_cmd = commands.Check(
-        config=config,
-        arguments={"message": message, "message_length_limit": len(message) - 1},
-    )
-
     with pytest.raises(CommitMessageLengthExceededError):
-        check_cmd()
-        error_mock.assert_called_once()
+        commands.Check(
+            config=config,
+            arguments={"message": message, "message_length_limit": len(message) - 1},
+        )()
 
 
 def test_check_command_with_amend_prefix_default(config, mocker: MockFixture):
     success_mock = mocker.patch("commitizen.out.success")
-    check_cmd = commands.Check(config=config, arguments={"message": "amend! test"})
-
-    check_cmd()
+    commands.Check(config=config, arguments={"message": "amend! test"})()
     success_mock.assert_called_once()
 
 
@@ -463,54 +413,42 @@ def test_check_command_with_config_message_length_limit(config, mocker: MockFixt
 
     config.settings["message_length_limit"] = len(message) + 1
 
-    check_cmd = commands.Check(
+    commands.Check(
         config=config,
         arguments={"message": message},
-    )
+    )()
 
-    check_cmd()
     success_mock.assert_called_once()
 
 
-def test_check_command_with_config_message_length_limit_exceeded(
-    config, mocker: MockFixture
-):
-    error_mock = mocker.patch("commitizen.out.error")
+def test_check_command_with_config_message_length_limit_exceeded(config):
     message = "fix(scope): some commit message"
 
     config.settings["message_length_limit"] = len(message) - 1
 
-    check_cmd = commands.Check(
-        config=config,
-        arguments={"message": message},
-    )
-
     with pytest.raises(CommitMessageLengthExceededError):
-        check_cmd()
-        error_mock.assert_called_once()
+        commands.Check(
+            config=config,
+            arguments={"message": message},
+        )()
 
 
 def test_check_command_cli_overrides_config_message_length_limit(
     config, mocker: MockFixture
 ):
-    success_mock = mocker.patch("commitizen.out.success")
     message = "fix(scope): some commit message"
-
     config.settings["message_length_limit"] = len(message) - 1
 
-    check_cmd = commands.Check(
-        config=config,
-        arguments={"message": message, "message_length_limit": len(message) + 1},
-    )
-
-    check_cmd()
-    success_mock.assert_called_once()
-
-    success_mock.reset_mock()
-    check_cmd = commands.Check(
-        config=config,
-        arguments={"message": message, "message_length_limit": None},
-    )
+    for message_length_limit in [len(message) + 1, None]:
+        success_mock = mocker.patch("commitizen.out.success")
+        commands.Check(
+            config=config,
+            arguments={
+                "message": message,
+                "message_length_limit": message_length_limit,
+            },
+        )()
+        success_mock.assert_called_once()
 
 
 class ValidationCz(BaseCommitizen):

tests/commands/test_commit_command.py

@@ -69,9 +69,9 @@ def test_commit_backup_on_failure(config, mocker: MockFixture):
     commit_mock.return_value = cmd.Command("", "error", b"", b"", 9)
     error_mock = mocker.patch("commitizen.out.error")
 
+    commit_cmd = commands.Commit(config, {})
+    temp_file = commit_cmd.backup_file_path
     with pytest.raises(CommitError):
-        commit_cmd = commands.Commit(config, {})
-        temp_file = commit_cmd.backup_file_path
         commit_cmd()
 
     prompt_mock.assert_called_once()
@@ -191,8 +191,7 @@ def test_commit_command_with_dry_run_option(config, mocker: MockFixture):
     }
 
     with pytest.raises(DryRunExit):
-        commit_cmd = commands.Commit(config, {"dry_run": True})
-        commit_cmd()
+        commands.Commit(config, {"dry_run": True})()
 
 
 @pytest.mark.usefixtures("staging_is_clean")
@@ -236,8 +235,7 @@ def test_commit_command_with_invalid_write_message_to_file_option(
     }
 
     with pytest.raises(NotAllowed):
-        commit_cmd = commands.Commit(config, {"write_message_to_file": tmp_path})
-        commit_cmd()
+        commands.Commit(config, {"write_message_to_file": tmp_path})()
 
 
 @pytest.mark.usefixtures("staging_is_clean")
@@ -316,8 +314,7 @@ def test_commit_when_nothing_to_commit(config, mocker: MockFixture):
     is_staging_clean_mock.return_value = True
 
     with pytest.raises(NothingToCommitError) as excinfo:
-        commit_cmd = commands.Commit(config, {})
-        commit_cmd()
+        commands.Commit(config, {})()
 
     assert "No files added to staging!" in str(excinfo.value)
 
@@ -379,8 +376,7 @@ def test_commit_when_customized_expected_raised(config, mocker: MockFixture, cap
     prompt_mock.side_effect = _err
 
     with pytest.raises(CustomError) as excinfo:
-        commit_cmd = commands.Commit(config, {})
-        commit_cmd()
+        commands.Commit(config, {})()
 
     # Assert only the content in the formatted text
     assert "This is the root custom err" in str(excinfo.value)
@@ -395,8 +391,7 @@ def test_commit_when_non_customized_expected_raised(
     prompt_mock.side_effect = _err
 
     with pytest.raises(ValueError):
-        commit_cmd = commands.Commit(config, {})
-        commit_cmd()
+        commands.Commit(config, {})()
 
 
 @pytest.mark.usefixtures("staging_is_clean")
@@ -405,8 +400,7 @@ def test_commit_when_no_user_answer(config, mocker: MockFixture, capsys):
     prompt_mock.return_value = None
 
     with pytest.raises(NoAnswersError):
-        commit_cmd = commands.Commit(config, {})
-        commit_cmd()
+        commands.Commit(config, {})()
 
 
 def test_commit_in_non_git_project(tmpdir, config):

tests/test_cz_customize.py

@@ -376,8 +376,8 @@ def config_with_unicode(request):
 
 
 def test_initialize_cz_customize_failed():
+    config = BaseConfig()
     with pytest.raises(MissingCzCustomizeConfigError) as excinfo:
-        config = BaseConfig()
         _ = CustomizeCommitsCz(config)
 
     assert MissingCzCustomizeConfigError.message in str(excinfo.value)