Separate error types on config parsing

Distinguish between missing and malformed; raise different errors

Author: dwhswenson

autorelease/scripts/bump_dev_version.py

@@ -6,7 +6,9 @@
 from packaging.version import Version
 import requests
 from autorelease.utils import split_setup_cfg_path
-from autorelease.version import get_setup_cfg, get_setup_name, get_setup_version
+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'])
@@ -56,7 +58,12 @@ def shared_parser():
 
 def get_version_info(conf_name, index):
     directory, filename = split_setup_cfg_path(conf_name)
-    conf = get_setup_cfg(directory=directory, filename=filename)
+    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}")
 

autorelease/scripts/cli.py

@@ -5,7 +5,9 @@
 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 get_setup_cfg, get_setup_name, get_setup_version
+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
 
@@ -89,7 +91,12 @@ def metadata():
               help="setup.cfg file to use")
 def metadata_version(conf):
     directory, filename = split_setup_cfg_path(conf)
-    setup_cfg = get_setup_cfg(directory=directory, filename=filename)
+    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
     value = get_setup_version(setup_cfg, default_version=None)
     field = "version"
 
@@ -105,7 +112,12 @@ def metadata_version(conf):
               help="setup.cfg file to use")
 def metadata_name(conf):
     directory, filename = split_setup_cfg_path(conf)
-    setup_cfg = get_setup_cfg(directory=directory, filename=filename)
+    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
     value = get_setup_name(setup_cfg, default_name=None)
     field = "name"
 

autorelease/tests/test_bump_dev_version.py

@@ -57,3 +57,17 @@ def unexpected_get_setup_cfg(*args, **kwargs):
     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_version.py

@@ -5,7 +5,8 @@
 
 
 from autorelease.version import (
-    _find_rel_path_for_file, get_setup_cfg, get_setup_name, get_setup_version
+    ConfigParserError, _find_rel_path_for_file, get_setup_cfg,
+    get_setup_name, get_setup_version
 )
 
 @pytest.mark.parametrize("depth, result", [
@@ -86,6 +87,5 @@ def test_get_setup_name_and_version_malformed_cfg(tmp_path):
         "version = 0.0.0\n"
     )
 
-    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="0.0.0") == "0.0.0"
+    with pytest.raises(ConfigParserError):
+        get_setup_cfg(str(tmp_path), "setup.cfg")

autorelease/version.py

@@ -102,6 +102,11 @@ def get_setup_cfg(directory, filename="setup.cfg"):
         directory for setup.cfg, relative to cwd; default '.'
     filename : str
         filename for setup.cfg; default 'setup.cfg'
+
+    Raises
+    ------
+    ConfigParserError
+        if setup.cfg exists but cannot be parsed
     """
     if isinstance(directory, int):
         rel_path = _find_rel_path_for_file(directory, filename)
@@ -113,10 +118,7 @@ def get_setup_cfg(directory, filename="setup.cfg"):
     conf = None
     if os.path.exists(setup_cfg):
         conf = ConfigParser()
-        try:
-            conf.read(setup_cfg)
-        except ConfigParserError:
-            conf = None
+        conf.read(setup_cfg)
 
     return conf