test: dependency convergence check on gRPC and GAX #595

suztomo · 2022-02-01T19:18:18Z

This PR adds a check to confirm gRPC version in the BOM and GAX's gRPC version converge.

Example failure

36b9816 gives an example failure:

Failed tests: testGrpcConvergence(com.google.cloud.DependencyConvergenceTest): The version for io.grpc:grpc-netty-shaded should be one but there are multiple of them: com.google.api:gax-grpc:jar:2.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.grpc:grpc-xds:jar:1.43.2 / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-all:jar:1.43.2 / io.grpc:grpc-xds:1.43.2 (compile) / io.grpc:grpc-netty-shaded:1.43.2 (compile), com.google.cloud:google-cloud-core-grpc:jar:2.4.0 / com.google.api:gax-grpc:2.11.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.grpc:grpc-alts:jar:1.43.2 / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-interop-testing:jar:1.43.2 / io.grpc:grpc-alts:1.43.2 (runtime) / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-netty-shaded:jar:1.43.2, com.google.cloud:native-image-support:jar:0.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (provided)

Excluding the opencensus artifact and grpc-grp

This is a compromise to implement the check without waiting for perfect convergence.

The test case ignores opencensus and grpc-grp artifacts because they depend on old gRPC version.

java.lang.AssertionError: The version for io.grpc:grpc-netty-shaded should be one but there are multiple of them:
com.google.cloud:grpc-gcp:jar:1.1.0 / io.grpc:grpc-netty-shaded:1.36.0 (runtime),
io.opencensus:opencensus-exporter-trace-stackdriver:jar:0.31.0 / io.grpc:grpc-netty-shaded:1.27.2 (compile),
com.google.api:gax-grpc:jar:2.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (runtime),
io.opencensus:opencensus-exporter-stats-stackdriver:jar:0.31.0 / io.grpc:grpc-netty-shaded:1.27.2 (compile),
io.grpc:grpc-interop-testing:jar:1.44.0 / io.grpc:grpc-alts:1.44.0 (runtime) / io.grpc:grpc-netty-shaded:1.44.0 (compile),
io.grpc:grpc-xds:jar:1.44.0 / io.grpc:grpc-netty-shaded:1.44.0 (compile),
io.grpc:grpc-alts:jar:1.44.0 / io.grpc:grpc-netty-shaded:1.44.0 (compile),
com.google.cloud:native-image-support:jar:0.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (provided),
io.grpc:grpc-all:jar:1.44.0 / io.grpc:grpc-xds:1.44.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (compile),
com.google.cloud:google-cloud-core-grpc:jar:2.4.0 / com.google.api:gax-grpc:2.11.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (runtime),
io.grpc:grpc-netty-shaded:jar:1.44.0

There are io.grpc:grpc-netty-shaded:1.27.2, io.grpc:grpc-netty-shaded:1.36.0 and io.grpc:grpc-netty-shaded:1.44.0 in the dependency graph... In order to pass this test, we need to upgrade io.opencensus:opencensus-exporter-trace-stackdriver and com.google.cloud:grpc-gcp:jar to use the latest gRPC version.

Fixes #532 ☕️

suztomo · 2022-02-02T16:40:53Z

.github/workflows/version-check.yaml

+  pull_request:
+name: version-check
+jobs:
+  upper-bound-check:


This upper-bound-check section is a copy from .github/workflows/upper-bound-check.yaml

suztomo · 2022-02-02T16:41:53Z

dependency-convergence-check/src/test/java/com/google/cloud/DependencyConvergenceTest.java

+    assertTrue(
+        "The version for "
+            + groupId
+            + ":"
+            + artifactId
+            + " should be one but there are multiple of them: "
+            + Joiner.on(", ").join(foundPaths),
+        foundVersions.size() <= 1);


When this assertion fails, it prints the following error:

java.lang.AssertionError: The version for io.grpc:grpc-netty-shaded should be one but there are multiple of them: com.google.cloud:grpc-gcp:jar:1.1.0 / io.grpc:grpc-netty-shaded:1.36.0 (runtime), io.opencensus:opencensus-exporter-trace-stackdriver:jar:0.31.0 / io.grpc:grpc-netty-shaded:1.27.2 (compile), com.google.api:gax-grpc:jar:2.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.opencensus:opencensus-exporter-stats-stackdriver:jar:0.31.0 / io.grpc:grpc-netty-shaded:1.27.2 (compile), io.grpc:grpc-interop-testing:jar:1.44.0 / io.grpc:grpc-alts:1.44.0 (runtime) / io.grpc:grpc-netty-shaded:1.44.0 (compile), io.grpc:grpc-xds:jar:1.44.0 / io.grpc:grpc-netty-shaded:1.44.0 (compile), io.grpc:grpc-alts:jar:1.44.0 / io.grpc:grpc-netty-shaded:1.44.0 (compile), com.google.cloud:native-image-support:jar:0.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (provided), io.grpc:grpc-all:jar:1.44.0 / io.grpc:grpc-xds:1.44.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (compile), com.google.cloud:google-cloud-core-grpc:jar:2.4.0 / com.google.api:gax-grpc:2.11.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.grpc:grpc-netty-shaded:jar:1.44.0

