Create new google-cloud-conformance-tests module

google-cloud-clients/pom.xml

@@ -420,6 +420,12 @@
         <artifactId>checker-compat-qual</artifactId>
         <version>2.5.5</version>
       </dependency>
+      <dependency>
+        <groupId>com.google.cloud</groupId>
+        <artifactId>google-cloud-conformance-tests</artifactId>
+        <version>0.1.0-SNAPSHOT</version>
+        <scope>test</scope>
+      </dependency>
     </dependencies>
   </dependencyManagement>
   <modules>

google-cloud-testing/google-cloud-conformance-tests/pom.xml

@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <artifactId>google-cloud-conformance-tests</artifactId>
+  <version>0.1.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+
+  <parent>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-testing</artifactId>
+    <version>0.98.1-alpha-SNAPSHOT</version><!-- {x-version-update:google-cloud-testing:current} -->
+  </parent>
+
+  <properties>
+    <protobuf.version>3.7.1</protobuf.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.google.api.grpc</groupId>
+      <artifactId>proto-google-cloud-firestore-v1</artifactId>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <extensions>
+      <extension>
+        <groupId>kr.motd.maven</groupId>
+        <artifactId>os-maven-plugin</artifactId>
+        <version>1.6.2</version>
+      </extension>
+    </extensions>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <version>3.0.0</version>
+        <executions>
+          <execution>
+            <id>add-main-resource</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>add-resource</goal>
+            </goals>
+            <configuration>
+              <resources>
+                <resource>
+                  <directory>src/main/proto</directory>
+                </resource>
+              </resources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+  <profiles>
+    <profile>
+      <id>gen-conformance-protos</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.xolstice.maven.plugins</groupId>
+            <artifactId>protobuf-maven-plugin</artifactId>
+            <version>0.6.1</version>
+            <executions>
+              <execution>
+                <id>generate-main</id>
+                <goals>
+                  <goal>compile</goal>
+                </goals>
+                <phase>generate-sources</phase>
+              </execution>
+              <execution>
+                <id>generate-test</id>
+                <goals>
+                  <goal>test-compile</goal>
+                </goals>
+                <phase>generate-test-sources</phase>
+              </execution>
+            </executions>
+            <configuration>
+              <protocArtifact>com.google.protobuf:protoc:${protobuf.version}:exe:${os.detected.classifier}</protocArtifact>
+            </configuration>
+          </plugin>
+          <plugin>
+            <groupId>com.coveo</groupId>
+            <artifactId>fmt-maven-plugin</artifactId>
+            <version>2.9</version>
+            <executions>
+              <execution>
+                <id>format-main</id>
+                <goals>
+                  <goal>format</goal>
+                </goals>
+                <phase>process-sources</phase>
+              </execution>
+              <execution>
+                <id>format-test</id>
+                <goals>
+                  <goal>format</goal>
+                </goals>
+                <phase>process-test-sources</phase>
+              </execution>
+            </executions>
+            <configuration>
+              <additionalSourceDirectories>
+                <directory>target/generated-sources/protobuf/java</directory>
+              </additionalSourceDirectories>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
+</project>

google-cloud-testing/google-cloud-conformance-tests/src/main/java/com/google/cloud/conformance/ConformanceTestLocator.java

