Merge pull request #141 from dwhswenson/refactor-config-source

Refactor to avoid duplication of config-file source of metadata

Author: dwhswenson

autorelease/gh_actions_stages/autorelease-gh-rel.yml

@@ -29,8 +29,8 @@ jobs:
           fi
         name: "Install autorelease"
       - run: |
-          VERSION=`python setup.py --version`
-          PROJECT=`python setup.py --name`
+          VERSION=`autorelease metadata version`
+          PROJECT=`autorelease metadata name`
           echo $$PROJECT $$VERSION
           autorelease-release --project $$PROJECT --version $$VERSION --token $$AUTORELEASE_TOKEN
         env:

autorelease/gh_actions_stages/autorelease-prep.yml

@@ -39,7 +39,7 @@ jobs:
         name: "Install release tools"
       - run: |
           bump-dev-version
-          python setup.py --version
+          autorelease metadata version
         name: "Bump testpypi dev version"
       - run: |
           python setup.py sdist bdist_wheel

autorelease/scripts/bump_dev_version.py

@@ -1,17 +1,14 @@
 import argparse
 import time
 
-try:
-    from configparser import ConfigParser, NoSectionError, NoOptionError
-except ImportError:
-    # py2
-    from ConfigParser import ConfigParser, NoSectionError, NoOptionError
-
-
 from json import JSONDecodeError
 
 from packaging.version import Version
 import requests
+from autorelease.utils import split_setup_cfg_path
+from autorelease.version import (
+    ConfigParserError, get_setup_cfg, get_setup_name, get_setup_version
+)
 
 def get_latest_pypi(package, index="https://test.pypi.org/pypi"):
     url = "/".join([index, package, 'json'])
@@ -60,10 +57,22 @@ def shared_parser():
     return parser
 
 def get_version_info(conf_name, index):
-    conf = ConfigParser()
-    conf.read(conf_name)
-    v_setup = conf.get('metadata', 'version')
-    package = conf.get('metadata', 'name')
+    directory, filename = split_setup_cfg_path(conf_name)
+    try:
+        conf = get_setup_cfg(directory=directory, filename=filename)
+    except ConfigParserError as exc:
+        raise RuntimeError(
+            f"Unable to parse setup config: {conf_name}"
+        ) from exc
+    if conf is None:
+        raise RuntimeError(f"Unable to find setup config: {conf_name}")
+
+    v_setup = get_setup_version(conf, default_version=None)
+    package = get_setup_name(conf, default_name=None)
+    if v_setup is None:
+        raise RuntimeError(f"Missing [metadata] version in {conf_name}")
+    if package is None:
+        raise RuntimeError(f"Missing [metadata] name in {conf_name}")
     v_pypi = get_latest_pypi(package, index)
     return conf, package, v_setup, v_pypi
 

autorelease/scripts/cli.py

@@ -4,6 +4,10 @@
 
 from autorelease.scripts.vendor import vendor_actions
 from autorelease.scripts.check import run_checks
+from autorelease.utils import split_setup_cfg_path
+from autorelease.version import (
+    ConfigParserError, get_setup_cfg, get_setup_name, get_setup_version
+)
 # from autorelease import ReleaseNoteWriter
 from autorelease.gh_api4.notes4 import NotesWriter, prs_since_latest_release
 
@@ -77,6 +81,60 @@ def auth(auth):
     auth = load_auth(auth)
     pprint(auth)
 
+@cli.group()
+def metadata():
+    pass
+
+
+@metadata.command(name="version")
+@click.option("-c", "--conf", type=str, default="setup.cfg",
+              help="setup.cfg file to use")
+def metadata_version(conf):
+    directory, filename = split_setup_cfg_path(conf)
+    try:
+        setup_cfg = get_setup_cfg(directory=directory, filename=filename)
+    except ConfigParserError as exc:
+        raise click.ClickException(
+            f"Unable to parse setup config: {conf}"
+        ) from exc
+    if setup_cfg is None:
+        raise click.ClickException(
+            f"Unable to find setup config: {conf}"
+        )
+    value = get_setup_version(setup_cfg, default_version=None)
+    field = "version"
+
+    if value is None:
+        raise click.ClickException(
+            f"Missing [metadata] {field} in {conf}"
+        )
+    click.echo(value)
+
+
+@metadata.command(name="name")
+@click.option("-c", "--conf", type=str, default="setup.cfg",
+              help="setup.cfg file to use")
+def metadata_name(conf):
+    directory, filename = split_setup_cfg_path(conf)
+    try:
+        setup_cfg = get_setup_cfg(directory=directory, filename=filename)
+    except ConfigParserError as exc:
+        raise click.ClickException(
+            f"Unable to parse setup config: {conf}"
+        ) from exc
+    if setup_cfg is None:
+        raise click.ClickException(
+            f"Unable to find setup config: {conf}"
+        )
+    value = get_setup_name(setup_cfg, default_name=None)
+    field = "name"
+
+    if value is None:
+        raise click.ClickException(
+            f"Missing [metadata] {field} in {conf}"
+        )
+    click.echo(value)
+
 
 @cli.command()
 @click.option('--conf', type=click.File('r'))

