test(test_changelog_command): adding test for changelog generated with customize commits

matteo_fiore · Lee-W · commit 437d8d957941 · 2022-03-29T10:20:14.000+08:00
diff --git a/commitizen/defaults.py b/commitizen/defaults.py
@@ -1,6 +1,6 @@
 import pathlib
 from collections import OrderedDict
-from typing import Any, Iterable, List, MutableMapping, Optional, Tuple, Union
+from typing import Any, Dict, Iterable, List, MutableMapping, Optional, Tuple, Union
 
 from typing_extensions import TypedDict
 
@@ -20,6 +20,9 @@ class CzSettings(TypedDict, total=False):
     info_path: Union[str, pathlib.Path]
     info: str
     message_template: str
+    commit_parser: Optional[str]
+    changelog_pattern: Optional[str]
+    change_type_map: Optional[Dict[str, str]]
 
 
 class Settings(TypedDict, total=False):
diff --git a/tests/commands/conftest.py b/tests/commands/conftest.py
@@ -3,7 +3,7 @@
 import pytest
 
 from commitizen import defaults
-from commitizen.config import BaseConfig
+from commitizen.config import BaseConfig, JsonConfig
 
 
 @pytest.fixture()
@@ -13,6 +13,36 @@ def config():
     return _config
 
 
+@pytest.fixture()
+def config_customize():
+    json_string = r"""{
+      "commitizen": {
+        "name": "cz_customize",
+        "version": "3.0.0",
+        "changelog_incremental": "true",
+        "customize": {
+          "message_template": "{{prefix}}({{scope}}): {{subject}}\n\n{{body}}{% if is_breaking_change %}\nBREAKING CHANGE: {{footer}}{% endif %}",
+          "schema": "<type>(<scope>): <subject>\n<BLANK LINE>\n<body>\n<BLANK LINE>\n(BREAKING CHANGE: <footer>)",
+          "schema_pattern": "(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\\(\\S+\\))?!?:(\\s.*)",
+          "change_type_map": {
+            "feat": "Feat",
+            "fix": "Fix",
+            "refactor": "Refactor",
+            "perf": "Perf"
+          },
+          "change_type_order": ["Refactor", "Feat"],
+          "commit_parser": "^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?",
+          "changelog_pattern": "^(BREAKING[\\-\\ ]CHANGE|feat|fix|refactor|perf)(\\(.+\\))?(!)?",
+          "questions": [
+
+          ]
+        }
+      }
+    }"""
+    _config = JsonConfig(data=json_string, path="not_exist.json")
+    return _config
+
+
 @pytest.fixture()
 def changelog_path() -> str:
     return os.path.join(os.getcwd(), "CHANGELOG.md")
diff --git a/tests/commands/test_changelog_command.py b/tests/commands/test_changelog_command.py
@@ -263,6 +263,28 @@ def test_changelog_hook(mocker, config):
     changelog_hook_mock.assert_called_with(full_changelog, full_changelog)
 
 
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_changelog_hook_customize(mocker, config_customize):
+    changelog_hook_mock = mocker.Mock()
+    changelog_hook_mock.return_value = "cool changelog hook"
+
+    create_file_and_commit("feat: new file")
+    create_file_and_commit("refactor: is in changelog")
+    create_file_and_commit("Merge into master")
+
+    changelog = Changelog(
+        config_customize,
+        {"unreleased_version": None, "incremental": True, "dry_run": False},
+    )
+    mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock)
+    changelog()
+    full_changelog = (
+        "## Unreleased\n\n### Refactor\n\n- is in changelog\n\n### Feat\n\n- new file\n"
+    )
+
+    changelog_hook_mock.assert_called_with(full_changelog, full_changelog)
+
+
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_multiple_incremental_do_not_add_new_lines(
     mocker, capsys, changelog_path
