prepare new library config

Author: ohmayr

.generator/cli.py

@@ -114,31 +114,103 @@ def _write_json_file(path: str, updated_content: Dict):
     with open(path, "w") as f:
         json.dump(updated_content, f, indent=2)
         f.write("\n")
- 
+
+def _add_new_library_source_roots(library_config: Dict, library_id: str) -> None:
+    """Adds the default source_roots to the library configuration if not present.
+
+    Args:
+        library_config(Dict): The library configuration.
+        library_id(str): The id of the library.
+    """
+    if library_config["source_roots"] is None:
+        library_config["source_roots"] = [f"packages/{library_id}"]
+
+
+def _add_new_library_preserve_regex(library_config: Dict, library_id: str) -> None:
+    """Adds the default preserve_regex to the library configuration if not present.
+
+    Args:
+        library_config(Dict): The library configuration.
+        library_id(str): The id of the library.
+    """
+    if library_config["preserve_regex"] is None:
+        library_config["preserve_regex"] = [
+            f"packages/{library_id}/CHANGELOG.md",
+            "docs/CHANGELOG.md",
+            "docs/README.rst",
+            "samples/README.txt",
+            "tar.gz",
+            "gapic_version.py",
+            "scripts/client-post-processing",
+            "samples/snippets/README.rst",
+            "tests/system",
+        ]
+
+
+def _add_new_library_remove_regex(library_config: Dict, library_id: str) -> None:
+    """Adds the default remove_regex to the library configuration if not present.
+
+    Args:
+        library_config(Dict): The library configuration.
+        library_id(str): The id of the library.
+    """
+    if library_config["remove_regex"] is None:
+        library_config["remove_regex"] = [f"packages/{library_id}"]
+
+
+def _add_new_library_tag_format(library_config: Dict) -> None:
+    """Adds the default tag_format to the library configuration if not present.
+
+    Args:
+        library_config(Dict): The library configuration.
+    """
+    if "tag_format" not in library_config:
+        library_config["tag_format"] = "{{id}}-v{{version}}"
+
+
 def _get_new_library_config(request_data: Dict) -> Dict:
-    """Returns the configuration for a new library.
+    """Finds and returns the configuration for a new library.
 
     Args:
         request_data(Dict): The request data from which to extract the new
         library config.
 
     Returns:
