docs(sample): add native-image sample #621

suztomo · 2022-02-28T22:31:06Z

Relocating the sample from native-image-support to this repository

mvn clean verify -DskipTests -P lint passes.

Fixes #<issue_number_goes_here> ☕️

If you write sample code, please follow the samples format.

Relocating the sample from native-image-support to this repository

generated-files-bot · 2022-02-28T22:31:11Z

Warning: This pull request is touching the following templated files:

samples/pom.xml

suztomo · 2022-02-28T22:42:40Z

samples/native-image-sample/pom.xml

+      <dependency>
+        <groupId>com.google.cloud</groupId>
+        <artifactId>libraries-bom</artifactId>
+        <version>24.2.0</version>


This is the version that works with native-image-support 0.10.0.

suztomo · 2022-02-28T22:43:06Z

samples/native-image-sample/pom.xml

+          <groupId>com.google.cloud</groupId>
+          <artifactId>native-image-support</artifactId>
+          <version>0.10.0</version>
+        </dependency>


No JUnit-related dependencies because this project doesn't use JUnit.

suztomo · 2022-02-28T22:43:37Z

samples/native-image-sample/src/main/java/com/example/tasks/TasksSampleApplication.java

+   */
+  public static void main(String[] args) throws IOException {
+    String projectId = ServiceOptions.getDefaultProjectId();
+    LocationName parent = LocationName.of(projectId, "us-east1");


Open question: Does this work for those who don't use us-east1?

mpeddada1 · 2022-02-28T23:59:10Z

Awesome, thank you Tomo! Could we also add an integration test for this sample?

suztomo · 2022-03-01T14:12:38Z

@mpeddada1 I didn’t find an integration test in the native-support repository. Would you share the URL of it?

mpeddada1 · 2022-03-01T14:46:12Z

@mpeddada1 I didn’t find an integration test in the native-support repository. Would you share the URL of it?

Ah I'm afraid we have to manually write tests for the samples. We have a few examples if you'd like to refer to them: googleapis/java-firestore#872, https://github.com/googleapis/java-datastore/pull/640/files

suztomo · 2022-03-01T15:52:57Z

Thank you.

suztomo · 2022-03-01T17:11:16Z

The Kokoro failed and it shows:

Apache Maven 3.8.1 (05c21c65bdfed0f71a2f2ada8b84da59348c4c5d)
Maven home: /usr/local/lib/maven
Java version: 1.8.0_322, vendor: Oracle Corporation, runtime: /usr/local/openjdk-8/jre

...

[INFO] --- maven-compiler-plugin:3.8.1:compile (default-compile) @ native-image-sample ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to /tmpfs/src/github/java-tasks/samples/native-image-sample/target/classes
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] javac: invalid target release: 11
Usage: javac <options> <source files>
use -help for a list of possible options

Next step: investigate how java-firestore reconcile Java version in Kokoro Sample build.

Why java-firestore doesn't complain Java version in "Kokoro - Test: Samples"?

https://source.cloud.google.com/results/invocations/416fe06b-014c-4092-97b3-7cd4b6d40496/targets succeeded. It doesn't have the native-image test target.

The java-firestore directory has a special handling in .kokoro/build.sh that only runs samples/snapshot project. https://github.com/googleapis/java-firestore/blob/cf36ed37b8c62ef1117f1b12a2bcbcf4601ecc3a/.kokoro/build.sh#L82

This means, java-firestore doesn't run samples/native-image-sample integration test as part of "Kokoro - Test: Samples" build.

This special handling doesn't exist in java-tasks repository's build.sh.

Problem in Java version for "Kokoro - Test: Samples"

SAMPLE_FORMAT.md says we should consider Java 11. However the Kokoro Sample test infrastructure doesn't work for Java 11 Maven configuration. That's the gap we need to fill.

Options

Just use Java8.
Not adding "samples/native-image-sample" project from "samples" project.
- This means we don't test the sample code in pull requests.
- This is (in effect) the status quo in the java-firestore repository.
Uplift the Kokoro build infrastructure to use Java 11 for samples.

Consideration

Java-tasks repository is just one of the many (~100) auto-generated libraries. Among them, we have some samples in some (12) repositories. What's the best way to address the gap across other repositories?

suztomo · 2022-03-01T18:39:17Z

"Kokoro - Test: Samples" now succeeds and it has ITNativeImageTasksSample.

mpeddada1

Looks great! Thanks

mpeddada1 · 2022-03-01T18:57:30Z

samples/native-image-sample/src/main/java/com/example/tasks/TasksSampleApplication.java

+   * FAILED_PRECONDITION: The queue cannot be created because a queue with this name existed
+   * too recently.
+   */
+  private static final String GRAALVM_TEST_QUEUE_NAME = "graal-test-queue-";


Could we replace "graalvm" with "native" or "native-image"?

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

docs(sample): add native-image sample

f1ed2e9

Relocating the sample from native-image-support to this repository

suztomo requested a review from a team as a code owner February 28, 2022 22:31

product-auto-label bot added the api: cloudtasks Issues related to the googleapis/java-tasks API. label Feb 28, 2022

product-auto-label bot added the samples Issues that are directly related to samples. label Feb 28, 2022

blunderbuss-gcf bot assigned kurtisvg Feb 28, 2022

suztomo marked this pull request as draft February 28, 2022 22:32

rafactor: fixed license header

5d9a432

suztomo commented Feb 28, 2022

View reviewed changes

suztomo added 2 commits March 1, 2022 11:44

test: adding ITNativeImageTasksSample

3c482b8

test: enriched readme in native-image-sample

a37b8a2

test: using environment variable for location

0497a17

suztomo marked this pull request as ready for review March 1, 2022 18:39

test: adding comment on Java version for native-image-sample

aa186e4

suztomo requested review from Neenu1995 and mpeddada1 March 1, 2022 18:40

mpeddada1 approved these changes Mar 1, 2022

View reviewed changes

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

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

suztomo added the automerge Merge the pull request once unit tests and other checks pass. label Mar 1, 2022

🦉 Updates from OwlBot post-processor

77eb07c

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

gcf-merge-on-green bot merged commit ec53481 into googleapis:main Mar 1, 2022

gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Mar 1, 2022

release-please bot mentioned this pull request Mar 1, 2022

chore(main): release 2.1.5 #625

Merged

release-please bot mentioned this pull request May 24, 2022

chore(main): release 3.0.0 #692

Closed

docs(sample): add native-image sample #621

docs(sample): add native-image sample #621

Uh oh!

Conversation

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

Uh oh!

Uh oh!

generated-files-bot bot commented Feb 28, 2022

Uh oh!

suztomo Feb 28, 2022

Choose a reason for hiding this comment

Uh oh!

suztomo Feb 28, 2022

Choose a reason for hiding this comment

Uh oh!

suztomo Feb 28, 2022

Choose a reason for hiding this comment

Uh oh!

mpeddada1 commented Feb 28, 2022

Uh oh!

suztomo commented Mar 1, 2022

Uh oh!

mpeddada1 commented Mar 1, 2022

Uh oh!

suztomo commented Mar 1, 2022

Uh oh!

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

Uh oh!

Why java-firestore doesn't complain Java version in "Kokoro - Test: Samples"?

Problem in Java version for "Kokoro - Test: Samples"

Options

Consideration

Uh oh!

suztomo commented Mar 1, 2022

Uh oh!

mpeddada1 left a comment

Choose a reason for hiding this comment

Uh oh!

mpeddada1 Mar 1, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

suztomo commented Feb 28, 2022 •

edited

Loading

suztomo commented Mar 1, 2022 •

edited

Loading