refactor(exception): move output message related to exception into exception

Author: Lee-W

commitizen/bump.py

@@ -6,7 +6,6 @@
 
 from packaging.version import Version
 
-from commitizen import out
 from commitizen.defaults import (
     MAJOR,
     MINOR,
@@ -162,12 +161,11 @@ def update_version_in_files(
                     file_content.append(line)
 
         if check_consistency and not current_version_found:
-            out.error(
+            raise CurrentVersionNotFoundError(
                 f"Current version {current_version} is not found in {location}.\n"
                 "The version defined in commitizen configuration and the ones in "
                 "version_files are possibly inconsistent."
             )
-            raise CurrentVersionNotFoundError()
 
         # Write the file out again
         with open(filepath, "w") as file:

commitizen/cli.py

@@ -5,7 +5,7 @@
 
 from decli import cli
 
-from commitizen import commands, config, out
+from commitizen import commands, config
 from commitizen.exceptions import CommitizenException, ExpectedExit, NoCommandFoundError
 
 logger = logging.getLogger(__name__)
@@ -266,7 +266,6 @@ def main():
     try:
         args = parser.parse_args()
     except TypeError:
-        out.error("Command is required")
         raise NoCommandFoundError()
 
     if args.name:
@@ -299,7 +298,6 @@ def main():
     try:
         args.func(conf, vars(args))()
     except AttributeError:
-        out.error("Command is required")
         raise NoCommandFoundError()
 
 

commitizen/commands/bump.py

@@ -58,8 +58,9 @@ def find_increment(self, commits: List[git.GitCommit]) -> Optional[str]:
         bump_pattern = self.cz.bump_pattern
         bump_map = self.cz.bump_map
         if not bump_map or not bump_pattern:
-            out.error(f"'{self.config.settings['name']}' rule does not support bump")
-            raise NoPatternMapError()
+            raise NoPatternMapError(
+                f"'{self.config.settings['name']}' rule does not support bump"
+            )
         increment = bump.find_increment(
             commits, regex=bump_pattern, increments_map=bump_map
         )
@@ -70,11 +71,6 @@ def __call__(self):  # noqa: C901
         try:
             current_version_instance: Version = Version(self.bump_settings["version"])
         except TypeError:
-            out.error(
-                "[NO_VERSION_SPECIFIED]\n"
-                "Check if current version is specified in config file, like:\n"
-                "version = 0.4.3\n"
-            )
             raise NoVersionSpecifiedError()
 
         # Initialize values from sources (conf)
@@ -103,8 +99,7 @@ def __call__(self):  # noqa: C901
         # No commits, there is no need to create an empty tag.
         # Unless we previously had a prerelease.
         if not commits and not current_version_instance.is_prerelease:
-            out.error("[NO_COMMITS_FOUND]\n" "No new commits found.")
-            raise NoCommitsFoundError()
+            raise NoCommitsFoundError("[NO_COMMITS_FOUND]\n" "No new commits found.")
 
         if increment is None:
             increment = self.find_increment(commits)
@@ -156,12 +151,10 @@ def __call__(self):  # noqa: C901
         self.config.set_key("version", new_version.public)
         c = git.commit(message, args=self._get_commit_args())
         if c.err:
-            out.error('git.commit error: "{}"'.format(c.err.strip()))
-            raise CommitFailedError()
+            raise CommitFailedError(f'git.commit error: "{c.err.strip()}"')
         c = git.tag(new_tag_version)
         if c.err:
-            out.error(c.err)
-            raise TagFailedError()
+            raise TagFailedError(c.err)
         out.success("Done!")
 
     def _get_commit_args(self):

commitizen/commands/changelog.py

@@ -73,12 +73,10 @@ def __call__(self):
             Callable
         ] = self.cz.changelog_message_builder_hook
         changelog_hook: Optional[Callable] = self.cz.changelog_hook
-
         if not changelog_pattern or not commit_parser:
-            out.error(
+            raise NoPatternMapError(
                 f"'{self.config.settings['name']}' rule does not support changelog"
             )
-            raise NoPatternMapError()
 
         tags = git.get_tags()
         if not tags:
@@ -92,8 +90,7 @@ def __call__(self):
 
         commits = git.get_commits(start=start_rev, args="--author-date-order")
         if not commits:
-            out.error("No commits found")
-            raise NoCommitsFoundError()
+            raise NoCommitsFoundError("No commits found")
 
         tree = changelog.generate_tree_from_commits(
             commits,

commitizen/commands/check.py

@@ -1,6 +1,5 @@
 import os
 import re
-import warnings
 from typing import Dict, Optional
 
 from commitizen import factory, git, out
@@ -33,13 +32,12 @@ def __init__(self, config: BaseConfig, arguments: Dict[str, str], cwd=os.getcwd(
 
     def _valid_command_argument(self):
         if bool(self.commit_msg_file) is bool(self.rev_range):
-            out.error(
+            raise InvalidCommandArgumentError(
                 (
                     "One and only one argument is required for check command! "
                     "See 'cz check -h' for more information"
                 )
             )
-            raise InvalidCommandArgumentError()
 
     def __call__(self):
         """Validate if commit messages follows the conventional pattern.
@@ -49,19 +47,17 @@ def __call__(self):
         """
         commit_msgs = self._get_commit_messages()
         if not commit_msgs:
-            warnings.warn(f"No commit found with range: '{self.rev_range}'")
-            raise NoCommitsFoundError()
+            raise NoCommitsFoundError(f"No commit found with range: '{self.rev_range}'")
 
         pattern = self.cz.schema_pattern()
         for commit_msg in commit_msgs:
             if not Check.validate_commit_message(commit_msg, pattern):
-                out.error(
+                raise InvalidCommitMessageError(
                     "commit validation: failed!\n"
                     "please enter a commit message in the commitizen format.\n"
                     f"commit: {commit_msg}\n"
                     f"pattern: {pattern}"
                 )
-                raise InvalidCommitMessageError()
         out.success("Commit validation: successful!")
 
     def _get_commit_messages(self):

commitizen/commands/commit.py

@@ -29,7 +29,6 @@ def __init__(self, config: BaseConfig, arguments: dict):
     def read_backup_message(self) -> str:
         # Check the commit backup file exists
         if not os.path.isfile(self.temp_file):
-            out.error("No commit backup found")
             raise NoCommitBackupError()
 
         # Read commit message from backup
@@ -45,8 +44,7 @@ def prompt_commit_questions(self) -> str:
         except ValueError as err:
             root_err = err.__context__
             if isinstance(root_err, CzException):
-                out.error(root_err.__str__())
-                raise CustomError()
+                raise CustomError(root_err.__str__())
             raise err
 
         if not answers:
@@ -57,8 +55,7 @@ def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")
 
         if git.is_staging_clean() and not dry_run:
-            out.write("No files added to staging!")
-            raise NothingToCommitError()
+            raise NothingToCommitError("No files added to staging!")
 
         retry: bool = self.arguments.get("retry")
 

commitizen/commands/init.py

@@ -2,6 +2,7 @@
 from packaging.version import Version
 
 from commitizen import factory, out
+from commitizen.exceptions import ExpectedExit, NoAnswersError
 from commitizen.config import BaseConfig, IniConfig, TomlConfig
 from commitizen.cz import registry
 from commitizen.defaults import long_term_support_config_files
@@ -79,8 +80,7 @@ def _ask_tag(self) -> str:
             ).ask()
 
             if not latest_tag:
-                out.error("Tag is required!")
-                raise SystemExit()
+                raise NoAnswersError("Tag is required!")
         return latest_tag
 
     def _ask_tag_format(self, latest_tag) -> str:
@@ -103,8 +103,7 @@ def _ask_tag_format(self, latest_tag) -> str:
 
     def _update_config_file(self, values):
         if not values:
-            out.write("The configuration were all set. Nothing to add.")
-            raise SystemExit()
+            raise ExpectedExit("The configuration were all set. Nothing to add.")
 
         for key, value in values.items():
             self.config.set_key(key, value)

commitizen/exceptions.py

@@ -43,6 +43,11 @@ def __str__(self):
 class ExpectedExit(CommitizenException):
     exit_code = ExitCode.EXPECTED_EXIT
 
+    def __init__(self, *args, **kwargs):
+        output_method = kwargs.get("output_method") or out.write
+        kwargs["output_method"] = output_method
+        super().__init__(*args, **kwargs)
+
 
 class DryRunExit(ExpectedExit):
     pass
@@ -68,6 +73,11 @@ class NoCommitsFoundError(CommitizenException):
 
 class NoVersionSpecifiedError(CommitizenException):
     exit_code = ExitCode.NO_VERSION_SPECIFIED
+    message = (
+        "[NO_VERSION_SPECIFIED]\n"
+        "Check if current version is specified in config file, like:\n"
+        "version = 0.4.3\n"
+    )
 
 
 class NoPatternMapError(CommitizenException):
@@ -96,6 +106,7 @@ class CommitError(CommitizenException):
 
 class NoCommitBackupError(CommitizenException):
     exit_code = ExitCode.NO_COMMIT_BACKUP
+    message = "No commit backup found"
 
 
 class NothingToCommitError(CommitizenException):
@@ -116,6 +127,7 @@ class NoRevisionError(CommitizenException):
 
 class NoCommandFoundError(CommitizenException):
     exit_code = ExitCode.NO_COMMAND_FOUND
+    message = "Command is required"
 
 
 class InvalidCommandArgumentError(CommitizenException):

commitizen/factory.py

@@ -1,4 +1,4 @@
-from commitizen import BaseCommitizen, out
+from commitizen import BaseCommitizen
 from commitizen.config import BaseConfig
 from commitizen.cz import registry
 from commitizen.exceptions import NoCommitizenFoundException
@@ -14,7 +14,6 @@ def commiter_factory(config: BaseConfig) -> BaseCommitizen:
             "The committer has not been found in the system.\n\n"
             f"Try running 'pip install {name}'\n"
         )
-        out.error(msg_error)
-        raise NoCommitizenFoundException(name)
+        raise NoCommitizenFoundException(msg_error)
     else:
         return _cz

tests/commands/test_bump_command.py

@@ -69,7 +69,7 @@ def test_bump_command(mocker):
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
-def test_bump_on_git_with_hooks_no_verify_disabled(mocker, capsys):
+def test_bump_on_git_with_hooks_no_verify_disabled(mocker):
     cmd.run("mkdir .git/hooks")
     with open(".git/hooks/pre-commit", "w") as f:
         f.write("#!/usr/bin/env bash\n" 'echo "0.1.0"')
@@ -81,11 +81,10 @@ def test_bump_on_git_with_hooks_no_verify_disabled(mocker, capsys):
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(CommitFailedError):
+    with pytest.raises(CommitFailedError) as excinfo:
         cli.main()
 
-    _, err = capsys.readouterr()
-    assert 'git.commit error: "0.1.0"' in err
+    assert 'git.commit error: "0.1.0"' in str(excinfo.value)
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
@@ -106,53 +105,44 @@ def test_bump_on_git_with_hooks_no_verify_enabled(mocker):
     assert tag_exists is True
 
 
-def test_bump_when_bumpping_is_not_support(mocker, capsys, tmp_commitizen_project):
+def test_bump_when_bumpping_is_not_support(mocker, tmp_commitizen_project):
     create_file_and_commit(
         "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported"
     )
 
     testargs = ["cz", "-n", "cz_jira", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(NoPatternMapError):
+    with pytest.raises(NoPatternMapError) as excinfo:
         cli.main()
 
-    _, err = capsys.readouterr()
-    assert "'cz_jira' rule does not support bump" in err
+    assert "'cz_jira' rule does not support bump" in str(excinfo.value)
 
 
 @pytest.mark.usefixtures("tmp_git_project")
-def test_bump_is_not_specify(mocker, capsys):
+def test_bump_when_version_is_not_specify(mocker):
     mocker.patch.object(sys, "argv", ["cz", "bump"])
 
-    with pytest.raises(NoVersionSpecifiedError):
+    with pytest.raises(NoVersionSpecifiedError) as excinfo:
         cli.main()
 
-    expected_error_message = (
-        "[NO_VERSION_SPECIFIED]\n"
-        "Check if current version is specified in config file, like:\n"
-        "version = 0.4.3\n"
-    )
-
-    _, err = capsys.readouterr()
-    assert expected_error_message in err
+    assert NoVersionSpecifiedError.message in str(excinfo.value)
 
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
-def test_bump_when_no_new_commit(mocker, capsys):
+def test_bump_when_no_new_commit(mocker):
     testargs = ["cz", "bump", "--yes"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(NoCommitsFoundError):
+    with pytest.raises(NoCommitsFoundError) as excinfo:
         cli.main()
 
     expected_error_message = "[NO_COMMITS_FOUND]\n" "No new commits found."
-    _, err = capsys.readouterr()
-    assert expected_error_message in err
+    assert expected_error_message in str(excinfo.value)
 
 
 def test_bump_when_version_inconsistent_in_version_files(
-    tmp_commitizen_project, mocker, capsys
+    tmp_commitizen_project, mocker
 ):
     tmp_version_file = tmp_commitizen_project.join("__version__.py")
     tmp_version_file.write("100.999.10000")
@@ -167,12 +157,11 @@ def test_bump_when_version_inconsistent_in_version_files(
     testargs = ["cz", "bump", "--yes", "--check-consistency"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(CurrentVersionNotFoundError):
+    with pytest.raises(CurrentVersionNotFoundError) as excinfo:
         cli.main()
 
     partial_expected_error_message = "Current version 0.1.0 is not found in"
-    _, err = capsys.readouterr()
-    assert partial_expected_error_message in err
+    assert partial_expected_error_message in str(excinfo.value)
 
 
 def test_bump_files_only(mocker, tmp_commitizen_project):

tests/commands/test_changelog_command.py

@@ -20,9 +20,11 @@ def test_changelog_on_empty_project(mocker):
     testargs = ["cz", "changelog", "--dry-run"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(NoCommitsFoundError):
+    with pytest.raises(NoCommitsFoundError) as excinfo:
         cli.main()
 
+    assert "No commits found" in str(excinfo)
+
 
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_from_version_zero_point_two(mocker, capsys):