Merge pull request #57 from egineering-llc/feature/tag-inbuilt-scm

Feature/tag inbuilt scm

Author: bvarner

README.md

@@ -7,10 +7,11 @@ It does so by:
  * Enforcing [gitflow](http://nvie.com/posts/a-successful-git-branching-model/) version heuristics in [Maven](http://maven.apache.org/) projects.
  * Coercing Maven to gracefully support the gitflow workflow without imposing complex CI job configurations or complex Maven setups.
     * Setting distributionManagement repositories (for things like [maven-deploy-plugin](https://maven.apache.org/plugins/maven-deploy-plugin/)) based upon the current git branch.
-    * SCM tagging builds for the master branch, using the CI server's repository connection information. (Zero Maven scm configuration necessary)
+    * SCM tagging builds for the master branch. You can use the project SCM definition, or if you omit it, you can resolve the CI server's repository connection information. (Zero Maven scm configuration necessary)
     * Promoting existing tested (staged) artifacts for release, rather than re-building the artifacts. Eliminates the risk of accidental master merges or commits resulting in untested code being released, and provides digest hash traceability for the history of artifacts.
     * Enabling the decoupling of repository deployment and execution environment delivery based on the current git branch.
  * Automated deployment, promotion, and delivery of projects without the [maven-release-plugin](http://maven.apache.org/maven-release/maven-release-plugin/) or some other [*almost there* solution](https://axelfontaine.com/blog/final-nail.html).
+ * Customizing maven project and system properties based upon the current branch being built. This allows test cases to target different execution environments without changing the artifact results.
 
 # Why would I want to use this?
 
@@ -34,10 +35,14 @@ All of the solutions to these issues are implemented independently in different
 
  1. Make sure you have a your Project SCM configured for your git repository, or that your build server sets environment variables for git branches and git URLs.
     Out of the box, the plugin will try to resolve the git branch based upon the SCM definition on your maven project, or fall back to the environment variables set by Jenkins and Hudson.
- 2. Configure the plugin goals and add the build extension to your Maven project. Here's an example that will get you going quickly...
+ 2. Configure the plugin goals and add the build extension to your Maven project. Here's an example that will get you going quickly with all the features...
 
 ```
 <project>
+    ...
+    <scm>
+        <developerConnection>scm:git:ssh://git@server/project/path.git</developerConnection>
+    </scm>
     ...
     <build>
         <plugins>
@@ -53,8 +58,6 @@ All of the solutions to these issues are implemented independently in different
                     <releaseDeploymentRepository>${release.repository}</releaseDeploymentRepository>
                     <stageDeploymentRepository>${stage.repository}</stageDeploymentRepository>
                     <snapshotDeploymentRepository>${snapshot.repository}</snapshotDeploymentRepository>
-                    <!-- The plugin will read the git branch ang git url by resolving these properties at run-time -->
-                    <gitBranchExpression/>
                 </configuration>
                 <executions>
                     <execution>
@@ -90,24 +93,24 @@ In practice, the Maven versions should:
 
  * Be synchronized with release branch and hotfix branch names.
  * Never be -SNAPSHOT in the master branch, release, or hotfix branches.
- * Always be -SNAPSHOT in the development branch.
+ * Always be -SNAPSHOT in the develop branch.
  * Be irrelevant if there's no git branch resolvable from your environment.
 
 The `enforce-versions` goal asserts these semantics when it can resolve the `gitBranchExpression`.
 
 The goal accomplishes this by checking the Maven pom.xml version value, and asserting the -SNAPSHOT status, as well as matching the current branch name
-against regular expressions, extracting version numbers from the branch names where applicable. If a regex specifies a subgroup 1, the content of that 
-subgroup is asserted to equal the version defined in the pom.xml.
+against regular expressions, extracting version numbers from the branch names where applicable. If a regex specifies subgroups, the content of the 
+last subgroup is asserted to equal the version defined in the pom.xml.
 
 The following properties change the behavior of this goal:
 
 | Property             | Default Value | SNAPSHOT allowed? | Description |
 | -------------------- | ------------- | --------------------------- | ----------- |
 | gitBranchExpression  | current git branch resolved from SCM or ${env.GIT_BRANCH} | n/a | Maven property expression to resolve in order to determine the current git branch |
-| masterBranchPattern  | origin/master | No | Regex. When matched, signals the master branch is being built. Note the lack of a subgroup. |
-| releaseBranchPattern | origin/release/(.*) | No | Regex. When matched, signals a release branch being built. Subgroup 1, if present, must match the Maven project version. |
-| hotfixBranchPattern  | origin/hotfix/(.*) | No | Regex. When matched, signals a hotfix branch is being built. Subgroup 1, if present, must match the Maven project version. |
-| developmentBranchPattern | origin/development | Yes | Regex. When matched, signals a development branch is being built. Note the lack of a subgroup. |
+| masterBranchPattern  | (origin/)?master | No | Regex. When matched, signals the master branch is being built. |
+| releaseBranchPattern | (origin/)?release/(.*) | No | Regex. When matched, signals a release branch being built. Last subgroup, if present, must match the Maven project version. |
+| hotfixBranchPattern  | (origin/)?hotfix/(.*) | No | Regex. When matched, signals a hotfix branch is being built. Last subgroup, if present, must match the Maven project version. |
+| developmentBranchPattern | (origin/)?develop | Yes | Regex. When matched, signals a development branch is being built. Note the lack of a subgroup. |
 
 ## Goal: `retarget-deploy` (Branch Specific Deploy Targets & Staging)
 
@@ -190,11 +193,8 @@ The following properties can be configured for this goal:
 | -------------------- | ------------- | ----------- |
 | gitBranchExpression  | current git branch resolved from SCM or ${env.GIT_BRANCH} | Maven property expression to resolve in order to determine the current git branch |
 | gitURLExpression     | current git branch resolved from SCM or ${env.GIT_URL} | Maven property expression to resolve for the GIT URL connection to use. |
-| masterBranchPattern  | origin/master | Regex. When matched against the resolved value of `gitBranchExpression` this plugin executes the scm:tag goal using the `gitURLExpression` to resolve the git URL to use. |
+| masterBranchPattern  | (origin/)?master | Regex. When matched against the resolved value of `gitBranchExpression` this plugin executes the scm:tag goal using the `gitURLExpression` to resolve the git URL to use. |
 | tag                  | ${project.version} | An expression to use for the SCM tag. |
-| tag.plugin.groupId   | org.apache.maven.plugins | The groupId of the plugin to use for tagging. |
-| tag.plugin.artifactId | maven-scm-plugin | The artifactId of the plugin to use for tagging. | 
-| tag.plugin.version | 1.9.4 | The version of the plugin to use for tagging. |
 
 
 ## Goal: `promote-master` and the Build Extension. (Copy Staged Artifacts to Releases)
@@ -267,7 +267,7 @@ that the first build deployed into. Once they're attached to the project, the `j
 the artifacts built by the first job into a jboss application server.
 
 
-## Goal: `set-properties` (Dynamically Set a Maven Project / System Properties)
+## Goal: `set-properties` (Dynamically Set Maven Project / System Properties)
 
 Some situations with automated testing (and integration testing in particular) demand changing configuration properties 
 based upon the branch type being built. This is a common necessity when configuring automated DB refactorings as part of

pom.xml

@@ -64,17 +64,6 @@
     </distributionManagement>
 
     <dependencies>
-        <dependency>
-            <groupId>org.twdata.maven</groupId>
-            <artifactId>mojo-executor</artifactId>
-            <version>2.2.0</version>
-            <exclusions>
-                <exclusion>
-                    <groupId>org.apache.maven</groupId>
-                    <artifactId>maven-core</artifactId>
-                </exclusion>
-            </exclusions>
-        </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>
             <artifactId>maven-core</artifactId>

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

@@ -30,16 +30,16 @@ public abstract class AbstractGitflowBranchMojo extends AbstractMojo {
     @Component
     protected ScmManager scmManager;
 
-    @Parameter(defaultValue = "origin/master", property = "masterBranchPattern", required = true)
+    @Parameter(defaultValue = "(origin/)?master", property = "masterBranchPattern", required = true)
     private String masterBranchPattern;
 
-    @Parameter(defaultValue = "origin/release/(.*)", property = "releaseBranchPattern", required = true)
+    @Parameter(defaultValue = "(origin/)?release/(.*)", property = "releaseBranchPattern", required = true)
     private String releaseBranchPattern;
 
-    @Parameter(defaultValue = "origin/hotfix/(.*)", property = "hotfixBranchPattern", required = true)
+    @Parameter(defaultValue = "(origin/)?hotfix/(.*)", property = "hotfixBranchPattern", required = true)
     private String hotfixBranchPattern;
 
-    @Parameter(defaultValue = "origin/development", property = "developmentBranchPattern", required = true)
+    @Parameter(defaultValue = "(origin/)?develop", property = "developmentBranchPattern", required = true)
     private String developmentBranchPattern;
 
     // @Parameter tag causes property resolution to fail for patterns containing ${env.}. Default provided in execute();
@@ -84,9 +84,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
 
         if (!eb.hasMoreLegalPlaceholders()) {
             /*
-             * /origin/master goes to the maven 'release' repo.
-             * /origin/release/.* , /origin/hotfix/.* , and /origin/bugfix/.* go to the maven 'stage' repo.
-             * /origin/development goes to the 'snapshot' repo.
+             * (/origin/)?master goes to the maven 'release' repo.
+             * (/origin/)?release/(.*) , (/origin/)?hotfix/(.*) , and (/origin/)?bugfix/(.*) go to the maven 'stage' repo.
+             * (/origin/)?develop goes to the 'snapshot' repo.
              * All other builds will use the default semantics for 'deploy'.
              */
             if (gitBranch.matches(masterBranchPattern)) {

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

@@ -28,13 +28,15 @@ 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.");
                 }
 
-                // If there is a group 1, expect it to match (exactly) the current projectVersion.
-                if (gitMatcher.groupCount() >= 1) {
-                    if (!gitMatcher.group(1).trim().equals(project.getVersion().trim())) {
-                        throw new MojoFailureException("The current git branch: [" + gitBranch + "] expected the maven project version to be: [" + gitMatcher.group(1).trim() + "], but the maven project version is: [" + project.getVersion() + "]");
+                // 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())) {
+                        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() + "]");
                     }
                 }
             }
+        } else if (GitBranchType.DEVELOPMENT.equals(type) && !ArtifactUtils.isSnapshot(project.getVersion())) {
+            throw new MojoFailureException("The current git branch: [" + gitBranch + "] is detected as the gitflow development branch, and expects a maven project version ending with -SNAPSHOT. The maven project version found was: [" + project.getVersion() + "]");
         }
     }
 }

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

@@ -102,10 +102,6 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
                 }
             }
 
