Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support public methods to use autogenerated admin clients. #2878

Merged
merged 34 commits into from
Feb 13, 2024
Merged
Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
edc5bbf
fix: prevent illegal negative timeout values into thread sleep() meth…
arpan14 Feb 6, 2023
49a85df
Merge pull request #1 from arpan14/retryerror
arpan14 Feb 8, 2023
4cd497b
Fixing lint issues.
arpan14 Feb 8, 2023
4a6aa8e
Merge branch 'googleapis:main' into main
arpan14 Mar 13, 2023
b2aa09d
Merge branch 'googleapis:main' into main
arpan14 Mar 15, 2023
8d6d71e
Merge branch 'googleapis:main' into main
arpan14 May 9, 2023
77e6e7d
Merge branch 'googleapis:main' into main
arpan14 Jul 17, 2023
e8b7fad
Merge branch 'googleapis:main' into main
arpan14 Jul 25, 2023
8aa84e1
Merge branch 'googleapis:main' into main
arpan14 Oct 10, 2023
57fd405
Merge branch 'googleapis:main' into main
arpan14 Oct 27, 2023
1253563
Merge branch 'googleapis:main' into main
arpan14 Nov 20, 2023
d4f6a60
Merge branch 'googleapis:main' into main
arpan14 Dec 15, 2023
3efaf7c
Merge branch 'googleapis:main' into main
arpan14 Dec 26, 2023
f41b39f
Merge branch 'googleapis:main' into main
arpan14 Jan 3, 2024
7e3287f
Merge branch 'googleapis:main' into main
arpan14 Jan 13, 2024
5d090ea
feat: support emulator with autogenerated admin clients.
arpan14 Feb 9, 2024
5c9c2e4
chore: modifying public interfaces and adding an integration test.
arpan14 Feb 10, 2024
bd4156b
chore: add deprecated annotations and add docs.
arpan14 Feb 10, 2024
8b5d800
chore: making interface methods default.
arpan14 Feb 12, 2024
500fd02
chore: add clirr ignore checks for public methods.
arpan14 Feb 12, 2024
832077e
Merge branch 'main' into admin-emulator-support
arpan14 Feb 12, 2024
0be2719
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…
arpan14 Feb 12, 2024
ab05f88
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…
arpan14 Feb 12, 2024
bb41cf7
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…
arpan14 Feb 12, 2024
3e8caa2
Update google-cloud-spanner/src/main/java/com/google/cloud/spanner/Sp…
arpan14 Feb 12, 2024
f71a4c1
chore: address PR comments.
arpan14 Feb 12, 2024
8330718
chore: decouple client stub objects and rely on common stub settings …
arpan14 Feb 12, 2024
d7f70fa
chore: remove unused map objects.
arpan14 Feb 12, 2024
07c9cd1
chore: fix broken unit tests.
arpan14 Feb 12, 2024
447ec3a
chore: handle case when client is terminated/shutdown
arpan14 Feb 12, 2024
3dd7017
chore: change to create methods and avoid stale instances.
arpan14 Feb 13, 2024
543fed9
Revert "chore: fix broken unit tests."
arpan14 Feb 13, 2024
53d4c7b
test: add more unit tests.
arpan14 Feb 13, 2024
d8d6a5b
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: fix broken unit tests.
  • Loading branch information
