fix(java): adding resource and reflection configurations for native image testing

pom.xml

@@ -152,6 +152,15 @@
       <artifactId>proto-google-cloud-spanner-v1</artifactId>
     </dependency>
 
+    <!-- Native Image dependencies-->
+    <dependency>
+      <groupId>org.graalvm.nativeimage</groupId>
+      <artifactId>svm</artifactId>
+      <version>22.0.0.2</version>
+      <scope>provided</scope>
+    </dependency>
+    <!-- Native Image dependencies-->
+
     <!-- Test dependencies -->
     <dependency>
       <groupId>com.google.cloud</groupId>
@@ -222,6 +231,14 @@
         <configuration>
           <exclude>com.google.cloud.spanner.IntegrationTest</exclude>
           <reportNameSuffix>sponge_log</reportNameSuffix>
+          <systemPropertyVariables>
+            <spanner.testenv.config.class>
+              com.google.cloud.spanner.GceTestEnvConfig
+            </spanner.testenv.config.class>
+            <spanner.testenv.instance>
+              projects/gcloud-devel/instances/spanner-testing-east1
+            </spanner.testenv.instance>
+          </systemPropertyVariables>
         </configuration>
       </plugin>
       <plugin>
@@ -311,6 +328,12 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-dependency-plugin</artifactId>
           <configuration>
+            <ignoredUsedUndeclaredDependencies>
+              <ignoredUsedUndeclaredDependency>org.graalvm.sdk:graal-sdk</ignoredUsedUndeclaredDependency>
+              <ignoredUsedUndeclaredDependency>com.google.api.grpc:grpc-google-cloud-spanner-v1</ignoredUsedUndeclaredDependency>
+              <ignoredUsedUndeclaredDependency>com.google.api.grpc:proto-google-cloud-spanner-admin-instance-v1</ignoredUsedUndeclaredDependency>
+              <ignoredUsedUndeclaredDependency>com.google.api.grpc:proto-google-cloud-spanner-admin-database-v1</ignoredUsedUndeclaredDependency>
+            </ignoredUsedUndeclaredDependencies>
             <ignoredUnusedDeclaredDependencies>
               <!-- TODO: Remove grpc-alts from ignored list once it has been removed from java-spanner -->
               <ignoredDependency>io.grpc:grpc-alts</ignoredDependency>

src/main/java/com/google/cloud/spanner/jdbc/nativeimage/SpannerFeature.java

