Merge pull request #84 from dany2691/cz-check

feat(Commands/check): enforce the project to always use conventional …

Author: woile

README.rst

@@ -160,13 +160,14 @@ Usage
     --version             get the version of the installed commitizen
 
     commands:
-    {ls,commit,c,example,info,schema,bump}
+    {ls,commit,c,example,info,schema,bump,check}
         ls                  show available commitizens
         commit (c)          create new commit
         example             show commit example
         info                show information about the cz
         schema              show commit schema
         bump                bump semantic version based on the git log
+        check               enforce the project to always use conventional commits
 
 Contributing
 ============

commitizen/cli.py

@@ -111,6 +111,21 @@
                 "help": "get the version of the installed commitizen",
                 "func": commands.Version,
             },
+            {
+                "name": ["check"],
+                "help": "enforce the project to always use conventional commits",
+                "func": commands.Check,
+                "arguments": [
+                    {
+                        "name": "--commit-msg-file",
+                        "help": (
+                            "ask for the name of the temporal file that contains "
+                            "the commit message. "
+                            "Using it in a git hook script: MSG_FILE=$1"
+                        ),
+                    }
+                ],
+            },
         ],
     },
 }

commitizen/commands/__init__.py

@@ -1,9 +1,11 @@
 from .bump import Bump
 from .commit import Commit
+from .check import Check
 from .example import Example
 from .info import Info
 from .list_cz import ListCz
 from .schema import Schema
 from .version import Version
 
-__all__ = ("Bump", "Commit", "Example", "Info", "ListCz", "Schema", "Version")
+__all__ = ("Bump", "Check", "Commit", "Example", "Info", "ListCz", "Schema",
+           "Version")

commitizen/commands/check.py

@@ -0,0 +1,52 @@
+import os
+import re
+
+from commitizen import out
+
+PATTERN = (r'(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert)'
+           r'(\([\w\-]+\))?:\s.*')
+NO_COMMIT_MSG = 3
+INVALID_COMMIT_MSG = 5
+
+
+class Check:
+    """Check if the current commit msg is a conventional commit."""
+
+    def __init__(self, config: dict, arguments: dict, cwd=os.getcwd()):
+        """Init method.
+
+        Parameters
+        ----------
+        config : dict
+            the config object required for the command to perform its action
+        arguments : dict
+            the arguments object that contains all
+            the flags provided by the user
+
+        """
+        self.config: dict = config
+        self.arguments: dict = arguments
+
+    def __call__(self):
+        """Validate if a commit message follows the conventional pattern.
+
+        Raises
+        ------
+        SystemExit
+            if the commit provided not follows the conventional pattern
+
+        """
+        commit_msg_content = self._get_commit_msg()
+        if self._is_conventional(PATTERN, commit_msg_content) is not None:
+            out.success("Conventional commit validation: successful!")
+        else:
+            out.error("conventional commit validation: failed!")
+            out.error("please enter a commit message in the conventional format.")
+            raise SystemExit(INVALID_COMMIT_MSG)
+
+    def _get_commit_msg(self):
+        temp_filename: str = self.arguments.get("commit_msg_file")
+        return open(temp_filename, 'r').read()
+
+    def _is_conventional(self, pattern, commit_msg):
+        return re.match(PATTERN, commit_msg)

tests/test_commands.py

@@ -1,4 +1,7 @@
+import contextlib
 import os
+import shutil
+import tempfile
 from unittest import mock
 
 import pytest
@@ -15,6 +18,15 @@ def staging_is_clean(mocker):
     is_staging_clean_mock.return_value = False
 
 
+@contextlib.contextmanager
+def get_temp_dir():
+    temp_dir = tempfile.mkdtemp()
+    try:
+        yield temp_dir
+    finally:
+        shutil.rmtree(temp_dir)
+
+
 @pytest.mark.usefixtures("staging_is_clean")
 def test_commit(mocker):
     prompt_mock = mocker.patch("questionary.prompt")
@@ -158,3 +170,46 @@ def test_version():
 
         commands.Version(config)()
         mocked_write.assert_called_once()
+
+
+def test_check_no_conventional_commit(mocker):
+    with pytest.raises(SystemExit):
+        error_mock = mocker.patch("commitizen.out.error")
+
+        with get_temp_dir() as dir:
+
+            tempfile = os.path.join(dir, "temp_commit_file")
+            with open(tempfile, 'w') as f:
+                f.write("no conventional commit")
+
+            check_cmd = commands.Check(
+                config=config,
+                arguments={"commit_msg_file": tempfile}
+            )
+            check_cmd()
+            error_mock.assert_called_once()
+
+
+def test_check_conventional_commit(mocker):
+    success_mock = mocker.patch("commitizen.out.success")
+    with get_temp_dir() as dir:
+
+        tempfile = os.path.join(dir, "temp_commit_file")
+        with open(tempfile, 'w') as f:
+            f.write("feat(lang): added polish language")
+
+        check_cmd = commands.Check(
+            config=config,
+            arguments={"commit_msg_file": tempfile}
+        )
+
+        check_cmd()
+        success_mock.assert_called_once()
+
+
+def test_check_command_when_commit_file_not_found():
+    with pytest.raises(FileNotFoundError):
+        commands.Check(
+            config=config,
+            arguments={"commit_msg_file": ""}
+        )()