autorelease/tests/test_bump_dev_version.py

@@ -1,5 +1,7 @@
 import pytest
 from autorelease.scripts.bump_dev_version import *
+import autorelease.scripts.bump_dev_version as bump_mod
+import autorelease.version as version_mod
 
 def test_shared_parser():
     parser = shared_parser()
@@ -22,3 +24,50 @@ def test_select_version(v_pypi, v_setup, expected):
 ])
 def test_bump_dev_version(version_str, expected):
     assert bump_dev_version(version_str) == expected
+
+
+def test_get_version_info_reuses_loaded_conf(tmp_path, monkeypatch):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata]\n"
+        "name = mypkg\n"
+        "version = 1.2.3.dev0\n"
+    )
+
+    real_get_setup_cfg = bump_mod.get_setup_cfg
+    calls = {"count": 0}
+
+    def counted_get_setup_cfg(*args, **kwargs):
+        calls["count"] += 1
+        return real_get_setup_cfg(*args, **kwargs)
+
+    def unexpected_get_setup_cfg(*args, **kwargs):
+        raise AssertionError("setup.cfg was reloaded")
+
+    monkeypatch.setattr(bump_mod, "get_setup_cfg", counted_get_setup_cfg)
+    monkeypatch.setattr(version_mod, "get_setup_cfg", unexpected_get_setup_cfg)
+    monkeypatch.setattr(bump_mod, "get_latest_pypi", lambda *args: "1.2.2")
+
+    conf, package, v_setup, v_pypi = bump_mod.get_version_info(
+        str(setup_cfg), "https://example.invalid/pypi"
+    )
+
+    assert calls["count"] == 1
+    assert conf.get("metadata", "name") == "mypkg"
+    assert package == "mypkg"
+    assert v_setup == "1.2.3.dev0"
+    assert v_pypi == "1.2.2"
+
+
+def test_get_version_info_malformed_cfg(tmp_path):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata\n"
+        "name = badpkg\n"
+        "version = 0.0.0\n"
+    )
+
+    with pytest.raises(RuntimeError, match="Unable to parse setup config"):
+        bump_mod.get_version_info(
+            str(setup_cfg), "https://example.invalid/pypi"
+        )

autorelease/tests/test_cli.py

@@ -0,0 +1,118 @@
+from click.testing import CliRunner
+
+import autorelease.scripts.cli as cli_mod
+
+
+def test_metadata_version(monkeypatch):
+    monkeypatch.setattr(
+        cli_mod, "get_setup_version",
+        lambda _conf, default_version=None: "1.2.3"
+    )
+    runner = CliRunner()
+    result = runner.invoke(cli_mod.cli, ["metadata", "version"])
+    assert result.exit_code == 0
+    assert result.output.strip() == "1.2.3"
+
+
+def test_metadata_name(monkeypatch):
+    monkeypatch.setattr(
+        cli_mod, "get_setup_name",
+        lambda _conf, default_name=None: "mypackage"
+    )
+    runner = CliRunner()
+    result = runner.invoke(cli_mod.cli, ["metadata", "name"])
+    assert result.exit_code == 0
+    assert result.output.strip() == "mypackage"
+
+
+def test_metadata_cli_name_and_version(tmp_path):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata]\n"
+        "name = mypkg\n"
+        "version = 1.2.3.dev0\n"
+    )
+
+    runner = CliRunner()
+    name_result = runner.invoke(
+        cli_mod.cli, ["metadata", "name", "--conf", str(setup_cfg)]
+    )
+    version_result = runner.invoke(
+        cli_mod.cli, ["metadata", "version", "--conf", str(setup_cfg)]
+    )
+
+    assert name_result.exit_code == 0
+    assert name_result.output == "mypkg\n"
+    assert version_result.exit_code == 0
+    assert version_result.output == "1.2.3.dev0\n"
+
+
+def test_metadata_cli_missing_file(tmp_path):
+    missing_cfg = tmp_path / "missing.cfg"
+    runner = CliRunner()
+
+    name_result = runner.invoke(
+        cli_mod.cli, ["metadata", "name", "--conf", str(missing_cfg)]
+    )
+    version_result = runner.invoke(
+        cli_mod.cli, ["metadata", "version", "--conf", str(missing_cfg)]
+    )
+
+    assert name_result.exit_code != 0
+    assert f"Unable to find setup config: {missing_cfg}" in name_result.output
+    assert version_result.exit_code != 0
+    assert f"Unable to find setup config: {missing_cfg}" in version_result.output
+
+
+def test_metadata_cli_missing_fields(tmp_path):
+    no_name_cfg = tmp_path / "setup_no_name.cfg"
+    no_name_cfg.write_text(
+        "[metadata]\n"
+        "version = 2.0.0\n"
+    )
+    no_version_cfg = tmp_path / "setup_no_version.cfg"
+    no_version_cfg.write_text(
+        "[metadata]\n"
+        "name = pkg-without-version\n"
+    )
+
+    runner = CliRunner()
+    missing_name_result = runner.invoke(
+        cli_mod.cli, ["metadata", "name", "--conf", str(no_name_cfg)]
+    )
+    missing_version_result = runner.invoke(
+        cli_mod.cli, ["metadata", "version", "--conf", str(no_version_cfg)]
+    )
+
+    assert missing_name_result.exit_code != 0
+    assert f"Missing [metadata] name in {no_name_cfg}" in missing_name_result.output
+    assert missing_version_result.exit_code != 0
+    assert (
+        f"Missing [metadata] version in {no_version_cfg}"
+        in missing_version_result.output
+    )
+
+
+def test_metadata_cli_malformed_cfg(tmp_path):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata\n"
+        "name = badpkg\n"
+        "version = 0.0.0\n"
+    )
+
+    runner = CliRunner()
+    name_result = runner.invoke(
+        cli_mod.cli, ["metadata", "name", "--conf", str(setup_cfg)]
+    )
+    version_result = runner.invoke(
+        cli_mod.cli, ["metadata", "version", "--conf", str(setup_cfg)]
+    )
+
+    assert name_result.exit_code != 0
+    assert f"Unable to parse setup config: {setup_cfg}" in name_result.output
+    assert version_result.exit_code != 0
+    assert (
+        f"Unable to parse setup config: {setup_cfg}"
+        in version_result.output
+    )

