test: use match in pytest.raises

Author: bearomorphism

tests/commands/test_bump_command.py

@@ -314,9 +314,8 @@ def test_bump_tag_exists_raises_exception(util: UtilFixture):
     util.create_file_and_commit("feat: new file")
     git.tag("0.2.0")
 
-    with pytest.raises(BumpTagFailedError) as excinfo:
+    with pytest.raises(BumpTagFailedError, match=re.escape("0.2.0")):
         util.run_cli("bump", "--yes")
-    assert "0.2.0" in str(excinfo.value)  # This should be a fatal error
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
@@ -338,18 +337,17 @@ def test_bump_when_bumping_is_not_support(util: UtilFixture):
         "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported"
     )
 
-    with pytest.raises(NoPatternMapError) as excinfo:
+    with pytest.raises(NoPatternMapError, match="'cz_jira' rule does not support bump"):
         util.run_cli("-n", "cz_jira", "bump", "--yes")
-    assert "'cz_jira' rule does not support bump" in str(excinfo.value)
 
 
 @pytest.mark.usefixtures("tmp_git_project")
 def test_bump_when_version_is_not_specify(util: UtilFixture):
-    with pytest.raises(NoVersionSpecifiedError) as excinfo:
+    with pytest.raises(
+        NoVersionSpecifiedError, match=re.escape(NoVersionSpecifiedError.message)
+    ):
         util.run_cli("bump")
 
-    assert NoVersionSpecifiedError.message in str(excinfo.value)
-
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_when_no_new_commit(util: UtilFixture):
@@ -360,11 +358,11 @@ def test_bump_when_no_new_commit(util: UtilFixture):
     util.run_cli("bump", "--yes")
 
     # bump without a new commit.
-    with pytest.raises(NoCommitsFoundError) as excinfo:
+    with pytest.raises(
+        NoCommitsFoundError, match=r"\[NO_COMMITS_FOUND\]\nNo new commits found\."
+    ):
         util.run_cli("bump", "--yes")
 
