Merge pull request #63 from egineering-llc/release/1.7.0

Release/1.7.0

Author: bvarner

README.md

@@ -9,7 +9,7 @@
     <groupId>com.e-gineering</groupId>
     <artifactId>gitflow-helper-maven-plugin</artifactId>
 
-    <version>1.6.0</version>
+    <version>1.7.0</version>
     <packaging>maven-plugin</packaging>
 
     <name>gitflow-helper-maven-plugin</name>

pom.xml

@@ -9,11 +9,14 @@
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProjectHelper;
 import org.codehaus.plexus.util.FileUtils;
+import org.eclipse.aether.DefaultRepositorySystemSession;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.artifact.DefaultArtifact;
 import org.eclipse.aether.impl.ArtifactResolver;
+import org.eclipse.aether.internal.impl.EnhancedLocalRepositoryManagerFactory;
 import org.eclipse.aether.repository.LocalRepository;
 import org.eclipse.aether.repository.RemoteRepository;
+import org.eclipse.aether.repository.RepositoryPolicy;
 import org.eclipse.aether.resolution.ArtifactRequest;
 import org.eclipse.aether.resolution.ArtifactResolutionException;
 import org.eclipse.aether.resolution.ArtifactResult;
@@ -27,7 +30,6 @@
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
-import java.lang.reflect.Field;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.util.ArrayList;
@@ -54,7 +56,10 @@ public abstract class AbstractGitflowBasedRepositoryMojo extends AbstractGitflow
     protected String snapshotDeploymentRepository;
 
     @Parameter(defaultValue = "${repositorySystemSession}", required = true)
-    private RepositorySystemSession session;
+    protected RepositorySystemSession session;
+
+    @Component
+    protected EnhancedLocalRepositoryManagerFactory localRepositoryManagerFactory;
 
     @Parameter(defaultValue = "${project.build.directory}", required = true)
     protected File buildDirectory;
@@ -109,7 +114,7 @@ protected ArtifactRepository getDeploymentRepository(final String altRepository)
      * @throws MojoExecutionException
      * @throws MojoFailureException
      */
