feat: add entry point by JoeWang1127 · Pull Request #2616 · googleapis/sdk-platform-java

JoeWang1127 · 2024-04-02T23:34:58Z

In this PR:

Create entry_point.py to combine generate_repo.py and generate_pr_description.py.
Change Integration test.

Follow up of #2604.

For the goal of series of PRs, please refer to improvement proposal.

blakeli0 · 2024-04-03T19:26:38Z

library_generation/cli/entry_point.py

+    """,
+)
+@click.option(
+    "--latest-generation-config",


Can we all it something more generic?Because theoretically we can compare any two configs, not always compare with the latest.

In addition, what if the latest-generation-config has a googleapis commitish that is prior to it in basedline-generation-config? I don't think we have to support this case, but we should at least handle this case so our script does not blow up, maybe by adding validations that the googleapis commitish in one of them should be higher than the other.

Can we all it something more generic?Because theoretically we can compare any two configs, not always compare with the latest.

I think these two names are intuitive, do you have other candidates?

what if the latest-generation-config has a googleapis commitish that is prior to it in basedline-generation-config?

The problem is we don't the relationship between two commitish without traversing from one to another. The worst scenario is the description has too many characters (due to lots of commits) and gh command returns error.

We decided to use current_generation_config and baseline_generation_config as parameter names.

The googleapis commitish in current_generation_config should be newer than baseline_generation_config and we'll verify this by commit time.

blakeli0 · 2024-04-03T19:52:35Z

library_generation/cli/entry_point.py

+@main.command()
+@click.option(
+    "--baseline-generation-config",
+    required=True,


Can we make the interface as simple as possible? For example, both of the configs can be optional. We can use the existence of baseline config to decide if we want to to generate PR descriptions, and assume the current config to be exist in the current folder?

If both are optional, then we have:

both are not specified, we assume there's a generation_config.yaml in the current dir and do not generate pr description.

one is specified, we use it to generate repo and do not generate pr description.

both are specified, we use current-generation-config to generate repo and generate pr description.

blakeli0 · 2024-04-05T17:42:24Z

library_generation/cli/entry_point.py

+        if not os.path.isfile(default_generation_config):
+            raise FileNotFoundError(
+                f"{default_generation_config} does not exist when "
+                f"both baseline_generation_config and current_generation_config"


This additional info may be more complete but may also confuse people, took me sometime to understand as well. Can we simply saying
f"{default_generation_config} does not exist.
or
f"{default_generation_config} does not exist. A valid generation config has to be passed in as "current_generation_config" or exist in current working directory.

blakeli0 · 2024-04-05T17:45:36Z

library_generation/cli/entry_point.py

+    default=None,
+    type=str,
+    help="""
+    Path to generation_config.yaml that contains the metadata about


Absolute path?

Relative path is fine because all path will be converted to absolute path later.

So either relative path or absolute path should work? If that's the case, let's document it here as well.

blakeli0 · 2024-04-05T18:16:49Z

library_generation/cli/entry_point.py

