OWLS-102537 Display exporter version (#202)

Author: russgold

build-helper-mojo/pom.xml

@@ -20,19 +20,19 @@
     <dependencies>
         <dependency>
             <groupId>org.apache.maven</groupId>
-            <artifactId>maven-plugin-api</artifactId>
-            <version>3.8.6</version>
+            <artifactId>maven-project</artifactId>
+            <version>2.2.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>
-            <artifactId>maven-model</artifactId>
+            <artifactId>maven-plugin-api</artifactId>
             <version>3.8.6</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>
-            <artifactId>maven-artifact</artifactId>
+            <artifactId>maven-model</artifactId>
             <version>3.8.6</version>
             <scope>provided</scope>
         </dependency>
@@ -62,10 +62,19 @@
             <artifactId>simplestub</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-clean-plugin</artifactId>

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/CopyExecutor.java

@@ -1,16 +1,13 @@
-// Copyright (c) 2020, Oracle and/or its affiliates.
+// Copyright (c) 2020, 2022, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.buildhelper;
 
 import java.io.File;
-import java.io.IOException;
 import java.nio.file.Path;
 
 public interface CopyExecutor {
 
   Path toPath(File file);
 
-  void copyFile(Path sourcePath, Path targetPath) throws IOException;
-
 }

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/CopyExecutorImpl.java

@@ -4,22 +4,13 @@
 package com.oracle.wls.buildhelper;
 
 import java.io.File;
-import java.io.IOException;
-import java.nio.file.Files;
 import java.nio.file.Path;
 
-import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
-
 public class CopyExecutorImpl implements CopyExecutor {
 
   @Override
   public Path toPath(File file) {
     return file.toPath();
   }
 
-  @Override
-  public void copyFile(Path sourcePath, Path targetPath) throws IOException {
-    Files.createDirectories(targetPath.getParent());
-    Files.copy(sourcePath, targetPath, REPLACE_EXISTING);
-  }
 }

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/BuildHelperMojo.java renamed to build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/FileCopyMojo.java

@@ -1,21 +1,24 @@
-// Copyright (c) 2020, Oracle and/or its affiliates.
+// Copyright (c) 2020, 2022 Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package com.oracle.wls.buildhelper;
 
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.Optional;
-
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Optional;
+
+import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
+
 @Mojo(name = "copy", defaultPhase = LifecyclePhase.PROCESS_RESOURCES)
-public class BuildHelperMojo extends AbstractMojo {
+public class FileCopyMojo extends AbstractMojo {
     @Parameter(required = true) private String sourceFile;
     @Parameter(required = true) private File targetFile;
     @Parameter private File userDir;
@@ -28,7 +31,8 @@ public void execute() throws MojoExecutionException {
         Path target = toPath(targetFile);
         try {
             getLog().info("Copying " + source + " to " + target);
-            executor.copyFile(source, target);
+            Files.createDirectories(target.getParent());
+            Files.copy(source, target, REPLACE_EXISTING);
         } catch (IOException e) {
             throw new MojoExecutionException("Unable to copy " + source + " to " + target, e);
         }

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/GitTagExecutor.java

@@ -0,0 +1,24 @@
+// Copyright (c) 2022, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.wls.buildhelper;
+
+import org.apache.maven.plugin.MojoExecutionException;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Path;
+
+/**
+ * An interface for the system interaction functionality required to execute the GitTag mojo.
+ */
+interface GitTagExecutor {
+
+  /**
+   * Issues a command and returns the response.
+   * @param commandLine the command to execute
+   */
+  String runCommand(String... commandLine) throws IOException, MojoExecutionException;
+
+  Path toPath(File file);
+}

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/GitTagExecutorImpl.java

@@ -0,0 +1,35 @@
+// Copyright (c) 2022, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.wls.buildhelper;
+
+import org.apache.maven.plugin.MojoExecutionException;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.nio.file.Path;
+import java.util.stream.Collectors;
+
+public class GitTagExecutorImpl implements GitTagExecutor {
+  @Override
+  public String runCommand(String... commandLineStrings) throws IOException, MojoExecutionException {
+    try {
+      final Process vp = new ProcessBuilder(commandLineStrings).start();
+
+      vp.waitFor();
+
+      final BufferedReader br = new BufferedReader(new InputStreamReader(vp.getInputStream()));
+      return br.lines().collect(Collectors.joining("\n"));
+    } catch (InterruptedException e) {
+      Thread.currentThread().interrupt();
+      throw new MojoExecutionException("Thread interrupted while running command " + String.join(" ", commandLineStrings));
+    }
+  }
+
+  @Override
+  public Path toPath(File file) {
+    return file.toPath();
+  }
+}

build-helper-mojo/src/main/java/com/oracle/wls/buildhelper/GitTagMojo.java

@@ -0,0 +1,73 @@
+// Copyright (c) 2022, Oracle and/or its affiliates.
+// Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+
+package com.oracle.wls.buildhelper;
+
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+@Mojo(name = "gitVersion", defaultPhase = LifecyclePhase.PREPARE_PACKAGE)
+public class GitTagMojo extends AbstractMojo {
+
+  @Parameter(required = true, defaultValue = "${project.build.outputDirectory}/version.properties")
+  private File outputFile;
+  
+  private final GitTagExecutor executor;
+
+  GitTagMojo(GitTagExecutor executor) {
+    this.executor = executor;
+  }
+
+  @SuppressWarnings("unused")
+  public GitTagMojo() {
+    this(new GitTagExecutorImpl());
+  }
+
+  @Override
+  public void execute() throws MojoExecutionException {
+    try {
+      final String versionString = toVersionString(executor.runCommand("git", "describe", "--tag"));
+      final Path path = executor.toPath(outputFile);
+      Files.createDirectories(path.getParent());
+      Files.write(path, createProperties(versionString));
+    } catch (IOException e) {
+      throw new MojoExecutionException("Error writing " + outputFile + ": " + e );
+    }
+
+  }
+
+  private List<String> createProperties(String versionString) {
+    return Collections.singletonList("version=" + versionString);
+  }
+
+  // parses the result of 'git describe --tag' to describe the current code version/
+  private String toVersionString(String gitResponse) {
+    final String[] segments = gitResponse.split("-");
+    if (segments.length == 1 || segments.length == 2)
+      return gitResponse;
+    else
+      return formatVersionString(segments);
+  }
+
+  private String formatVersionString(String[] segments) {
+    final String commit = segments[segments.length - 1];
+    final String numCommits = segments[segments.length - 2];
+    final String versionParts = String.join("-", Arrays.copyOfRange(segments, 0, segments.length - 2));
+    return formatVersionString(commit, numCommits, versionParts);
+  }
+
+  private String formatVersionString(String commit, String numCommits, String versionParts) {
+    return commit + " (" + numCommits + " commits since " + versionParts + ")";
+  }
+}