-    private RemoteRepository getRepository(final String altRepository) throws MojoExecutionException, MojoFailureException {
+    protected RemoteRepository getRepository(final String altRepository) throws MojoExecutionException, MojoFailureException {
         if (getLog().isDebugEnabled()) {
             getLog().debug("Creating remote Aether repository (to resolve remote artifacts) for: " + altRepository);
         }
@@ -137,15 +142,14 @@ private RemoteRepository getRepository(final String altRepository) throws MojoEx
     }
 
     private String getCoordinates(ArtifactResult result) {
-        StringBuilder buffer = new StringBuilder( 128 );
-        buffer.append( result.getArtifact().getGroupId() );
-        buffer.append( ':' ).append( result.getArtifact().getArtifactId() );
-        buffer.append( ':' ).append( result.getArtifact().getExtension() );
-        if ( result.getArtifact().getClassifier().length() > 0 )
-        {
-            buffer.append( ':' ).append( result.getArtifact().getClassifier() );
+        StringBuilder buffer = new StringBuilder(128);
+        buffer.append(result.getArtifact().getGroupId());
+        buffer.append(':').append(result.getArtifact().getArtifactId());
+        buffer.append(':').append(result.getArtifact().getExtension());
+        if (result.getArtifact().getClassifier().length() > 0) {
+            buffer.append(':').append(result.getArtifact().getClassifier());
         }
-        buffer.append( ':' ).append( result.getArtifact().getBaseVersion() );
+        buffer.append(':').append(result.getArtifact().getBaseVersion());
         return buffer.toString();
     }
 
@@ -183,47 +187,46 @@ private String getCoordinates(org.apache.maven.artifact.Artifact artifact) {
      * group:artifact:type:classifier:version
      */
     protected void attachArtifactCatalog() throws MojoExecutionException {
-            getLog().info("Cataloging Artifacts for promotion & reattachment: " + project.getBuild().getDirectory());
+        getLog().info("Cataloging Artifacts for promotion & reattachment: " + project.getBuild().getDirectory());
 
-            File catalog = new File(buildDirectory, project.getArtifact().getArtifactId() + ".txt");
+        File catalog = new File(buildDirectory, project.getArtifact().getArtifactId() + ".txt");
 
-            PrintWriter writer = null;
+        PrintWriter writer = null;
 
-            try {
-                catalog.delete();
-                buildDirectory.mkdirs();
-                writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(catalog), Charset.forName("UTF-8")));
-
-                if (project.getArtifact() != null && project.getArtifact().getFile() != null &&
-                        project.getArtifact().getFile().exists() && !project.getArtifact().getFile().isDirectory())
-                {
-                    String coords = getCoordinates(project.getArtifact());
-                    if (!coords.isEmpty()){
-                        getLog().info("Cataloging: " + coords);
-                        writer.println(coords);
-                    }
-                } else {
-                    getLog().info("No primary artifact to catalog, cataloging attached artifacts instead.");
+        try {
+            catalog.delete();
+            buildDirectory.mkdirs();
+            writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(catalog), Charset.forName("UTF-8")));
+
+            if (project.getArtifact() != null && project.getArtifact().getFile() != null &&
+                    project.getArtifact().getFile().exists() && !project.getArtifact().getFile().isDirectory()) {
+                String coords = getCoordinates(project.getArtifact());
+                if (!coords.isEmpty()) {
+                    getLog().info("Cataloging: " + coords);
+                    writer.println(coords);
                 }
+            } else {
+                getLog().info("No primary artifact to catalog, cataloging attached artifacts instead.");
+            }
 
-                // Iterate the attached artifacts.
-                for (org.apache.maven.artifact.Artifact artifact : project.getAttachedArtifacts()) {
-                    String coords = getCoordinates(artifact);
-                    if (!coords.isEmpty()) {
-                        getLog().info("Cataloging: " + coords);
-                        writer.println(coords);
-                    }
+            // Iterate the attached artifacts.
+            for (org.apache.maven.artifact.Artifact artifact : project.getAttachedArtifacts()) {
+                String coords = getCoordinates(artifact);
+                if (!coords.isEmpty()) {
+                    getLog().info("Cataloging: " + coords);
+                    writer.println(coords);
                 }
+            }
 
-                getLog().info("Attaching catalog artifact: " + catalog);
-                projectHelper.attachArtifact(project, "txt", "catalog", catalog);
-            } catch (IOException ioe) {
-                throw new MojoExecutionException("Failed to create catalog of artifacts", ioe);
-            } finally {
-                if (writer != null) {
-                    writer.close();
-                }
+            getLog().info("Attaching catalog artifact: " + catalog);
+            projectHelper.attachArtifact(project, "txt", "catalog", catalog);
+        } catch (IOException ioe) {
+            throw new MojoExecutionException("Failed to create catalog of artifacts", ioe);
+        } finally {
+            if (writer != null) {
+                writer.close();
             }
+        }
     }
 
     /**
@@ -250,35 +253,30 @@ protected void attachExistingArtifacts(final String sourceRepository, final bool
         // A place to store our resolved files...
         List<ArtifactResult> resolvedArtifacts = new ArrayList<ArtifactResult>();
 
-        // Keep track of the original base directory.
-        Field localBaseDir = null;
-        File originalBaseDir = session.getLocalRepositoryManager().getRepository().getBasedir();
 
-        // Disable the local repository - using a bit of reflection that I wish we didn't need to use.
+        // Use a custom repository session, setup to force a few behaviors we like.
+        DefaultRepositorySystemSession tempSession = new DefaultRepositorySystemSession(session);
+        tempSession.setUpdatePolicy(RepositoryPolicy.UPDATE_POLICY_ALWAYS);
+
         File tempRepo = null;
         if (disableLocal) {
-            getLog().info("Disabling local repository @ " + session.getLocalRepository().getBasedir());
+            getLog().info("Disabling local repository @ " + tempSession.getLocalRepository().getBasedir());
             try {
-                localBaseDir = LocalRepository.class.getDeclaredField("basedir");
-                localBaseDir.setAccessible(true);
-
-                // Generate a new temp directory.
                 tempRepo = Files.createTempDirectory("gitflow-helper-maven-plugin-repo").toFile();
 
                 getLog().info("Using temporary local repository @ " + tempRepo.getAbsolutePath());
-                localBaseDir.set(session.getLocalRepositoryManager().getRepository(), tempRepo);
+                tempSession.setLocalRepositoryManager(localRepositoryManagerFactory.newInstance(tempSession, new LocalRepository(tempRepo)));
             } catch (Exception ex) {
                 getLog().warn("Failed to disable local repository path.", ex);
             }
         }
 
-
         List<ArtifactRequest> requiredArtifacts = new ArrayList<ArtifactRequest>();
 
         // Locate our text catalog classifier file. :-)
         BufferedReader reader = null;
         try {
-            ArtifactResult catalogResult = artifactResolver.resolveArtifact(session, new ArtifactRequest(new DefaultArtifact(project.getGroupId(), project.getArtifactId(), "catalog", "txt", project.getVersion()), remoteRepositories, null));
+            ArtifactResult catalogResult = artifactResolver.resolveArtifact(tempSession, new ArtifactRequest(new DefaultArtifact(project.getGroupId(), project.getArtifactId(), "catalog", "txt", project.getVersion()), remoteRepositories, null));
             resolvedArtifacts.add(catalogResult);
 
             if (catalogResult.isResolved()) {
@@ -301,14 +299,15 @@ protected void attachExistingArtifacts(final String sourceRepository, final bool
             if (reader != null) {
                 try {
                     reader.close();
-                } catch (IOException ioe) {}
+                } catch (IOException ioe) {
+                }
             }
         }
 
 
         // Resolve the artifacts from the catalog (if there are any)
         try {
-            resolvedArtifacts.addAll(artifactResolver.resolveArtifacts(session, requiredArtifacts));
+            resolvedArtifacts.addAll(artifactResolver.resolveArtifacts(tempSession, requiredArtifacts));
         } catch (ArtifactResolutionException are) {
             throw new MojoExecutionException("Failed to resolve the required project files from: " + sourceRepository, are);
         }
@@ -339,12 +338,6 @@ protected void attachExistingArtifacts(final String sourceRepository, final bool
 
         // Restore the local repository, again using reflection.
         if (disableLocal) {
-            try {
-                localBaseDir.set(session.getLocalRepositoryManager().getRepository(), originalBaseDir);
-                localBaseDir.setAccessible(false);
-            } catch (Exception ex) {
-                getLog().warn("Failed to restore original local repository path.", ex);
-            }
             if (tempRepo != null) {
                 try {
                     FileUtils.deleteDirectory(tempRepo);

src/main/java/com/e_gineering/maven/gitflowhelper/AbstractGitflowBasedRepositoryMojo.java

@@ -33,6 +33,9 @@ public abstract class AbstractGitflowBranchMojo extends AbstractMojo {
     @Parameter(defaultValue = "(origin/)?master", property = "masterBranchPattern", required = true)
     private String masterBranchPattern;
 
+    @Parameter(defaultValue = "(origin/)?support/(.*)", property = "supportBranchPattern", required = true)
+    private String supportBranchPattern;
+
     @Parameter(defaultValue = "(origin/)?release/(.*)", property = "releaseBranchPattern", required = true)
     private String releaseBranchPattern;
 
@@ -91,6 +94,8 @@ public void execute() throws MojoExecutionException, MojoFailureException {
              */
             if (gitBranch.matches(masterBranchPattern)) {
                 logExecute(GitBranchType.MASTER, gitBranch, masterBranchPattern);
+            } else if (gitBranch.matches(supportBranchPattern)) {
+                logExecute(GitBranchType.SUPPORT, gitBranch, supportBranchPattern);
             } else if (gitBranch.matches(releaseBranchPattern)) {
                 logExecute(GitBranchType.RELEASE, gitBranch, releaseBranchPattern);
             } else if (gitBranch.matches(hotfixBranchPattern)) {

src/main/java/com/e_gineering/maven/gitflowhelper/AbstractGitflowBranchMojo.java

@@ -16,7 +16,9 @@ public class AttachDeployedArtifactsMojo extends AbstractGitflowBasedRepositoryM
     @Override
     protected void execute(GitBranchType type, String gitBranch, String branchPattern) throws MojoExecutionException, MojoFailureException {
         switch (type) {
-            case MASTER: {
+            case MASTER:
+            case SUPPORT:
+            {
                 getLog().info("Attaching artifacts from release repository...");
                 attachExistingArtifacts(releaseDeploymentRepository, true);
                 break;

src/main/java/com/e_gineering/maven/gitflowhelper/AttachDeployedArtifactsMojo.java

@@ -28,11 +28,18 @@ protected void execute(final GitBranchType type, final String gitBranch, final S
                     throw new MojoFailureException("The current git branch: [" + gitBranch + "] is defined as a release branch. The maven project version: [" + project.getVersion() + "] is currently a snapshot version.");
                 }
 
-                // Expect the last group on non-master branches to match (exactly) the current projectVersion. (only release / hotfix branches)
-                if (gitMatcher.groupCount() > 0 && !GitBranchType.MASTER.equals(type)) {
-                    if (!gitMatcher.group(gitMatcher.groupCount()).trim().equals(project.getVersion().trim())) {
+                // Non-master version branches require a pom version match of some kind to the branch subgroups.
+                if (gitMatcher.groupCount() > 0) {
+                    // HOTFIX and RELEASE branches require an exact match to the last subgroup.
+                    if ((GitBranchType.RELEASE.equals(type) || GitBranchType.HOTFIX.equals(type)) && !gitMatcher.group(gitMatcher.groupCount()).trim().equals(project.getVersion().trim())) {
                         throw new MojoFailureException("The current git branch: [" + gitBranch + "] expected the maven project version to be: [" + gitMatcher.group(gitMatcher.groupCount()).trim() + "], but the maven project version is: [" + project.getVersion() + "]");
                     }
+
+                    // SUPPORT branches require a 'starts with' match of the maven project version to the subgroup.
+                    // ex: /origin/support/3.1 must have a maven version that starts with "3.1", ala: "3.1.2"
+                    if (GitBranchType.SUPPORT.equals(type) && !project.getVersion().startsWith(gitMatcher.group(gitMatcher.groupCount()).trim())) {
+                        throw new MojoFailureException("The current git branch: [" + gitBranch + "] expected the maven project version to start with: [" + gitMatcher.group(gitMatcher.groupCount()).trim() + "], but the maven project version is: [" + project.getVersion() + "]");
+                    }
                 }
             }
         } else if (GitBranchType.DEVELOPMENT.equals(type) && !ArtifactUtils.isSnapshot(project.getVersion())) {

src/main/java/com/e_gineering/maven/gitflowhelper/EnforceVersionsMojo.java

@@ -7,11 +7,12 @@
  */
 public enum GitBranchType {
     MASTER,
+    SUPPORT,
     RELEASE,
     HOTFIX,
     DEVELOPMENT,
     OTHER,
     UNDEFINED;
 
-    static final EnumSet<GitBranchType> VERSIONED_TYPES = EnumSet.of(GitBranchType.MASTER, GitBranchType.RELEASE, GitBranchType.HOTFIX);
+    static final EnumSet<GitBranchType> VERSIONED_TYPES = EnumSet.of(GitBranchType.MASTER, GitBranchType.SUPPORT, GitBranchType.RELEASE, GitBranchType.HOTFIX);
 }

src/main/java/com/e_gineering/maven/gitflowhelper/GitBranchType.java

@@ -65,7 +65,8 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
                 try {
                     pluginsToRetain.add(descriptorCreator.findPluginForPrefix(prefix, session));
                 } catch (NoPluginFoundForPrefixException ex) {
-                    throw new MavenExecutionException("Unable to resolve plugin for prefix: " + prefix, ex);
+                    logger.warn("gitflow-helper-maven-plugin: Unable to resolve project plugin for prefix: " + prefix + " for goal: " + goal);
+//                    throw new MavenExecutionException("Unable to resolve plugin for prefix: " + prefix, ex);
                 }
             }
         }
@@ -128,7 +129,10 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
                 logger.info("gitflow-helper-maven-plugin: Enabling MasterPromoteExtension. GIT_BRANCH: [" + gitBranch + "] matches masterBranchPattern: [" + masterBranchPattern + "]");
 
                 for (MavenProject project : session.getProjects()) {
-                    // Drop all the plugins from the build except for the gitflow-helper-maven-plugin.
+                    // Drop all the plugins from the build except for the gitflow-helper-maven-plugin, or plugins we
+                    // invoked goals for which could be mapped back to plugins in our project build.
+                    // Goals invoked from the commandline which cannot be mapped back to our project, will get warnings, but should still execute.
+                    // If someone is on 'master' and starts executing goals, we need to allow them to do that.
                     project.getBuildPlugins().removeAll(pluginsToDrop.get(project));
                 }
             }

src/main/java/com/e_gineering/maven/gitflowhelper/MasterPromoteExtension.java

@@ -28,6 +28,7 @@ protected void execute(final GitBranchType type, final String gitBranch, final S
                 break;
             }
 
+            case SUPPORT:
             case MASTER: {
                 getLog().info("Resolving & Reattaching existing artifacts from stageDeploymentRepository [" + stageDeploymentRepository + "]");
 

src/main/java/com/e_gineering/maven/gitflowhelper/PromoteMasterMojo.java

@@ -18,6 +18,7 @@ protected void execute(final GitBranchType type, final String gitBranch, final S
         }
 
         switch (type) {
+            case SUPPORT:
             case MASTER: {
                 getLog().info("Setting release artifact repository to: [" + releaseDeploymentRepository + "]");
                 project.setSnapshotArtifactRepository(null);