Merge pull request commitizen-tools#51 from Lee-W/general-expection-for-customize-commit

General expection for customize commit

Author: woile

commitizen/commands/commit.py

@@ -5,11 +5,13 @@
 import questionary
 
 from commitizen import factory, git, out
+from commitizen.cz.exceptions import CzException
 
 NO_ANSWERS = 5
 COMMIT_ERROR = 6
 NO_COMMIT_BACKUP = 7
 NOTHING_TO_COMMIT = 8
+CUSTOM_ERROR = 9
 
 
 class Commit:
@@ -41,7 +43,15 @@ def __call__(self):
             # Prompt user for the commit message
             cz = self.cz
             questions = cz.questions()
-            answers = questionary.prompt(questions, style=cz.style)
+            try:
+                answers = questionary.prompt(questions, style=cz.style)
+            except ValueError as err:
+                root_err = err.__context__
+                if isinstance(root_err, CzException):
+                    out.error(root_err.__str__())
+                    raise SystemExit(CUSTOM_ERROR)
+                raise err
+
             if not answers:
                 raise SystemExit(NO_ANSWERS)
             m = cz.message(answers)

commitizen/cz/conventional_commits/conventional_commits.py

@@ -2,11 +2,12 @@
 
 from commitizen import defaults
 from commitizen.cz.base import BaseCommitizen
+from commitizen.cz.exceptions import CzException
 
 __all__ = ["ConventionalCommitsCz"]
 
 
-class NoSubjectException(Exception):
+class NoSubjectException(CzException):
     ...
 
 
@@ -26,7 +27,7 @@ def parse_subject(text):
         text = text.strip(".").strip()
 
     if not text:
-        raise NoSubjectException
+        raise NoSubjectException("Subject is required.")
 
     return text
 

commitizen/cz/exceptions.py

@@ -0,0 +1,2 @@
+class CzException(Exception):
+    ...

docs/customization.md

@@ -7,7 +7,6 @@ The basic steps are:
 3. expose the class at the end of your file assigning it to `discover_this`
 4. Create a python package starting with `cz_` using `setup.py`, `poetry`, etc
 
-
 Check an [example](convcomms) on how to configure `BaseCommitizen`.
 
 ## Custom commit rules
@@ -122,4 +121,15 @@ That's it, your commitizen now supports custom rules and you can run
 cz -n cz_strange bump
 ```
 
-[convcomms]: https://github.com/Woile/commitizen/blob/master/commitizen/cz/conventional_commits/conventional_commits.py
+[convcomms]: https://github.com/Woile/commitizen/blob/master/commitizen/cz/conventional_commits/conventional_commits.py
+
+## Raise Customize Exception
+
+If you wannt `commitizen` to catch your exception and print the message, you'll have to inherit `CzException`.
+
+```python
+from commitizen.cz.exception import CzException
+
+class NoSubjectProvidedException(CzException):
+    ...
+```

tests/test_commands.py

@@ -4,6 +4,7 @@
 import pytest
 
 from commitizen import cmd, commands, defaults
+from commitizen.cz.exceptions import CzException
 
 config = {"name": defaults.name}
 
@@ -92,6 +93,24 @@ def test_commit_when_nothing_to_commit(mocker):
     assert err.value.code == commands.commit.NOTHING_TO_COMMIT
 
 
+def test_commit_when_customized_expected_raised(mocker, capsys):
+    _err = ValueError()
+    _err.__context__ = CzException("This is the root custom err")
+
+    prompt_mock = mocker.patch("questionary.prompt")
+    prompt_mock.side_effect = _err
+
+    with pytest.raises(SystemExit) as err:
+        commit_cmd = commands.Commit(config, {})
+        commit_cmd()
+
+    assert err.value.code == commands.commit.CUSTOM_ERROR
+
+    # Assert only the content in the formatted text
+    captured = capsys.readouterr()
+    assert "This is the root custom err" in captured.err
+
+
 def test_example():
     with mock.patch("commitizen.out.write") as write_mock:
         commands.Example(config)()