feat: populate library version in config

Author: ohmayr

.generator/cli.py

@@ -186,14 +186,50 @@ def _get_new_library_config(request_data: Dict) -> Dict:
                 return library_config
     return {}
 
+def _get_library_version(library_id: str, repo: str) -> str:
+    """Gets the library version from its gapic_version.py file.
 
-def _prepare_new_library_config(library_config: Dict) -> Dict:
+    Args:
+        library_id(str): The id of the library.
+        repo(str): The path to the repository.
+
+    Returns:
+        str: The version of the library.
+    """
+    library_path = Path(f"{repo}/packages/{library_id}")
+    gapic_version_files = list(library_path.rglob("**/gapic_version.py"))
+    if not gapic_version_files:
+        raise ValueError(f"Could not find gapic_version.py for {library_id}")
+
+    content = _read_text_file(gapic_version_files[0])
+    match = re.search(r"__version__\s*=\s*[\"']([^\"']+)[\"']", content)
+    if not match:
+        raise ValueError(f"Could not extract version from {gapic_version_files[0]}")
+    return match.group(1)
+
+
+def _add_new_library_version(
+    library_config: Dict, library_id: str, repo: str
+) -> None:
+    """Adds the library version to the configuration if it's not present.
+
+    Args:
+        library_config(Dict): The library configuration.
+        library_id(str): The id of the library.
+        repo(str): The path to the repository.
+    """
+    if len(library_config["version"]) == 0:
+        library_config["version"] = _get_library_version(library_id, repo)
+
+
+def _prepare_new_library_config(library_config: Dict, repo: str) -> Dict:
     """
     Prepares the new library's configuration by removing temporary keys and
     adding default values.
 
     Args:
         library_config (Dict): The raw library configuration.
+        repo (str): The path to the repository.
 
     Returns:
         Dict: The prepared library configuration.
@@ -209,6 +245,7 @@ def _prepare_new_library_config(library_config: Dict) -> Dict:
     _add_new_library_preserve_regex(library_config, library_id)
     _add_new_library_remove_regex(library_config, library_id)
     _add_new_library_tag_format(library_config)
+    _add_new_library_version(library_config, library_id, repo)
 
     return library_config
 
@@ -246,7 +283,7 @@ def handle_configure(
         # configure-request.json contains the library definitions.
         request_data = _read_json_file(f"{librarian}/{CONFIGURE_REQUEST_FILE}")
         new_library_config = _get_new_library_config(request_data)
-        prepared_config = _prepare_new_library_config(new_library_config)
+        prepared_config = _prepare_new_library_config(new_library_config, repo)
 
         # Write the new library configuration to configure-response.json.
         _write_json_file(f"{librarian}/configure-response.json", prepared_config)

.generator/test_cli.py

@@ -44,8 +44,10 @@
     _get_library_dist_name,
     _get_library_id,
     _get_libraries_to_prepare_for_release,
+    _get_library_version,
     _get_new_library_config,
     _get_previous_version,
+    _add_new_library_version,
     _prepare_new_library_config,
     _process_changelog,
     _process_version_file,
@@ -171,6 +173,7 @@ def mock_configure_request_data():
             {
                 "id": "google-cloud-language",
                 "apis": [{"path": "google/cloud/language/v1", "status": "new"}],
+                "version": "",
             }
         ]
     }
@@ -317,17 +320,19 @@ def test_get_new_library_config_empty_input():
     assert config == {}
 
 
-def test_prepare_new_library_config():
+def test_prepare_new_library_config(mocker):
     """Tests the preparation of a new library's configuration."""
+    mocker.patch("cli._get_library_version", return_value="1.2.3")
     raw_config = {
         "id": "google-cloud-language",
         "apis": [{"path": "google/cloud/language/v1", "status": "new"}],
         "source_roots": None,
         "preserve_regex": None,
         "remove_regex": None,
+        "version": "",
     }
 
-    prepared_config = _prepare_new_library_config(raw_config)
+    prepared_config = _prepare_new_library_config(raw_config, "repo")
 
     # Check that status is removed
     assert "status" not in prepared_config["apis"][0]