@@ -0,0 +1,131 @@
+/*
+ * Copyright 2022 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
+ *
+ *     https://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.jdbc.nativeimage;
+
+import com.google.api.gax.nativeimage.NativeImageUtils;
+import com.oracle.svm.core.annotate.AutomaticFeature;
+import com.oracle.svm.core.configure.ResourcesRegistry;
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.hosted.Feature;
+import org.graalvm.nativeimage.impl.ConfigurationCondition;
+
+/** Registers Spanner library classes for reflection. */
+@AutomaticFeature
+final class SpannerFeature implements Feature {
+
+  private static final String SPANNER_CLASS = "com.google.spanner.v1.SpannerGrpc";
+  private static final String SPANNER_TEST_CLASS = "com.google.cloud.spanner.GceTestEnvConfig";
+  private static final String MOCK_CLASS = "com.google.cloud.spanner.MockDatabaseAdminServiceImpl";
+  private static final String CLIENT_SIDE_IMPL_CLASS =
+      "com.google.cloud.spanner.connection.ClientSideStatementImpl";
+  private static final String CLIENT_SIDE_VALUE_CONVERTER =
+      "com.google.cloud.spanner.connection.ClientSideStatementValueConverters";
+  private static final String CONNECTION_IMPL =
+      "com.google.cloud.spanner.connection.ConnectionImpl";
+  private static final String CLIENT_SIDE_STATEMENTS =
+      "com.google.cloud.spanner.connection.ClientSideStatements";
+  private static final String CONNECTION_STATEMENT_EXECUTOR =
+      "com.google.cloud.spanner.connection.ConnectionStatementExecutor";
+  private static final String CLIENT_SIDE_STATEMENT_NO_PARAM_EXECUTOR =
+      "com.google.cloud.spanner.connection.ClientSideStatementNoParamExecutor";
+  private static final String CLIENT_SIDE_STATEMENT_SET_EXECUTOR =
+      "com.google.cloud.spanner.connection.ClientSideStatementSetExecutor";
+  private static final String ABSTRACT_STATEMENT_PARSER =
+      "com.google.cloud.spanner.connection.AbstractStatementParser";
+  private static final String STATEMENT_PARSER =
+      "com.google.cloud.spanner.connection.SpannerStatementParser";
+  private static final String POSTGRESQL_STATEMENT_PARSER =
+      "com.google.cloud.spanner.connection.PostgreSQLStatementParser";
+  private static final String DIALECT = "com.google.cloud.spanner.Dialect";
+  private static final String STATEMENT_RESULT =
+      "com.google.cloud.spanner.connection.StatementResult$ResultType";
+
+  @Override
+  public void beforeAnalysis(BeforeAnalysisAccess access) {
+    registerSpannerTestClasses(access);
+    if (access.findClassByName(CLIENT_SIDE_IMPL_CLASS) != null) {
+      NativeImageUtils.registerClassHierarchyForReflection(access, CLIENT_SIDE_IMPL_CLASS);
+    }
+    if (access.findClassByName(CLIENT_SIDE_STATEMENT_NO_PARAM_EXECUTOR) != null) {
+      NativeImageUtils.registerClassForReflection(access, CLIENT_SIDE_STATEMENT_NO_PARAM_EXECUTOR);
+    }
+    if (access.findClassByName(CLIENT_SIDE_STATEMENT_SET_EXECUTOR) != null) {
+      NativeImageUtils.registerClassForReflection(access, CLIENT_SIDE_STATEMENT_SET_EXECUTOR);
+    }
+    if (access.findClassByName(CLIENT_SIDE_VALUE_CONVERTER) != null) {
+      NativeImageUtils.registerClassHierarchyForReflection(access, CLIENT_SIDE_VALUE_CONVERTER);
+    }
+    if (access.findClassByName(CLIENT_SIDE_STATEMENTS) != null) {
+      NativeImageUtils.registerClassForReflection(access, CLIENT_SIDE_STATEMENTS);
+    }
+    if (access.findClassByName(CONNECTION_STATEMENT_EXECUTOR) != null) {
+      NativeImageUtils.registerClassForReflection(access, CONNECTION_STATEMENT_EXECUTOR);
+    }
+    if (access.findClassByName(CONNECTION_IMPL) != null) {
+      NativeImageUtils.registerClassForReflection(access, CONNECTION_IMPL);
+    }
+    if (access.findClassByName(ABSTRACT_STATEMENT_PARSER) != null) {
+      NativeImageUtils.registerClassHierarchyForReflection(access, ABSTRACT_STATEMENT_PARSER);
+      NativeImageUtils.registerClassForReflection(access, DIALECT);
+    }
+    if (access.findClassByName(STATEMENT_PARSER) != null) {
+      NativeImageUtils.registerConstructorsForReflection(access, STATEMENT_PARSER);
+    }
+    if (access.findClassByName(POSTGRESQL_STATEMENT_PARSER) != null) {
+      NativeImageUtils.registerConstructorsForReflection(access, POSTGRESQL_STATEMENT_PARSER);
+    }
+    if (access.findClassByName(STATEMENT_RESULT) != null) {
+      NativeImageUtils.registerClassForReflection(access, STATEMENT_RESULT);
+    }
+
+    Class<?> spannerClass = access.findClassByName(SPANNER_CLASS);
+    if (spannerClass != null) {
+      NativeImageUtils.registerClassHierarchyForReflection(
+          access, "com.google.spanner.admin.database.v1.Database");
+      NativeImageUtils.registerClassHierarchyForReflection(
+          access, "com.google.spanner.admin.instance.v1.Instance");
+      NativeImageUtils.registerClassForReflection(
+          access, "com.google.spanner.admin.database.v1.RestoreInfo");
+
+      // Resources
+      ResourcesRegistry resourcesRegistry = ImageSingletons.lookup(ResourcesRegistry.class);
+      resourcesRegistry.addResources(
+          ConfigurationCondition.alwaysTrue(),
+          "\\Qcom/google/cloud/spanner/connection/ClientSideStatements.json\\E");
+      resourcesRegistry.addResources(
+          ConfigurationCondition.alwaysTrue(),
+          "\\Qcom/google/cloud/spanner/connection/PG_ClientSideStatements.json\\E");
+      resourcesRegistry.addResources(
+          "\\Qcom/google/cloud/spanner/spi/v1/grpc-gcp-apiconfig.json\\E");
+      resourcesRegistry.addResources(
+          ConfigurationCondition.alwaysTrue(),
+          "\\Qcom/google/cloud/spanner/connection/ITSqlScriptTest_TestQueryOptions.sql\\E");
+    }
+  }
+
+  private void registerSpannerTestClasses(BeforeAnalysisAccess access) {
+    Class<?> spannerTestClass = access.findClassByName(SPANNER_TEST_CLASS);
+    if (spannerTestClass != null) {
+      NativeImageUtils.registerConstructorsForReflection(access, SPANNER_TEST_CLASS);
+    }
+    Class<?> mockClass = access.findClassByName(MOCK_CLASS);
+    if (mockClass != null) {
+      NativeImageUtils.registerClassForReflection(
+          access, "com.google.cloud.spanner.MockDatabaseAdminServiceImpl$MockBackup");
+    }
+  }
+}

