chore: declare test-jar in GAX's testlib artifacts #1474

JoeWang1127 · 2023-03-09T22:51:00Z

Thank you for opening a Pull Request! For general contributing guidelines, please refer to contributing guide

Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #1144 ☕️

conventional-commit-lint-gcf · 2023-03-09T22:51:05Z

🤖 I detect that the PR title and the commit message differ and there's only one commit. To use the PR title for the commit history, you can use Github's automerge feature with squashing, or use automerge label. Good luck human!

-- conventional-commit-lint bot
https://conventionalcommits.org/

suztomo · 2023-03-10T14:52:23Z

gapic-generator-java/pom.xml

@@ -374,6 +374,7 @@
    <dependency>
      <groupId>com.google.api</groupId>
      <artifactId>gax</artifactId>
+      <type>test-jar</type>


Can you add source code comment why this test-jar is important?

suztomo · 2023-03-10T15:05:58Z

Assuming this is the correct fix, will we need any change in the users of GAX’s testlib-classifier users?

JoeWang1127 · 2023-03-10T15:09:41Z

Assuming this is the correct fix, will we need any change in the users of GAX’s testlib-classifier users?

I think they need to add <type>test-jar</type> in their pom file.

I found out this in the failing Kokoro checks

[ERROR]   The project com.google.cloud:google-cloud-accessapproval:2.13.0 (/tmpfs/src/github/gapic-generator-java/google-cloud-java/java-accessapproval/google-cloud-accessapproval/pom.xml) has 3 errors
[ERROR]     'dependencies.dependency.version' for com.google.api:gax:jar:testlib is missing. @ line 80, column 21
[ERROR]     'dependencies.dependency.version' for com.google.api:gax-grpc:jar:testlib is missing. @ line 86, column 17
[ERROR]     'dependencies.dependency.version' for com.google.api:gax-httpjson:jar:testlib is missing. @ line 92, column 17

suztomo · 2023-03-10T15:26:26Z

My own confirmation.

Remove local Maven repository cache: $ rm -rf ~/.m2/repository/com/google/api/gax*

Checkout main (not this pull request):

[email protected] ~/gapic-generator-java
~/gapic-generator-java $ git checkout main
Already on 'main'
Your branch is up to date with 'origin/main'.
[email protected] ~/gapic-generator-java
~/gapic-generator-java $ git pull
Already up to date.

Open gapic-generator-java project in IntelliJ and tried running the gapic-generator-java module's unit tests. It shows the error.

Now checkout this pull request.

~/gapic-generator-java $ gh pr checkout 1474

Run the unit tests in IntelliJ. It succeeded.

suztomo · 2023-03-10T15:27:19Z

@blakeli0 Can you confirm this pull request fixes the problem in your IntelliJ? (It worked form me)

suztomo · 2023-03-10T15:29:21Z

gax-java/gax-bom/pom.xml

@@ -48,6 +48,7 @@
        <groupId>com.google.api</groupId>
        <artifactId>gax</artifactId>
        <version>2.23.3-SNAPSHOT</version><!-- {x-version-update:gax:current} -->
+        <type>test-jar</type>


@JoeWang1127 'dependencies.dependency.version' for com.google.api:gax:jar:testlib is missing. @ line 80, column 21 came from the BOM's declaration of the artifacts. Do you really need that?

I think this line is needed to bring the test code.

A BOM doesn't determine what code goes to JAR file.

There's an error in gapic-generator-java module if I delete this line and reload the project:

'dependencies.dependency.version' for com.google.api:gax-grpc:test-jar:testlib is missing.

OK it’s for IntelliJ. Then it makes sense.

blakeli0 · 2023-03-10T17:25:33Z

@blakeli0 Can you confirm this pull request fixes the problem in your IntelliJ? (It worked form me)

Yes, I verified that it's working now with Joe's fix. Thank you so much @JoeWang1127 !

suztomo · 2023-03-10T18:41:27Z

gax-java/gax-bom/pom.xml

+        <groupId>com.google.api</groupId>
+        <artifactId>gax</artifactId>
+        <version>2.23.3-SNAPSHOT</version><!-- {x-version-update:gax:current} -->
+        <classifier>testlib</classifier>


Trying an additional entry that does not carry "test-jar".

@suztomo thanks for the help.

sonarcloud · 2023-03-10T18:43:27Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

…enerator-java into chore/enable-test-jar

sonarcloud · 2023-03-10T19:24:06Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

suztomo

Thank you.

Source-Link: googleapis/synthtool@7a220e2 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:6d4e3a15c62cfdcb823d60e16da7521e7c6fc00eba07c8ff12e4de9924a57d28

product-auto-label bot added the size: xs Pull request size is extra small. label Mar 9, 2023

chore: add test jar

2484061

