Added --list function

Author: coordt

bumpversion/cli.py

@@ -8,10 +8,10 @@
 from bumpversion import __version__
 
 # from bumpversion.aliases import AliasedGroup
-from bumpversion.bump import do_bump
-from bumpversion.config import find_config_file, get_configuration
+from bumpversion.bump import do_bump, get_next_version
+from bumpversion.config import Config, find_config_file, get_configuration
 from bumpversion.logging import setup_logging
-from bumpversion.utils import get_overrides
+from bumpversion.utils import get_context, get_overrides
 
 logger = logging.getLogger(__name__)
 
@@ -140,6 +140,12 @@
     required=False,
     help="Extra arguments to commit command",
 )
+@click.option(
+    "--list",
+    "show_list",
+    is_flag=True,
+    help="List machine readable information",
+)
 def cli(
     version_part: str,
     files: list,
@@ -161,6 +167,7 @@ def cli(
     tag_message: Optional[str],
     message: Optional[str],
     commit_args: Optional[str],
+    show_list: bool,
 ) -> None:
     """Change the version."""
     setup_logging(verbose)
@@ -186,6 +193,10 @@ def cli(
     found_config_file = find_config_file(config_file)
     config = get_configuration(found_config_file, **overrides)
 
+    if show_list:
+        log_list(config, version_part, new_version)
+        return
+
     config.allow_dirty = allow_dirty if allow_dirty is not None else config.allow_dirty
     if not config.allow_dirty and config.scm_info.tool:
         config.scm_info.tool.assert_nondirty()
@@ -199,8 +210,13 @@ def cli(
     do_bump(version_part, new_version, config, found_config_file, dry_run)
 
 
-def _log_list(config: dict, new_version: str) -> None:
+def log_list(config: Config, version_part: Optional[str], new_version: Optional[str]) -> None:
     """Output configuration with new version."""
-    logger.info("new_version=%s", new_version)
-    for key, value in config.items():
-        logger.info("%s=%s", key, value)
+    ctx = get_context(config)
+    version = config.version_config.parse(config.current_version)
+    next_version = get_next_version(version, config, version_part, new_version)
+    next_version_str = config.version_config.serialize(next_version, ctx)
+
+    click.echo(f"new_version={next_version_str}")
+    for key, value in config.dict(exclude={"scm_info", "parts"}).items():
+        click.echo(f"{key}={value}")

tests/test_cli.py

@@ -1,13 +1,15 @@
 """Tests for `bumpversion` package."""
+import shutil
+import subprocess
+from pathlib import Path
 
+import pytest
 from click.testing import CliRunner, Result
+from pytest import param
 
 from bumpversion import __version__, cli
 from tests.conftest import inside_dir
 
-# To learn more about testing Click applications, visit the link below.
-# https://click.palletsprojects.com/en/8.1.x/testing/
-
 
 def test_version_displays_library_version():
     """
@@ -56,3 +58,154 @@ def test_no_configured_files_still_file_args_work(mocker, tmp_path):
     call_args = mocked_do_bump.call_args[0]
     assert len(call_args[2].files) == 1
     assert call_args[2].files[0].filename == "do-this-file.txt"
+
+
+def test_missing_explicit_config_file(tmp_path: Path):
+    """The command-line processor should raise an exception if the config file is missing."""
+    with inside_dir(tmp_path):
+        runner: CliRunner = CliRunner()
+        with inside_dir(tmp_path):
+            result: Result = runner.invoke(cli.cli, ["--config-file", "missing-file.cfg"])
+        assert result.exit_code != 0
+        assert "'missing-file.cfg' does not exist." in result.output
+
+
+def test_cli_options_override_config(tmp_path: Path, fixtures_path: Path, mocker):
+    """The command-line processor should override the config file."""
+    # Arrange
+    config_path = tmp_path / "this_config.toml"
+    fixture_toml = fixtures_path / "basic_cfg.toml"
+    shutil.copy(fixture_toml, config_path)
+    runner: CliRunner = CliRunner()
+    mocked_do_bump = mocker.patch("bumpversion.cli.do_bump")
+
+    # Act
+    with inside_dir(tmp_path):
+        result: Result = runner.invoke(
+            cli.cli,
+            [
+                "--config-file",
+                str(config_path),
+                "--current-version",
+                "1.1.0",
+                "--new-version",
+                "1.2.0",
+                "--allow-dirty",
+                "--parse",
+                r"XXX(?P<spam>\d+);(?P<blob>\d+);(?P<slurp>\d+)",
+                "--serialize",
+                "XXX{spam};{blob};{slurp}",
+                "--search",
+                "my-search",
+                "--replace",
+                "my-replace",
+                "--no-commit",
+                "--no-tag",
+                "patch",
+                "do-this-file.txt",
+            ],
+        )
+
+    # Assert
+    assert result.exit_code == 0
+    assert mocked_do_bump.call_count == 1
+    assert mocked_do_bump.call_args[0][0] == "patch"
+    assert mocked_do_bump.call_args[0][1] == "1.2.0"
+    the_config = mocked_do_bump.call_args[0][2]
+    assert the_config.current_version == "1.1.0"
+    assert the_config.allow_dirty
+    assert the_config.parse == r"XXX(?P<spam>\d+);(?P<blob>\d+);(?P<slurp>\d+)"
+    assert the_config.serialize == ["XXX{spam};{blob};{slurp}"]
+    assert the_config.search == "my-search"
+    assert the_config.replace == "my-replace"
+    assert the_config.commit is False
+    assert the_config.tag is False
+    assert len(the_config.files) == 4
+    assert {f.filename for f in the_config.files} == {
+        "setup.py",
+        "bumpversion/__init__.py",
+        "CHANGELOG.md",
+        "do-this-file.txt",
+    }
+    assert mocked_do_bump.call_args[0][3] == config_path
+
+
+@pytest.mark.parametrize(
+    ["repo", "scm_command"],
+    [
+        param("git_repo", "git", id="git"),
+        param("hg_repo", "hg", id="hg"),
+    ],
+)
+def test_dirty_work_dir_raises_error(repo: str, scm_command: str, request):
+    repo_path: Path = request.getfixturevalue(repo)
+    with inside_dir(repo_path):
+        # Arrange
+        repo_path.joinpath("dirty2").write_text("i'm dirty! 1.1.1")
+        subprocess.run([scm_command, "add", "dirty2"], check=True)
+        runner: CliRunner = CliRunner()
+
+        # Act
+        result: Result = runner.invoke(cli.cli, ["patch", "--current-version", "1.1.1", "--no-allow-dirty", "dirty2"])
+
+    # Assert
+    assert result.exit_code != 0
+    assert "working directory is not clean" in result.output
+
+
+def test_listing_outputs_correctly_and_stops(tmp_path: Path, fixtures_path: Path):
+    """The --list option should list the configuration and nothing else."""
+    # Arrange
+    config_path = tmp_path / "pyproject.toml"
+    toml_path = fixtures_path / "basic_cfg.toml"
+    shutil.copy(toml_path, config_path)
+    runner: CliRunner = CliRunner()
+
+    with inside_dir(tmp_path):
+        result: Result = runner.invoke(cli.cli, ["--list", "patch"])
+
+    if result.exit_code != 0:
+        print(result.output)
+        print(result.exception)
+
+    assert result.exit_code == 0
+    assert set(result.output.splitlines(keepends=False)) == {
+        "new_version=1.0.1-dev",
+        "current_version=1.0.0",
+        "parse=(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
+        "serialize=['{major}.{minor}.{patch}-{release}', '{major}.{minor}.{patch}']",
+        "search={current_version}",
+        "replace={new_version}",
+        "tag=True",
+        "sign_tags=False",
+        "tag_name=v{new_version}",
+        "tag_message=Bump version: {current_version} → {new_version}",
+        "allow_dirty=False",
+        "commit=True",
+        "message=Bump version: {current_version} → {new_version}",
+        "commit_args=None",
+        "files=[{'filename': 'setup.py', 'glob': None, 'parse': None, 'serialize': "
+        "None, 'search': None, 'replace': None}, {'filename': "
+        "'bumpversion/__init__.py', 'glob': None, 'parse': None, 'serialize': None, "
+        "'search': None, 'replace': None}, {'filename': 'CHANGELOG.md', 'glob': None, "
+        "'parse': None, 'serialize': None, 'search': '**unreleased**', 'replace': "
+        "'**unreleased**\\n**v{new_version}**'}]",
+    }
+
+
+def test_non_scm_operations_if_scm_not_installed(tmp_path: Path, monkeypatch):
+    """Everything works except SCM commands if the SCM is unusable."""
+    # Arrange
+    monkeypatch.setenv("PATH", "")
+
+    with inside_dir(tmp_path):
+        version_path = tmp_path / "VERSION"
+        version_path.write_text("31.0.3")
+
+        runner: CliRunner = CliRunner()
+
+        # Act
+        runner.invoke(cli.cli, ["major", "--current-version", "31.0.3", "VERSION"])
+
+    # Assert
+    assert version_path.read_text() == "32.0.0"