Merge pull request #53 from raehalme/feature/52

Issue #52: The Git branch name is now resolved using ScmManager, falling back to '${env.GIT_BRANCH}' if it cannot be resolved by the scmManager.

Author: bvarner

pom.xml

@@ -92,6 +92,21 @@
             <artifactId>maven-plugin-api</artifactId>
             <version>3.1.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.maven.scm</groupId>
+            <artifactId>maven-scm-api</artifactId>
+            <version>1.9.5</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.scm</groupId>
+            <artifactId>maven-scm-manager-plexus</artifactId>
+            <version>1.9.5</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.scm</groupId>
+            <artifactId>maven-scm-provider-gitexe</artifactId>
+            <version>1.9.5</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.maven.plugin-tools</groupId>
             <artifactId>maven-plugin-annotations</artifactId>

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

@@ -8,6 +8,8 @@
 import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
+import org.apache.maven.scm.ScmException;
+import org.apache.maven.scm.manager.ScmManager;
 import org.codehaus.plexus.util.cli.CommandLineUtils;
 
 import java.io.IOException;
@@ -26,6 +28,9 @@ public abstract class AbstractGitflowBranchMojo extends AbstractMojo {
     @Component
     protected MavenProject project;
 
+    @Component
+    protected ScmManager scmManager;
+
     @Parameter(defaultValue = "origin/master", property = "masterBranchPattern", required = true)
     private String masterBranchPattern;
 
@@ -61,7 +66,7 @@ private void logExecute(final GitBranchType type, final String gitBranch, final
 
     public void execute() throws MojoExecutionException, MojoFailureException {
         if (gitBranchExpression == null) {
-            gitBranchExpression = "${env.GIT_BRANCH}";
+            gitBranchExpression = getGitBranch();
         }
 
         try {
@@ -100,4 +105,16 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             logExecute(GitBranchType.UNDEFINED, gitBranch, null);
         }
     }
+
+    private String getGitBranch() throws MojoExecutionException {
+        try {
+            String branch = ScmUtils.getGitBranch(scmManager, project);
+            if (branch == null) {
+                throw new MojoExecutionException("gitflow-helper-maven-plugin requires a Git project, use gitBranchExpression to by-pass this check");
+            }
+            return branch;
+        } catch (ScmException e) {
+            throw new MojoExecutionException("Cannot get the branch information from the git repository: \n" + e.getLocalizedMessage(), e);
+        }
+    }
 }

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

@@ -7,13 +7,17 @@
 import org.apache.maven.lifecycle.internal.MojoDescriptorCreator;
 import org.apache.maven.model.Plugin;
 import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
+import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.project.MavenProject;
+import org.apache.maven.scm.ScmException;
+import org.apache.maven.scm.manager.ScmManager;
 import org.codehaus.plexus.component.annotations.Component;
 import org.codehaus.plexus.component.annotations.Requirement;
 import org.codehaus.plexus.logging.Logger;
 import org.codehaus.plexus.util.cli.CommandLineUtils;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 
+import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -34,6 +38,9 @@ public class MasterPromoteExtension extends AbstractMavenLifecycleParticipant {
     @Requirement
     private Logger logger;
 
+    @Requirement
+    protected ScmManager scmManager;
+
     @Override
     public void afterProjectsRead(MavenSession session) throws MavenExecutionException {
         Properties systemEnvVars = null;
@@ -97,6 +104,10 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
                 }
             }
 
+            if (gitBranchExpression == null) {
+                gitBranchExpression = getGitBranch(project);
+            }
+
             pluginsToDrop.put(project, dropPlugins);
         }
 
@@ -145,4 +156,16 @@ private String extractConfigValue(String parameter, Object configuration) {
         }
         return null;
     }
+
+    private String getGitBranch(MavenProject project) throws MavenExecutionException {
+        try {
+            String branch = ScmUtils.getGitBranch(scmManager, project);
+            if (branch == null) {
+                throw new MavenExecutionException("gitflow-helper-maven-plugin requires a Git project, use gitBranchExpression to by-pass this check", project.getFile());
+            }
+            return branch;
+        } catch (ScmException e) {
+            throw new MavenExecutionException("Cannot get the branch information from the git repository: \n" + e.getLocalizedMessage(), e);
+        }
+    }
 }

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

@@ -0,0 +1,33 @@
+package com.e_gineering.maven.gitflowhelper;
+
+import org.apache.commons.lang.StringUtils;
+import org.apache.maven.project.MavenProject;
+import org.apache.maven.scm.ScmException;
+import org.apache.maven.scm.ScmFile;
+import org.apache.maven.scm.ScmFileSet;
+import org.apache.maven.scm.log.ScmLogDispatcher;
+import org.apache.maven.scm.manager.ScmManager;
+import org.apache.maven.scm.provider.ScmProvider;
+import org.apache.maven.scm.provider.git.gitexe.command.branch.GitBranchCommand;
+import org.apache.maven.scm.provider.git.repository.GitScmProviderRepository;
+import org.apache.maven.scm.repository.ScmRepository;
+
+public abstract class ScmUtils {
+    public static String getGitBranch(ScmManager scmManager, MavenProject project) throws ScmException {
+        String scmConnectionUrl = project.getScm().getConnection();
+        String scmDeveloperConnectionUrl = project.getScm().getDeveloperConnection();
+        String connectionUrl = StringUtils.isNotBlank(scmDeveloperConnectionUrl) ? scmDeveloperConnectionUrl : scmConnectionUrl;
+        if (StringUtils.isBlank(connectionUrl)) {
+            return "${env.GIT_BRANCH}";
+        }
+
+        ScmRepository repository = scmManager.makeScmRepository(connectionUrl);
+        ScmProvider provider = scmManager.getProviderByRepository(repository);
+        if (!GitScmProviderRepository.PROTOCOL_GIT.equals(provider.getScmType())) {
+            return null;
+        } else {
+            ScmFileSet fileSet = new ScmFileSet(project.getBasedir());
+            return GitBranchCommand.getCurrentBranch(new ScmLogDispatcher(), (GitScmProviderRepository)repository.getProviderRepository(), fileSet);
+        }
+    }
+}