-        Dict: The configuration of a new library.
+        Dict: The unmodified configuration of a new library, or an empty
+        dictionary if not found.
     """
-    new_library_config = {}
     for library_config in request_data.get("libraries", []):
         all_apis = library_config.get("apis", [])
         for api in all_apis:
             if api.get("status") == "new":
-                new_library_config = library_config
-                break
-    
+                return library_config
+    return {}
+
+
+def _prepare_new_library_config(library_config: Dict) -> Dict:
+    """
+    Prepares the new library's configuration by removing temporary keys and
+    adding default values.
+
+    Args:
+        library_config (Dict): The raw library configuration.
+
+    Returns:
+        Dict: The prepared library configuration.
+    """
     # remove status key from new library config.
-    all_apis = new_library_config.get("apis", [])
+    all_apis = library_config.get("apis", [])
     for api in all_apis:
-        del api["status"]
-    
-    return new_library_config
+        if "status" in api:
+            del api["status"]
+
+    library_id = _get_library_id(library_config)
+    _add_new_library_source_roots(library_config, library_id)
+    _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)
+
+    return library_config
 
 
 def handle_configure(
@@ -174,9 +246,10 @@ 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)
 
         # Write the new library configuration to configure-response.json.
-        _write_json_file(f"{librarian}/configure-response.json", new_library_config)
+        _write_json_file(f"{librarian}/configure-response.json", prepared_config)
 
     except Exception as e:
         raise ValueError("Configuring a new library failed.") from e

.generator/test_cli.py

@@ -46,6 +46,7 @@
     _get_libraries_to_prepare_for_release,
     _get_new_library_config,
     _get_previous_version,
+    _prepare_new_library_config,
     _process_changelog,
     _process_version_file,
     _read_bazel_build_py_rule,
@@ -267,36 +268,39 @@ def mock_state_file(tmp_path, monkeypatch):
     return request_file
 
 
-def test_handle_configure(mock_configure_request_file, mocker):
+def test_handle_configure_success(mock_configure_request_file, mocker):
     """Tests the successful execution path of handle_configure."""
     mock_write_json = mocker.patch("cli._write_json_file")
+    mock_prepare_config = mocker.patch(
+        "cli._prepare_new_library_config", return_value={"id": "prepared"}
+    )
 
     handle_configure()
 
-    # Verify that the correct configuration is written to the response file.
-    expected_config = {
-        "id": "google-cloud-language",
-        "apis": [{"path": "google/cloud/language/v1"}],
-    }
+    mock_prepare_config.assert_called_once()
     mock_write_json.assert_called_once_with(
-        f"{LIBRARIAN_DIR}/configure-response.json", expected_config
+        f"{LIBRARIAN_DIR}/configure-response.json", {"id": "prepared"}
     )
 
 
-def test_handle_configure_failure(mocker):
-    """Tests that handle_configure raises ValueError on failure."""
+def test_handle_configure_no_new_library(mocker):
+    """Tests that handle_configure fails if no new library is found."""
+    mocker.patch("cli._read_json_file", return_value={"libraries": []})
+    # The call to _prepare_new_library_config with an empty dict will raise a ValueError
+    # because _get_library_id will fail.
     with pytest.raises(ValueError, match="Configuring a new library failed."):
         handle_configure()
 
 
-def test_get_new_library_config_new_library_found(mock_configure_request_data):
+def test_get_new_library_config_found(mock_configure_request_data):
     """Tests that the new library configuration is returned when found."""
     config = _get_new_library_config(mock_configure_request_data)
     assert config["id"] == "google-cloud-language"
-    assert "status" not in config["apis"][0]
+    # Assert that the config is NOT modified
+    assert "status" in config["apis"][0]
 
 
-def test_get_new_library_config_no_new_library():
+def test_get_new_library_config_not_found():
     """Tests that an empty dictionary is returned when no new library is found."""
     request_data = {
         "libraries": [
@@ -313,6 +317,49 @@ def test_get_new_library_config_empty_input():
     assert config == {}
 
 
+def test_prepare_new_library_config():
+    """Tests the preparation of a new library's configuration."""
+    raw_config = {
+        "id": "google-cloud-language",
+        "apis": [{"path": "google/cloud/language/v1", "status": "new"}],
+        "source_roots": None,
+        "preserve_regex": None,
+        "remove_regex": None,
+    }
+
+    prepared_config = _prepare_new_library_config(raw_config)
+
+    # Check that status is removed
+    assert "status" not in prepared_config["apis"][0]
+    # Check that defaults are added
+    assert prepared_config["source_roots"] == ["packages/google-cloud-language"]
+    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}}"
+
+
+def test_prepare_new_library_config_preserves_existing_values():
+    """Tests that existing values in the config are not overwritten."""
+    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}}",
+    }
+
+    prepared_config = _prepare_new_library_config(raw_config)
+
+    # Check that status is removed
+    assert "status" not in prepared_config["apis"][0]
+    # Check that existing values are preserved
+    assert prepared_config["source_roots"] == ["packages/google-cloud-language-custom"]
+    assert prepared_config["preserve_regex"] == ["custom/regex"]
+    assert prepared_config["remove_regex"] == ["custom/remove"]
+    assert prepared_config["tag_format"] == "custom-format-{{version}}"
+
+
 def test_get_library_id_success():
     """Tests that _get_library_id returns the correct ID when present."""
     request_data = {"id": "test-library", "name": "Test Library"}