feat: make generated test values comply with url path template #903

vam-google · 2022-01-21T10:32:24Z

This includes nested messages creation when there are url paths with subfields mentioned (like /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*})

This is needed for rest transports tests because, unlike grpc, request fields must match path templates for rest logic pass the tests.

Main changes are in DefaultValueComposer and HttpRuleParser classes.

The generated pattern-matching samples are in the following format:
given the pattern pattern:
/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
the value will be:
field.name=projects/project-1234/databases/database-1234/collectionGroups/collectionGroup-1234/fields/field-1234

This includes nested messages creation when there are url paths with subfields mentioned (like `/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}`) This is needed for rest transports tests, because unlike grpc, request fields must match path templates for rest logic pass the tests. Main changes are in `DefaultValueComposer` and `HttpRuleParser` classes. The generated pattern-matching samples are in the following format: given the pattern pattern: ``` /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*} ``` the value will be: ``` field.name=projects/project-1234/databases/database-1234/collectionGroups/collectionGroup-1234/fields/field-1234 ```

codecov · 2022-01-21T10:46:26Z

Codecov Report

Merging #903 (3f692cb) into main (90df081) will increase coverage by 0.01%.
The diff coverage is 88.00%.

@@            Coverage Diff             @@
##             main     #903      +/-   ##
==========================================
+ Coverage   87.84%   87.86%   +0.01%     
==========================================
  Files         153      153              
  Lines       15966    16024      +58     
  Branches     1155     1166      +11     
==========================================
+ Hits        14025    14079      +54     
- Misses       1601     1602       +1     
- Partials      340      343       +3

Impacted Files	Coverage Δ
...erator/gapic/composer/common/TransportContext.java	`100.00% <ø> (ø)`
...rator/gapic/composer/grpcrest/GrpcRestContext.java	`0.00% <0.00%> (ø)`
.../composer/rest/ServiceClientTestClassComposer.java	`94.51% <ø> (+0.30%)`	⬆️
...rator/gapic/protoparser/MethodSignatureParser.java	`94.73% <ø> (ø)`
.../composer/grpc/ServiceClientTestClassComposer.java	`93.58% <60.00%> (-0.01%)`	⬇️
...common/AbstractServiceClientTestClassComposer.java	`88.78% <82.60%> (-0.49%)`	⬇️
...pi/generator/gapic/protoparser/HttpRuleParser.java	`83.33% <85.00%> (+1.22%)`	⬆️
...ic/composer/defaultvalue/DefaultValueComposer.java	`84.48% <91.37%> (+1.35%)`	⬆️
...api/generator/gapic/composer/grpc/GrpcContext.java	`97.05% <100.00%> (+0.08%)`	⬆️
...omposer/rest/HttpJsonServiceStubClassComposer.java	`52.94% <100.00%> (ø)`
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 90df081...3f692cb. Read the comment docs.

...a/com/google/api/generator/gapic/composer/common/AbstractServiceClientTestClassComposer.java

src/main/java/com/google/api/generator/gapic/composer/defaultvalue/DefaultValueComposer.java

src/main/java/com/google/api/generator/gapic/model/HttpBindings.java

src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java

meltsufin · 2022-01-21T16:38:40Z

src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceClientTest.golden

@@ -219,7 +220,30 @@ public class ComplianceClientTest {
    RepeatRequest request =
        RepeatRequest.newBuilder()
            .setName("name3373707")
-            .setInfo(ComplianceData.newBuilder().build())


What has caused this statement to get expanded like that?

This is the gist of this change: the fields of the nested object (ComplianceData) is mentioned in url path template (https://github.com/googleapis/gapic-generator-java/blob/main/src/test/java/com/google/api/generator/gapic/testdata/compliance.proto#L66), thus it has to be properly constructed in the tests for rest logic to pass (it needs to construct url to make a call, and to construct it we need the values from input message to do the substitution).

chanseokoh · 2022-01-21T20:00:17Z

I'll LGTM once the changes are in.

vam-google · 2022-01-21T20:31:08Z

@chanseokoh pushed, PTAL

This includes nested messages creation when there are url paths with subfields mentioned (like `/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}`) This is needed for rest transports tests because, unlike grpc, request fields must match path templates for rest logic pass the tests. Main changes are in `DefaultValueComposer` and `HttpRuleParser` classes. The generated pattern-matching samples are in the following format: given the pattern pattern: `/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}` the value will be: `field.name=projects/project-1234/databases/database-1234/collectionGroups/collectionGroup-1234/fields/field-1234`

…-plugin to v3.4.1 (#903) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [org.apache.maven.plugins:maven-javadoc-plugin](https://maven.apache.org/plugins/) ([source](https://togithub.com/apache/maven-javadoc-plugin)) | `3.4.0` -> `3.4.1` | [![age](https://badges.renovateapi.com/packages/maven/org.apache.maven.plugins:maven-javadoc-plugin/3.4.1/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/maven/org.apache.maven.plugins:maven-javadoc-plugin/3.4.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/maven/org.apache.maven.plugins:maven-javadoc-plugin/3.4.1/compatibility-slim/3.4.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/maven/org.apache.maven.plugins:maven-javadoc-plugin/3.4.1/confidence-slim/3.4.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-core).

vam-google requested review from a team as code owners January 21, 2022 10:32

vam-google requested a review from chanseokoh January 21, 2022 10:33

chanseokoh reviewed Jan 21, 2022

View reviewed changes

meltsufin reviewed Jan 21, 2022

View reviewed changes

address PR feedback

3f692cb

chanseokoh approved these changes Jan 21, 2022

View reviewed changes

vam-google merged commit bfb35cd into googleapis:main Jan 21, 2022

release-please bot mentioned this pull request Jan 21, 2022

chore(main): release 2.5.0 #905

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: make generated test values comply with url path template #903

feat: make generated test values comply with url path template #903

vam-google commented Jan 21, 2022

codecov bot commented Jan 21, 2022 •

edited

Loading

meltsufin Jan 21, 2022

vam-google Jan 21, 2022

chanseokoh commented Jan 21, 2022

vam-google commented Jan 21, 2022

feat: make generated test values comply with url path template #903

feat: make generated test values comply with url path template #903

Conversation

vam-google commented Jan 21, 2022

codecov bot commented Jan 21, 2022 • edited Loading

Codecov Report

meltsufin Jan 21, 2022

Choose a reason for hiding this comment

vam-google Jan 21, 2022

Choose a reason for hiding this comment

chanseokoh commented Jan 21, 2022

vam-google commented Jan 21, 2022

codecov bot commented Jan 21, 2022 •

edited

Loading