@@ -336,20 +341,23 @@ def test_prepare_new_library_config():
     assert "packages/google-cloud-language/CHANGELOG.md" in prepared_config["preserve_regex"]
     assert prepared_config["remove_regex"] == ["packages/google-cloud-language"]
     assert prepared_config["tag_format"] == "{{id}}-v{{version}}"
+    assert prepared_config["version"] == "1.2.3"
 
 
-def test_prepare_new_library_config_preserves_existing_values():
+def test_prepare_new_library_config_preserves_existing_values(mocker):
     """Tests that existing values in the config are not overwritten."""
+    mocker.patch("cli._get_library_version", return_value="1.2.3")
     raw_config = {
         "id": "google-cloud-language",
         "apis": [{"path": "google/cloud/language/v1", "status": "new"}],
         "source_roots": ["packages/google-cloud-language-custom"],
         "preserve_regex": ["custom/regex"],
         "remove_regex": ["custom/remove"],
         "tag_format": "custom-format-{{version}}",
+        "version": "4.5.6",
     }
 
-    prepared_config = _prepare_new_library_config(raw_config)
+    prepared_config = _prepare_new_library_config(raw_config, "repo")
 
     # Check that status is removed
     assert "status" not in prepared_config["apis"][0]
@@ -358,6 +366,60 @@ def test_prepare_new_library_config_preserves_existing_values():
     assert prepared_config["preserve_regex"] == ["custom/regex"]
     assert prepared_config["remove_regex"] == ["custom/remove"]
     assert prepared_config["tag_format"] == "custom-format-{{version}}"
+    assert prepared_config["version"] == "4.5.6"
+
+
+def test_get_library_version_success(mocker):
+    """Tests successful extraction of a version from a file."""
+    mock_rglob = mocker.patch(
+        "pathlib.Path.rglob", return_value=[pathlib.Path("repo/gapic_version.py")]
+    )
+    mocker.patch("cli._read_text_file", return_value='__version__ = "1.2.3"')
+    version = _get_library_version("google-cloud-language", "repo")
+    assert version == "1.2.3"
+    mock_rglob.assert_called_once_with("**/gapic_version.py")
+
+
+def test_get_library_version_no_file(mocker):
+    """Tests failure when gapic_version.py is not found."""
+    mocker.patch("pathlib.Path.rglob", return_value=[])
+    with pytest.raises(ValueError, match="Could not find gapic_version.py"):
+        _get_library_version("google-cloud-language", "repo")
+
+
+def test_get_library_version_no_version_in_file(mocker):
+    """Tests failure when the version string is not in the file."""
+    mocker.patch(
+        "pathlib.Path.rglob", return_value=[pathlib.Path("repo/gapic_version.py")]
+    )
+    mocker.patch("cli._read_text_file", return_value="some_other_content = 'foo'")
+    with pytest.raises(ValueError, match="Could not extract version"):
+        _get_library_version("google-cloud-language", "repo")
+
+
+def test_add_new_library_version_populates_version(mocker):
+    """Tests that the version is populated if it's missing."""
+    mock_get_version = mocker.patch("cli._get_library_version", return_value="1.2.3")
+    config = {"version": ""}
+    _add_new_library_version(config, "google-cloud-language", "repo")
+    assert config["version"] == "1.2.3"
+    mock_get_version.assert_called_once_with("google-cloud-language", "repo")
+
+
+def test_add_new_library_version_preserves_version():
+    """Tests that an existing version is preserved."""
+    config = {"version": "4.5.6"}
+    _add_new_library_version(config, "google-cloud-language", "repo")
+    assert config["version"] == "4.5.6"
+
+
+def test_add_new_library_version_populates_missing_key(mocker):
+    """Tests that the version is populated if the key is missing."""
+    mock_get_version = mocker.patch("cli._get_library_version", return_value="1.2.3")
+    config = {}  # No 'version' key
+    _add_new_library_version(config, "google-cloud-language", "repo")
+    assert config["version"] == "1.2.3"
+    mock_get_version.assert_called_once_with("google-cloud-language", "repo")
 
 
 def test_get_library_id_success():