feat: support GDC-H Credentials by diegomarquezp · Pull Request #1642 · googleapis/sdk-platform-java

diegomarquezp · 2023-04-20T17:18:13Z

This PR adds support for GDC-H credentials.
Mainly, it adds the option to have gdchApiAudience in ClientContext and StubSettings.
ClientContext.create(StubSettings) will verify that:

if gdchApiAudience is set, then only a GdchCredential returned from the CredentialProvider is accepted
gdchApiAudience is a valid URI

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

gax-java/gax/src/test/java/com/google/api/gax/rpc/ClientContextTest.java

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

gax-java/gax/src/main/java/com/google/api/gax/rpc/StubSettings.java

gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

gax-java/gax/src/main/java/com/google/api/gax/rpc/StubSettings.java

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

blakeli0 · 2023-05-24T20:35:43Z

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

+    GdchCredentials fromClient =
+            (GdchCredentials) client.getSettings().getCredentialsProvider().getCredentials();
+
+    assertSame(credentials, fromClient);


I thought the credential would be different since it now has an additional field gdchApiAudience?

So the provider is not modified when creating the ClientContext. In fact, ClientContext.create() retrieves the Credentials from the provider, then modifies them accordingly (e.g. re-create with gdchApiAudience or any other type of `Credentials) and stores them as an internal property.

I'm just describing what happens with ClientContext creation.
For example,

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

Lines 193 to 199 in ea05922

if (settings.getQuotaProjectId() != null) {

// If the quotaProjectId is set, wrap original credentials with correct quotaProjectId as

// QuotaProjectIdHidingCredentials.

// Ensure that a custom set quota project id takes priority over one detected by credentials.

// Avoid the backend receiving possibly conflict values of quotaProjectId

credentials = new QuotaProjectIdHidingCredentials(credentials);

}

Modifies the Credentials object and then a new ClientContext is created with such Credentials

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

Lines 261 to 264 in ea05922

return newBuilder()

.setBackgroundResources(backgroundResources.build())

.setExecutor(backgroundExecutor)

.setCredentials(credentials)

Should ClientContext.create() alter the Credentials provided by CredentialsProvider?

While the logic above is correct, the test seems not validating what it declares (Blake's point from different angle). The test description WithAudience - is is not tested.

Instead, test validates that the original credential stay in credential provider as is.

Also, this is effectively a unit test, not integration, right?

Also, this is effectively a unit test, not integration, right?

We want to test that the audience set through ClientSetting in a client library is being properly propagated to ClientContext and set to Credentials, which we cannot test through unit tests, only through showcase clients. So yeah this is not a true integration tests that interact with servers, more like a component test only verifying the client behaviors.
That being said, I agree with you that this test does not verify the audience, which we should.

gax-java/gax/src/test/java/com/google/api/gax/rpc/ClientContextTest.java

java-shared-dependencies/first-party-dependencies/pom.xml

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

.../src/test/java/com/google/showcase/v1beta1/it/util/InterceptingMockTokenServerTransport.java

gapic-generator-java-pom-parent/pom.xml

java-shared-dependencies/first-party-dependencies/pom.xml

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java

showcase/pom.xml

showcase/gapic-showcase/src/test/resources/META-INF/native-image/resource-config.json

blakeli0

LGTM with one minor comment. Feel free to merge it after the comment is resolved.

sonarqubecloud · 2023-06-28T22:27:39Z

[gapic-generator-java-root] Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

90.0% Coverage
0.0% Duplication

sonarqubecloud · 2023-06-28T22:32:10Z

[java_showcase_integration_tests] SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

67.5% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarqubecloud · 2023-06-28T22:36:36Z

[java_showcase_unit_tests] Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

90.0% Coverage
0.0% Duplication

* chore: initial additions to handle GDC-H API audience * chore: add unit tests for GDC-H * chore: cleanup of logic * chore: decompose tests into separate methods * chore: fix clirr diff check * chore: fmt:format * chore: add support in `ClientSettings` * chore: add showcase IT for GDCH credentials * chore: comments * chore: improve tests * chore: add partial IT for testing context credential * chore: recreate GdchCredentials with audience using convenience method * chore: more readable api audience logic * chore: no wildcard imports * chore: javadoc for public methods * chore: gdch test to use default null initialization * chore: tear down for gdch IT * chore: `assertThrows` for gdch ITs * chore: mvn fmt:format * test: remove context test * docs: explain that audience will be overriden if set through client/stub settings * test: test audience setting should modify initial credentials * chore: clirr check * chore: ignore gdch changes * chore: format * chore: default to endpoint if audience not provided * test: refresh gdch creds to confirm audience works * chore: fmt * chore: fmt * chore: better test names in ClientContextTest * chore: better test names for showcase tests * chore: simplify refresh verification logic * chore: include outcome in gdch it test names * chore: expand comments in GDCH ITs * test: intercept mock transport to verify audience * chore: fmt * chore: move auth test-jar to shared dependencies * chore: cleanup * chore: use inferred version for auth library * deps: update google-auth-java-library to 1.19.0 * choreL fmt ITGdch.java * chore: import auth test-jar using common version variable * chore: remove auth test-jar import from first-party-dependencies * chore: add license headers to new files * chore: revert google-auth-version to be obtained from main branch * chore: correct showcase parent pom indentation * chore: remove resource declaration for native test build

* fix: Use bindings for resolving multi pattern resources * chore: Fix lint issues * chore: Add unit tests for the behavior * chore: Add comments for the tests * chore: Remove unused comment * feat: support GDC-H Credentials (#1642) * chore: initial additions to handle GDC-H API audience * chore: add unit tests for GDC-H * chore: cleanup of logic * chore: decompose tests into separate methods * chore: fix clirr diff check * chore: fmt:format * chore: add support in `ClientSettings` * chore: add showcase IT for GDCH credentials * chore: comments * chore: improve tests * chore: add partial IT for testing context credential * chore: recreate GdchCredentials with audience using convenience method * chore: more readable api audience logic * chore: no wildcard imports * chore: javadoc for public methods * chore: gdch test to use default null initialization * chore: tear down for gdch IT * chore: `assertThrows` for gdch ITs * chore: mvn fmt:format * test: remove context test * docs: explain that audience will be overriden if set through client/stub settings * test: test audience setting should modify initial credentials * chore: clirr check * chore: ignore gdch changes * chore: format * chore: default to endpoint if audience not provided * test: refresh gdch creds to confirm audience works * chore: fmt * chore: fmt * chore: better test names in ClientContextTest * chore: better test names for showcase tests * chore: simplify refresh verification logic * chore: include outcome in gdch it test names * chore: expand comments in GDCH ITs * test: intercept mock transport to verify audience * chore: fmt * chore: move auth test-jar to shared dependencies * chore: cleanup * chore: use inferred version for auth library * deps: update google-auth-java-library to 1.19.0 * choreL fmt ITGdch.java * chore: import auth test-jar using common version variable * chore: remove auth test-jar import from first-party-dependencies * chore: add license headers to new files * chore: revert google-auth-version to be obtained from main branch * chore: correct showcase parent pom indentation * chore: remove resource declaration for native test build * fix: [gapic-generator-java] handle response and metadata type ambiguity in LRO parsing (#1726) * chore: Bump grpc-java version to 1.55.3 (#1829) * chore: Bump gapic-showcase version to 0.28.2 (#1830) * build(deps): Bump guava version to 32.1.1-jre (#1832) * chore: Bump guava version to 32.1.1-jre * chore: Add guava to gradle template * chore: Add j2obc-annotations to shared-dependencies (#1834) * ci: fix showcase-clirr check on release PRs (#1835) Install sdk-platform-java before performing final clirr check, so version changes are available in the local repository * chore(main): release 2.23.0 (#1806) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> * chore(main): release 2.23.1-SNAPSHOT (#1836) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> * chore: Implement gRPC and HttpJson showcase tests for IAM (#1789) * chore: Add framework for iam showcase tests * chore: Generate clients with IAM stubs * chore: Add IAM showcase tests * chore: Add samples * chore: Exclude httpjson tests * chore: Use @before to create the resource * chore: Use constant for policy * chore: Log resource name * chore: Test use setPolicyRequest's resourceName * chore: run mvn clean before showcase tests * chore: Attempt again with cache deleted * chore: Add logging for test * chore: Sleep for 1s * chore: Use resource from setPolicyRequest * chore: Ignore failing HttpJson test for now * chore: Un-ignore test * chore: Fix lint issues * chore: Test with rooms/ prefix * chore: Use Identity client for Users * chore: Create user resource to assign policy to * chore: Use user's name as resource id * chore: Change resource name before each test * chore: Add iam-grpc in pom * chore: Resolve sonar issues * chore: Add comment for testIamPolicy * chore: Address PR comments * ci: showcase native check (#1833) * ci: showcase native check * fix: add explicit java version * fix: adjust syntax * fix: add resource-config entry for ITGdch * fix: copy file to temp folder so it can be accessed by path * chore: formatting * fix: prevent shutdown warnings with client.awaitTermination * ci: fix build file location for downstream test * chore: use static imports for Truth assertions * chore: Resolve merge conflicts * chore: Use bindings for any matching resource patterns * chore: Fix lint issues * chore: Remove unused code * chore: Fix lint issues * chore: Add test for resourceName matching bindings * chore: Fix lint issues --------- Co-authored-by: Diego Alonso Marquez Palacios <diegomarquezp@google.com> Co-authored-by: Emily Wang <emmwang@google.com> Co-authored-by: Burke Davison <40617934+burkedavison@users.noreply.github.com> Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

diegomarquezp added 2 commits April 14, 2023 17:01

chore: initial additions to handle GDC-H API audience

80f7327

chore: add unit tests for GDC-H

110f043

product-auto-label bot added the size: m Pull request size is medium. label Apr 20, 2023

diegomarquezp changed the title ~~feat: support GDC-H Credentials~~ feat: [wip] support GDC-H Credentials Apr 20, 2023

diegomarquezp added 3 commits May 3, 2023 14:04

chore: cleanup of logic

7385189

chore: decompose tests into separate methods

032af75

chore: fix clirr diff check

6cc7f6b

diegomarquezp closed this May 3, 2023

diegomarquezp reopened this May 3, 2023

diegomarquezp added 7 commits May 3, 2023 15:43

chore: fmt:format

78df0fd

chore: add support in ClientSettings

f5b9d99

Merge remote-tracking branch 'origin/main' into gdc-h

5f149db

chore: add showcase IT for GDCH credentials

bbde736

chore: comments

8fb9ced

chore: improve tests

ea4a03c

chore: add partial IT for testing context credential

ea05922

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels May 23, 2023

diegomarquezp commented May 23, 2023

View reviewed changes

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java Outdated Show resolved Hide resolved

blakeli0 reviewed May 24, 2023

View reviewed changes

gax-java/gax/src/test/java/com/google/api/gax/rpc/ClientContextTest.java Outdated Show resolved Hide resolved

blakeli0 reviewed May 24, 2023

View reviewed changes

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java Outdated Show resolved Hide resolved

blakeli0 reviewed May 24, 2023

View reviewed changes

diegomarquezp added 8 commits May 24, 2023 18:32

chore: recreate GdchCredentials with audience using convenience method

5cbf2b2

chore: more readable api audience logic

40f21a5

chore: no wildcard imports

27cb7c7

chore: javadoc for public methods

bd44dd1

chore: gdch test to use default null initialization

c5cac43

chore: tear down for gdch IT

f1b5cbf

chore: assertThrows for gdch ITs

5e2af11

chore: mvn fmt:format

a3a0f4b

diegomarquezp added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 23, 2023

chore: move auth test-jar to shared dependencies

1c69890

blakeli0 reviewed Jun 23, 2023

View reviewed changes

diegomarquezp added 4 commits June 23, 2023 15:14

chore: cleanup

a2e6c90

chore: use inferred version for auth library

d6ce65c

deps: update google-auth-java-library to 1.19.0

60828fe

choreL fmt ITGdch.java

e30dabb

diegomarquezp removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 28, 2023

chore: import auth test-jar using common version variable

ad0f3ba

diegomarquezp requested a review from blakeli0 June 28, 2023 20:55

blakeli0 reviewed Jun 28, 2023

View reviewed changes

gapic-generator-java-pom-parent/pom.xml Show resolved Hide resolved

blakeli0 reviewed Jun 28, 2023

View reviewed changes

java-shared-dependencies/first-party-dependencies/pom.xml Outdated Show resolved Hide resolved

blakeli0 reviewed Jun 28, 2023

View reviewed changes

showcase/gapic-showcase/src/test/java/com/google/showcase/v1beta1/it/ITGdch.java Show resolved Hide resolved

blakeli0 reviewed Jun 28, 2023

View reviewed changes

showcase/pom.xml Outdated Show resolved Hide resolved

diegomarquezp added 5 commits June 28, 2023 17:27

chore: remove auth test-jar import from first-party-dependencies

4f819b7

chore: add license headers to new files

95a3568

chore: revert google-auth-version to be obtained from main branch

5e84582

Merge remote-tracking branch 'origin/main' into gdc-h

7e7979a

chore: correct showcase parent pom indentation

596ff9b

blakeli0 reviewed Jun 28, 2023

View reviewed changes

showcase/gapic-showcase/src/test/resources/META-INF/native-image/resource-config.json Outdated Show resolved Hide resolved

blakeli0 approved these changes Jun 28, 2023

View reviewed changes

chore: remove resource declaration for native test build

f08dffc

diegomarquezp merged commit 26da0d3 into main Jun 28, 2023

diegomarquezp deleted the gdc-h branch June 28, 2023 22:39

release-please bot mentioned this pull request Jun 28, 2023

chore(main): release 2.23.0 #1806

Merged

	if (settings.getQuotaProjectId() != null) {
	// If the quotaProjectId is set, wrap original credentials with correct quotaProjectId as
	// QuotaProjectIdHidingCredentials.
	// Ensure that a custom set quota project id takes priority over one detected by credentials.
	// Avoid the backend receiving possibly conflict values of quotaProjectId
	credentials = new QuotaProjectIdHidingCredentials(credentials);
	}

	return newBuilder()
	.setBackgroundResources(backgroundResources.build())
	.setExecutor(backgroundExecutor)
	.setCredentials(credentials)

Conversation

diegomarquezp commented Apr 20, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blakeli0 May 24, 2023

Choose a reason for hiding this comment

Uh oh!

diegomarquezp May 24, 2023

Choose a reason for hiding this comment

Uh oh!

TimurSadykov Jun 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blakeli0 Jun 2, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blakeli0 left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jun 28, 2023

Uh oh!

sonarqubecloud bot commented Jun 28, 2023

Uh oh!

sonarqubecloud bot commented Jun 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

TimurSadykov Jun 1, 2023 •

edited

Loading