-    assert "[NO_COMMITS_FOUND]\nNo new commits found." in str(excinfo.value)
-
 
 def test_bump_when_version_inconsistent_in_version_files(
     tmp_commitizen_project, util: UtilFixture
@@ -378,11 +376,12 @@ def test_bump_when_version_inconsistent_in_version_files(
 
     util.create_file_and_commit("feat: new file")
 
-    with pytest.raises(CurrentVersionNotFoundError) as excinfo:
+    with pytest.raises(
+        CurrentVersionNotFoundError,
+        match=re.escape("Current version 0.1.0 is not found in"),
+    ):
         util.run_cli("bump", "--yes", "--check-consistency")
 
-    assert "Current version 0.1.0 is not found in" in str(excinfo.value)
-
 
 def test_bump_major_version_zero_when_major_is_not_zero(
     tmp_commitizen_project, util: UtilFixture
@@ -403,13 +402,14 @@ def test_bump_major_version_zero_when_major_is_not_zero(
     util.create_tag("v1.0.0")
     util.create_file_and_commit("feat(user)!: new file")
 
-    with pytest.raises(NotAllowed) as excinfo:
+    with pytest.raises(
+        NotAllowed,
+        match=re.escape(
+            "--major-version-zero is meaningless for current version 1.0.0"
+        ),
+    ):
         util.run_cli("bump", "--yes", "--major-version-zero")
 
-    assert "--major-version-zero is meaningless for current version 1.0.0" in str(
-        excinfo.value
-    )
-
 
 def test_bump_files_only(tmp_commitizen_project, util: UtilFixture):
     tmp_version_file = tmp_commitizen_project / "__version__.py"
@@ -539,13 +539,14 @@ def test_prevent_prerelease_when_no_increment_detected(
 
     util.create_file_and_commit("test: new file")
 
-    with pytest.raises(NoCommitsFoundError) as excinfo:
+    with pytest.raises(
+        NoCommitsFoundError,
+        match=re.escape(
+            "[NO_COMMITS_FOUND]\nNo commits found to generate a pre-release."
+        ),
+    ):
         util.run_cli("bump", "-pr", "beta")
 
-    assert "[NO_COMMITS_FOUND]\nNo commits found to generate a pre-release." in str(
-        excinfo.value
-    )
-
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_with_changelog_to_stdout_arg(
@@ -735,14 +736,14 @@ def test_bump_invalid_manual_version_raises_exception(
 ):
     util.create_file_and_commit("feat: new file")
 
-    with pytest.raises(InvalidManualVersion) as excinfo:
+    with pytest.raises(
+        InvalidManualVersion,
+        match=re.escape(
+            f"[INVALID_MANUAL_VERSION]\nInvalid manual version: '{manual_version}'"
+        ),
+    ):
         util.run_cli("bump", "--yes", manual_version)
 
-    assert (
-        f"[INVALID_MANUAL_VERSION]\nInvalid manual version: '{manual_version}'"
-        in str(excinfo.value)
-    )
-
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 @pytest.mark.parametrize(
@@ -770,13 +771,12 @@ def test_bump_manual_version(util: UtilFixture, manual_version):
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_bump_manual_version_disallows_major_version_zero(util: UtilFixture):
     util.create_file_and_commit("feat: new file")
-    with pytest.raises(NotAllowed) as excinfo:
+    with pytest.raises(
+        NotAllowed,
+        match="--major-version-zero cannot be combined with MANUAL_VERSION",
+    ):
         util.run_cli("bump", "--yes", "--major-version-zero", "0.2.0")
 
-    assert "--major-version-zero cannot be combined with MANUAL_VERSION" in str(
-        excinfo.value
-    )
-
 
 @pytest.mark.parametrize(
     ("initial_version", "expected_version_after_bump"),

tests/commands/test_changelog_command.py

@@ -861,11 +861,9 @@ def test_changelog_from_rev_range_not_found(
     util.create_file_and_commit("feat: new file")
     util.create_tag("1.0.0")
 
-    with pytest.raises(NoCommitsFoundError) as excinfo:
+    with pytest.raises(NoCommitsFoundError, match="Could not find a valid revision"):
         util.run_cli("changelog", rev_range)  # it shouldn't exist
 
-    assert "Could not find a valid revision" in str(excinfo)
-
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_multiple_matching_tags(

tests/commands/test_check_command.py

@@ -73,9 +73,8 @@ def test_check_jira_fails(mocker: MockFixture, util: UtilFixture):
     mock_path.return_value.read_text.return_value = (
         "random message for J-2 #fake_command blah"
     )
-    with pytest.raises(InvalidCommitMessageError) as excinfo:
+    with pytest.raises(InvalidCommitMessageError, match="commit validation: failed!"):
         util.run_cli("-n", "cz_jira", "check", "--commit-msg-file", "some_file")
-    assert "commit validation: failed!" in str(excinfo.value)
 
 
 @pytest.mark.parametrize(
@@ -167,30 +166,31 @@ def test_check_a_range_of_git_commits_and_failed(config, mocker: MockFixture):
         return_value=_build_fake_git_commits(["This commit does not follow rule"]),
     )
 
-    with pytest.raises(InvalidCommitMessageError) as excinfo:
+    with pytest.raises(
+        InvalidCommitMessageError, match="This commit does not follow rule"
+    ):
         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):
-    with pytest.raises(InvalidCommandArgumentError) as excinfo:
+    with pytest.raises(
+        InvalidCommandArgumentError,
+        match="Only one of --rev-range, --message, and --commit-msg-file is permitted by check command!",
+    ):
         commands.Check(
             config=config,
             arguments={"commit_msg_file": "some_file", "rev_range": "HEAD~10..master"},
         )
-    assert (
-        "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command!"
-        in str(excinfo.value)
-    )
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_check_command_with_empty_range(config: BaseConfig, util: UtilFixture):
     # must initialize git with a commit
     util.create_file_and_commit("feat: initial")
-    with pytest.raises(NoCommitsFoundError) as excinfo:
+    with pytest.raises(
+        NoCommitsFoundError, match="No commit found with range: 'master..master'"
+    ):
         commands.Check(config=config, arguments={"rev_range": "master..master"})()
-    assert "No commit found with range: 'master..master'" in str(excinfo)
 
 
 def test_check_a_range_of_failed_git_commits(config, mocker: MockFixture):
@@ -204,9 +204,11 @@ def test_check_a_range_of_failed_git_commits(config, mocker: MockFixture):
         return_value=_build_fake_git_commits(ill_formatted_commits_msgs),
     )
 
-    with pytest.raises(InvalidCommitMessageError) as excinfo:
+    with pytest.raises(
+        InvalidCommitMessageError,
+        match=r"[\s\S]*".join(ill_formatted_commits_msgs),
+    ):
         commands.Check(config=config, arguments={"rev_range": "HEAD~10..master"})()
-    assert all([msg in str(excinfo.value) for msg in ill_formatted_commits_msgs])
 
 
 def test_check_command_with_valid_message(config, success_mock: MockType):
@@ -277,9 +279,8 @@ def test_check_command_with_pipe_message_and_failed(
 ):
     mocker.patch("sys.stdin", StringIO("bad commit message"))
 
-    with pytest.raises(InvalidCommitMessageError) as excinfo:
+    with pytest.raises(InvalidCommitMessageError, match="commit validation: failed!"):
         util.run_cli("check")
-    assert "commit validation: failed!" in str(excinfo.value)
 
 
 def test_check_command_with_comment_in_message_file(
@@ -440,11 +441,10 @@ def test_check_command_with_custom_validator_failed(
     mock_path.return_value.read_text.return_value = (
         "123-ABC issue id has wrong format and misses colon"
     )
-    with pytest.raises(InvalidCommitMessageError) as excinfo:
+    with pytest.raises(
+        InvalidCommitMessageError,
+        match=r"commit validation: failed![\s\S]*pattern: ",
+    ):
         util.run_cli(
             "--name", "cz_custom_validator", "check", "--commit-msg-file", "some_file"
         )
-    assert "commit validation: failed!" in str(excinfo.value), (
-        "Pattern validation unexpectedly passed"
-    )
-    assert "pattern: " in str(excinfo.value), "Pattern not found in error message"

tests/commands/test_commit_command.py

@@ -1,3 +1,4 @@
+import re
 import sys
 from pathlib import Path
 from unittest.mock import ANY
@@ -84,11 +85,11 @@ def test_commit_backup_on_failure(
 
 @pytest.mark.usefixtures("staging_is_clean", "commit_mock")
 def test_commit_retry_fails_no_backup(config):
-    with pytest.raises(NoCommitBackupError) as excinfo:
+    with pytest.raises(
+        NoCommitBackupError, match=re.escape(NoCommitBackupError.message)
+    ):
         commands.Commit(config, {"retry": True})()
 
-    assert NoCommitBackupError.message in str(excinfo.value)
-
 
 @pytest.mark.usefixtures("staging_is_clean", "backup_file")
 def test_commit_retry_works(
@@ -209,11 +210,9 @@ def test_commit_command_with_gpgsign_and_always_signoff_enabled(
 def test_commit_when_nothing_to_commit(config, mocker: MockFixture):
     mocker.patch("commitizen.git.is_staging_clean", return_value=True)
 
-    with pytest.raises(NothingToCommitError) as excinfo:
+    with pytest.raises(NothingToCommitError, match="No files added to staging!"):
         commands.Commit(config, {})()
 
-    assert "No files added to staging!" in str(excinfo.value)
-
 
 @pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat")
 def test_commit_with_allow_empty(config, success_mock: MockType, commit_mock: MockType):
@@ -242,12 +241,9 @@ def test_commit_when_customized_expected_raised(config, mocker: MockFixture):
     _err = ValueError()
     _err.__context__ = CzException("This is the root custom err")
     mocker.patch("questionary.prompt", side_effect=_err)
-    with pytest.raises(CustomError) as excinfo:
+    with pytest.raises(CustomError, match="This is the root custom err"):
         commands.Commit(config, {})()
 
-    # Assert only the content in the formatted text
-    assert "This is the root custom err" in str(excinfo.value)
-
 
 @pytest.mark.usefixtures("staging_is_clean")
 def test_commit_when_non_customized_expected_raised(config, mocker: MockFixture):

tests/test_bump_update_version_in_files.py

@@ -1,3 +1,4 @@
+import re
 from collections.abc import Callable
 from pathlib import Path
 from shutil import copyfile
@@ -199,7 +200,14 @@ def test_file_version_inconsistent_error(
     ]
     old_version = "1.2.3"
     new_version = "2.0.0"
-    with pytest.raises(CurrentVersionNotFoundError) as excinfo:
+    with pytest.raises(
+        CurrentVersionNotFoundError,
+        match=re.escape(
+            f"Current version {old_version} is not found in {inconsistent_python_version_file}.\n"
+            "The version defined in commitizen configuration and the ones in "
+            "version_files are possibly inconsistent."
+        ),
+    ):
         bump.update_version_in_files(
             old_version,
             new_version,
@@ -208,13 +216,6 @@ def test_file_version_inconsistent_error(
             encoding="utf-8",
         )
 
-    expected_msg = (
-        f"Current version 1.2.3 is not found in {inconsistent_python_version_file}.\n"
-        "The version defined in commitizen configuration and the ones in "
-        "version_files are possibly inconsistent."
-    )
-    assert expected_msg in str(excinfo.value)
-
 
 def test_multiple_versions_to_bump(
     multiple_versions_to_update_poetry_lock, file_regression
@@ -285,7 +286,14 @@ def test_update_version_in_files_with_check_consistency_true_failure(
     version_files = [commitizen_config_file, inconsistent_python_version_file]
 
     # This should fail because inconsistent_python_version_file doesn't contain the current version
-    with pytest.raises(CurrentVersionNotFoundError) as excinfo:
+    with pytest.raises(
+        CurrentVersionNotFoundError,
+        match=re.escape(
+            f"Current version {old_version} is not found in {inconsistent_python_version_file}.\n"
+            "The version defined in commitizen configuration and the ones in "
+            "version_files are possibly inconsistent."
+        ),
+    ):
         bump.update_version_in_files(
             old_version,
             new_version,
@@ -294,13 +302,6 @@ def test_update_version_in_files_with_check_consistency_true_failure(
             encoding="utf-8",
         )
 
-    expected_msg = (
-        f"Current version {old_version} is not found in {inconsistent_python_version_file}.\n"
-        "The version defined in commitizen configuration and the ones in "
-        "version_files are possibly inconsistent."
-    )
-    assert expected_msg in str(excinfo.value)
-
 
 @pytest.mark.parametrize(
     ("encoding", "filename"),

tests/test_changelog.py

@@ -1228,11 +1228,11 @@ def test_generate_ordered_changelog_tree(change_type_order, expected_reordering)
 
 def test_generate_ordered_changelog_tree_raises():
     change_type_order = ["BREAKING CHANGE", "feat", "refactor", "feat"]
-    with pytest.raises(InvalidConfigurationError) as excinfo:
+    with pytest.raises(
+        InvalidConfigurationError, match="Change types contain duplicated types"
+    ):
         list(changelog.generate_ordered_changelog_tree(COMMITS_TREE, change_type_order))
 
-    assert "Change types contain duplicated types" in str(excinfo)
-
 
 def test_render_changelog(
     gitcommits, tags, changelog_content, any_changelog_format: ChangelogFormat
@@ -1543,9 +1543,10 @@ def test_get_next_tag_name_after_version(tags):
     assert last_tag_name is None
 
     # Test error when version not found
-    with pytest.raises(changelog.NoCommitsFoundError) as exc_info:
+    with pytest.raises(
+        changelog.NoCommitsFoundError, match="Could not find a valid revision range"
+    ):
         changelog.get_next_tag_name_after_version(tags, "nonexistent")
-    assert "Could not find a valid revision range" in str(exc_info.value)
 
 
 @dataclass