refactor: raise an InvalidConfigurationError

Author: KyleKing

commitizen/changelog.py

@@ -34,6 +34,7 @@
 from jinja2 import Environment, PackageLoader
 
 from commitizen import defaults
+from commitizen.exceptions import InvalidConfigurationError
 from commitizen.git import GitCommit, GitTag
 
 CATEGORIES = [
@@ -131,7 +132,7 @@ def generate_tree_from_commits(
 
 def order_changelog_tree(tree: Iterable, change_type_order: List[str]) -> Iterable:
     if len(set(change_type_order)) != len(change_type_order):
-        raise RuntimeError(
+        raise InvalidConfigurationError(
             f"Change types contain duplicates types ({change_type_order})"
         )
 

commitizen/exceptions.py

@@ -23,6 +23,7 @@ class ExitCode(enum.IntEnum):
     NO_REVISION = 16
     CURRENT_VERSION_NOT_FOUND = 17
     INVALID_COMMAND_ARGUMENT = 18
+    INVALID_CONFIGURATION = 19
 
 
 class CommitizenException(Exception):
@@ -137,3 +138,7 @@ class NoCommandFoundError(CommitizenException):
 
 class InvalidCommandArgumentError(CommitizenException):
     exit_code = ExitCode.INVALID_COMMAND_ARGUMENT
+
+
+class InvalidConfigurationError(CommitizenException):
+    exit_code = ExitCode.INVALID_CONFIGURATION

docs/exit_codes.md

@@ -26,3 +26,4 @@ These exit codes can be found in `commitizen/exceptions.py::ExitCode`.
 | NoRevisionError | 16 | No revision found |
 | CurrentVersionNotFoundError | 17 | current version cannot be found in *version_files* |
 | InvalidCommandArgumentError | 18 | The argument provide to command is invalid (e.g. `cz check -commit-msg-file filename --rev-range master..`) |
+| InvalidConfigurationError | 19 | An error was found in the Commitizen Configuration, such as duplicates in `change_type_order` |

tests/test_changelog.py

@@ -1,6 +1,7 @@
 import pytest
 
 from commitizen import changelog, defaults, git
+from commitizen.exceptions import InvalidConfigurationError
 
 COMMITS_DATA = [
     {
@@ -833,10 +834,10 @@ def test_order_changelog_tree(change_type_order, expected_reordering):
 
 def test_order_changelog_tree_raises():
     change_type_order = ["BREAKING CHANGE", "feat", "refactor", "feat"]
-    with pytest.raises(RuntimeError) as excinfo:
+    with pytest.raises(InvalidConfigurationError) as excinfo:
         changelog.order_changelog_tree(COMMITS_TREE, change_type_order)
 
-    assert " duplicate" in str(excinfo)
+    assert "Change types contain duplicates types" in str(excinfo)
 
 
 def test_render_changelog(gitcommits, tags, changelog_content):