default to mono repo

Author: ohmayr

.generator/cli.py

@@ -25,6 +25,7 @@
 import tempfile
 import yaml
 from datetime import date, datetime
+from functools import lru_cache
 from pathlib import Path
 from typing import Dict, List
 import build.util
@@ -493,18 +494,49 @@ def _create_repo_metadata_from_service_config(
         "api_shortname": api_shortname,
     }
 
-def _get_repo_metadata_file_path(output: str, library_id: str, is_mono_repo: bool):
+
+def _get_repo_metadata_file_path(base: str, library_id: str, is_mono_repo: bool):
+    """Constructs the full path to the .repo-metadata.json file.
+
+    Args:
+        base (str): The base directory where the library is located.
+        library_id (str): The ID of the library.
+        is_mono_repo (bool): True if the current repository is a mono-repo.
+
+    Returns:
+        str: The absolute path to the .repo-metadata.json file.
+    """
     path_to_library = f"packages/{library_id}" if is_mono_repo else "."
-    return f"{output}/{path_to_library}/.repo-metadata.json"
+    return f"{base}/{path_to_library}/.repo-metadata.json"
+
+
+@lru_cache(maxsize=None)
+def _get_repo_name_from_repo_metadata(base: str, library_id: str, is_mono_repo: bool):
+    """Retrieves the repository name from the .repo-metadata.json file.
+
+    This function is cached to avoid redundant file I/O.
 
-def _get_repo_name_from_repo_metadata(output: str, library_id: str, is_mono_repo: bool):
-    file_path = _get_repo_metadata_file_path(output, library_id, is_mono_repo)
+    Args:
+        base (str): The base directory where the library is located.
+        library_id (str): The ID of the library.
+        is_mono_repo (bool): True if the current repository is a mono-repo.
+
+    Returns:
+        str: The name of the repository (e.g., 'googleapis/google-cloud-python').
+
+    Raises:
+        ValueError: If the '.repo-metadata.json' file is missing the 'repo' field.
+    """
+    if is_mono_repo:
+        return "google-cloud-python"
+    file_path = _get_repo_metadata_file_path(base, library_id, is_mono_repo)
     repo_metadata = _read_json_file(file_path)
     repo_name = repo_metadata.get("repo")
     if not repo_name:
         raise ValueError("`.repo-metadata.json` file is missing required 'repo' field.")
     return repo_name
 
+
 def _generate_repo_metadata_file(
     output: str, library_id: str, source: str, apis: List[Dict], is_mono_repo: bool
 ):
