chore: add ability to update library specific version files in release-init (googleapis#14350)

parthea · web-flow · commit d5df127ea0e7 · 2025-09-05T10:14:38.000-04:00
This PR builds on top of googleapis#14349 and adds the ability to update the client library version in client library version files using the `librarian release init` command such as - [gapic_version.py](https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-language/google/cloud/language_v1/gapic_version.py) - [snippet_metadata*.json](https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-language/samples/generated_samples/snippet_metadata_google.cloud.language.v2.json) Towards googleapis/librarian#886
diff --git a/.generator/cli.py b/.generator/cli.py
@@ -91,6 +91,19 @@ def _read_json_file(path: str) -> Dict:
         return json.load(f)
 
 
+def _write_json_file(path: str, updated_content: Dict):
+    """Helper function that writes a json file with the given dictionary.
+
+    Args:
+        path(str): The file path to write.
+        updated_content(Dict): The dictionary to write.
+    """
+
+    with open(path, "w") as f:
+        json.dump(updated_content, f, indent=2)
+        f.write("\n")
+
+
 def handle_configure():
     # TODO(https://github.com/googleapis/librarian/issues/466): Implement configure command and update docstring.
     logger.info("'configure' command executed.")
@@ -472,7 +485,9 @@ def _get_libraries_to_prepare_for_release(library_entries: Dict) -> List[dict]:
     ]
 
 
-def _update_global_changelog(changelog_src: str, changelog_dest: str, all_libraries: List[dict]):
+def _update_global_changelog(
+    changelog_src: str, changelog_dest: str, all_libraries: List[dict]
+):
     """Updates the versions of libraries in the main CHANGELOG.md.
 
     Args:
@@ -498,6 +513,71 @@ def replace_version_in_changelog(content):
     _write_text_file(changelog_dest, updated_content)
 
 
+def _process_version_file(content, version, version_path) -> str:
+    """This function searches for a version string in the
+    given content, replaces the version and returns the content.
+
+    Args:
+        content(str): The contents where the version string should be replaced.
+        version(str): The new version of the library.
+        version_path(str): The relative path to the version file
+
+    Raises: ValueError if the version string could not be found in the given content
+
+    Returns: A string with the modified content.
+    """
+    pattern = r"(__version__\s*=\s*[\"'])([^\"']+)([\"'].*)"
+    replacement_string = f"\\g<1>{version}\\g<3>"
+    new_content, num_replacements = re.subn(pattern, replacement_string, content)
+    if num_replacements == 0:
+        raise ValueError(
+            f"Could not find version string in {version_path}. File was not modified."
+        )
+    return new_content
+
+
+def _update_version_for_library(
+    repo: str, output: str, path_to_library: str, version: str
+):
+    """Updates the version string in `**/gapic_version.py` and `samples/**/snippet_metadata.json`
+        for a given library.
+
+    Args:
+        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.
+        output(str): Path to the directory in the container where modified
+            code should be placed.
+        path_to_library(str): Relative path to the library to update
+        version(str): The new version of the library
+
+    Raises: `ValueError` if a version string could not be located in `**/gapic_version.py`
+        within the given library.
+    """
+
+    # Find and update gapic_version.py files
+    gapic_version_files = Path(f"{repo}/{path_to_library}").rglob("**/gapic_version.py")
+    for version_file in gapic_version_files:
+        updated_content = _process_version_file(
+            _read_text_file(version_file), version, version_file
+        )
+        output_path = f"{output}/{version_file.relative_to(repo)}"
+        _write_text_file(output_path, updated_content)
+
+    # Find and update snippet_metadata.json files
+    snippet_metadata_files = Path(f"{repo}/{path_to_library}").rglob(
+        "samples/**/*.json"
+    )
+    for metadata_file in snippet_metadata_files:
+        output_path = f"{output}/{metadata_file.relative_to(repo)}"
+        os.makedirs(Path(output_path).parent, exist_ok=True)
+        shutil.copy(metadata_file, output_path)
+
+        metadata_contents = _read_json_file(metadata_file)
+        metadata_contents["clientLibrary"]["version"] = version
+        _write_json_file(output_path, metadata_contents)
+
+
 def handle_release_init(
     librarian: str = LIBRARIAN_DIR, repo: str = REPO_DIR, output: str = OUTPUT_DIR
 ):
@@ -536,7 +616,11 @@ def handle_release_init(
         # Prepare the release for each library by updating the
         # library specific version files and library specific changelog.
         for library_release_data in libraries_to_prep_for_release:
-            # TODO(https://github.com/googleapis/google-cloud-python/pull/14350):
+            version = library_release_data["version"]
+            package_name = library_release_data["id"]
+            path_to_library = f"packages/{package_name}"
+            _update_version_for_library(repo, output, path_to_library, version)
+
             # Update library specific version files.
             # TODO(https://github.com/googleapis/google-cloud-python/pull/14353):
             # Conditionally update the library specific CHANGELOG if there is a change.
diff --git a/.generator/test_cli.py b/.generator/test_cli.py
@@ -15,12 +15,12 @@
 import json
 import logging
 import os
+import pathlib
 import subprocess
 import unittest.mock
 from unittest.mock import MagicMock, mock_open
 
 import pytest
-
 from cli import (
     GENERATE_REQUEST_FILE,
     BUILD_REQUEST_FILE,
@@ -34,12 +34,15 @@
     _get_library_id,
     _get_libraries_to_prepare_for_release,
     _locate_and_extract_artifact,
+    _process_version_file,
     _read_json_file,
     _read_text_file,
     _run_individual_session,
     _run_nox_sessions,
     _run_post_processor,
     _update_global_changelog,
+    _update_version_for_library,
+    _write_json_file,
     _write_text_file,
     handle_build,
     handle_configure,
@@ -514,6 +517,7 @@ def test_handle_release_init_success(mocker, mock_release_init_request_file):
     Simply tests that `handle_release_init` runs without errors.
     """
     mocker.patch("cli._update_global_changelog", return_value=None)
