refactor: introduce DryRunExit, ExpectedExit, NoCommandFoundError, InvalidCommandArgumentError

Instead of using SystemExit, we raise these error as CommitizenException

Author: Lee-W

commitizen/commands/bump.py

@@ -8,6 +8,8 @@
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
     CommitFailedError,
+    DryRunExit,
+    ExpectedExit,
     NoCommitsFoundError,
     NoPatternMapError,
     NoVersionSpecifiedError,
@@ -129,7 +131,7 @@ def __call__(self):  # noqa: C901
 
         # Do not perform operations over files or git.
         if dry_run:
-            raise SystemExit()
+            raise DryRunExit()
 
         bump.update_version_in_files(
             current_version,
@@ -138,7 +140,7 @@ def __call__(self):  # noqa: C901
             check_consistency=self.check_consistency,
         )
         if is_files_only:
-            raise SystemExit()
+            raise ExpectedExit()
 
         if self.changelog:
             changelog = Changelog(

commitizen/commands/changelog.py

@@ -6,6 +6,7 @@
 from commitizen import changelog, factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.exceptions import (
+    DryRunExit,
     NoCommitsFoundError,
     NoPatternMapError,
     NoRevisionError,
@@ -108,7 +109,7 @@ def __call__(self):
 
         if self.dry_run:
             out.write(changelog_out)
-            raise SystemExit(0)
+            raise DryRunExit()
 
         lines = []
         if self.incremental and os.path.isfile(self.file_name):

commitizen/commands/check.py

@@ -5,7 +5,11 @@
 
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
-from commitizen.exceptions import InvalidCommitMessageError, NoCommitsFoundError
+from commitizen.exceptions import (
+    InvalidCommandArgumentError,
+    InvalidCommitMessageError,
+    NoCommitsFoundError,
+)
 
 
 class Check:
@@ -35,13 +39,13 @@ def _valid_command_argument(self):
                     "See 'cz check -h' for more information"
                 )
             )
-            raise SystemExit()
+            raise InvalidCommandArgumentError()
 
     def __call__(self):
         """Validate if commit messages follows the conventional pattern.
 
         Raises:
-            SystemExit: if the commit provided not follows the conventional pattern
+            InvalidCommitMessageError: if the commit provided not follows the conventional pattern
         """
         commit_msgs = self._get_commit_messages()
         if not commit_msgs:

commitizen/commands/commit.py

