Add effective-config, effective-test-config and crypt goals

Author: adrienlauer

CHANGELOG.md

@@ -1,3 +1,9 @@
+# Version 2.4.0 (2017-02-09)
+
+* [new] New goal `effective-config` to dump effective configuration of the project as YAML.
+* [new] New goal `effective-test-config` to dump effective test configuration of the project as YAML.
+* [new] New goal `crypt` to crypt password using the configured master key store of the application.
+
 # Version 2.3.2 (2017-02-06)
 
 * [new] Detect and use the latest version of Maven archetype plugin when generating a project.

pom.xml

@@ -19,7 +19,7 @@
 
     <groupId>org.seedstack</groupId>
     <artifactId>seedstack-maven-plugin</artifactId>
-    <version>2.3.2-SNAPSHOT</version>
+    <version>2.4.0-SNAPSHOT</version>
     <packaging>maven-plugin</packaging>
 
     <properties>

src/license/THIRD-PARTY.properties

@@ -12,7 +12,7 @@
 # Please fill the missing licenses for dependencies :
 #
 #
-#Mon Feb 06 10:34:27 CET 2017
+#Thu Feb 09 18:02:08 CET 2017
 classworlds--classworlds--1.1-alpha-2=
 commons-collections--commons-collections--3.1=
 dom4j--dom4j--1.6.1=

src/main/java/org/seedstack/maven/AbstractExecutableMojo.java

