feat: add entry point

library_generation/cli/entry_point.py

@@ -0,0 +1,94 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+
+import click as click
+from library_generation.generate_pr_description import generate_pr_descriptions
+from library_generation.generate_repo import generate_from_yaml
+from library_generation.model.generation_config import from_yaml
+from library_generation.utils.generation_config_comparator import compare_config
+
+
+@click.group(invoke_without_command=False)
+@click.pass_context
+@click.version_option(message="%(version)s")
+def main(ctx):
+    pass
+
+
+@main.command()
+@click.option(
+    "--baseline-generation-config",
+    required=True,
+    type=str,
+    help="""
+    Path to generation_config.yaml that contains the metadata about
+    library generation.
+    The googleapis commit in the configuration is the baseline commit,
+    exclusively, from which the commit message is considered.
+    """,
+)
+@click.option(
+    "--latest-generation-config",
+    required=True,
+    type=str,
+    help="""
+    Path to generation_config.yaml that contains the metadata about
+    library generation.
+    The googleapis commit in the configuration is the latest commit,
+    inclusively, to which the commit message is considered.
+    """,
+)
+@click.option(
+    "--repository-path",
+    type=str,
+    default=".",
+    show_default=True,
+    help="""
+    The repository path to which the generated files
+    will be sent.
+    If not specified, the repository will be generated to the current working
+    directory.
+    """,
+)
+def generate(
+    baseline_generation_config: str,
+    latest_generation_config: str,
+    repository_path: str,
+):
+    # convert paths to absolute paths, so they can be correctly referenced in
+    # downstream scripts
+    baseline_generation_config = os.path.abspath(baseline_generation_config)
+    latest_generation_config = os.path.abspath(latest_generation_config)
+    repository_path = os.path.abspath(repository_path)
+    config_change = compare_config(
+        baseline_config=from_yaml(baseline_generation_config),
+        latest_config=from_yaml(latest_generation_config),
+    )
+    # generate libraries
+    generate_from_yaml(
+        config=config_change.latest_config,
+        repository_path=repository_path,
+        target_library_names=config_change.get_changed_libraries(),
+    )
+    # generate pull request description
+    generate_pr_descriptions(
+        config=config_change.latest_config,
+        baseline_commit=config_change.baseline_config.googleapis_commitish,
+        description_path=repository_path,
+    )
+
+
+if __name__ == "__main__":
+    main()

library_generation/generate_pr_description.py

@@ -14,11 +14,10 @@
 # limitations under the License.
 import os
 import shutil
+import click as click
 from typing import Dict
-
-import click
 from git import Commit, Repo
-from library_generation.model.generation_config import from_yaml
+from library_generation.model.generation_config import GenerationConfig, from_yaml
 from library_generation.utils.proto_path_utils import find_versioned_proto_path
 from library_generation.utils.commit_message_formatter import format_commit_message
 from library_generation.utils.commit_message_formatter import wrap_override_commit