arpan14 committed Feb 12, 2024
commit 07c9cd1121f2cf1f6e51d89a8981944325b2ad7b
Original file line number Diff line number Diff line change
@@ -30,12 +30,17 @@
import com.google.cloud.Timestamp;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.protobuf.ByteString;
import com.google.protobuf.util.Timestamps;
import com.google.spanner.v1.Session;
import com.google.spanner.v1.Transaction;
import io.opentelemetry.api.OpenTelemetry;
import java.io.IOException;
import java.util.Collections;
import java.util.Map;
import org.junit.Before;
@@ -59,6 +64,10 @@ public final class BatchClientImplTest {

@Mock private SpannerRpc gapicRpc;
@Mock private SpannerOptions spannerOptions;
@Mock private InstanceAdminStubSettings instanceAdminStubSettings;
@Mock private DatabaseAdminStubSettings databaseAdminStubSettings;
@Mock private DatabaseAdminStub databaseAdminStub;
@Mock private InstanceAdminStub instanceAdminStub;
@Captor private ArgumentCaptor<Map<SpannerRpc.Option, Object>> optionsCaptor;
@Mock private BatchTransactionId txnID;

@@ -72,7 +81,7 @@ public static void setupOpenTelemetry() {

@SuppressWarnings("unchecked")
@Before
public void setUp() {
public void setUp() throws IOException {
initMocks(this);
DatabaseId db = DatabaseId.of(DB_NAME);
when(spannerOptions.getNumChannels()).thenReturn(4);
@@ -86,6 +95,10 @@ public void setUp() {
GrpcTransportOptions transportOptions = mock(GrpcTransportOptions.class);
when(transportOptions.getExecutorFactory()).thenReturn(mock(ExecutorFactory.class));
when(spannerOptions.getTransportOptions()).thenReturn(transportOptions);
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(gapicRpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(gapicRpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);
@SuppressWarnings("resource")
SpannerImpl spanner = new SpannerImpl(gapicRpc, spannerOptions);
client = new BatchClientImpl(spanner.getSessionClient(db));
Original file line number Diff line number Diff line change
@@ -34,6 +34,10 @@
import com.google.cloud.Timestamp;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.cloud.spanner.v1.stub.SpannerStubSettings;
import com.google.protobuf.ByteString;
@@ -52,6 +56,7 @@
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Scope;
import java.io.IOException;
import java.text.ParseException;
import java.util.Calendar;
import java.util.Collections;
@@ -76,6 +81,10 @@
public class SessionImplTest {
@Mock private SpannerRpc rpc;
@Mock private SpannerOptions spannerOptions;
@Mock private InstanceAdminStubSettings instanceAdminStubSettings;
@Mock private DatabaseAdminStubSettings databaseAdminStubSettings;
@Mock private DatabaseAdminStub databaseAdminStub;
@Mock private InstanceAdminStub instanceAdminStub;
private com.google.cloud.spanner.Session session;
@Captor private ArgumentCaptor<Map<SpannerRpc.Option, Object>> optionsCaptor;
private Map<SpannerRpc.Option, Object> options;
@@ -88,7 +97,7 @@ public static void setupOpenTelemetry() {

@SuppressWarnings("unchecked")
@Before
public void setUp() {
public void setUp() throws IOException {
MockitoAnnotations.initMocks(this);
when(spannerOptions.getNumChannels()).thenReturn(4);
when(spannerOptions.getPrefetchChunks()).thenReturn(1);
@@ -101,6 +110,10 @@ public void setUp() {
when(spannerOptions.getTransportOptions()).thenReturn(transportOptions);
when(spannerOptions.getSessionPoolOptions()).thenReturn(mock(SessionPoolOptions.class));
when(spannerOptions.getOpenTelemetry()).thenReturn(OpenTelemetry.noop());
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(rpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(rpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);
@SuppressWarnings("resource")
SpannerImpl spanner = new SpannerImpl(rpc, spannerOptions);
String dbName = "projects/p1/instances/i1/databases/d1";
Original file line number Diff line number Diff line change
@@ -29,9 +29,14 @@
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.spanner.SpannerException.DoNotConstructDirectly;
import com.google.cloud.spanner.SpannerImpl.ClosedException;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.spanner.v1.ExecuteSqlRequest.QueryOptions;
import io.opentelemetry.api.OpenTelemetry;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Collections;
@@ -55,6 +60,10 @@
public class SpannerImplTest {
@Mock private SpannerRpc rpc;
@Mock private SpannerOptions spannerOptions;
@Mock private InstanceAdminStubSettings instanceAdminStubSettings;
@Mock private DatabaseAdminStubSettings databaseAdminStubSettings;
@Mock private DatabaseAdminStub databaseAdminStub;
@Mock private InstanceAdminStub instanceAdminStub;
private SpannerImpl impl;

@Captor ArgumentCaptor<Map<SpannerRpc.Option, Object>> options;
@@ -66,7 +75,7 @@ public static void setupOpenTelemetry() {
}

@Before
public void setUp() {
public void setUp() throws IOException {
MockitoAnnotations.initMocks(this);
when(spannerOptions.getNumChannels()).thenReturn(4);
when(spannerOptions.getDatabaseRole()).thenReturn("role");
@@ -75,6 +84,10 @@ public void setUp() {
when(spannerOptions.getClock()).thenReturn(NanoClock.getDefaultClock());
when(spannerOptions.getSessionLabels()).thenReturn(Collections.emptyMap());
when(spannerOptions.getOpenTelemetry()).thenReturn(OpenTelemetry.noop());
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(rpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(rpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);
impl = new SpannerImpl(rpc, spannerOptions);
}

Original file line number Diff line number Diff line change
@@ -34,6 +34,10 @@
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
import com.google.cloud.spanner.TransactionManager.TransactionState;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.protobuf.ByteString;
import com.google.protobuf.Empty;
@@ -47,6 +51,7 @@
import com.google.spanner.v1.Session;
import com.google.spanner.v1.Transaction;
import io.opentelemetry.api.OpenTelemetry;
import java.io.IOException;
import java.util.Collections;
import java.util.UUID;
import java.util.concurrent.Executors;
@@ -77,6 +82,10 @@ public void release(ScheduledExecutorService exec) {

@Mock private SessionImpl session;
@Mock TransactionRunnerImpl.TransactionContextImpl txn;
@Mock private InstanceAdminStubSettings instanceAdminStubSettings;
@Mock private DatabaseAdminStubSettings databaseAdminStubSettings;
@Mock private DatabaseAdminStub databaseAdminStub;
@Mock private InstanceAdminStub instanceAdminStub;
private TransactionManagerImpl manager;

@BeforeClass
@@ -201,7 +210,7 @@ public void commitAfterRollbackFails() {

@SuppressWarnings("unchecked")
@Test
public void usesPreparedTransaction() {
public void usesPreparedTransaction() throws IOException {
SpannerOptions options = mock(SpannerOptions.class);
when(options.getNumChannels()).thenReturn(4);
GrpcTransportOptions transportOptions = mock(GrpcTransportOptions.class);
@@ -248,6 +257,11 @@ public void usesPreparedTransaction() {
com.google.protobuf.Timestamp.newBuilder()
.setSeconds(System.currentTimeMillis() * 1000))
.build()));
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(rpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(rpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);

DatabaseId db = DatabaseId.of("test", "test", "test");
try (SpannerImpl spanner = new SpannerImpl(rpc, options)) {
DatabaseClient client = spanner.getDatabaseClient(db);
@@ -263,7 +277,7 @@ public void usesPreparedTransaction() {

@SuppressWarnings({"unchecked", "resource"})
@Test
public void inlineBegin() {
public void inlineBegin() throws IOException {
SpannerOptions options = mock(SpannerOptions.class);
when(options.getNumChannels()).thenReturn(4);
GrpcTransportOptions transportOptions = mock(GrpcTransportOptions.class);
@@ -332,6 +346,11 @@ public void inlineBegin() {
com.google.protobuf.Timestamp.newBuilder()
.setSeconds(System.currentTimeMillis() * 1000))
.build()));
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(rpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(rpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);

DatabaseId db = DatabaseId.of("test", "test", "test");
try (SpannerImpl spanner = new SpannerImpl(rpc, options)) {
DatabaseClient client = spanner.getDatabaseClient(db);
Original file line number Diff line number Diff line change
@@ -34,6 +34,10 @@
import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
import com.google.cloud.spanner.SessionClient.SessionId;
import com.google.cloud.spanner.TransactionRunnerImpl.TransactionContextImpl;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
import com.google.cloud.spanner.spi.v1.SpannerRpc;
import com.google.common.base.Preconditions;
import com.google.protobuf.ByteString;
@@ -63,6 +67,7 @@
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.context.Scope;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;
@@ -81,6 +86,7 @@
/** Unit test for {@link com.google.cloud.spanner.TransactionRunnerImpl} */
@RunWith(JUnit4.class)
public class TransactionRunnerImplTest {

private static final class TestExecutorFactory
implements ExecutorFactory<ScheduledExecutorService> {
@Override
@@ -97,6 +103,10 @@ public void release(ScheduledExecutorService exec) {
@Mock private SpannerRpc rpc;
@Mock private SessionImpl session;
@Mock private TransactionRunnerImpl.TransactionContextImpl txn;
@Mock private InstanceAdminStubSettings instanceAdminStubSettings;
@Mock private DatabaseAdminStubSettings databaseAdminStubSettings;
@Mock private DatabaseAdminStub databaseAdminStub;
@Mock private InstanceAdminStub instanceAdminStub;
private TransactionRunnerImpl transactionRunner;
private boolean firstRun;
private boolean usedInlinedBegin;
@@ -151,7 +161,7 @@ public void setUp() {

@SuppressWarnings("unchecked")
@Test
public void usesPreparedTransaction() {
public void usesPreparedTransaction() throws IOException {
SpannerOptions options = mock(SpannerOptions.class);
when(options.getNumChannels()).thenReturn(4);
GrpcTransportOptions transportOptions = mock(GrpcTransportOptions.class);
@@ -196,6 +206,11 @@ public void usesPreparedTransaction() {
.setCommitTimestamp(
Timestamp.newBuilder().setSeconds(System.currentTimeMillis() * 1000))
.build()));
when(instanceAdminStubSettings.createStub()).thenReturn(instanceAdminStub);
when(databaseAdminStubSettings.createStub()).thenReturn(databaseAdminStub);
when(rpc.getInstanceAdminStubSettings()).thenReturn(instanceAdminStubSettings);
when(rpc.getDatabaseAdminStubSettings()).thenReturn(databaseAdminStubSettings);

DatabaseId db = DatabaseId.of("test", "test", "test");
try (SpannerImpl spanner = new SpannerImpl(rpc, options)) {
DatabaseClient client = spanner.getDatabaseClient(db);
Loading
Oops, something went wrong.