@@ -0,0 +1,206 @@
+/*
+ * Copyright 2019 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.conformance;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+public final class ConformanceTestLocator {
+
+  private ConformanceTestLocator() {}
+
+  /**
+   * Given the provided {@link MatchPattern matchPattern} list resources on the classpath starting
+   * from {@link MatchPattern#getBaseResourcePath() MatchPattern.getBaseResourcePath} and for each
+   * resources resource test that it is a file and that matches according to {@link
+   * MatchPattern#matches(String) MatchPattern.matches(String)}.
+   *
+   * <p>Resolution of resources paths will be against the current threads context class loader
+   * ({@link Thread#currentThread()}.{@link Thread#getContextClassLoader() getContextClassLoader()}
+   *
+   * @param matchPattern The {@link MatchPattern} to match against
+   * @return The list of all resources on the classpath that match the specified {@code
+   *     matchPattern}
+   * @throws IOException If there is an error attempting to read a classpath resource (listing the
+   *     contents of a directory or jar).
+   * @throws URISyntaxException If there is an error translating a classpath URL into a filesystem
+   *     URI.
+   */
+  public static List<String> findAllResourcePaths(final MatchPattern matchPattern)
+      throws IOException, URISyntaxException {
+    return findAllResourcePaths(matchPattern, Thread.currentThread().getContextClassLoader());
+  }
+
+  /**
+   * Given the provided {@link MatchPattern matchPattern} list resources on the classpath starting
+   * from {@link MatchPattern#getBaseResourcePath() MatchPattern.getBaseResourcePath} and for each
+   * resources resource test that it is a file and that matches according to {@link
+   * MatchPattern#matches(String) MatchPattern.matches(String)}.
+   *
+   * <p>Resolution of resources paths will be against the parameter {@code classLoader}
+   *
+   * @param matchPattern The {@link MatchPattern} to match against
+   * @param classLoader The classLoader to scan for resources
+   * @return The list of all resources on the classpath that match the specified {@code
+   *     matchPattern}
+   * @throws IOException If there is an error attempting to read a classpath resource (listing the
+   *     contents of a directory or jar).
+   * @throws URISyntaxException If there is an error translating a classpath URL into a filesystem
+   *     URI.
+   */
+  public static List<String> findAllResourcePaths(
+      final MatchPattern matchPattern, ClassLoader classLoader)
+      throws IOException, URISyntaxException {
+    final List<String> resourcePaths = new ArrayList<>();
+    final Enumeration<URL> pkgDir = classLoader.getResources(matchPattern.getBaseResourcePath());
+    while (pkgDir.hasMoreElements()) {
+      URL url = pkgDir.nextElement();
+      if (url != null) {
+        final String scheme = url.getProtocol();
+        switch (scheme) {
+          case "file":
+            final List<String> cf = handleFileScheme(url, matchPattern);
+            resourcePaths.addAll(cf);
+            break;
+          case "jar":
+            final List<String> cj = handleJarScheme(url, matchPattern);
+            resourcePaths.addAll(cj);
+            break;
+          default:
+            throw new IllegalStateException("Unable to scan scheme '" + scheme + "'");
+        }
+      }
+    }
+
+    return resourcePaths;
+  }
+
+  private static List<String> handleFileScheme(final URL url, MatchPattern mp)
+      throws IOException, URISyntaxException {
+    final Path path = Paths.get(url.toURI());
+    return handleFileScheme(mp, path);
+  }
+
+  private static List<String> handleFileScheme(final MatchPattern mp, final Path path)
+      throws IOException {
+    final List<String> resourcePaths = new ArrayList<>();
+    try (final DirectoryStream<Path> paths = Files.newDirectoryStream(path)) {
+      for (Path p : paths) {
+        if (Files.isDirectory(p)) {
+          resourcePaths.addAll(handleFileScheme(mp, p));
+        } else {
+          final String filePath = normalizePath(p);
+          final String resourcePath =
+              filePath.substring(filePath.indexOf(mp.getBaseResourcePath()));
+          if (mp.matches(resourcePath)) {
+            resourcePaths.add(resourcePath);
+          }
+        }
+      }
+    }
+    return resourcePaths;
+  }
+
+  private static List<String> handleJarScheme(final URL url, MatchPattern mp) throws IOException {
+    final String urlPath = url.getPath();
+    final String jarPath = urlPath.substring(5, urlPath.indexOf("!"));
+
+    final List<String> resourcePaths = new ArrayList<>();
+    final JarFile jarFile = new JarFile(jarPath);
+    final Enumeration<JarEntry> jarEntries = jarFile.entries();
+    while (jarEntries.hasMoreElements()) {
+      JarEntry je = jarEntries.nextElement();
+      if (!je.isDirectory() && mp.matches(je.getName())) {
+        resourcePaths.add(je.getName());
+      }
+    }
+    return resourcePaths;
+  }
+
+  private static String normalizePath(Path p) {
+    final String s = p.normalize().toString();
+    if (File.separatorChar == '\\') {
+      return s.replace('\\', '/');
+    } else {
+      return s;
+    }
+  }
+
+  /**
+   * Factory method to create a relatively simple {@link MatchPattern}.
+   *
+   * @param baseResourcePath The non-null base path to start scanning for resources on the classpath
+   * @param suffix The non-null suffix to match found elements against for inclusion
+   * @return A new {@link MatchPattern} where classpath scanning will start from {@code
+   *     baseResourcePath} walking the classpath and matching to elements that end in {@code
+   *     suffix}. Suffix matching is a simple match (non-regex).
+   */
+  public static MatchPattern newMatchPattern(final String baseResourcePath, final String suffix) {
+    if (baseResourcePath == null) {
+      throw new IllegalArgumentException("baseResourcePath must be non-null");
+    }
+    if (suffix == null || suffix.isEmpty()) {
+      throw new IllegalArgumentException("suffix must be non-null and non-empty");
+    }
+    // when listing the resources from the classpath, a leading slash will result in resources
+    // not being found. If the baseResourcePath passed in here has a leading slash, detect and
+    // remove it.
+    int begin = 0;
+    if (baseResourcePath.startsWith("/")) {
+      begin = 1;
+    }
+    return new SimpleMatchPattern(baseResourcePath.substring(begin), suffix);
+  }
+
+  public interface MatchPattern {
+    String getBaseResourcePath();
+
+    boolean matches(String resourcePath);
+  }
+
+  private static final class SimpleMatchPattern implements MatchPattern {
+    private final String baseResourcePath;
+    private final String suffix;
+
+    SimpleMatchPattern(final String baseResourcePath, final String suffix) {
+      // parameter construction validation is performed in the factory method #newMatchPattern
+      this.baseResourcePath = baseResourcePath;
+      this.suffix = suffix;
+    }
+
+    @Override
+    public String getBaseResourcePath() {
+      return baseResourcePath;
+    }
+
+    @Override
+    public boolean matches(final String resourcePath) {
+      return resourcePath.startsWith(baseResourcePath) && resourcePath.endsWith(suffix);
+    }
+  }
+}