@@ -53,47 +52,57 @@ def main(ctx):
     This commit should be an ancestor of googleapis commit in configuration.
     """,
 )
-@click.option(
-    "--repo-url",
-    type=str,
-    default="https://github.com/googleapis/googleapis.git",
-    show_default=True,
-    help="""
-    GitHub repository URL.
-    """,
-)
 def generate(
     generation_config_yaml: str,
-    repo_url: str,
     baseline_commit: str,
-) -> str:
-    description = generate_pr_descriptions(
-        generation_config_yaml=generation_config_yaml,
-        repo_url=repo_url,
-        baseline_commit=baseline_commit,
-    )
+) -> None:
     idx = generation_config_yaml.rfind("/")
     config_path = generation_config_yaml[:idx]
-    with open(f"{config_path}/pr_description.txt", "w+") as f:
-        f.write(description)
-    return description
+    generate_pr_descriptions(
+        config=from_yaml(generation_config_yaml),
+        baseline_commit=baseline_commit,
+        description_path=config_path,
+    )
 
 
 def generate_pr_descriptions(
-    generation_config_yaml: str,
-    repo_url: str,
+    config: GenerationConfig,
     baseline_commit: str,
-) -> str:
-    config = from_yaml(generation_config_yaml)
+    description_path: str,
+    repo_url: str = "https://github.com/googleapis/googleapis.git",
+) -> None:
+    """
+    Generate pull request description from baseline_commit (exclusive) to the
+    googleapis commit (inclusive) in the given generation config.
+
+    The pull request description will be generated into
+    description_path/pr_description.txt.
+
+    :param config: a GenerationConfig object. The googleapis commit in this
+    configuration is the latest commit, inclusively, from which the commit
+    message is considered.
+    :param baseline_commit: The baseline (oldest) commit, exclusively, from
+    which the commit message is considered. This commit should be an ancestor
+    of googleapis commit in configuration.
+    :param description_path: the path to which the pull request description
+    file goes.
+    :param repo_url: the GitHub repository from which retrieves the commit
+    history.
+    """
     paths = config.get_proto_path_to_library_name()
-    return __get_commit_messages(
+    description = __get_commit_messages(
         repo_url=repo_url,
         latest_commit=config.googleapis_commitish,
         baseline_commit=baseline_commit,
         paths=paths,
         is_monorepo=config.is_monorepo,
     )
 
+    description_file = f"{description_path}/pr_description.txt"
+    print(f"Writing pull request description to {description_file}")
+    with open(description_file, "w+") as f:
+        f.write(description)
+
 
 def __get_commit_messages(
     repo_url: str,

library_generation/generate_repo.py

@@ -12,13 +12,10 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+import click as click
 import library_generation.utils.utilities as util
-import click
-import os
 from library_generation.generate_composed_library import generate_composed_library
-from library_generation.model.generation_config import GenerationConfig
-from library_generation.model.generation_config import from_yaml
+from library_generation.model.generation_config import GenerationConfig, from_yaml
 from library_generation.model.library_config import LibraryConfig
 from library_generation.utils.monorepo_postprocessor import monorepo_postprocessing
 
@@ -75,8 +72,9 @@ def generate(
     target_library_names: str,
     repository_path: str,
 ):
+    config = from_yaml(generation_config_yaml)
     generate_from_yaml(
-        generation_config_yaml=generation_config_yaml,
+        config=config,
         repository_path=repository_path,
         target_library_names=target_library_names.split(",")
         if target_library_names is not None
@@ -85,30 +83,23 @@ def generate(
 
 
 def generate_from_yaml(
-    generation_config_yaml: str,
+    config: GenerationConfig,
     repository_path: str,
     target_library_names: list[str] = None,
 ) -> None:
     """
-    Parses a config yaml and generates libraries via
+    Based on the generation config, generates libraries via
     generate_composed_library.py
-    :param generation_config_yaml: Path to generation_config.yaml that contains
-    the metadata about library generation
-    :param repository_path: If specified, the generated files will be sent to
-    this location. If not specified, the repository will be generated to the
-    current working directory.
+
+    :param config: a GenerationConfig object.
+    :param repository_path: The repository path to which the generated files
+    will be sent.
     :param target_library_names: a list of libraries to be generated.
