test(bump): provide tests for update_changelog_on_bump config option

Author: Jan Willhaus

tests/commands/conftest.py

@@ -1,3 +1,5 @@
+import os
+
 import pytest
 
 from commitizen import defaults
@@ -9,3 +11,13 @@ def config():
     _config = BaseConfig()
     _config.settings.update({"name": defaults.name})
     return _config
+
+
+@pytest.fixture()
+def changelog_path() -> str:
+    return os.path.join(os.getcwd(), "CHANGELOG.md")
+
+
+@pytest.fixture()
+def config_path() -> str:
+    return os.path.join(os.getcwd(), "pyproject.toml")

tests/commands/test_bump_command.py

@@ -1,4 +1,5 @@
 import inspect
+import os
 import sys
 from unittest.mock import MagicMock
 
@@ -301,3 +302,50 @@ def test_none_increment_should_not_call_git_tag(mocker, tmp_commitizen_project):
 
     # restore pop stashed
     git.tag = stashed_git_tag
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_bump_with_changelog_arg(mocker, changelog_path):
+    create_file_and_commit("feat(user): new file")
+    testargs = ["cz", "bump", "--yes", "--changelog"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    tag_exists = git.tag_exist("0.2.0")
+    assert tag_exists is True
+
+    with open(changelog_path, "r") as f:
+        out = f.read()
+    assert out.startswith("#")
+    assert "0.2.0" in out
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_bump_with_changelog_config(mocker, changelog_path, config_path):
+    create_file_and_commit("feat(user): new file")
+    with open(config_path, "a") as fp:
+        fp.write("update_changelog_on_bump = true\n")
+
+    testargs = ["cz", "bump", "--yes"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    tag_exists = git.tag_exist("0.2.0")
+    assert tag_exists is True
+
+    with open(changelog_path, "r") as f:
+        out = f.read()
+    assert out.startswith("#")
+    assert "0.2.0" in out
+
+
+@pytest.mark.usefixtures("tmp_commitizen_project")
+def test_bump_with_negated_changelog_config(mocker, changelog_path, config_path):
+    create_file_and_commit("feat(user): new file")
+    with open(config_path, "a") as fp:
+        fp.write("update_changelog_on_bump = true\n")
+
+    testargs = ["cz", "bump", "--yes", "--no-changelog"]
+    mocker.patch.object(sys, "argv", testargs)
+    cli.main()
+    tag_exists = git.tag_exist("0.2.0")
+    assert tag_exists is True
+    assert not os.path.exists(changelog_path)

tests/commands/test_changelog_command.py

@@ -1,4 +1,3 @@
-import os
 import sys
 from datetime import date
 
@@ -15,11 +14,6 @@
 from tests.utils import create_file_and_commit
 
 
-@pytest.fixture()
-def changelog_path() -> str:
-    return os.path.join(os.getcwd(), "CHANGELOG.md")
-
-
 @pytest.mark.usefixtures("tmp_commitizen_project")
 def test_changelog_on_empty_project(mocker):
     testargs = ["cz", "changelog", "--dry-run"]

tests/test_conf.py

@@ -32,6 +32,7 @@
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
     "style": [["pointer", "reverse"], ["question", "underline"]],
     "changelog_file": "CHANGELOG.md",
+    "update_changelog_on_bump": False,
 }
 
 _new_settings = {
@@ -42,6 +43,7 @@
     "version_files": ["commitizen/__version__.py", "pyproject.toml"],
     "style": [["pointer", "reverse"], ["question", "underline"]],
     "changelog_file": "CHANGELOG.md",
+    "update_changelog_on_bump": False,
 }
 
 _read_settings = {