@@ -10,6 +10,7 @@
 from commitizen.exceptions import (
     CommitError,
     CustomError,
+    DryRunExit,
     NoAnswersError,
     NoCommitBackupError,
     NothingToCommitError,
@@ -69,7 +70,7 @@ def __call__(self):
         out.info(f"\n{m}\n")
 
         if dry_run:
-            raise NothingToCommitError()
+            raise DryRunExit()
 
         c = git.commit(m)
 

commitizen/exceptions.py

@@ -4,34 +4,39 @@
 
 
 class ExitCode(enum.IntEnum):
+    EXPECTED_EXIT = 0
     NO_COMMITIZEN_FOUND = 1
-
     NOT_A_GIT_PROJECT = 2
-    MISSING_CONFIG = 15
-
     NO_COMMITS_FOUND = 3
     NO_VERSION_SPECIFIED = 4
     NO_PATTERN_MAP = 5
     COMMIT_FAILED = 6
     TAG_FAILED = 7
-    CURRENT_VERSION_NOT_FOUND = 17
-
     NO_ANSWERS = 8
     COMMIT_ERROR = 9
     NO_COMMIT_BACKUP = 10
     NOTHING_TO_COMMIT = 11
     CUSTOM_ERROR = 12
-
+    NO_COMMAND_FOUND = 13
     INVALID_COMMIT_MSG = 14
-
-    # Changelog
+    MISSING_CONFIG = 15
     NO_REVISION = 16
+    CURRENT_VERSION_NOT_FOUND = 17
+    INVALID_COMMAND_ARGUMENT = 18
 
 
 class CommitizenException(Exception):
     pass
 
 
+class ExpectedExit(CommitizenException):
+    exit_code = ExitCode.EXPECTED_EXIT
+
+
+class DryRunExit(ExpectedExit):
+    pass
+
+
 class NoCommitizenFoundException(CommitizenException):
     exit_code = ExitCode.NO_COMMITIZEN_FOUND
 
@@ -102,3 +107,11 @@ class InvalidCommitMessageError(CommitizenException):
 
 class NoRevisionError(CommitizenException):
     exit_code = ExitCode.NO_REVISION
+
+
+class NoCommandFoundError(CommitizenException):
+    exit_code = ExitCode.NO_COMMAND_FOUND
+
+
+class InvalidCommandArgumentError(CommitizenException):
+    exit_code = ExitCode.INVALID_COMMAND_ARGUMENT

tests/commands/test_changelog_command.py

@@ -6,7 +6,7 @@
 
 from commitizen import cli, git
 from commitizen.commands.changelog import Changelog
-from commitizen.exceptions import NoCommitsFoundError
+from commitizen.exceptions import DryRunExit, NoCommitsFoundError
 from tests.utils import create_file_and_commit
 
 
@@ -40,7 +40,7 @@ def test_changlog_from_version_zero_point_two(mocker, capsys):
 
     testargs = ["cz", "changelog", "--start-rev", "0.2.0", "--dry-run"]
     mocker.patch.object(sys, "argv", testargs)
-    with pytest.raises(SystemExit):
+    with pytest.raises(DryRunExit):
         cli.main()
 
     out, _ = capsys.readouterr()
@@ -55,7 +55,7 @@ def test_changlog_with_different_cz(mocker, capsys):
     testargs = ["cz", "-n", "cz_jira", "changelog", "--dry-run"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(SystemExit):
+    with pytest.raises(DryRunExit):
         cli.main()
     out, _ = capsys.readouterr()
     assert (

tests/commands/test_check_command.py

@@ -4,7 +4,11 @@
 import pytest
 
 from commitizen import cli, commands, git
-from commitizen.exceptions import InvalidCommitMessageError, NoCommitsFoundError
+from commitizen.exceptions import (
+    InvalidCommandArgumentError,
+    InvalidCommitMessageError,
+    NoCommitsFoundError,
+)
 
 COMMIT_LOG = [
     "refactor: A code change that neither fixes a bug nor adds a feature",
@@ -191,7 +195,7 @@ def test_check_a_range_of_git_commits_and_failed(config, mocker):
     "args", [{"rev_range": "HEAD~10..master", "commit_msg_file": "some_file"}, {}]
 )
 def test_check_command_with_invalid_argment(args, config, capsys):
-    with pytest.raises(SystemExit):
+    with pytest.raises(InvalidCommandArgumentError):
         commands.Check(config=config, arguments=args)
     _, err = capsys.readouterr()
     assert "One and only one argument is required for check command!" in err

tests/commands/test_commit_command.py

@@ -7,6 +7,7 @@
 from commitizen.exceptions import (
     CommitError,
     CustomError,
+    DryRunExit,
     NoCommitBackupError,
     NothingToCommitError,
 )
@@ -97,7 +98,7 @@ def test_commit_command_with_dry_run_option(config, mocker):
         "footer": "",
     }
 
-    with pytest.raises(NothingToCommitError):
+    with pytest.raises(DryRunExit):
         commit_cmd = commands.Commit(config, {"dry_run": True})
         commit_cmd()
 

tests/test_cli.py

@@ -4,13 +4,14 @@
 
 from commitizen import cli
 from commitizen.__version__ import __version__
+from commitizen.exceptions import ExpectedExit, NoCommandFoundError
 
 
 def test_sysexit_no_argv(mocker, capsys):
     testargs = ["cz"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(SystemExit):
+    with pytest.raises(ExpectedExit):
         cli.main()
         out, _ = capsys.readouterr()
         assert out.startswith("usage")
@@ -20,7 +21,7 @@ def test_cz_with_arg_but_without_command(mocker, capsys):
     testargs = ["cz", "--name", "cz_jira"]
     mocker.patch.object(sys, "argv", testargs)
 
-    with pytest.raises(SystemExit):
+    with pytest.raises(NoCommandFoundError):
         cli.main()
         _, err = capsys.readouterr()
         assert "Command is required" in err