feat: Integration Tests setup for experimental host

Author: sagnghos

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

@@ -814,7 +814,11 @@ protected SpannerOptions(Builder builder) {
     openTelemetry = builder.openTelemetry;
     enableApiTracing = builder.enableApiTracing;
     enableExtendedTracing = builder.enableExtendedTracing;
-    enableBuiltInMetrics = builder.enableBuiltInMetrics;
+    if (builder.isExperimentalHost) {
+      enableBuiltInMetrics = false;
+    } else {
+      enableBuiltInMetrics = builder.enableBuiltInMetrics;
+    }
     enableEndToEndTracing = builder.enableEndToEndTracing;
     monitoringHost = builder.monitoringHost;
     defaultTransactionOptions = builder.defaultTransactionOptions;

google-cloud-spanner/src/main/java/com/google/cloud/spanner/testing/ExperimentalHostHelper.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * 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.google.cloud.spanner.testing;
+
+import com.google.cloud.NoCredentials;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.base.Strings;
+import io.grpc.ManagedChannelBuilder;
+
+public class ExperimentalHostHelper {
+  private static final String EXPERIMENTAL_HOST = "spanner.experimental_host";
+  private static final String USE_PLAIN_TEXT = "spanner.use_plain_text";
+  private static final String USE_MTLS = "spanner.mtls";
+  private static final String CLIENT_CERT_PATH = "spanner.client_cert_path";
+  private static final String CLIENT_CERT_KEY_PATH = "spanner.client_cert_key_path";
+
+  /**
+   * Checks whether the emulator is being used. This is done by checking if the
+   * SPANNER_EMULATOR_HOST environment variable is set.
+   *
+   * @return true if the emulator is being used. Returns false otherwise.
+   */
+  public static boolean isExperimentalHost() {
+    return !Strings.isNullOrEmpty(System.getProperty(EXPERIMENTAL_HOST));
+  }
+
+  public static void appendExperimentalHost(StringBuilder uri) {
+    uri.append(";isExperimentalHost=true");
+    if (isMtlsSetup()) {
+      String clientCertificate = System.getProperty(CLIENT_CERT_PATH, "");
+      String clientKey = System.getProperty(CLIENT_CERT_KEY_PATH, "");
+      uri.append(";clientCertificate=").append(clientCertificate);
+      uri.append(";clientKey=").append(clientKey);
+    }
+  }
+
+  public static boolean isMtlsSetup() {
+    return Boolean.getBoolean(USE_MTLS);
+  }
+
+  public static void setExperimentalHostSpannerOptions(SpannerOptions.Builder builder) {
+    String experimentalHost = System.getProperty(EXPERIMENTAL_HOST, "");
+    boolean usePlainText = Boolean.getBoolean(USE_PLAIN_TEXT);
+    builder.setExperimentalHost(experimentalHost);
+    builder.setBuiltInMetricsEnabled(false);
+    if (usePlainText) {
+      builder
+          .setChannelConfigurator(ManagedChannelBuilder::usePlaintext)
+          .setCredentials(NoCredentials.getInstance());
+    }
+    if (isMtlsSetup()) {
+      String clientCertificate = System.getProperty(CLIENT_CERT_PATH, "");
+      String clientKey = System.getProperty(CLIENT_CERT_KEY_PATH, "");
+      builder.useClientCert(clientCertificate, clientKey);
+    }
+  }
+}

google-cloud-spanner/src/test/java/com/google/cloud/spanner/GceTestEnvConfig.java

@@ -16,6 +16,8 @@
 
 package com.google.cloud.spanner;
 
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.setExperimentalHostSpannerOptions;
 import static com.google.common.base.Preconditions.checkState;
 
 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
@@ -101,6 +103,10 @@ public GceTestEnvConfig() {
           .setInterceptorProvider(interceptorProvider);
       builder.setChannelProvider(customChannelProviderBuilder.build());
     }
+
+    if (isExperimentalHost()) {
+      setExperimentalHostSpannerOptions(builder);
+    }
     options = builder.build();
   }
 

google-cloud-spanner/src/test/java/com/google/cloud/spanner/ITSessionPoolIntegrationTest.java

@@ -16,7 +16,9 @@
 
 package com.google.cloud.spanner;
 
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assume.assumeFalse;
 
 import com.google.cloud.grpc.GrpcTransportOptions.ExecutorFactory;
 import com.google.cloud.spanner.SessionPool.PooledSessionFuture;