autorelease/tests/test_version.py

@@ -4,7 +4,10 @@
 import os
 
 
-from autorelease.version import _find_rel_path_for_file
+from autorelease.version import (
+    ConfigParserError, _find_rel_path_for_file, get_setup_cfg,
+    get_setup_name, get_setup_version
+)
 
 @pytest.mark.parametrize("depth, result", [
     (0, '.'), (1, '..'), (2, '..' + os.sep + '..'),
@@ -25,3 +28,64 @@ def test_find_rel_path_for_file_finds_no_file():
     with mock.patch('autorelease.version.os.path.isfile', lambda x: False):
         assert _find_rel_path_for_file(-1, 'setup.cfg') is None
 
+
+def test_get_setup_name_and_version(tmp_path):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata]\n"
+        "name = mypkg\n"
+        "version = 1.2.3.dev0\n"
+    )
+    conf = get_setup_cfg(str(tmp_path), "setup.cfg")
+    assert get_setup_name(conf, default_name=None) == "mypkg"
+    assert get_setup_version(conf, default_version=None) == "1.2.3.dev0"
+
+
+def test_get_setup_name_and_version_missing_file(tmp_path):
+    default_name = "default-name"
+    default_version = "0.0.0"
+    conf = get_setup_cfg(str(tmp_path), "setup.cfg")
+    assert get_setup_name(conf, default_name=default_name) == default_name
+    assert get_setup_version(
+        conf, default_version=default_version
+    ) == default_version
+
+
+def test_get_setup_name_and_version_missing_fields(tmp_path):
+    setup_cfg_no_name = tmp_path / "setup_no_name.cfg"
+    setup_cfg_no_name.write_text(
+        "[metadata]\n"
+        "version = 2.0.0\n"
+    )
+    conf_no_name = get_setup_cfg(str(tmp_path), "setup_no_name.cfg")
+    assert get_setup_name(
+        conf_no_name, default_name="default-name"
+    ) == "default-name"
+    assert get_setup_version(
+        conf_no_name, default_version=None
+    ) == "2.0.0"
+
+    setup_cfg_no_version = tmp_path / "setup_no_version.cfg"
+    setup_cfg_no_version.write_text(
+        "[metadata]\n"
+        "name = pkg-without-version\n"
+    )
+    conf_no_version = get_setup_cfg(str(tmp_path), "setup_no_version.cfg")
+    assert get_setup_version(
+        conf_no_version, default_version="0.0.0"
+    ) == "0.0.0"
+    assert get_setup_name(
+        conf_no_version, default_name=None
+    ) == "pkg-without-version"
+
+
+def test_get_setup_name_and_version_malformed_cfg(tmp_path):
+    setup_cfg = tmp_path / "setup.cfg"
+    setup_cfg.write_text(
+        "[metadata\n"
+        "name = badpkg\n"
+        "version = 0.0.0\n"
+    )
+
+    with pytest.raises(ConfigParserError):
+        get_setup_cfg(str(tmp_path), "setup.cfg")