JoeWang1127 force-pushed the chore/enable-test-jar branch from 12bdf6d to 2484061 Compare March 9, 2023 22:52

add test jar for showcase

46b7938

JoeWang1127 mentioned this pull request Mar 9, 2023

After repository merge IntelliJ is showing some classes missing #1144

Closed

JoeWang1127 linked an issue Mar 9, 2023 that may be closed by this pull request

After repository merge IntelliJ is showing some classes missing #1144

Closed

suztomo reviewed Mar 10, 2023

View reviewed changes

Merge branch 'main' into chore/enable-test-jar

92ad52e

suztomo changed the title ~~chore: add test jar~~ chore: declare test-jar in GAX's testlib artifacts Mar 10, 2023

suztomo reviewed Mar 10, 2023

View reviewed changes

how about duplicating entries?

1aa9040

product-auto-label bot added size: s Pull request size is small. and removed size: xs Pull request size is extra small. labels Mar 10, 2023

testlib for gax-httpjson too

faf89ba

suztomo reviewed Mar 10, 2023

View reviewed changes

JoeWang1127 added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 10, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 10, 2023

JoeWang1127 added 2 commits March 10, 2023 14:11

Merge branch 'chore/enable-test-jar' of github.com:googleapis/gapic-g…

c95c5d4

…enerator-java into chore/enable-test-jar

add source comment

f3b8be5

JoeWang1127 added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 10, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 10, 2023

JoeWang1127 marked this pull request as ready for review March 10, 2023 19:58

JoeWang1127 requested a review from a team as a code owner March 10, 2023 19:58

JoeWang1127 requested review from suztomo and blakeli0 March 10, 2023 19:58

blakeli0 approved these changes Mar 10, 2023

View reviewed changes

suztomo approved these changes Mar 10, 2023

View reviewed changes

Merge branch 'main' into chore/enable-test-jar

f106572

JoeWang1127 merged commit 68f24f2 into main Mar 10, 2023

JoeWang1127 deleted the chore/enable-test-jar branch March 10, 2023 23:05

suztomo mentioned this pull request Mar 15, 2023

chore: add aggregate test coverage collection of gax within the showcase and gax modules #1430

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: declare test-jar in GAX's testlib artifacts #1474

chore: declare test-jar in GAX's testlib artifacts #1474

JoeWang1127 commented Mar 9, 2023 •

edited

Loading

conventional-commit-lint-gcf bot commented Mar 9, 2023 •

edited

Loading

suztomo Mar 10, 2023

JoeWang1127 Mar 10, 2023

suztomo commented Mar 10, 2023

JoeWang1127 commented Mar 10, 2023

suztomo commented Mar 10, 2023

suztomo commented Mar 10, 2023

suztomo Mar 10, 2023

JoeWang1127 Mar 10, 2023

suztomo Mar 10, 2023

JoeWang1127 Mar 10, 2023 •

edited

Loading

suztomo Mar 10, 2023

blakeli0 commented Mar 10, 2023

suztomo Mar 10, 2023 •

edited

Loading

JoeWang1127 Mar 10, 2023

sonarcloud bot commented Mar 10, 2023

sonarcloud bot commented Mar 10, 2023

suztomo left a comment

chore: declare test-jar in GAX's testlib artifacts #1474

chore: declare test-jar in GAX's testlib artifacts #1474

Conversation

JoeWang1127 commented Mar 9, 2023 • edited Loading

conventional-commit-lint-gcf bot commented Mar 9, 2023 • edited Loading

suztomo Mar 10, 2023

Choose a reason for hiding this comment

JoeWang1127 Mar 10, 2023

Choose a reason for hiding this comment

suztomo commented Mar 10, 2023

JoeWang1127 commented Mar 10, 2023

suztomo commented Mar 10, 2023

suztomo commented Mar 10, 2023

suztomo Mar 10, 2023

Choose a reason for hiding this comment

JoeWang1127 Mar 10, 2023

Choose a reason for hiding this comment

suztomo Mar 10, 2023

Choose a reason for hiding this comment

JoeWang1127 Mar 10, 2023 • edited Loading

Choose a reason for hiding this comment

suztomo Mar 10, 2023

Choose a reason for hiding this comment

blakeli0 commented Mar 10, 2023

suztomo Mar 10, 2023 • edited Loading

Choose a reason for hiding this comment

JoeWang1127 Mar 10, 2023

Choose a reason for hiding this comment

sonarcloud bot commented Mar 10, 2023

sonarcloud bot commented Mar 10, 2023

suztomo left a comment

Choose a reason for hiding this comment

JoeWang1127 commented Mar 9, 2023 •

edited

Loading

conventional-commit-lint-gcf bot commented Mar 9, 2023 •

edited

Loading

JoeWang1127 Mar 10, 2023 •

edited

Loading

suztomo Mar 10, 2023 •

edited

Loading