test(check): add test of checking commit message with comment in it

Author: yuukidach

commitizen/commands/check.py

@@ -95,7 +95,7 @@ def _get_commits(self):
         return git.get_commits(end=self.rev_range)
 
     def _filter_comments(self, msg: str) -> str:
-        lines = [line for line in msg.split('\n') if not line.startswith('#')]
+        lines = [line for line in msg.split("\n") if not line.startswith("#")]
         return "\n".join(lines)
 
     @staticmethod

tests/commands/test_check_command.py

@@ -275,3 +275,23 @@ def test_check_command_with_pipe_message_and_failed(mocker):
     with pytest.raises(InvalidCommitMessageError) as excinfo:
         cli.main()
     assert "commit validation: failed!" in str(excinfo.value)
+
+
+def test_check_command_with_comment_in_messege_file(mocker, capsys):
+    testargs = ["cz", "check", "--commit-msg-file", "some_file"]
+    mocker.patch.object(sys, "argv", testargs)
+    mocker.patch(
+        "commitizen.commands.check.open",
+        mocker.mock_open(
+            read_data="# <type>: (If applied, this commit will...) <subject>\n"
+            "# |<---- Try to Limit to a Max of 50 char ---->|\n"
+            "ci: add commitizen pre-commit hook\n"
+            "\n"
+            "# Explain why this change is being made\n"
+            "# |<---- Try To Limit Each Line to a Max Of 72 Char ---->|\n"
+            "This pre-commit hook will check our commits automatically."
+        ),
+    )
+    cli.main()
+    out, _ = capsys.readouterr()
+    assert "Commit validation: successful!" in out