Skip to content
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

chore: Change all the references of OwlBot.yaml to OwlBot-hermetic.yaml. #2642

Merged
merged 5 commits into from
Apr 16, 2024
Merged

chore: Change all the references of OwlBot.yaml to OwlBot-hermetic.yaml. #2642

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be826fe
chore: Change all the refences to OwlBot.yaml to OwlBot-hermetic.yaml.
blakeli0 Apr 15, 2024
fb47b60
chore: Remove `goldens` folder from `.gitignore`.
blakeli0 Apr 15, 2024
e0af661
chore: Extract .OwlBot-hermetic.yaml to a variable.
blakeli0 Apr 15, 2024
a560d50
chore: Update versions.
blakeli0 Apr 16, 2024
6eefe4e
chore: Fix typo
blakeli0 Apr 16, 2024
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
40 changes: 20 additions & 20 deletions library_generation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,24 +55,24 @@ of versions.txt.
For each module (e.g. `google-cloud-java/java-asset`), the following files/folders
will be created/modified:

| Name | Notes |
|:----------------------------|:-------------------------------------------------------------------------|
| google-*/ | Source code generated by gapic-generator-java |
| google-*/pom.xml | Only be generated if it does not exist |
| grpc-*/ | Source code generated by grpc generator, one per each version |
| grpc-*/pom.xml | Only be generated if it does not exist |
| proto-*/ | Source code generated by Protobuf default compiler, one per each version |
| proto-*/pom.xml | Only be generated if it does not exist |
| samples/snippets/generated/ | Only be generated if `include_samples` is set to true |
| google-*-bom/pom.xml | Library BOM, only be generated if it does not exist |
| pom.xml | Library parent BOM, only be generated if it does not exist |
| .repo-metadata.json | Always generated from inputs |
| .OwlBot.yaml | Only be generated from a template if it does not exist |
| owlbot.py | Only be generated from a template if it does not exist |
| README.md | Always generated from inputs |
| gapic-libraries-bom/pom.xml | Always generated from inputs |
| pom.xml (repo root dir) | Always generated from inputs |
| versions.txt | New entries will be added if they don’t exist |
| Name | Notes |
|:------------------------------------|:-------------------------------------------------------------------------|
| google-*/ | Source code generated by gapic-generator-java |
| google-*/pom.xml | Only be generated if it does not exist |
| grpc-*/ | Source code generated by grpc generator, one per each version |
| grpc-*/pom.xml | Only be generated if it does not exist |
| proto-*/ | Source code generated by Protobuf default compiler, one per each version |
| proto-*/pom.xml | Only be generated if it does not exist |
| samples/snippets/generated/ | Only be generated if `include_samples` is set to true |
| google-*-bom/pom.xml | Library BOM, only be generated if it does not exist |
| pom.xml | Library parent BOM, only be generated if it does not exist |
| .repo-metadata.json | Always generated from inputs |
| .OwlBot-hermetic.yaml | Only be generated from a template if it does not exist |
| owlbot.py | Only be generated from a template if it does not exist |
| README.md | Always generated from inputs |
| gapic-libraries-bom/pom.xml | Always generated from inputs |
| pom.xml (repo root dir) | Always generated from inputs |
| versions.txt | New entries will be added if they don’t exist |

### googleapis commit history