-            if (gitBranchExpression == null) {
-                gitBranchExpression = ScmUtils.resolveBranchOrExpression(scmManager, project, new DefaultLog(logger));
-            }
-
             pluginsToDrop.put(project, dropPlugins);
         }
 
@@ -117,15 +113,15 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
             logger.debug("Master Branch Pattern: " + masterBranchPattern);
 
             if (gitBranchExpression == null) {
-                logger.debug("Using default gitBranchExpression.");
-                gitBranchExpression = "${env.GIT_BRANCH}";
+                logger.debug("Using default branch expression resolver.");
+                gitBranchExpression = ScmUtils.resolveBranchOrExpression(scmManager, session.getTopLevelProject(), new DefaultLog(logger));
             }
             logger.debug("Git Branch Expression: " + gitBranchExpression);
 
 
             PropertyResolver pr = new PropertyResolver();
             String gitBranch = pr.resolveValue(gitBranchExpression, session.getCurrentProject().getProperties(), systemEnvVars);
-            logger.info("Build Extension Resolved: " + gitBranchExpression + " to: " + gitBranch);
+            logger.info("gitflow-helper-maven-plugin: Build Extension resolved gitBranchExpression: " + gitBranchExpression + " to: " + gitBranch);
 
             // Test to see if the current GIT_BRANCH matches the masterBranchPattern...
             if (gitBranch != null && gitBranch.matches(masterBranchPattern)) {

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

@@ -21,12 +21,11 @@ public abstract class ScmUtils {
      * Given the ScmManager for the current execution cycle, and the MavenProject structure, determine the SCM URL or
      * an expression we can resolve the URL from.
      *
-     * @param scmManager The current maven ScmManager
      * @param project    The Current maven Project
      * @param log        A Log to write to
      * @return The developerConnection, if none set, the connection, if none set, then the expression, <code>"${env.GIT_URL}"</code>
      */
-    public static String resolveUrlOrExpression(final ScmManager scmManager, final MavenProject project, final Log log) {
+    public static String resolveUrlOrExpression(final MavenProject project, final Log log) {
         String connectionUrl = null;
 
         // Some projects don't specify SCM Blocks, and instead rely upon the CI server to provide an '${env.GIT_BRANCH}'
@@ -53,7 +52,7 @@ public static String resolveUrlOrExpression(final ScmManager scmManager, final M
      * @throws ScmException
      */
     public static String resolveBranchOrExpression(final ScmManager scmManager, final MavenProject project, final Log log) {
-        String connectionUrl = resolveUrlOrExpression(scmManager, project, log);
+        String connectionUrl = resolveUrlOrExpression(project, log);
 
         // If a connectionURL other than the default expression was resolved, try to resolve the branch.
         if (!StringUtils.equals(connectionUrl, DEFAULT_URL_EXPRESSION)) {