src/main/resources/META-INF/native-image/com.google.cloud/google-cloud-spanner-jdbc/native-image.properties

@@ -0,0 +1,3 @@
+Args = --initialize-at-build-time==com.google.cloud.spanner.IntegrationTestEnv,\
+  com.google.cloud.spanner.jdbc.it.JdbcIntegrationTestEnv,\
+  com.google.common.collect.RegularImmutableMap

src/main/resources/META-INF/native-image/com.google.cloud/google-cloud-spanner-jdbc/resource-config.json

@@ -0,0 +1,9 @@
+{
+  "resources":{
+    "includes":[
+      {"pattern":".*.sql"},
+      {"pattern":".*.json"},
+      {"pattern":".*.txt"}
+    ]
+  }
+}

src/test/java/com/google/cloud/spanner/jdbc/it/ITJdbcPreparedStatementTest.java

@@ -35,8 +35,8 @@
 import com.google.cloud.spanner.testing.EmulatorSpannerHelper;
 import com.google.common.base.Strings;
 import com.google.common.io.BaseEncoding;
-import java.io.File;
-import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
 import java.io.StringReader;
 import java.math.BigDecimal;
 import java.sql.BatchUpdateException;
@@ -54,7 +54,6 @@
 import java.util.Arrays;
 import java.util.Calendar;
 import java.util.List;
-import java.util.Objects;
 import java.util.Scanner;
 import java.util.TimeZone;
 import java.util.UUID;
@@ -1106,14 +1105,14 @@ private void assertDefaultParameterMetaData(ParameterMetaData pmd, int expectedP
   }
 
   private List<String> readValuesFromFile(String filename) {
-    File file = new File(Objects.requireNonNull(getClass().getResource(filename)).getFile());
     StringBuilder builder = new StringBuilder();
-    try (Scanner scanner = new Scanner(file)) {
+    try (InputStream stream = ITJdbcPreparedStatementTest.class.getResourceAsStream(filename)) {
+      Scanner scanner = new Scanner(stream);
       while (scanner.hasNextLine()) {
         String line = scanner.nextLine();
         builder.append(line).append("\n");
       }
-    } catch (FileNotFoundException e) {
+    } catch (IOException e) {
       throw new RuntimeException(e);
     }
     String[] array = builder.toString().split(";");