Expand Down Expand Up @@ -231,7 +231,7 @@ $repository_path
| |_samples
| | |_snippets
| | | |_generated
| |_.OwlBot.yaml
| |_.OwlBot-hermetic.yaml
| |_.repo-metadata.json
| |_owlbot.py
| |_pom.xml
Expand Down Expand Up @@ -275,7 +275,7 @@ $repository_path
| |_samples
| | |_snippets
| | | |_generated
| |_.OwlBot.yaml
| |_.OwlBot-hermetic.yaml
| |_.repo-metadata.json
| |_owlbot.py
| |_pom.xml
Expand Down
2 changes: 1 addition & 1 deletion library_generation/generate_composed_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def generate_composed_library(
build_file_folder = Path(f"{output_folder}/{gapic.proto_path}").resolve()
print(f"build_file_folder: {build_file_folder}")
gapic_inputs = parse_build_file(build_file_folder, gapic.proto_path)
# generate prerequisite files (.repo-metadata.json, .OwlBot.yaml,
# generate prerequisite files (.repo-metadata.json, .OwlBot-hermetic.yaml,
# owlbot.py) here because transport is parsed from BUILD.bazel,
# which lives in a versioned proto_path.
util.generate_prerequisite_files(
Expand Down
17 changes: 4 additions & 13 deletions library_generation/owlbot/bin/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,10 @@ set -ex
scripts_root=$1
versions_file=$2
configuration_yaml=$3
is_monorepo=$4


# This script can be used to process HW libraries and monorepo
# (google-cloud-java) libraries, which require a slightly different treatment
# monorepo folders have an .OwlBot.yaml file in the module folder (e.g.
# java-asset/.OwlBot.yaml), whereas HW libraries have the yaml in
# `.github/.OwlBot.yaml`
monorepo="false"
if [[ -f "$(pwd)/.OwlBot.yaml" ]]; then
monorepo="true"
fi

if [[ "${monorepo}" == "true" ]]; then
if [[ "${is_monorepo}" == "true" ]]; then
mv owl-bot-staging/* temp
rm -rd owl-bot-staging/
mv temp owl-bot-staging
Expand All @@ -50,7 +41,7 @@ fi

# apply repo templates
echo "Rendering templates"
python3 "${scripts_root}/owlbot/src/apply_repo_templates.py" "${configuration_yaml}" "${monorepo}"
python3 "${scripts_root}/owlbot/src/apply_repo_templates.py" "${configuration_yaml}" "${is_monorepo}"

# templates as well as retrieving files from owl-bot-staging
echo "Retrieving files from owl-bot-staging directory..."
Expand All @@ -66,7 +57,7 @@ echo "...done"

# write or restore pom.xml files
echo "Generating missing pom.xml..."
python3 "${scripts_root}/owlbot/src/fix-poms.py" "${versions_file}" "${monorepo}"
python3 "${scripts_root}/owlbot/src/fix-poms.py" "${versions_file}" "${is_monorepo}"
echo "...done"

# write or restore clirr-ignored-differences.xml
Expand Down
14 changes: 7 additions & 7 deletions library_generation/postprocess_library.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# has the following requirements
# - a .repo-metadata.json file must be present
# - an owlbot.py file must be present
# - an .OwlBot.yaml file must be present
# - an .OwlBot-hermetic.yaml file must be present
# 2 - preprocessed_sources_path: used to transfer the raw grpc, proto and gapic
# libraries into the postprocessing_target via copy-code
# 3 - versions_file: path to file containing versions to be applied to the poms
Expand Down Expand Up @@ -44,7 +44,7 @@ for required_input in "${required_inputs[@]}"; do
fi
done

for owlbot_file in ".repo-metadata.json" "owlbot.py" ".OwlBot.yaml"
for owlbot_file in ".repo-metadata.json" "owlbot.py" ".OwlBot-hermetic.yaml"
blakeli0 marked this conversation as resolved.
Show resolved Hide resolved
do
if [[ $(find "${postprocessing_target}" -name "${owlbot_file}" | wc -l) -eq 0 ]]; then
echo "necessary file for postprocessing '${owlbot_file}' was not found in postprocessing_target"
Expand All @@ -59,10 +59,10 @@ if [[ -z "${owlbot_cli_source_folder}" ]]; then
fi


# we determine the location of the .OwlBot.yaml file by checking if the target
# we determine the location of the .OwlBot-hermetic.yaml file by checking if the target
# folder is a monorepo folder or not
if [[ "${is_monorepo}" == "true" ]]; then
# the deep-remove-regex and deep-preserve-regex of the .OwlBot.yaml
# the deep-remove-regex and deep-preserve-regex of the .OwlBot-hermetic.yaml
# files in the monorepo libraries assume that `copy-code` is run
# from the root of the monorepo. However, we call `copy-code` from inside each
# library, so a path like `/java-asset/google-.*/src` will not have
Expand All @@ -74,12 +74,12 @@ if [[ "${is_monorepo}" == "true" ]]; then
# - "/google-.*/src"

library_name=$(basename "${postprocessing_target}")
cat "${postprocessing_target}/.OwlBot.yaml" \
cat "${postprocessing_target}/.OwlBot-hermetic.yaml" \
| sed "s/- \"\/${library_name}/ - \"/" \
> "${postprocessing_target}/.OwlBot.hermetic.yaml"
Copy link
Contributor

Choose a reason for hiding this comment

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

As a follow up, we may want to modify the regexes in every yaml of google-cloud-java:

/java-asset/google-.*/src

to

/google-.*/src

That way, we can get rid of this logic that creates a temporary owlbot yaml (which has a very similar name too)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agreed!

owlbot_yaml_relative_path=".OwlBot.hermetic.yaml"
else
owlbot_yaml_relative_path=".github/.OwlBot.yaml"
owlbot_yaml_relative_path=".github/.OwlBot-hermetic.yaml"
fi

# Default values for running copy-code directly from host
Expand Down Expand Up @@ -150,5 +150,5 @@ popd # temp dir
# run the postprocessor
echo 'running owl-bot post-processor'
pushd "${postprocessing_target}"
bash "${scripts_root}/owlbot/bin/entrypoint.sh" "${scripts_root}" "${versions_file}" "${configuration_yaml_path}"
bash "${scripts_root}/owlbot/bin/entrypoint.sh" "${scripts_root}" "${versions_file}" "${configuration_yaml_path}" "${is_monorepo}"
popd # postprocessing_target
35 changes: 0 additions & 35 deletions library_generation/test/resources/goldens/.OwlBot-golden.yaml
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions library_generation/test/utilities_unit_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,8 @@ def test_generate_prerequisite_files_non_monorepo_success(self):
# since this is a single library, we treat this as HW repository,
# meaning that the owlbot yaml will be inside a .github folder
file_comparator.compare_files(
f"{library_path}/.github/.OwlBot.yaml",
f"{library_path}/.OwlBot-golden.yaml",
f"{library_path}/.github/.OwlBot-hermetic.yaml",
f"{library_path}/.OwlBot-hermetic-golden.yaml",
)
file_comparator.compare_files(
f"{library_path}/owlbot.py", f"{library_path}/owlbot-golden.py"
Expand All @@ -374,8 +374,8 @@ def test_generate_prerequisite_files_monorepo_success(self):
f"{library_path}/.repo-metadata-monorepo-golden.json",
)
file_comparator.compare_files(
f"{library_path}/.OwlBot.yaml",
f"{library_path}/.OwlBot-golden.yaml",
f"{library_path}/.OwlBot-hermetic.yaml",
f"{library_path}/.OwlBot-hermetic-golden.yaml",
)
file_comparator.compare_files(
f"{library_path}/owlbot.py", f"{library_path}/owlbot-golden.py"
Expand Down Expand Up @@ -432,7 +432,7 @@ def __setup_prerequisite_files(
library_path = f"{resources_dir}/goldens"
files = [
f"{library_path}/.repo-metadata.json",
f"{library_path}/.OwlBot.yaml",
f"{library_path}/.OwlBot-hermetic.yaml",
f"{library_path}/owlbot.py",
]
cleanup(files)
Expand Down
4 changes: 2 additions & 2 deletions library_generation/utils/utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,8 @@ def generate_prerequisite_files(
with open(f"{library_path}/{json_file}", "w") as fp:
json.dump(repo_metadata, fp, indent=2)

# generate .OwlBot.yaml
owlbot_yaml_file = ".OwlBot.yaml"
# generate .OwlBot-hermetic.yaml
owlbot_yaml_file = ".OwlBot-hermetic.yaml"
path_to_owlbot_yaml_file = (
f"{library_path}/{owlbot_yaml_file}"
if config.is_monorepo()
Expand Down
4 changes: 2 additions & 2 deletions library_generation/utils/utilities.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ get_proto_path_from_preprocessed_sources() {

# for a pre-processed library stored in $preprocessed_sources_path, a folder
# tree is built on $target_folder so it looks like a googleapis-gen folder and
# is therefore consumable by an .OwlBot.yaml file
# is therefore consumable OwlBot CLI
build_owlbot_cli_source_folder() {
local postprocessing_target=$1
local target_folder=$2
Expand All @@ -288,7 +288,7 @@ build_owlbot_cli_source_folder() {
owlbot_staging_folder="${postprocessing_target}/owl-bot-staging"
mkdir -p "${owlbot_staging_folder}"

# By default (thanks to generation templates), .OwlBot.yaml `deep-copy` section
# By default (thanks to generation templates), .OwlBot-hermetic.yaml `deep-copy` section
# references a wildcard pattern matching a folder
# ending with `-java` at the leaf of proto_path. We then use a generated-java
# folder that will be picked up by copy-code
Expand Down
Loading