@@ -21,6 +21,7 @@
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 
 /**
@@ -32,11 +33,14 @@ public class AbstractExecutableMojo extends AbstractMojo {
     private MavenProject project;
     @Parameter(defaultValue = "${project.build.outputDirectory}", required = true)
     private File classesDirectory;
+    @Parameter(defaultValue = "${project.build.testOutputDirectory}", required = true)
+    private File testClassesDirectory;
     @Parameter(property = "args")
     private String args;
 
     private final IsolatedThreadGroup isolatedThreadGroup = new IsolatedThreadGroup("seed-app");
     private final Object monitor = new Object();
+    private boolean testMode = false;
     protected Runnable runnable;
 
     @Override
@@ -68,6 +72,10 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         joinNonDaemonThreads(isolatedThreadGroup);
     }
 
+    protected void enableTestMode() {
+        this.testMode = true;
+    }
+
     protected Object getMonitor() {
         return monitor;
     }
@@ -118,30 +126,46 @@ private URL[] getClassPathUrls() throws MojoExecutionException {
         List<URL> urls = new ArrayList<URL>();
 
         try {
-            // Project resources
-            for (Resource resource : this.project.getResources()) {
-                File directory = new File(resource.getDirectory());
-                urls.add(directory.toURI().toURL());
-                removeDuplicatesFromOutputDirectory(this.classesDirectory, directory);
+            if (testMode) {
+                // Project test resources
+                addResources(this.testClassesDirectory, this.project.getTestResources(), urls);
+
+                // Project test classes
+                urls.add(this.testClassesDirectory.toURI().toURL());
             }
 
+            // Project resources
+            addResources(this.classesDirectory, this.project.getResources(), urls);
+
             // Project classes
             urls.add(this.classesDirectory.toURI().toURL());
 
-            // Project dependencies
-            for (Artifact artifact : this.project.getArtifacts()) {
-                File file = artifact.getFile();
-                if (file.getName().endsWith(".jar")) {
-                    urls.add(file.toURI().toURL());
-                }
-            }
+            // Project dependencies (scope is dependent upon the @Mojo annotation and the already executed phase)
+            addArtifacts(this.project.getArtifacts(), urls);
         } catch (MalformedURLException e) {
             throw new MojoExecutionException("Unable to build classpath", e);
         }
 
         return urls.toArray(new URL[urls.size()]);
     }
 
+    private void addArtifacts(Collection<Artifact> artifacts, List<URL> urls) throws MalformedURLException {
+        for (Artifact artifact : artifacts) {
+            File file = artifact.getFile();
+            if (file.getName().endsWith(".jar")) {
+                urls.add(file.toURI().toURL());
+            }
+        }
+    }
+
+    private void addResources(File classesDirectory, List<Resource> resources, List<URL> urls) throws MalformedURLException {
+        for (Resource resource : resources) {
+            File directory = new File(resource.getDirectory());
+            urls.add(directory.toURI().toURL());
+            removeDuplicatesFromOutputDirectory(classesDirectory, directory);
+        }
+    }
+
     private void removeDuplicatesFromOutputDirectory(File outputDirectory, File originDirectory) {
         if (originDirectory.isDirectory()) {
             String[] list = originDirectory.list();

src/main/java/org/seedstack/maven/CryptMojo.java

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.maven;
+
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Execute;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.seedstack.maven.runnables.ToolLauncherRunnable;
+
+/**
+ * Defines the crypt goal. This goal runs the crypt Seed tool which crypts the given argument using a key/pair in
+ * the master keystore of the application.
+ */
+@Mojo(name = "crypt", requiresProject = true, threadSafe = true, defaultPhase = LifecyclePhase.VALIDATE, requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
+@Execute(phase = LifecyclePhase.PROCESS_CLASSES)
+public class CryptMojo extends AbstractExecutableMojo {
+    @Override
+    public void execute() throws MojoExecutionException, MojoFailureException {
+        runnable = new ToolLauncherRunnable("crypt", getArgs(), getMonitor(), getLog());
+        super.execute();
+    }
+}

src/main/java/org/seedstack/maven/EffectiveConfigMojo.java

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.maven;
+
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Execute;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.seedstack.maven.runnables.ToolLauncherRunnable;
+
+/**
+ * Defines the effective-config goal. This goal runs the effective-config Seed tool which dumps the effective configuration of
+ * the application.
+ */
+@Mojo(name = "effective-config", requiresProject = true, threadSafe = true, defaultPhase = LifecyclePhase.VALIDATE, requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME)
+@Execute(phase = LifecyclePhase.PROCESS_CLASSES)
+public class EffectiveConfigMojo extends AbstractExecutableMojo {
+    @Override
+    public void execute() throws MojoExecutionException, MojoFailureException {
+        runnable = new ToolLauncherRunnable("effective-config", getArgs(), getMonitor(), getLog());
+        super.execute();
+    }
+}

src/main/java/org/seedstack/maven/EffectiveTestConfigMojo.java

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.maven;
+
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Execute;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.seedstack.maven.runnables.ToolLauncherRunnable;
+
+/**
+ * Defines the effective-test-config goal. This goal runs the effective-config Seed tool with the test classpath,
+ * which dumps the effective test configuration.
+ */
+@Mojo(name = "effective-test-config", requiresProject = true, threadSafe = true, defaultPhase = LifecyclePhase.VALIDATE, requiresDependencyResolution = ResolutionScope.TEST)
+@Execute(phase = LifecyclePhase.PROCESS_TEST_CLASSES)
+public class EffectiveTestConfigMojo extends AbstractExecutableMojo {
+    public EffectiveTestConfigMojo() {
+        enableTestMode();
+    }
+
+    @Override
+    public void execute() throws MojoExecutionException, MojoFailureException {
+        runnable = new ToolLauncherRunnable("effective-config", getArgs(), getMonitor(), getLog());
+        super.execute();
+    }
+}

src/main/java/org/seedstack/maven/GenerateMojo.java

@@ -7,7 +7,6 @@
  */
 package org.seedstack.maven;
 
-import edu.emory.mathcs.backport.java.util.Collections;
 import org.apache.commons.lang.StringUtils;
 import org.apache.maven.archetype.ArchetypeManager;
 import org.apache.maven.archetype.catalog.Archetype;
@@ -26,6 +25,7 @@
 import org.seedstack.maven.components.ArtifactResolver;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;