feat: add dependency versions script

.kokoro/shared-dependencies-version.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+# 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.
+
+# Print out Java
+java -version
+
+# Get the directory of the build script
+scriptDir=$(realpath $(dirname "${BASH_SOURCE[0]}"))
+
+# Returns 0 if this is a release branch
+function isReleaseBranch() {
+  # Check if we're currently on a non-SNAPSHOT release branch.
+  currBranch=$(git rev-parse --abbrev-ref HEAD | grep "release-v")
+  snapShotCheck=$(echo ${currBranch} | grep "\-SNAPSHOT")
+  # Return 1 (failure) if this is not a release branch
+  if [[ -z ${currBranch} ]] || [[ ! -z ${snapShotCheck} ]]; then
+    return 1
+  fi
+  echo ${currBranch}
+  return 0
+}
+
+# Returns 0 if a library update commit was found, and 1 otherwise.
+# Echos commit message (if found) before completion.
+function getLibraryUpdateCommit() {
+  currentCommitNumber=$(git rev-parse HEAD)
+
+  # Check if we're updating a dependency including shared-dependencies.
+  currentCommitMessage=$(git log -1 ${currentCommitNumber} | grep "deps: update dependency com.google.cloud:google-cloud-")
+
+  if [[ -z ${currentCommitMessage} ]]; then
+    return 1
+  fi
+
+  echo ${currentCommitMessage}
+  return 0
+}
+
+runRelease=$(isReleaseBranch)
+returnValue=$?
+# If this is a release branch
+if [[ ${returnValue} -eq 0 ]]; then
+  # go to the dependency-convergence directory, i.e. our container for the script
+  pushd "${scriptDir}/../dependency-convergence"
+  mvn clean install -DskipTests
+  # Single quotes around double quotes so that the branch name is counted as only one argument
+  mvn exec:java -Dexec.args="'${runRelease}'"
+  exitCode=$?
+  popd
+  exit ${exitCode}
+fi
+
+libraryUpdate=$(getLibraryUpdateCommit)
+returnValue=$?
+
+if [[ ${returnValue} -eq 0 ]]; then
+  # go to the dependency-convergence directory, i.e. our container for the script
+  pushd "${scriptDir}/../dependency-convergence"
+  mvn clean install -DskipTests
+  mvn exec:java -e -Dexec.args="'${libraryUpdate}'"
+  exitCode=$?
+  popd
+  exit ${exitCode}
+fi
+
+echo "No release or library updates found! Assuming no error."
+exit 0

dependency-convergence/pom.xml

@@ -0,0 +1,61 @@
+<?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>
+  <parent>
+    <groupId>com.google.cloud.tools</groupId>
+    <artifactId>dependencies-parent</artifactId>
+    <version>1.5.0</version>
+  </parent>
+  <groupId>com.google.cloud.tools</groupId>
+  <artifactId>google-cloud-bom-dependencies-check</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+
+  <name>Google Cloud BOM Dependencies Check</name>
+  <organization>
+    <name>Google LLC.</name>
+    <url>https://www.google.com</url>
+  </organization>
+
+  <licenses>
+    <license>
+      <name>The Apache License, Version 2.0</name>
+      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
+    </license>
+  </licenses>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud.tools</groupId>
+      <artifactId>dependencies</artifactId>
+      <version>1.5.0</version>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.guava</groupId>
+      <artifactId>guava</artifactId>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>exec-maven-plugin</artifactId>
+        <configuration>
+          <skip>false</skip>
+          <mainClass>cloudbomcommitcheck.RecentCommitCheck</mainClass>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </build>
+</project>

dependency-convergence/src/main/java/cloudbomcommitcheck/Arguments.java

