Merge pull request #84 from egineering-llc/feature/pr83-integration

Feature/pr83 integration

Author: bvarner

.travis.yml

@@ -4,7 +4,6 @@ script: mvn verify
 
 jdk:
  - openjdk7
- - oraclejdk7
  - oraclejdk8
 
 cache:

README.md

@@ -124,6 +124,7 @@ All of the solutions to these issues are implemented independently in different
                             <hotfixBranchPropertyFile>foo/bar/emer.props</hotfixBranchPropertyFile>
                             <releaseBranchPropertyFile>foo/bar/test.props</releaseBranchPropertyFile>
                             <developmentBranchPropertyFile>foo/bar/dev.props</developmentBranchPropertyFile>
+                            <featureOrBugfixBranchPropertyFile>foo/bar/feat.props</featureOrBugfixBranchPropertyFile>
                             <otherBranchPropertyFile>foo/bar/ci.props</otherBranchPropertyFile>
                             <undefinedBranchPropertyFile>foo/bar/local.props</undefinedBranchPropertyFile>
                         </configuration>
@@ -143,8 +144,8 @@ One common stumbling block for teams adjusting to gitflow with Maven projects is
 In practice, the Maven versions should:
 
  * Be synchronized with release branch and hotfix branch names.
- * Never be -SNAPSHOT in the master, support, release, or hotfix branches.
- * Always be -SNAPSHOT in the develop branch.
+ * Never be -SNAPSHOT in the master, support, release, or hotfix branches. Also, no -SNAPSHOT parent or (plugin) dependencies are allowed. (This condition may be disabled by setting `enforceNonSnapshots` = `false`.)
+ * Always be -SNAPSHOT in the feature and develop branches.
  * 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`.
@@ -158,12 +159,17 @@ 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 |
+| deploySnapshotTypeBranches  | `false` | n/a | When `true`, the POM version should end with the feature branch name and -SNAPSHOT, e.g. `1.0.0-myfeature-SNAPSHOT`. This prevents a feature branch snapshot from "overwriting" a snapshot from the develop branch. |
+| enforceNonSnapshots | `true` | n/a | When `true`, enforce the requirement that none of the following may contain a -SNAPSHOT: the POM version, any parent, or any (plugin) dependencies. |
+| releaseBranchMatchType  | `equals` | n/a | When `equals`, the POM version should be identical to the branch name for release and hotfix branches (e.g. POM version should be `1.0.0` for branch `release/1.0.0`). When `startsWith`, POM version should start with the name branch (e.g. POM version could be `1.0.1` for branch `release/1.0`. When using the `update-stage-dependencies` mojo, set to `equals`, otherwise set to `startsWith`. |
 | masterBranchPattern  | (origin/)?master | No | Regex. When matched, signals the master branch is being built. |
 | supportBranchPattern | (origin/)?support/(.*) | No | Regex. When matches, signals a support branch (long term master-equivalent for older release) being built. Last subgroup, if present, must be start of the Maven project version. |
 | 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. |
+| featureOrBugfixBranchPattern | (origin/)?(?:feature&#124;bugfix)/(.*) | Yes | Regex. When matched, signals a feature or bugfix branch is being built. |
 | 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)
 
 One of the challenges of building a good CI/CD job for Maven environments is the lack of a 'staging' repository baked into Maven.
@@ -179,10 +185,12 @@ plugins in the build process (deploy, site-deploy, etc.) will use the repositori
 | Property | Default Value | Description | 
 | -------- | ------------- | ----------- |
 | gitBranchExpression  | current git branch resolved from SCM or ${env.GIT_BRANCH} | Maven property expression to resolve in order to determine the current git branch |
+| deploySnapshotTypeBranches  | `false` | When `true`, feature branches will also be deployed to the snapshots repository. |
 | releaseDeploymentRepository | n/a | The repository to use for releases. (Builds with a GIT_BRANCH matching `masterBranchPattern` or `supportBranchPattern`) |
 | stageDeploymentRepository | n/a | The repository to use for staging. (Builds with a GIT_BRANCH matching `releaseBranchPattern` or `hotfixBranchPattern`) | 
 | snapshotDeploymentRepository | n/a | The repository to use for snapshots. (Builds matching `developmentBranchPattern`) |
 
+
 **The repository properties should follow the following format**, `id::layout::url::uniqueVersion`.
 
 When using this plugin, the `<distributionManagement>` repository definitions can be completely removed from your pom.xml 
@@ -250,11 +258,11 @@ properties from files with an assigned keyPrefix, letting you name-space propert
 The maven `-U` command line switch does a fine job of updating SNAPSHOT versions from snapshot repositories, there is no
 built-in way to force maven to re-resolve non-snapshot release versions. This goal addresses that shortcoming in a fairly
 straight-forward manner. Any release version dependency of the project which was provided to the local repository by a
-remote repository with the same ID as the `<stageDeploymentRepository>`, will be purged from the local repository and 
+remote repository with the same ID as the `<stageDeploymentRepository>`, will be purged from the local repository and
 re-resolved (so you get the latest version from either the stage repository, or your release repository).
 
-It is **very important** if you're using this goal, that the **`stageDeploymentReposity` have a unique repository/server id**. 
-If you use the same ID for release, snapshot, and stage, every time you exeucte this goal, every release version 
+It is **very important** if you're using this goal, that the **`stageDeploymentReposity` have a unique repository/server id**.
+If you use the same ID for release, snapshot, and stage, every time you exeucte this goal, every release version
 dependency will be purged and re-resolved.
 
 If you have a local build / install of a release version, this goal will currently not update that package, by design.
@@ -299,7 +307,7 @@ To accomplish this the `promote-master` goal and a Maven build extension work to
 
 With the build extension added to your project, any build where the `gitBranchExpression` matches the `masterBranchPattern` or `supportBranchPattern` will have it's
 build lifecycle (plugins, goals, etc) altered. Any plugin other than the gitflow-helper-maven-plugin, the maven-deploy-plugin, or plugins with goals
- explicitly referenced on the command line  will be ignored (removed from the project reactor). 
+ explicitly referenced on the command line will be ignored (removed from the project reactor). 
 This allows us to enforce the ideal that code should never be built in the master branch.
 
 The `promote-master` goal executes when the `gitBranchExpression` resolves to a value matching the `masterBranchPattern` or `supportBranchPattern` regular expression.
@@ -331,6 +339,7 @@ The following table describes the git branch expression -> repository used for r
 | supportBranchPattern  | release    |
 | releaseBranchPattern  | stage      |
 | hotfixBranchPattern   | stage      |
+| featureOrBugfixBranchPattern | snapshots | 
 | developmentBranchPattern | snapshots | 
 | All Others            | local      |
 
@@ -352,3 +361,15 @@ it's building. The attach-deploy will 'clean' the maven project, then download t
 that the first build deployed into. Once they're attached to the project, the `jboss-as:deploy-only` goal will deliver
 the artifacts built by the first job into a jboss application server.
 
+
+# Resolving the Git branch name
+As stated before, the plugin determines what to do by resolving the Git branch name.
+
+ * The first try is a `git symbolic-ref HEAD` to check the local branch name. If it's found, that's the branch name that's used.
+ * If the `symbolic-ref` fails then it's probably due to a detached HEAD. This typically happens on Jenkins, when it simply checks out the commit hash that was just pushed.
+   Or, it's because of a developer doing a `git checkout origin/feature/x`, e.g. when doing a code review and no local branch is required.
+   In such a case:
+    * The plugin will first resolve the HEAD to a commit using `git rev-parse HEAD`.
+    * Next, it will do a `git show-ref` to check which (local/remote) branches point to the commit.
+    * If it can resolve the commit to a single branch type (e.g. develop or master) then that's the branch name that's used.
+ * If all of the above fails, `${env.GIT_BRANCH}` is tried.

pom.xml

@@ -128,7 +128,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-plugin-plugin</artifactId>
-                <version>3.2</version>
+                <version>3.5.1</version>
                 <configuration>
                     <goalPrefix>gitflow-helper</goalPrefix>
                     <skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
@@ -151,7 +151,7 @@
             <plugin>
                 <groupId>org.codehaus.plexus</groupId>
                 <artifactId>plexus-component-metadata</artifactId>
-                <version>1.6</version>
+                <version>1.7.1</version>
                 <executions>
                     <execution>
                         <goals>
@@ -164,7 +164,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
-                <version>2.4</version>
+                <version>3.0.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -189,7 +189,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-gpg-plugin</artifactId>
-                        <version>1.5</version>
+                        <version>1.6</version>
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>
@@ -203,7 +203,7 @@
                     <plugin>
                         <groupId>org.sonatype.plugins</groupId>
                         <artifactId>nexus-staging-maven-plugin</artifactId>
-                        <version>1.6.7</version>
+                        <version>1.6.8</version>
                         <extensions>true</extensions>
                         <configuration>
                             <serverId>ossrh</serverId>

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

@@ -45,6 +45,20 @@ abstract class AbstractGitflowBasedRepositoryMojo extends AbstractGitflowBranchM
     private static final Pattern ALT_REPO_SYNTAX_PATTERN = Pattern.compile("(.+)::(.+)::(.+)::(.+)");
     private static final String CATALOG_HEADER = "[artifacts]";
 
+    /**
+     * Returns the policy or a default policy if {@code policy} is null.
+     *
+     * @param policy the policy to check
+     * @return the {@link org.apache.maven.model.RepositoryPolicy}
+     */
+    private static org.apache.maven.model.RepositoryPolicy ensureRepositoryPolicy(
+            @Nullable org.apache.maven.model.RepositoryPolicy policy) {
+        if (policy == null) {
+            return new org.apache.maven.model.RepositoryPolicy();
+        }
+        return policy;
+    }
+
     private static PrintWriter newPrintWriter(File catalog) throws FileNotFoundException {
         checkNotNull(catalog, "catalog must not be null");
         return new PrintWriter(new OutputStreamWriter(new FileOutputStream(catalog), UTF_8));
@@ -116,7 +130,8 @@ ArtifactRepository getDeploymentRepository(final String altRepository)
 
             if (candidate == null) {
                 throw new MojoFailureException(altRepository, "Invalid syntax for repository or repository id not resolved..",
-                        "Invalid syntax for repository. Use \"id::layout::url::unique\" or only specify the \"id\".");
+                        "Invalid syntax for repository. Use \"id::layout::url::unique\" or only specify the \"id\"." +
+                        " For the \"id\", make sure that the corresponding <repository> element has been defined (e.g. in the ~/.m2/settings.xml file)");
             }
         }
 
@@ -134,7 +149,12 @@ ArtifactRepository getDeploymentRepository(final String altRepository)
 
             return repositoryFactory.createDeploymentArtifactRepository(id, url, repoLayout, unique);
         } else {
-            return repositoryFactory.createDeploymentArtifactRepository(candidate.getId(), candidate.getUrl(), getLayout(candidate.getLayout()), candidate.getSnapshots().isEnabled());
+            return repositoryFactory.createDeploymentArtifactRepository(
+                    candidate.getId(),
+                    candidate.getUrl(),
+                    getLayout(candidate.getLayout()),
+                    ensureRepositoryPolicy(candidate.getSnapshots()).isEnabled()
+            );
         }
     }
 

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

@@ -21,15 +21,12 @@ public abstract class AbstractGitflowBranchMojo extends AbstractMojo {
 
     private Properties systemEnvVars = new Properties();
 
-    private PropertyResolver resolver = new PropertyResolver();
-
-
-    @Component
-    protected MavenProject project;
-
     @Component
     protected ScmManager scmManager;
 
+    @Parameter(defaultValue = "${project}", readonly = true)
+    protected MavenProject project;
+
     @Parameter(defaultValue = "(origin/)?master", property = "masterBranchPattern", required = true)
     private String masterBranchPattern;
 
@@ -45,68 +42,63 @@ public abstract class AbstractGitflowBranchMojo extends AbstractMojo {
     @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();
+    @Parameter(defaultValue = "(origin/)?(?:feature|bugfix)/(.*)", property = "featureOrBugfixBranchPattern", required = true)
+    private String featureOrBugfixBranchPattern;
+
+    // An expression that resolves to the git branch at run-time.
+    // @Parameter tag causes property resolution to fail for patterns containing ${env.}.
+    // The default value _must_ be provided programmaticially at run-time.
     @Parameter(property = "gitBranchExpression", required = false)
     private String gitBranchExpression;
 
-    protected abstract void execute(final GitBranchType type, final String gitBranch, final String branchPattern) throws MojoExecutionException, MojoFailureException;
+    @Parameter(defaultValue = "false", property = "deploySnapshotTypeBranches")
+    boolean deploySnapshotTypeBranches;
+
+    @Parameter(defaultValue = "equals", property = "releaseBranchMatchType", required = true)
+    String releaseBranchMatchType;
 
     /**
-     * Method exposing Property Resolving for subclasses.
+     * Convenience Method exposing Property Resolving for subclasses.
      *
      * @param expression
      * @return
      */
     protected String resolveExpression(final String expression) {
-        return resolver.resolveValue(expression, project.getProperties(), systemEnvVars);
+        return PropertyResolver.resolveValue(expression, project.getProperties(), systemEnvVars);
     }
 
-    private void logExecute(final GitBranchType type, final String gitBranch, final String branchPattern) throws MojoExecutionException, MojoFailureException {
-        getLog().debug("Building for GitBranchType: " + type.name() + ". gitBranch: '" + gitBranch + "' branchPattern: '" + branchPattern + "'");
-        execute(type, gitBranch, branchPattern);
-    }
+    /**
+     * Method to be implemented by branch-aware mojos
+     *
+     * @param currentBranch
+     *
+     * @throws MojoExecutionException
+     * @throws MojoFailureException
+     */
+    protected abstract void execute(final GitBranchInfo currentBranch) throws MojoExecutionException, MojoFailureException;
 
     public void execute() throws MojoExecutionException, MojoFailureException {
-        if (gitBranchExpression == null) {
-            gitBranchExpression = ScmUtils.resolveBranchOrExpression(scmManager, project, getLog());
-        }
-
+        // Weather we resolve a single branch name or not, it won't hurt to run it through property replacement.
         try {
             systemEnvVars = CommandLineUtils.getSystemEnvVars();
         } catch (IOException ioe) {
             throw new MojoExecutionException("Unable to read System Envirionment Variables: ", ioe);
         }
 
-        // Try to resolve the gitBranchExpression to an actual Value...
-        String gitBranch = resolveExpression(gitBranchExpression);
-        ExpansionBuffer eb = new ExpansionBuffer(gitBranch);
+        // Validate the match type.
+        checkReleaseBranchMatchTypeParam();
 
-        if (!gitBranchExpression.equals(gitBranch) || getLog().isDebugEnabled()) { // Resolves Issue #9
-            getLog().debug("Resolved gitBranchExpression: '" + gitBranchExpression + " to '" + gitBranch + "'");
-        }
+        ScmUtils scmUtils = new ScmUtils(systemEnvVars, scmManager, project, getLog(), masterBranchPattern, supportBranchPattern, releaseBranchPattern, hotfixBranchPattern, developmentBranchPattern, featureOrBugfixBranchPattern);
+        GitBranchInfo branchInfo = scmUtils.resolveBranchInfo(gitBranchExpression);
 
-        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/)?develop goes to the 'snapshot' repo.
-             * All other builds will use the default semantics for 'deploy'.
-             */
-            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)) {
-                logExecute(GitBranchType.HOTFIX, gitBranch, hotfixBranchPattern);
-            } else if (gitBranch.matches(developmentBranchPattern)) {
-                logExecute(GitBranchType.DEVELOPMENT, gitBranch, developmentBranchPattern);
-            } else {
-                logExecute(GitBranchType.OTHER, gitBranch, null);
-            }
-        } else {
-            logExecute(GitBranchType.UNDEFINED, gitBranch, null);
+        getLog().debug("Building for: " + branchInfo);
+        execute(branchInfo);
+    }
+
+    private void checkReleaseBranchMatchTypeParam() throws MojoFailureException {
+        if (!"equals".equals(releaseBranchMatchType) && !"startsWith".equals(releaseBranchMatchType)) {
+            throw new MojoFailureException("'releaseBranchMatchType' should be either 'equals' or 'startsWith'. Found '" + releaseBranchMatchType + "'.");
         }
     }
 }
+