Skip to content

feat(library_generation): generic grouping folder for unversioned libraries staging paths #13341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blakeli0 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(library_generation): generic grouping folder for unversioned libraries staging paths #13341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions sdk-platform-java/hermetic_build/library_generation/templates/owlbot.yaml.monorepo.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,19 @@ deep-copy-regex:
- source: "/{{ proto_path }}/(v.*)/.*-java/samples/snippets/generated"
dest: "/owl-bot-staging/{{ module_name }}/$1/samples/snippets/generated"
{%- else %}
{%- if proto_only %}
- source: "/{{ proto_path }}/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/{{ module_name }}/proto-{{ artifact_id }}/src"
dest: "/owl-bot-staging/{{ module_name }}/{{ unversioned_dir }}/{{ artifact_id }}/src"
{%- else %}
- source: "/{{ proto_path }}/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/{{ module_name }}/{{ unversioned_dir }}/proto-{{ artifact_id }}/src"
- source: "/{{ proto_path }}/.*-java/grpc-google-.*/src"
dest: "/owl-bot-staging/{{ module_name }}/grpc-{{ artifact_id }}/src"
dest: "/owl-bot-staging/{{ module_name }}/{{ unversioned_dir }}/grpc-{{ artifact_id }}/src"
- source: "/{{ proto_path }}/.*-java/gapic-google-.*/src"
dest: "/owl-bot-staging/{{ module_name }}/{{ artifact_id }}/src"
dest: "/owl-bot-staging/{{ module_name }}/{{ unversioned_dir }}/{{ artifact_id }}/src"
- source: "/{{ proto_path }}/.*-java/samples/snippets/generated"
dest: "/owl-bot-staging/{{ module_name }}/samples/snippets/generated"
dest: "/owl-bot-staging/{{ module_name }}/{{ unversioned_dir }}/samples/snippets/generated"
{%- endif %}
{%- endif %}
{%- endif %}

Expand Down
35 changes: 35 additions & 0 deletions ...library_generation/tests/resources/goldens/.OwlBot-hermetic-unversioned-gapic-golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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
#
# http://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.


deep-remove-regex:
- "/java-bare-metal-solution/grpc-google-.*/src"
- "/java-bare-metal-solution/proto-google-.*/src"
- "/java-bare-metal-solution/google-.*/src"
- "/java-bare-metal-solution/samples/snippets/generated"

deep-preserve-regex:
- "/java-bare-metal-solution/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"

deep-copy-regex:
- source: "/google/cloud/baremetalsolution/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/java-bare-metal-solution/baremetalsolution/proto-google-cloud-bare-metal-solution/src"
- source: "/google/cloud/baremetalsolution/.*-java/grpc-google-.*/src"
dest: "/owl-bot-staging/java-bare-metal-solution/baremetalsolution/grpc-google-cloud-bare-metal-solution/src"
- source: "/google/cloud/baremetalsolution/.*-java/gapic-google-.*/src"
dest: "/owl-bot-staging/java-bare-metal-solution/baremetalsolution/google-cloud-bare-metal-solution/src"
- source: "/google/cloud/baremetalsolution/.*-java/samples/snippets/generated"
dest: "/owl-bot-staging/java-bare-metal-solution/baremetalsolution/samples/snippets/generated"

api-name: baremetalsolution
29 changes: 29 additions & 0 deletions ...ry_generation/tests/resources/goldens/.OwlBot-hermetic-unversioned-proto-only-golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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
#
# http://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.


deep-remove-regex:
- "/java-bare-metal-solution/grpc-google-.*/src"
- "/java-bare-metal-solution/proto-google-.*/src"
- "/java-bare-metal-solution/google-.*/src"
- "/java-bare-metal-solution/samples/snippets/generated"

deep-preserve-regex:
- "/java-bare-metal-solution/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"

deep-copy-regex:
- source: "/google/cloud/baremetalsolution/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/java-bare-metal-solution/baremetalsolution/google-cloud-bare-metal-solution/src"