-    If specified, only the library whose library_name is in
-    target-library-names will be generated.
+    If specified, only the library whose library_name is in target_library_names
+    will be generated.
     If specified with an empty list, then no library will be generated.
     If not specified, all libraries in the configuration yaml will be generated.
     """
-    # convert paths to absolute paths, so they can be correctly referenced in
-    # downstream scripts
-    generation_config_yaml = os.path.abspath(generation_config_yaml)
-    repository_path = os.path.abspath(repository_path)
-
-    config = from_yaml(generation_config_yaml)
     target_libraries = get_target_libraries(
         config=config, target_library_names=target_library_names
     )
@@ -117,7 +108,7 @@ def generate_from_yaml(
     )
 
     for library_path, library in repo_config.libraries.items():
-        print(f"generating library {library.api_shortname}")
+        print(f"generating library {library.get_library_name()}")
 
         generate_composed_library(
             config=config,

library_generation/test/integration_tests.py

@@ -42,9 +42,8 @@
     "java-bigtable": "chore/test-hermetic-build",
 }
 config_dir = f"{script_dir}/resources/integration"
-config_name = "generation_config.yaml"
-monorepo_baseline_commit = "a17d4caf184b050d50cacf2b0d579ce72c31ce74"
-split_repo_baseline_commit = "679060c64136e85b52838f53cfe612ce51e60d1d"
+baseline_config_name = "baseline_generation_config.yaml"
+latest_config_name = "latest_generation_config.yaml"
 
 
 class IntegrationTest(unittest.TestCase):
@@ -74,15 +73,11 @@ def test_entry_point_running_in_container(self):
             )
             repo_volumes = f"-v repo-{repo}:/workspace/{repo} -v config-{repo}:/workspace/config-{repo}"
             # 4. run entry_point.py in docker container
-            baseline_commit = (
-                monorepo_baseline_commit
-                if repo == "google-cloud-java"
-                else split_repo_baseline_commit
-            )
             self.__run_entry_point_in_docker_container(
                 repo=repo,
                 repo_volumes=repo_volumes,
-                baseline_commit=baseline_commit,
+                baseline_config=baseline_config_name,
+                latest_config=latest_config_name,
             )
             # 5. compare generation result with golden files
             print(
@@ -162,7 +157,7 @@ def test_entry_point_running_in_container(self):
                 )
                 print("  pom.xml comparison succeed.")
                 # compare PR description
-                description_file = f"{config_dir}/{repo}/pr_description.txt"
+                description_file = f"{output_dir}/{repo}/pr_description.txt"
                 self.assertTrue(
                     cmp(
                         f"{config_dir}/{repo}/pr-description-golden.txt",
@@ -243,7 +238,7 @@ def __bind_device_to_volumes(cls, volume_name: str, device_dir: str):
 
     @classmethod
     def __run_entry_point_in_docker_container(
-        cls, repo: str, repo_volumes: str, baseline_commit: str
+        cls, repo: str, repo_volumes: str, baseline_config: str, latest_config: str
     ):
         subprocess.check_call(
             [
@@ -266,41 +261,14 @@ def __run_entry_point_in_docker_container(
                 "/src",
                 image_tag,
                 "python",
-                "/src/generate_repo.py",
+                "/src/cli/entry_point.py",
                 "generate",
-                f"--generation-config-yaml=/workspace/config-{repo}/{config_name}",
+                f"--baseline-generation-config=/workspace/config-{repo}/{baseline_config}",
+                f"--latest-generation-config=/workspace/config-{repo}/{latest_config}",
                 f"--repository-path=/workspace/{repo}",
             ]
         )
 
-        subprocess.check_call(
-            [
-                "docker",
-                "run",
-                "--rm",
-                "-v",
-                f"repo-{repo}:/workspace/{repo}",
-                "-v",
-                f"config-{repo}:/workspace/config-{repo}",
-                "-v",
-                "/tmp:/tmp",
-                "-v",
-                "/var/run/docker.sock:/var/run/docker.sock",
-                "-e",
-                "RUNNING_IN_DOCKER=true",
-                "-e",
-                f"REPO_BINDING_VOLUMES={repo_volumes}",
-                "-w",
-                "/src",
-                image_tag,
-                "python",
-                "/src/generate_pr_description.py",
-                "generate",
-                f"--generation-config-yaml=/workspace/config-{repo}/{config_name}",
-                f"--baseline-commit={baseline_commit}",
-            ]
-        )
-
     @classmethod
     def __get_config_files(cls, path: str) -> list[tuple[str, str]]:
         config_files = []
@@ -310,7 +278,7 @@ def __get_config_files(cls, path: str) -> list[tuple[str, str]]:
             repo = sub_dir.name
             if repo in ["golden", "java-bigtable"]:
                 continue
-            config = f"{sub_dir}/{config_name}"
+            config = f"{sub_dir}/{latest_config_name}"
             config_files.append((repo, config))
         return config_files