suztomo · 2022-02-02T16:45:33Z

dependency-convergence-check/src/test/java/com/google/cloud/DependencyConvergenceTest.java

+public class DependencyConvergenceTest {
+
+  @Test
+  public void testGrpcConvergence() throws Exception {


For now, it only checks gRPC used by GAX.

suztomo · 2022-02-02T16:46:09Z

.github/workflows/version-check.yaml

+      - name: Check the BOM content satisfies the upper-bound-check test case
+        run: mvn -B -V -ntp verify -Dcheckstyle.skip
+        working-directory: upper-bound-check
+  dependency-convergence-check:


dependency-convergence-check is a new check.

suztomo · 2022-02-03T22:21:14Z

36b9816 gives an example failure:

Failed tests:   testGrpcConvergence(com.google.cloud.DependencyConvergenceTest): The version for io.grpc:grpc-netty-shaded should be one but there are multiple of them: com.google.api:gax-grpc:jar:2.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.grpc:grpc-xds:jar:1.43.2 / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-all:jar:1.43.2 / io.grpc:grpc-xds:1.43.2 (compile) / io.grpc:grpc-netty-shaded:1.43.2 (compile), com.google.cloud:google-cloud-core-grpc:jar:2.4.0 / com.google.api:gax-grpc:2.11.0 (compile) / io.grpc:grpc-netty-shaded:1.44.0 (runtime), io.grpc:grpc-alts:jar:1.43.2 / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-interop-testing:jar:1.43.2 / io.grpc:grpc-alts:1.43.2 (runtime) / io.grpc:grpc-netty-shaded:1.43.2 (compile), io.grpc:grpc-netty-shaded:jar:1.43.2, com.google.cloud:native-image-support:jar:0.11.0 / io.grpc:grpc-netty-shaded:1.44.0 (provided)

* ci: adding dependency convergence check * test: try bad gRPC version * ci: fixed description of the check * test: reverted gRPC version * renaming to gRPC convergence test

suztomo added do not merge Indicates a pull request not ready for merge, due to either quality or timing. and removed do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Feb 1, 2022

ci: adding dependency convergence check

eff6258

suztomo force-pushed the grpc_version_check branch from e42474e to eff6258 Compare February 2, 2022 16:40

suztomo commented Feb 2, 2022

View reviewed changes

suztomo added the owlbot:run Add this label to trigger the Owlbot post processor. label Feb 2, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Feb 2, 2022

suztomo marked this pull request as ready for review February 2, 2022 17:45

suztomo requested a review from a team as a code owner February 2, 2022 17:45

suztomo requested a review from Neenu1995 February 2, 2022 17:47

test: try bad gRPC version

36b9816

suztomo added 2 commits February 3, 2022 17:23

ci: fixed description of the check

97f61cc

test: reverted gRPC version

936fd62

suztomo added kokoro:run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Feb 3, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Feb 3, 2022

yoshi-kokoro removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Feb 3, 2022

suztomo requested review from mpeddada1 and removed request for mpeddada1 February 8, 2022 15:52

Neenu1995 approved these changes Feb 8, 2022

View reviewed changes

renaming to gRPC convergence test

737768f

Neenu1995 added the owlbot:run Add this label to trigger the Owlbot post processor. label Feb 8, 2022

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Feb 8, 2022

suztomo merged commit 60df3db into googleapis:main Feb 8, 2022

suztomo deleted the grpc_version_check branch February 8, 2022 21:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test: dependency convergence check on gRPC and GAX #595

test: dependency convergence check on gRPC and GAX #595

Uh oh!

suztomo commented Feb 1, 2022 •

edited

Loading

Uh oh!

suztomo Feb 2, 2022 •

edited

Loading

Uh oh!

suztomo Feb 2, 2022

Uh oh!

suztomo Feb 2, 2022

Uh oh!

suztomo Feb 2, 2022

Uh oh!

suztomo commented Feb 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

test: dependency convergence check on gRPC and GAX #595

test: dependency convergence check on gRPC and GAX #595

Uh oh!

Conversation

suztomo commented Feb 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example failure

Excluding the opencensus artifact and grpc-grp

Uh oh!

suztomo Feb 2, 2022 • 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!

suztomo Feb 2, 2022

Choose a reason for hiding this comment

Uh oh!

suztomo Feb 2, 2022

Choose a reason for hiding this comment

Uh oh!

suztomo Feb 2, 2022

Choose a reason for hiding this comment

Uh oh!

suztomo commented Feb 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

suztomo commented Feb 1, 2022 •

edited

Loading

suztomo Feb 2, 2022 •

edited

Loading