@@ -53,6 +55,7 @@ public class ITSessionPoolIntegrationTest {
 
   @BeforeClass
   public static void setUpDatabase() {
+    assumeFalse("Only Multiplexed Sessions are supported on this host", isExperimentalHost());
     db =
         env.getTestHelper()
             .createTestDatabase(

google-cloud-spanner/src/test/java/com/google/cloud/spanner/ITTransactionRetryTest.java

@@ -17,6 +17,7 @@
 package com.google.cloud.spanner;
 
 import static com.google.cloud.spanner.testing.EmulatorSpannerHelper.isUsingEmulator;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
@@ -42,6 +43,7 @@ public void TestRetryInfo() {
     assumeFalse(
         "Skipping the test due to a known bug b/422916293",
         env.getTestHelper().getOptions().isEnableDirectAccess());
+    assumeFalse("Skipping the test due to a known bug b/422916293", isExperimentalHost());
 
     // Creating a database with the table which contains INT64 columns
     Database db =

google-cloud-spanner/src/test/java/com/google/cloud/spanner/IntegrationTestEnv.java

@@ -16,6 +16,7 @@
 
 package com.google.cloud.spanner;
 
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static com.google.common.base.Preconditions.checkState;
 import static org.junit.Assume.assumeFalse;
 
@@ -130,6 +131,9 @@ boolean isCloudDevel() {
   protected void before() throws Throwable {
     this.initializeConfig();
     assumeFalse(alwaysCreateNewInstance && isCloudDevel());
+    assumeFalse(
+        "Creating instances is not supported in experimental host",
+        alwaysCreateNewInstance && isExperimentalHost());
 
     this.config.setUp();
     SpannerOptions options = config.spannerOptions();
@@ -324,7 +328,7 @@ private void cleanUpInstance() {
       if (isOwnedInstance) {
         // Delete the instance, which implicitly drops all databases in it.
         try {
-          if (!EmulatorSpannerHelper.isUsingEmulator()) {
+          if (!EmulatorSpannerHelper.isUsingEmulator() && !isExperimentalHost()) {
             // Backups must be explicitly deleted before the instance may be deleted.
             logger.log(
                 Level.FINE, "Deleting backups on test instance {0}", testHelper.getInstanceId());

google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ITAbstractSpannerTest.java

@@ -16,6 +16,9 @@
 
 package com.google.cloud.spanner.connection;
 
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.appendExperimentalHost;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
+
 import com.google.cloud.NoCredentials;
 import com.google.cloud.spanner.Database;
 import com.google.cloud.spanner.ErrorCode;
@@ -236,6 +239,9 @@ public static StringBuilder extractConnectionUrl(SpannerOptions options, Databas
     if (options.getCredentials() == NoCredentials.getInstance()) {
       url.append(";usePlainText=true");
     }
+    if (isExperimentalHost()) {
+      appendExperimentalHost(url);
+    }
     return url;
   }
 

google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/it/ITRetryDmlAsPartitionedDmlTest.java

@@ -17,6 +17,7 @@
 package com.google.cloud.spanner.connection.it;
 
 import static com.google.cloud.spanner.testing.EmulatorSpannerHelper.isUsingEmulator;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertThrows;
@@ -54,6 +55,7 @@ public class ITRetryDmlAsPartitionedDmlTest extends ITAbstractSpannerTest {
   public static void setup() {
     // This shadows the setup() method in the super class and prevents it from being executed.
     // That allows us to have a custom setup method in this class.
+    assumeFalse("Skipping the test due to a known bug b/422916293", isExperimentalHost());
   }
 
   @BeforeClass

google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITAutogeneratedAdminClientTest.java

@@ -17,6 +17,7 @@
 package com.google.cloud.spanner.it;
 
 import static com.google.cloud.spanner.testing.EmulatorSpannerHelper.isUsingEmulator;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.*;
 import static org.junit.Assume.assumeFalse;
@@ -84,6 +85,7 @@ public static List<DatabaseDialect> data() {
 
   @BeforeClass
   public static void setUp() {
+    assumeFalse("Experimental Host does not support database roles", isExperimentalHost());
     assumeFalse("Emulator does not support database roles", isUsingEmulator());
     testHelper = env.getTestHelper();
     dbAdminClient = testHelper.getClient().createDatabaseAdminClient();

google-cloud-spanner/src/test/java/com/google/cloud/spanner/it/ITBatchReadTest.java

@@ -19,9 +19,11 @@
 import static com.google.cloud.spanner.connection.ITAbstractSpannerTest.extractConnectionUrl;
 import static com.google.cloud.spanner.connection.ITAbstractSpannerTest.getKeyFile;
 import static com.google.cloud.spanner.connection.ITAbstractSpannerTest.hasValidKeyFile;
+import static com.google.cloud.spanner.testing.ExperimentalHostHelper.isExperimentalHost;
 import static com.google.common.truth.Truth.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assume.assumeFalse;
 
 import com.google.cloud.ByteArray;
 import com.google.cloud.Timestamp;
@@ -247,6 +249,7 @@ public void readUsingIndex() {
 
   @Test
   public void dataBoostRead() {
+    assumeFalse("data boost is not supported on experimental host yet", isExperimentalHost());
     BitSet seenRows = new BitSet(numRows);
     TimestampBound bound = getRandomBound();
     PartitionOptions partitionParams = getRandomPartitionOptions();
@@ -299,6 +302,7 @@ private PartitionOptions getRandomPartitionOptions() {
 
   @Test
   public void dataBoostQuery() {
+    assumeFalse("data boost is not supported on experimental host yet", isExperimentalHost());
     BitSet seenRows = new BitSet(numRows);
     TimestampBound bound = getRandomBound();
     PartitionOptions partitionParams = getRandomPartitionOptions();