+    mocker.patch("cli._update_version_for_library", return_value=None)
     handle_release_init()
 
 
@@ -554,6 +558,31 @@ def test_write_text_file():
         handle.write.assert_called_once_with("modified content")
 
 
+def test_write_json_file():
+    """Tests writing a json file.
+    See https://docs.python.org/3/library/unittest.mock.html#mock-open
+    """
+    m = mock_open()
+
+    expected_dict = {"name": "call me json"}
+
+    with unittest.mock.patch("cli.open", m):
+        _write_json_file("fake_path.json", expected_dict)
+
+        handle = m()
+        # Get all the arguments passed to the mock's write method
+        # and join them into a single string.
+        written_content = "".join(
+            [call.args[0] for call in handle.write.call_args_list]
+        )
+
+        # Create the expected output string with the correct formatting.
+        expected_output = json.dumps(expected_dict, indent=2) + "\n"
+
+        # Assert that the content written to the mock file matches the expected output.
+        assert written_content == expected_output
+
+
 def test_update_global_changelog(mocker, mock_release_init_request_file):
     """Tests that the global changelog is updated
     with the new version for a given library.
@@ -571,3 +600,66 @@ def test_update_global_changelog(mocker, mock_release_init_request_file):
 
         handle = m()
         handle.write.assert_called_once_with("[google-cloud-language==1.2.3]")
+
+
+def test_update_version_for_library_success(mocker):
+    m = mock_open()
+
+    mock_rglob = mocker.patch(
+        "pathlib.Path.rglob", return_value=[pathlib.Path("repo/gapic_version.py")]
+    )
+    mock_shutil_copy = mocker.patch("shutil.copy")
+    mock_content = '__version__ = "1.2.2"'
+    mock_json_metadata = {"clientLibrary": {"version": "0.1.0"}}
+
+    with unittest.mock.patch("cli.open", m):
+        mocker.patch("cli._read_text_file", return_value=mock_content)
+        mocker.patch("cli._read_json_file", return_value=mock_json_metadata)
+        _update_version_for_library(
+            "repo", "output", "packages/google-cloud-language", "1.2.3"
+        )
+
+        handle = m()
+        assert handle.write.call_args_list[0].args[0] == '__version__ = "1.2.3"'
+
+        # Get all the arguments passed to the mock's write method
+        # and join them into a single string.
+        written_content = "".join(
+            [call.args[0] for call in handle.write.call_args_list[1:]]
+        )
+        # Create the expected output string with the correct formatting.
+        assert (
+            written_content
+            == '{\n  "clientLibrary": {\n    "version": "1.2.3"\n  }\n}\n'
+        )
+
+
+def test_update_version_for_library_failure(mocker):
+    """Tests that value error is raised if the version string cannot be found"""
+    m = mock_open()
+
+    mock_rglob = mocker.patch(
+        "pathlib.Path.rglob", return_value=[pathlib.Path("repo/gapic_version.py")]
+    )
+    mock_content = "not found"
+    with pytest.raises(ValueError):
+        with unittest.mock.patch("cli.open", m):
+            mocker.patch("cli._read_text_file", return_value=mock_content)
+            _update_version_for_library(
+                "repo", "output", "packages/google-cloud-language", "1.2.3"
+            )
+
+
+def test_process_version_file_success():
+    version_file_contents = '__version__ = "1.2.2"'
+    new_version = "1.2.3"
+    modified_content = _process_version_file(
+        version_file_contents, new_version, "file.txt"
+    )
+    assert modified_content == f'__version__ = "{new_version}"'
+
+
+def test_process_version_file_failure():
+    """Tests that value error is raised if the version string cannot be found"""
+    with pytest.raises(ValueError):
+        _process_version_file("", "", "")
