refactor: extract and move comment formatting logic to util # 8000 1089
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
diegomarquezp
approved these changes
Nov 8, 2022
blakeli0
reviewed
Nov 8, 2022
src/main/java/com/google/api/generator/gapic/composer/utils/CommentFormatter.java
Show resolved
Hide resolved
blakeli0
reviewed
Nov 8, 2022
src/main/java/com/google/api/generator/gapic/composer/utils/CommentFormatter.java
Outdated
Show resolved
Hide resolved
blakeli0
reviewed
Nov 8, 2022
src/main/java/com/google/api/generator/gapic/composer/utils/CommentFormatter.java
Show resolved
Hide resolved
blakeli0
requested changes
Nov 8, 2022
|
Regarding the code coverage: The use of this logic/util method in the two composers is covered by the integration tests (e.g. redis golden file). Sonar is unhappy with coverage because the existing composer unit tests (e.g. through Todo: will need to look more into how |
|
Kudos, SonarCloud Quality Gate passed! |
|
Some additional test-related changes from addressing code coverage:
|
blakeli0
approved these changes
Nov 18, 2022
emmileaf
added a commit
that referenced
this pull request
Nov 30, 2022
* Extracts common logic to an util class, and exposes it for reuse * Adds description for echo service explicitly in TestProtoLoader since it is not parsed from source code location as an end-to-end call would (this allows the existing ServiceClientClassTest to cover class header comments that are also formatted with the util’s logic) * Adds ClientLibraryPackageInfoComposerTest as a golden-updating test
suztomo
pushed a commit
that referenced
this pull request
Dec 16, 2022
* Extracts common logic to an util class, and exposes it for reuse * Adds description for echo service explicitly in TestProtoLoader since it is not parsed from source code location as an end-to-end call would (this allows the existing ServiceClientClassTest to cover class header comments that are also formatted with the util’s logic) * Adds ClientLibraryPackageInfoComposerTest as a golden-updating test
suztomo
pushed a commit
that referenced
this pull request
Mar 21, 2023
🤖 I have created a release *beep* *boop* --- ### Updating meta-information for bleeding-edge SNAPSHOT release. --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Both
ClientLibraryPackageInfoComposerandServiceClientCommentComposercurrently have additional parsing logic to convert protobuf comments to a Javadoc-compatible format. For example, this handles bulleted list items with asterisks in secret manager service proto.This PR extracts common logic to an util class, and exposes it for reuse by Spring Codegen.
[Update] Additional test-related changes from addressing code coverage:
TestProtoLoadersince it is not parsed from source code location as an end-to-end call wouldServiceClientClassTestto cover class header comments that are also formatted with the util’s logicClientLibraryPackageInfoComposerTestas a golden-updating test