feat: create repo-metadata during generation

Author: ohmayr

.generator/cli.py

@@ -360,6 +360,68 @@ def _clean_up_files_after_post_processing(output: str, library_id: str):
     ):  # pragma: NO COVER
         os.remove(gapic_version_file)
 
+def _create_repo_metadata_from_service_config(
+    service_config_name: str, api_path: str, source: str, library_id: str
+) -> Dict:
+    """Creates the .repo-metadata.json content from the service config.
+
+    Args:
+        service_config_name (str): The name of the service config file.
+        api_path (str): The path to the API.
+        source (str): The path to the source directory.
+        library_id (str): The ID of the library.
+
+    Returns:
+        Dict: The content of the .repo-metadata.json file.
+    """
+    full_service_config_path = f"{source}/{api_path}/{service_config_name}"
+
+    # TODO(ohmayr): Read the api service config to backfill .repo-metadata.json
+    return {
+        "api_shortname": "",
+        "name_pretty": "",
+        "product_documentation": "",
+        "api_description": "",
+        "client_documentation": "",
+        "issue_tracker": "",
+        "release_level": "",
+        "language": "python",
+        "library_type": "GAPIC_AUTO",
+        "repo": "googleapis/google-cloud-python",
+        "distribution_name": "",
+        "api_id": "",
+    }
+
+
+def _generate_repo_metadata_file(
+    output: str, library_id: str, source: str, apis: List[Dict]
+):
+    """Generates the .repo-metadata.json file from the primary API service config.
+
+    Args:
+        output (str): The path to the output directory.
+        library_id (str): The ID of the library.
+        source (str): The path to the source directory.
+        apis (List[Dict]): A list of APIs to generate.
+    """
+    path_to_library = f"packages/{library_id}"
+    output_repo_metadata = f"{output}/{path_to_library}/.repo-metadata.json"
+
+    os.makedirs(f"{output}/{path_to_library}", exist_ok=True)
+
+    # TODO(ohmayr): Programatically determine the primary api to be used to
+    # to determine the information for metadata. For now, let's use the first
+    # api in the list.
+    primary_api = apis[0]
+
+    metadata_content = _create_repo_metadata_from_service_config(
+        primary_api.get("service_config"),
+        primary_api.get("path"),
+        source,
+        library_id,
+    )
+    _write_json_file(output_repo_metadata, metadata_content)
+
 
 def handle_generate(
     librarian: str = LIBRARIAN_DIR,
@@ -398,6 +460,7 @@ def handle_generate(
             api_path = api.get("path")
             if api_path:
                 _generate_api(api_path, library_id, source, output)
+        _generate_repo_metadata_file(output, library_id, source, apis_to_generate)
         _copy_files_needed_for_post_processing(output, input, library_id)
         _run_post_processor(output, library_id)
         _clean_up_files_after_post_processing(output, library_id)

.generator/test_cli.py

@@ -37,9 +37,11 @@
     _clean_up_files_after_post_processing,
     _copy_files_needed_for_post_processing,
     _create_main_version_header,
+    _create_repo_metadata_from_service_config,
     _determine_generator_command,
     _determine_library_namespace,
     _generate_api,
+    _generate_repo_metadata_file,
     _get_api_generator_options,
     _get_library_dist_name,
     _get_library_id,
@@ -1071,6 +1073,52 @@ def test_determine_library_namespace_success(
     assert namespace == expected_namespace
 
 
+def test_create_repo_metadata_from_service_config():
+    """Tests the creation of .repo-metadata.json content."""
+    service_config_name = "service_config.yaml"
+    api_path = "google/cloud/language/v1"
+    source = "/source"
+    library_id = "google-cloud-language"
+
+    metadata = _create_repo_metadata_from_service_config(
+        service_config_name, api_path, source, library_id
+    )
+
+    assert metadata["language"] == "python"
+    assert metadata["library_type"] == "GAPIC_AUTO"
+    assert metadata["repo"] == "googleapis/google-cloud-python"
+
+
+def test_generate_repo_metadata_file(mocker):
+    """Tests the generation of the .repo-metadata.json file."""
+    mock_write_json = mocker.patch("cli._write_json_file")
+    mock_create_metadata = mocker.patch(
+        "cli._create_repo_metadata_from_service_config",
+        return_value={"repo": "googleapis/google-cloud-python"},
+    )
+    mocker.patch("os.makedirs")
+
+    output = "/output"
+    library_id = "google-cloud-language"
+    source = "/source"
+    apis = [
+        {
+            "service_config": "service_config.yaml",
+            "path": "google/cloud/language/v1",
+        }
+    ]
+
+    _generate_repo_metadata_file(output, library_id, source, apis)
+
+    mock_create_metadata.assert_called_once_with(
+        "service_config.yaml", "google/cloud/language/v1", source, library_id
+    )
+    mock_write_json.assert_called_once_with(
+        f"{output}/packages/{library_id}/.repo-metadata.json",
+        {"repo": "googleapis/google-cloud-python"},
+    )
+
+
 def test_determine_library_namespace_fails_not_subpath():
     """Tests that a ValueError is raised if the gapic path is not inside the package root."""
     pkg_root_path = Path("repo/packages/my-lib")