add test coverage

Author: ohmayr

.generator/cli.py

@@ -25,7 +25,7 @@
 import yaml
 from datetime import datetime
 from pathlib import Path
-from typing import Dict, List
+from typing import Dict, List, Optional
 from distutils.core import run_setup
 
 import tomli
@@ -549,25 +549,78 @@ def _verify_library_namespace(library_id: str, repo: str):
             )
 
 
-def _get_setup_dist_name(library_id: str, repo: str):
+def _get_setup_dist_name(library_id: str, repo: str) -> Optional[str]:
+    """Gets the library distribution name from a `setup.py` file.
+
+    Tries to execute `run_setup` on the file and extract the 'name'
+    property. Logs and returns None on any exception.
+
+    Args:
+        library_id(str): id of the library.
+        repo(str): This directory will contain all directories that make up a
+            library, the .librarian folder, and any global file declared in
+            the config.yaml.
+
+    Returns:
+        Optional[str]: The library distribution name if found and parsed, otherwise None.
+    """
     try:
         dist = run_setup(f"{repo}/packages/{library_id}/setup.py")
         return dist.get_name()
     except Exception as e:
+        logger.debug(
+            f"failed to get distribution name for `{library_id}` from `setup.py` : {e}",
+            exc_info=True,
+        )
         return None
 
 
-def _get_toml_dist_name(library_id: str, repo: str):
+def _get_toml_dist_name(library_id: str, repo: str) -> Optional[str]:
+    """Gets the library distribution name from a `pyproject.toml` file.
+
+    Parses the TOML file and safely accesses the name from the
+    [project] table using `.get()`. Logs and returns None on any
+    exception (e.g., FileNotFoundError, TOMLDecodeError).
+
+    Args:
+        library_id(str): id of the library.
+        repo(str): This directory will contain all directories that make up a
+            library, the .librarian folder, and any global file declared in
+            the config.yaml.
+
+    Returns:
+        Optional[str]: The library distribution name if found and parsed, otherwise None.
+    """
     try:
         pyproject_toml_file = Path(f"{repo}/packages/{library_id}/pyproject.toml")
         with open(pyproject_toml_file, "rb") as f:
             data = tomli.load(f)
             return data.get("project", {}).get("name")
     except Exception as e:
+        logger.debug(
+            f"failed to get distribution name for `{library_id}` from `pyproject.toml` : {e}",
+            exc_info=True,
+        )
         return None
 
 
 def _verify_library_dist_name(library_id: str, repo: str):
+    """Verifies the library distribution name against its config files.
+
+    This function ensures that:
+    1. At least one of `setup.py` or `pyproject.toml` exists and is valid.
+    2. Any existing config file's 'name' property matches the `library_id`.
+
+    Args:
+        library_id: id of the library.
+        repo: This directory will contain all directories that make up a
+            library, the .librarian folder, and any global file declared in
+            the config.yaml.
+
+    Raises:
+        ValueError: If no valid config file is found, or if a name
+            in an existing file does not match the `library_id`.
+    """
     setup_dist_name = _get_setup_dist_name(library_id, repo)
     toml_dist_name = _get_toml_dist_name(library_id, repo)
     if setup_dist_name is None and toml_dist_name is None:

.generator/requirements-test.in

@@ -17,3 +17,5 @@ pytest-cov
 pytest-mock
 gcp-synthtool @ git+https://github.com/googleapis/synthtool@5aa438a342707842d11fbbb302c6277fbf9e4655
 starlark-pyo3>=2025.1
+# TODO(https://github.com/googleapis/google-cloud-python/issues/14443): tomli is part of the standard library for Python 3.11. Remove once we use 3.11+ for librarian.
+tomli

.generator/test_cli.py

@@ -41,6 +41,8 @@
     _get_library_id,
     _get_libraries_to_prepare_for_release,
     _get_previous_version,
+    _get_setup_dist_name,
+    _get_toml_dist_name,
     _locate_and_extract_artifact,
     _process_changelog,
     _process_version_file,
@@ -52,6 +54,7 @@
     _update_changelog_for_library,
     _update_global_changelog,
     _update_version_for_library,