@@ -518,7 +550,9 @@ def _generate_repo_metadata_file(
         is_mono_repo(bool): True if the current repository is a mono-repo.
     """
     path_to_library = f"packages/{library_id}" if is_mono_repo else "."
-    output_repo_metadata = _get_repo_metadata_file_path(output, library_id, is_mono_repo)
+    output_repo_metadata = _get_repo_metadata_file_path(
+        output, library_id, is_mono_repo
+    )
 
     # TODO(https://github.com/googleapis/librarian/issues/2334)): If `.repo-metadata.json`
     # already exists in the `output` dir, then this means that it has been successfully copied
@@ -1053,7 +1087,11 @@ def _verify_library_namespace(library_id: str, repo: str, is_mono_repo: bool):
         # Exclude proto paths which are not intended to be used for code generation.
         # Generally any protos under the `samples` or `tests` directories or in a
         # directory called `proto` are not used for code generation.
-        if proto_path.startswith("tests") or proto_path.startswith("samples") or proto_path.endswith("proto"):
+        if (
+            proto_path.startswith("tests")
+            or proto_path.startswith("samples")
+            or proto_path.endswith("proto")
+        ):
             continue
         relevant_dirs.add(proto_file.parent)
 
@@ -1344,7 +1382,7 @@ def _process_changelog(
     version: str,
     previous_version: str,
     library_id: str,
-    repo_name: str
+    repo_name: str,
 ):
     """This function searches the given content for the anchor pattern
     `[1]: https://pypi.org/project/{library_id}/#history`
@@ -1372,7 +1410,10 @@ def _process_changelog(
     entry_parts = []
     entry_parts.append(
         _create_main_version_header(
-            version=version, previous_version=previous_version, library_id=library_id, repo_name=repo_name
+            version=version,
+            previous_version=previous_version,
+            library_id=library_id,
+            repo_name=repo_name,
         )
     )
 
@@ -1444,7 +1485,7 @@ def _update_changelog_for_library(
 
     changelog_src = f"{repo}/{relative_path}"
     changelog_dest = f"{output}/{relative_path}"
-    repo_name = _get_repo_name_from_repo_metadata(output, library_id, is_mono_repo)
+    repo_name = _get_repo_name_from_repo_metadata(repo, library_id, is_mono_repo)
     updated_content = _process_changelog(
         _read_text_file(changelog_src),
         library_changes,

.generator/test_cli.py

@@ -49,6 +49,7 @@
     _get_libraries_to_prepare_for_release,
     _get_new_library_config,
     _get_previous_version,
+    _get_repo_name_from_repo_metadata,
     _get_staging_child_directory,
     _add_new_library_version,
     _prepare_new_library_config,
@@ -141,6 +142,13 @@
 )"""
 
 
+@pytest.fixture(autouse=True)
+def _clear_lru_cache():
+    """Automatically clears the cache of all LRU-cached functions after each test."""
+    yield
+    _get_repo_name_from_repo_metadata.cache_clear()
+
+
 @pytest.fixture
 def mock_generate_request_file(tmp_path, monkeypatch):
     """Creates the mock request file at the correct path inside a temp dir."""
@@ -1265,6 +1273,9 @@ def test_update_changelog_for_library_single_repo(mocker):
     mock_read = mocker.patch("cli._read_text_file", return_value=mock_content)
     mock_write = mocker.patch("cli._write_text_file")
     mock_path_exists = mocker.patch("cli.os.path.lexists", return_value=True)
+    mocker.patch(
+        "cli._get_repo_name_from_repo_metadata", return_value="google-cloud-python"
+    )
     _update_changelog_for_library(
         "repo",
         "output",
@@ -1300,15 +1311,20 @@ def test_process_changelog_success():
     library_id = "google-cloud-language"
 
     result = _process_changelog(
-        mock_content, _MOCK_LIBRARY_CHANGES, version, previous_version, library_id
+        mock_content,
+        _MOCK_LIBRARY_CHANGES,
+        version,
+        previous_version,
+        library_id,
+        "google-cloud-python",
     )
     assert result == expected_result
 
 
 def test_process_changelog_failure():
     """Tests that value error is raised if the changelog anchor string cannot be found"""
     with pytest.raises(ValueError):
-        _process_changelog("", [], "", "", "")
+        _process_changelog("", [], "", "", "", "google-cloud-python")
 
 
 def test_update_changelog_for_library_failure(mocker):
@@ -1351,7 +1367,9 @@ def test_create_main_version_header():
     previous_version = "1.2.2"
     version = "1.2.3"
     library_id = "google-cloud-language"
-    actual_header = _create_main_version_header(version, previous_version, library_id)
+    actual_header = _create_main_version_header(
+        version, previous_version, library_id, "google-cloud-python"
+    )
     assert actual_header == expected_header
 
 
@@ -1885,3 +1903,19 @@ def test_copy_readme_to_docs_source_not_exists(mocker, is_mono_repo):
     mock_os_remove.assert_not_called()
     mock_makedirs.assert_not_called()
     mock_shutil_copy.assert_not_called()
+
+
+def test_get_repo_name_from_repo_metadata_success(mocker):
+    """Tests that the repo name is returned when it exists."""
+    mocker.patch(
+        "cli._read_json_file", return_value={"repo": "googleapis/google-cloud-python"}
+    )
+    repo_name = _get_repo_name_from_repo_metadata("base", "library_id", False)
+    assert repo_name == "googleapis/google-cloud-python"
+
+
+def test_get_repo_name_from_repo_metadata_missing_repo(mocker):
+    """Tests that a ValueError is raised when the repo field is missing."""
+    mocker.patch("cli._read_json_file", return_value={})
+    with pytest.raises(ValueError):
+        _get_repo_name_from_repo_metadata("base", "library_id", False)