api-name: baremetalsolution
38 changes: 37 additions & 1 deletion sdk-platform-java/hermetic_build/library_generation/tests/utilities_unit_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,38 @@ def test_generate_postprocessing_prerequisite_files_proto_only_repo_success(self
)
self.__remove_postprocessing_prerequisite_files(path=library_path)

def test_generate_postprocessing_prerequisite_files_unversioned_proto_only_success(self):
self.maxDiff = None
library_path = self.__setup_postprocessing_prerequisite_files(
combination=3,
library_type="OTHER",
proto_path="google/cloud/baremetalsolution",
has_version=False,
proto_only=True,
)

file_comparator.compare_files(
f"{library_path}/.OwlBot-hermetic.yaml",
f"{library_path}/.OwlBot-hermetic-unversioned-proto-only-golden.yaml",
)
self.__remove_postprocessing_prerequisite_files(path=library_path)

def test_generate_postprocessing_prerequisite_files_unversioned_gapic_success(self):
self.maxDiff = None
library_path = self.__setup_postprocessing_prerequisite_files(
combination=2,
library_type="GAPIC_AUTO",
proto_path="google/cloud/baremetalsolution",
has_version=False,
proto_only=False,
)

file_comparator.compare_files(
f"{library_path}/.OwlBot-hermetic.yaml",
f"{library_path}/.OwlBot-hermetic-unversioned-gapic-golden.yaml",
)
self.__remove_postprocessing_prerequisite_files(path=library_path)

def test_generate_postprocessing_prerequisite_files__custom_transport_set_in_config__success(
self,
):
Expand Down Expand Up @@ -326,6 +358,9 @@ def __setup_postprocessing_prerequisite_files(
combination: int,
library_type: str = "GAPIC_AUTO",
library: LibraryConfig = library_1,
proto_path: str = "google/cloud/baremetalsolution/v2",
has_version: bool = True,
proto_only: bool = False,
) -> str:
library_path = f"{resources_dir}/goldens"
files = [
Expand All @@ -336,7 +371,6 @@ def __setup_postprocessing_prerequisite_files(
cleanup(files)
library.library_type = library_type
config = self.__get_a_gen_config(combination, library_type=library_type)
proto_path = "google/cloud/baremetalsolution/v2"
gapic_inputs = GapicInputs() # defaults to transport=grpc
transport = library.get_transport(gapic_inputs)
util.generate_postprocessing_prerequisite_files(
Expand All @@ -345,6 +379,8 @@ def __setup_postprocessing_prerequisite_files(
proto_path=proto_path,
transport=transport,
library_path=library_path,
has_version=has_version,
proto_only=proto_only,
)
return library_path

Expand Down
4 changes: 4 additions & 0 deletions sdk-platform-java/hermetic_build/library_generation/utils/utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ def generate_postprocessing_prerequisite_files(
library_path: str,
language: str = "java",
has_version: bool = True,
proto_only: bool = False,
) -> None:
"""
Generates the postprocessing prerequisite files for a library.
Expand Down Expand Up @@ -301,6 +302,7 @@ def generate_postprocessing_prerequisite_files(
else f"{library_path}/.github/{owlbot_yaml_file}"
)
if not os.path.exists(path_to_owlbot_yaml_file):
unversioned_dir = remove_version_from(proto_path).split("/")[-1]
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

If proto_path contains a trailing slash (e.g., google/cloud/baremetalsolution/), remove_version_from(proto_path) may also retain it. Splitting by / and taking the last element [-1] would then result in an empty string "", leading to malformed paths in the rendered OwlBot configuration. Stripping trailing slashes or using os.path.basename makes this extraction much more robust.

Suggested change
unversioned_dir = remove_version_from(proto_path).split("/")[-1]
unversioned_dir = os.path.basename(remove_version_from(proto_path).rstrip("/"))

render(
template_name="owlbot.yaml.monorepo.j2",
output_name=path_to_owlbot_yaml_file,
Expand All @@ -309,6 +311,8 @@ def generate_postprocessing_prerequisite_files(
module_name=repo_metadata["repo_short"],
api_shortname=library.api_shortname,
has_version=has_version,
proto_only=proto_only,
unversioned_dir=unversioned_dir,
)

# generate owlbot.py
Expand Down
Loading