+    _verify_library_dist_name,
     _verify_library_namespace,
     _write_json_file,
     _write_text_file,
@@ -525,7 +528,8 @@ def test_handle_build_success(caplog, mocker, mock_build_request_file):
     caplog.set_level(logging.INFO)
 
     mocker.patch("cli._run_nox_sessions")
-    mocker.patch("cli._verify_library_namespace", return_value=True)
+    mocker.patch("cli._verify_library_namespace")
+    mocker.patch("cli._verify_library_dist_name")
     handle_build()
 
     assert "'build' command executed." in caplog.text
@@ -922,6 +926,70 @@ def test_determine_library_namespace_fails_not_subpath():
         _determine_library_namespace(gapic_parent_path, pkg_root_path)
 
 
+def test_get_setup_dist_name_exists(mocker):
+    """Tests that a valid library distribution name exists in `pyproject.toml`."""
+    mock_dist = MagicMock()
+    mock_dist.get_name.return_value = "my-lib"
+    mocker.patch("cli.run_setup", return_value=mock_dist)
+    assert _get_setup_dist_name("my-lib", "repo") == "my-lib"
+
+
+def test_get_setup_dist_name_file_not_found(caplog):
+    """Tests that distribution name is None if `setup.py` does not exist."""
+    caplog.set_level(logging.DEBUG)
+    assert _get_setup_dist_name("my-lib", "repo") is None
+    assert len(caplog.records) == 1
+
+
+def test_get_toml_dist_name_exists(mocker):
+    """Tests that a valid library distribution name exists in `pyproject.toml`."""
+    mock_data = {"project": {"name": "my-lib"}}
+    mocker.patch("tomli.load", return_value=mock_data)
+    mocker.patch("builtins.open", mocker.mock_open(read_data=b"fake toml data"))
+    assert _get_toml_dist_name("my-lib", "repo") == "my-lib"
+
+
+def test_get_toml_dist_name_file_not_found(caplog):
+    """Tests that distribution name is None if `pyproject.toml` does not exist."""
+    caplog.set_level(logging.DEBUG)
+    assert _get_toml_dist_name("my-lib", "repo") is None
+    assert len(caplog.records) == 1
+
+
+def test_verify_library_dist_name_setup_success(mocker):
+    """Tests success when a library distribution name in setup.py is valid."""
+    mock_setup_file = mocker.patch("cli._get_setup_dist_name", return_value="my-lib")
+    _verify_library_dist_name("my-lib", "repo")
+    mock_setup_file.assert_called_once_with("my-lib", "repo")
+
+
+def test_verify_library_dist_name_setup_success(mocker):
+    """Tests success when a library distribution name in toml is valid."""
+    mock_toml_file = mocker.patch("cli._get_toml_dist_name", return_value="my-lib")
+    _verify_library_dist_name("my-lib", "repo")
+    mock_toml_file.assert_called_once_with("my-lib", "repo")
+
+
+def test_verify_library_dist_name_fail():
+    """Tests failure when a library does not have a `setup.py` or `pyproject.toml`."""
+    with pytest.raises(ValueError):
+        _verify_library_dist_name("my-lib", "repo")
+
+
+def test_verify_library_dist_name_setup_fail(mocker):
+    """Tests failure when a library has an invalid distribution name in `setup.py`."""
+    mocker.patch("cli._get_setup_dist_name", return_value="invalid-lib-name")
+    with pytest.raises(ValueError):
+        _verify_library_dist_name("my-lib", "repo")
+
+
+def test_verify_library_dist_name_toml_fail(mocker):
+    """Tests failure when a library has an invalid distribution name in `pyproject.toml`."""
+    mocker.patch("cli._get_toml_dist_name", return_value="invalid-lib-name")
+    with pytest.raises(ValueError):
+        _verify_library_dist_name("my-lib", "repo")
+
+
 def test_verify_library_namespace_success_valid(mocker, mock_path_class):
     """Tests success when a single valid namespace is found."""
     # 1. Get the mock instance from the mock class's return_value