[chores:fix] Commitizen: added unhandled valid cases, moved code to releaser/ dir #110

openwisp_utils/commitizen/openwisp.py → openwisp_utils/releaser/commitizen.py

@@ -152,7 +152,8 @@ def schema_pattern(self) -> str:
         # Body is optional (.* allows empty) and there's no second blank line required
         regular_pattern = (
             r"\[[a-z0-9!/:-]+\] [A-Z][^\n]*( #(?P<issue>\d+))?"
-            r"$(\n\n(.*\n)?Fixes #(?P=issue)\n?)?"
+            r"$(\n\n(.*\n)?(?:Close|Closes|Closed|Fix|Fixes|Fixed"
+            r"|Resolve|Resolves|Resolved|Related to) #(?P=issue)\n?)?"
         )
         return rf"(?sm)^(?:{merge_pattern}|{regular_pattern})\Z"
 
@@ -167,3 +168,6 @@ def info(self) -> str:
             f"Allowed commit prefixes:\n\n{prefixes_list}\n\n"
             "If in doubt, use chores."
         )
+
+
+__all__ = ["OpenWispCommitizen"]

openwisp_utils/commitizen/tests.py → openwisp_utils/releaser/tests/test_commitizen_rules.py

@@ -36,6 +36,28 @@ def test_valid_commit_without_body():
     assert code == 0
 
 
+def test_valid_commit_message_with_closes():
+    # GitHub also accepts "Closes" keyword to close issues
+    message = (
+        "[feature:qa] Standardized commit messages #110\n\n"
+        "Commitizen has been integrated.\n\n"
+        "Closes #110"
+    )
+    code, out, err = run_cz_check(message)
+    assert code == 0
+
+
+def test_valid_commit_message_with_related_to():
+    # "Related to" is used to reference issues without closing them
+    message = (
+        "[feature] Progress on feature #110\n\n"
+        "Partial implementation.\n\n"
+        "Related to #110"
+    )
+    code, out, err = run_cz_check(message)
+    assert code == 0
+
+
 def test_merge_commits_ignored():
     message = "Merge branch 'master' into issues/110-commit-convention-standardization"
     code, out, err = run_cz_check(message)

runtests.py

@@ -27,7 +27,6 @@
     pytest_exit_code = pytest.main(
         [
             "openwisp_utils/releaser/tests",
-            "openwisp_utils/commitizen/tests.py",
         ]
     )
     sys.exit(pytest_exit_code)

setup.py

@@ -15,17 +15,16 @@
     platforms=["Platform Independent"],
     keywords=["django", "netjson", "openwrt", "networking", "openwisp"],
     packages=find_packages(exclude=["tests*", "docs*"]),
-    py_modules=["cz_openwisp"],
-    include_package_data=True,
     entry_points={
         "console_scripts": [
             "checkmigrations = openwisp_utils.qa:check_migration_name",
             "checkcommit = openwisp_utils.qa:check_commit_message",
         ],
         "commitizen.plugin": [
-            "openwisp = cz_openwisp:OpenWispCommitizen",
+            "openwisp = openwisp_utils.releaser.commitizen:OpenWispCommitizen",
         ],
     },
+    include_package_data=True,
     scripts=["openwisp-qa-check", "openwisp-qa-format", "openwisp-pre-push-hook"],
     zip_safe=False,
     install_requires=[