+    help="""
+    Path to generation_config.yaml that contains the metadata about
+    library generation.
+    The googleapis commit in the configuration is the oldest commit,


Can we include some high level description for baseline-generation-config? For example, something like "We compare baseline-generation-config with the current generation config, and generate commit messages based on the diff of the googleapis-commitish between the two generation configs."
Same comment for current-generation-config below.

I added high level description of generate method in doc string.
User can read the docs through

python library_generation/cli/entry_point.py generate --help

Thanks, looks good! I think we still need more info to distinguish between baseline-generation-config from current-generation-config. For example, both descriptions include Absolute or relative path to generation_config.yaml that contains the metadata about library generation., in fact, only the info in current-generation-config is used for generation, baseline-generation-config is only used for generating commit history. Also the additional info regarding inclusive/exclusive of googleapis commitish might be a little too detailed.

Changed the comment.

library_generation/cli/entry_point.py

blakeli0 · 2024-04-05T18:56:14Z

library_generation/generate_pr_description.py

+    commit = repo.commit(current_commit)
+    current_commit_time = __get_commit_timestamp(commit)
+    baseline_commit_time = __get_commit_timestamp(repo.commit(baseline_commit))
+    if current_commit_time < baseline_commit_time:


Like this validation! I think we should add = though.

Suggested change

if current_commit_time < baseline_commit_time:

if current_commit_time <= baseline_commit_time:

Done.

Added unit tests to verify the behavior.

blakeli0 · 2024-04-05T20:21:08Z

library_generation/cli/entry_point.py

+        repository_path=repository_path,
+        target_library_names=config_change.get_changed_libraries(),
+    )
+    generate_pr_descriptions(


We probably want to rename generate_pr_description to something like generate_commit_history, because we just happen to use PR description to capture the commit history, and we could use other ways. It could be a separate PR.

sonarqubecloud · 2024-04-05T21:51:53Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

sonarqubecloud · 2024-04-05T21:55:20Z

Quality Gate passed for 'java_showcase_integration_tests'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

blakeli0 · 2024-04-05T22:40:03Z

library_generation/README.md

 # generate the repository
-python -m library_generation/generate_repo.py generate \
--generation-config-yaml=/path/to/config-file \
+python -m library_generation/entry_point.py generate \


FYI, we have to remove -m here, this is what tripped me when I run locally, I updated it in my PR

🤖 I have created a release *beep* *boop* --- <details><summary>2.39.0</summary> ## [2.39.0](v2.38.1...v2.39.0) (2024-04-18) ### Features * add `libraries_bom_version` to generation configuration ([#2639](#2639)) ([56c7ca5](56c7ca5)) * Add ChannelPoolSettings Getter for gRPC's ChannelProvider ([#2612](#2612)) ([d0c5191](d0c5191)) * add config change ([#2604](#2604)) ([8312706](8312706)) * add entry point ([#2616](#2616)) ([b19fa33](b19fa33)) * add generation config comparator ([#2587](#2587)) ([a94c2f0](a94c2f0)) * Add JavadocJar Task to build.gradle for self service libraries ([#2593](#2593)) ([993f5ac](993f5ac)) * Client/StubSettings' getEndpoint() returns the resolved endpoint ([#2440](#2440)) ([4942bc1](4942bc1)) * generate selected libraries ([#2598](#2598)) ([739ddbb](739ddbb)) * Validate the Universe Domain inside Java-Core ([#2592](#2592)) ([35d789f](35d789f)) ### Bug Fixes * add main to `generate_repo.py` ([#2607](#2607)) ([fedeb32](fedeb32)) * correct deep-remove and deep-preserve regexes ([#2572](#2572)) ([4c7fd88](4c7fd88)) * first attempt should use the min of RPC timeout and total timeout ([#2641](#2641)) ([0349232](0349232)) * remove duplicated calls to AutoValue builders ([#2636](#2636)) ([53a3727](53a3727)) * remove unnecessary slf4j and AbstractGoogleClientRequest native image configs ([0cb7d0e](0cb7d0e)) * remove unnecessary slf4j and AbstractGoogleClientRequest native image configs ([#2628](#2628)) ([0cb7d0e](0cb7d0e)) ### Dependencies * update arrow.version to v15.0.2 ([#2589](#2589)) ([777acf3](777acf3)) * update dependency com.google.cloud.opentelemetry:detector-resources-support to v0.28.0 ([#2649](#2649)) ([e4ed176](e4ed176)) * update dependency gitpython to v3.1.41 [security] ([#2625](#2625)) ([e41bd8f](e41bd8f)) * update dependency net.bytebuddy:byte-buddy to v1.14.13 ([#2646](#2646)) ([73ac5a4](73ac5a4)) * update dependency org.threeten:threeten-extra to v1.8.0 ([#2650](#2650)) ([226325a](226325a)) * update dependency org.threeten:threetenbp to v1.6.9 ([#2602](#2602)) ([371753e](371753e)) * update dependency org.threeten:threetenbp to v1.6.9 ([#2665](#2665)) ([8935bc8](8935bc8)) * update google api dependencies ([#2584](#2584)) ([cd20604](cd20604)) * update googleapis/java-cloud-bom digest to 7071341 ([#2608](#2608)) ([8d74140](8d74140)) * update netty dependencies to v4.1.109.final ([#2597](#2597)) ([8990693](8990693)) * update opentelemetry-java monorepo to v1.37.0 ([#2652](#2652)) ([f8fa2e9](f8fa2e9)) * update protobuf dependencies to v3.25.3 ([#2491](#2491)) ([b0e5041](b0e5041)) * update slf4j monorepo to v2.0.13 ([#2647](#2647)) ([f030e29](f030e29)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

JoeWang1127 added 5 commits April 2, 2024 19:01

feat: add entry_point.py

95b66a8

remove cli in generate_repo.py

964d81a

remove cli in generate_pr_description.py

5b303cb

add comment

4f6cedd

fix integration test

531244d

product-auto-label bot added the size: l Pull request size is large. label Apr 2, 2024

JoeWang1127 added 5 commits April 2, 2024 19:39

rename config

a6811d5

change pr description file path

14cdfb9

add comments

24f2070

restore CLI

853b70c

format code

923f149

JoeWang1127 marked this pull request as ready for review April 3, 2024 15:21

JoeWang1127 requested review from a team, blakeli0 and diegomarquezp April 3, 2024 15:21

blakeli0 reviewed Apr 3, 2024

View reviewed changes

JoeWang1127 added 14 commits April 3, 2024 19:21

change input to current_generation_config

1cd3859

change to optional inputs

ffc16ee

raise exception if current commit is older than baseline commit

87c7d1c

add unit test

9d723b0

add error log

fd7897a

convert time to int

ca902ec

add comment

4895971

extract helper method

87c0bdd

refactor tests

69fd09b

add integration test

d2b3963

change if

b4b907b

refactor

ce25efa

restore integration test

8d1d3f6

add unit tests

e155ea0

JoeWang1127 added 4 commits April 4, 2024 11:35

add unit tests

8de0c3d

test setup

e518d3f

restore unit tests

22eb127

refactor

c25e2bd

JoeWang1127 requested a review from blakeli0 April 5, 2024 12:50

blakeli0 reviewed Apr 5, 2024

View reviewed changes

change error message

cc137b0

blakeli0 reviewed Apr 5, 2024

View reviewed changes

JoeWang1127 added 3 commits April 5, 2024 15:05

fail if current config is null but baseline is not

5dbcd2c

two commits should be different

3d3522b

change doc

280cee5

blakeli0 reviewed Apr 5, 2024

View reviewed changes

change comment

881b557

blakeli0 approved these changes Apr 5, 2024

View reviewed changes

change readme

4de89de

JoeWang1127 enabled auto-merge (squash) April 5, 2024 21:45

JoeWang1127 merged commit b19fa33 into main Apr 5, 2024

JoeWang1127 deleted the feat/add-entry-point branch April 5, 2024 22:24

release-please bot mentioned this pull request Apr 5, 2024

chore(main): release 2.39.0 #2594

Merged

blakeli0 reviewed Apr 5, 2024

View reviewed changes

JoeWang1127 mentioned this pull request Apr 16, 2024

chore: update hermetic library generation workflow googleapis/google-cloud-java#10693

Merged

	if current_commit_time < baseline_commit_time:
	if current_commit_time <= baseline_commit_time:

Conversation

JoeWang1127 commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Apr 5, 2024

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud bot commented Apr 5, 2024

Quality Gate passed for 'java_showcase_integration_tests'

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JoeWang1127 commented Apr 2, 2024 •

edited

Loading