@@ -0,0 +1,145 @@
+/*
+ * 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 cloudbomcommitcheck;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import javax.annotation.Nullable;
+import org.apache.commons.cli.CommandLine;
+import org.apache.commons.cli.CommandLineParser;
+import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.HelpFormatter;
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.OptionGroup;
+import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
+
+/**
+ * Command-line option for {@link RecentCommitCheck}. The tool takes either a pom.xml file path or
+ * Maven coordinates for a BOM.
+ *
+ * @see <a href="https://github.com/googleapis/java-cloud-bom/blob/master/dashboard/src/main/java/com/google/cloud/tools/opensource/cloudbomdashboard/DashboardArguments.java"</a>
+ */
+final class Arguments {
+
+  private static final Options options = configureOptions();
+  private static final HelpFormatter helpFormatter = new HelpFormatter();
+
+  private final CommandLine commandLine;
+
+  private Arguments(CommandLine commandLine) {
+    this.commandLine = commandLine;
+  }
+
+  /**
+   * Returns true if the argument for a file is specified. False if the argument for coordinates is
+   * specified.
+   *
+   * <p>It is guaranteed that either a file path or Maven coordinates for a BOM are available.
+   */
+  boolean hasFile() {
+    return commandLine.hasOption('f');
+  }
+
+  /**
+   * Returns true if the argument for a versionless coordinates is specified; otherwise false.
+   *
+   * <p>It is guaranteed that either a file path or Maven coordinates for a BOM are available.
+   */
+  boolean hasVersionlessCoordinates() {
+    return commandLine.hasOption('a');
+  }
+
+  /**
+   * Returns an absolute path to pom.xml file of a BOM. Null if file is not specified.
+   */
+  @Nullable
+  Path getBomFile() {
+    if (!commandLine.hasOption('f')) {
+      return null;
+    }
+    // Trim the value so that maven exec plugin can pass arguments with exec.arguments="-f pom.xml"
+    return Paths.get(commandLine.getOptionValue('f').trim()).toAbsolutePath();
+  }
+
+  /**
+   * Returns the Maven coordinates of a BOM. Null if coordinates are not specified.
+   */
+  @Nullable
+  String getBomCoordinates() {
+    if (!commandLine.hasOption('c')) {
+      return null;
+    }
+    return commandLine.getOptionValue('c').trim();
+  }
+
+  /**
+   * Returns the versionless Maven coordinates of a BOM. Null if versionless coordinates are not
+   * specified.
+   */
+  @Nullable
+  String getVersionlessCoordinates() {
+    if (!commandLine.hasOption('a')) {
+      return null;
+    }
+    return commandLine.getOptionValue('a').trim();
+  }
+
+  static Arguments readCommandLine(String... arguments) throws ParseException {
+    CommandLineParser parser = new DefaultParser();
+
+    try {
+      // Throws ParseException if required option group ('-f' or '-c') is not specified
+      return new Arguments(parser.parse(options, arguments));
+    } catch (ParseException ex) {
+      helpFormatter.printHelp("DashboardMain", options);
+      throw ex;
+    }
+  }
+
+  private static Options configureOptions() {
+    Options options = new Options();
+    OptionGroup inputGroup = new OptionGroup();
+    inputGroup.setRequired(true);
+
+    Option inputFileOption =
+        Option.builder("f").longOpt("bom-file").hasArg().desc("File to a BOM (pom.xml)").build();
+    inputGroup.addOption(inputFileOption);
+
+    Option inputCoordinatesOption =
+        Option.builder("c")
+            .longOpt("bom-coordinates")
+            .hasArg()
+            .desc(
+                "Maven coordinates of a BOM. For example, com.google.cloud:libraries-bom:1.0.0")
+            .build();
+    inputGroup.addOption(inputCoordinatesOption);
+
+    Option versionlessCoordinatesOption =
+        Option.builder("a")
+            .longOpt("all-versions")
+            .hasArg()
+            .desc(
+                "Maven coordinates of a BOM without version. "
+                    + "For example, com.google.cloud:libraries-bom")
+            .build();
+    inputGroup.addOption(versionlessCoordinatesOption);
+
+    options.addOptionGroup(inputGroup);
+    return options;
+  }
+}