chore: added regional endpoint sample for datastore #1043
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * Copyright 2023 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.datastore; | ||
|
|
||
| // Imports the Google Cloud client library | ||
|
|
||
| import com.google.cloud.datastore.Datastore; | ||
| import com.google.cloud.datastore.DatastoreOptions; | ||
|
|
||
| public class RegionalEndpoint { | ||
|
|
||
| public Datastore createClient() throws Exception { | ||
| // Instantiates a client | ||
| // [START datastore_regional_endpoint] | ||
| DatastoreOptions options = | ||
| DatastoreOptions.newBuilder().setHost("https://nam5-datastore.googleapis.com").build(); | ||
| Datastore datastore = options.getService(); | ||
| // [END datastore_regional_endpoint] | ||
| return datastore; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Copyright 2023 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.datastore; | ||
|
|
||
| import com.google.cloud.datastore.Datastore; | ||
| import com.google.cloud.datastore.Entity; | ||
| import com.google.cloud.datastore.Key; | ||
| import com.rule.SystemsOutRule; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| /** Tests for quickstart sample. */ | ||
| @RunWith(JUnit4.class) | ||
| @SuppressWarnings("checkstyle:abbreviationaswordinname") | ||
| public class RegionalEndpointIT { | ||
|
|
||
| private static RegionalEndpoint regionalEndpoint; | ||
| @Rule public final SystemsOutRule systemsOutRule = new SystemsOutRule(); | ||
|
|
||
| private static final void deleteTestEntity(Datastore datastore) { | ||
| String kind = "Task"; | ||
| String name = "sampletask1"; | ||
| Key taskKey = datastore.newKeyFactory().setKind(kind).newKey(name); | ||
| datastore.delete(taskKey); | ||
| } | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| regionalEndpoint = new RegionalEndpoint(); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| System.setOut(null); | ||
|
There was a problem hiding this comment. issue: Remove this. If you use the |
||
| } | ||
|
|
||
| @Test | ||
| public void testRegionalEndpoint() throws Exception { | ||
| Datastore datastoreWithEndpoint = regionalEndpoint.createClient(); | ||
|
|
||
| // run a few operations with the client | ||
| deleteTestEntity(datastoreWithEndpoint); | ||
| // The kind for the new entity | ||
| String kind = "Task"; | ||
| // The name/ID for the new entity | ||
| String name = "sampletask1"; | ||
|
There was a problem hiding this comment. These are created in a common project, and many of these tests can be run at least 4x simultaneously. You should strongly consider using a UUID as name, possibly with a common prefix to tell you which test created, but failed before deleting the object. There was a problem hiding this comment. Updated to an identifiable ID. Thank you. |
||
| // The Cloud Datastore key for the new entity | ||
| Key taskKey = datastoreWithEndpoint.newKeyFactory().setKind(kind).newKey(name); | ||
|
|
||
| // Prepares the new entity | ||
| Entity task = Entity.newBuilder(taskKey).set("description", "Buy milk").build(); | ||
|
|
||
| // Saves the entity | ||
| datastoreWithEndpoint.put(task); | ||
|
|
||
| System.out.printf("Saved %s: %s%n", task.getKey().getName(), task.getString("description")); | ||
|
There was a problem hiding this comment. nit: Remove print statements. Tests are most commonly run in a CI/CD environment where output is written to logs. |
||
|
|
||
| // Retrieve entity | ||
| Entity retrieved = datastoreWithEndpoint.get(taskKey); | ||
|
|
||
| System.out.printf("Retrieved %s: %s%n", taskKey.getName(), retrieved.getString("description")); | ||
|
|
||
| systemsOutRule.assertContains("Saved sampletask1: Buy milk"); | ||
|
There was a problem hiding this comment. issue: it looks like this test is upserting an entity and then querying the Datastore for the same entity. You don't need to do a string comparison here. Instead just compare the |
||
| systemsOutRule.assertContains("Retrieved sampletask1: Buy milk"); | ||
| deleteTestEntity(datastoreWithEndpoint); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: current best practice is to include
importstatements and the sample class inside the region tags.See:
https://googlecloudplatform.github.io/samples-style-guide/#region-tags
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.