Merge branch 'master' into release/2

Author: host6

README.md

@@ -2,13 +2,6 @@
 [![Build Status](https://travis-ci.org/scm4j/scm4j-releaser.svg?branch=release/2)](https://travis-ci.org/scm4j/scm4j-releaser)
 [![Coverage Status](https://coveralls.io/repos/github/scm4j/scm4j-releaser/badge.svg?branch=release/2)](https://coveralls.io/github/scm4j/scm4j-releaser?branch=release/2)
 
-# Status
-
-IN DEVELOPMENT
-
-# Overview
-
-Tool to manage projects which are represented by many components, each component has its own repository (multi-repository configuration). It  detectes changes in repositories, builds new components versions and actualizes dependency lists.
 
 # Terms
 

build.gradle

@@ -46,6 +46,7 @@ dependencies {
 		add(configuration ?: name.contains('test') ? 'testCompile' : 'compile', "$group:$name:${version?:''}${classifier?:''}${ext?:''}")
 	}
 
+	testCompile 'com.github.stefanbirkner:system-rules:1.16.1'
 	testCompile 'junit:junit:4.12'
 	testCompile 'org.mockito:mockito-all:1.9.5'
 	testCompile 'nl.jqno.equalsverifier:equalsverifier:2.3'

docs/data-structure-SCM4J_VCS_REPOS.md

@@ -42,11 +42,11 @@ Yaml file consists of number of rules which are applied in order of appearance,
 - mycompany:component4:
    url: http://mycompany.com/repos/component4
    type: svn
-   releaseBanchPrefix: B
+   releaseBranchPrefix: B
    devBranch: branches/develop
 
 # All repos will have `rel` as a `release` branch prefix by default, if not specified above
 - ~:
-   releaseBanchPrefix: rel/
+   releaseBranchPrefix: rel/
 
 ```

run.groovy

@@ -2,13 +2,9 @@
 @Grab('com.github.scm4j:scm4j-releaser:2.1')
 
 import org.scm4j.releaser.cli.CLI;
-import org.scm4j.releaser.exceptions.EConfig;
 
 class CLIRunner {
 	static void main(args) {
-		try {
-			CLI.main(args);
-		} catch (EConfig e) {
-		}
+		System.exit(new CLI().exec(args));
 	}
 }

src/main/java/org/scm4j/releaser/SCMReleaser.java

@@ -79,10 +79,10 @@ public IAction getProductionReleaseAction(Component comp, ActionKind actionKind)
 			childActions.add(getProductionReleaseAction(mDep, actionKind)); 
 		}
 
-		return getProductionReleaseActionRoot(comp, childActions, actionKind);
+		return getProductionReleaseActionRoot(comp, rb, childActions, actionKind);
 	}
 
-	public IAction getProductionReleaseActionRoot(Component comp, List<IAction> childActions, ActionKind actionKind) {
+	private  IAction getProductionReleaseActionRoot(Component comp, ReleaseBranch rb, List<IAction> childActions, ActionKind actionKind) {
 		DevelopBranch db = new DevelopBranch(comp);
 		if (!db.hasVersionFile()) {
 			throw new EComponentConfig("no " + VER_FILE_NAME + " file for " + comp.toString());
@@ -93,62 +93,65 @@ public IAction getProductionReleaseActionRoot(Component comp, List<IAction> chil
 			return new ActionNone(comp, childActions, "develop branch is IGNORED");
 		}
 
-		ReleaseBranch rb = new ReleaseBranch(comp);
 		ReleaseBranchStatus rbs = rb.getStatus();
 
 		if (rbs == ReleaseBranchStatus.MISSING) {
 			skipAllBuilds(childActions);
 			if (actionKind == ActionKind.BUILD) {
-				return new ActionNone(comp, childActions, "nothing to build. " + rb.getVersion() + " " + rb.getStatus());
+				return new ActionNone(comp, childActions, "nothing to build. " + getReleaseBranchDetailsStr(rb, rbs));
 			}
 
-			return new SCMActionFork(comp, childActions, ReleaseBranchStatus.MISSING, ReleaseBranchStatus.MDEPS_ACTUAL, options);
+			return new SCMActionFork(comp, rb, childActions, ReleaseBranchStatus.MISSING, ReleaseBranchStatus.MDEPS_ACTUAL, options);
 		}
 
 		if (rbs == ReleaseBranchStatus.BRANCHED) {
 			// need to freeze mdeps
 			skipAllBuilds(childActions);
 			if (actionKind == ActionKind.BUILD) {
-				return new ActionNone(comp, childActions, "nothing to build. " + rb.getVersion() + " " + rb.getStatus());
+				return new ActionNone(comp, childActions, "nothing to build. " + getReleaseBranchDetailsStr(rb, rbs));
 			}
-			return new SCMActionFork(comp, childActions, ReleaseBranchStatus.BRANCHED,  ReleaseBranchStatus.MDEPS_ACTUAL, options);
+			return new SCMActionFork(comp, rb, childActions, ReleaseBranchStatus.BRANCHED,  ReleaseBranchStatus.MDEPS_ACTUAL, options);
 		}
 
 		if (rbs == ReleaseBranchStatus.MDEPS_FROZEN) {
 			if (needToActualizeMDeps(rb)) {
 				// need to actualize
 				skipAllBuilds(childActions);
 				if (actionKind == ActionKind.BUILD) {
-					return new ActionNone(comp, childActions, "nothing to build. " + rb.getVersion() + " " + rb.getStatus());
+					return new ActionNone(comp, childActions, "nothing to build. " + getReleaseBranchDetailsStr(rb, rbs));
 				}
-				return new SCMActionFork(comp, childActions, ReleaseBranchStatus.MDEPS_FROZEN, ReleaseBranchStatus.MDEPS_ACTUAL, options);
+				return new SCMActionFork(comp, rb, childActions, ReleaseBranchStatus.MDEPS_FROZEN, ReleaseBranchStatus.MDEPS_ACTUAL, options);
 			} else {
 				// All necessary version will be build by Child Actions. Need to build
 				skipAllForks(childActions);
 				if (actionKind == ActionKind.FORK) {
-					return new ActionNone(comp, childActions, "nothing to fork. " + rb.getVersion() + " " + rb.getStatus());
+					return new ActionNone(comp, childActions, "nothing to fork. " + getReleaseBranchDetailsStr(rb, rbs));
 				}
-				return new SCMActionBuild(comp, childActions, ReleaseReason.NEW_DEPENDENCIES, rb.getVersion(), options);
+				return new SCMActionBuild(comp, rb, childActions, ReleaseReason.NEW_DEPENDENCIES, rb.getVersion(), options);
 			}
 		}
 
 		if (rbs == ReleaseBranchStatus.MDEPS_ACTUAL) {
 			// need to build
 			if (actionKind == ActionKind.FORK) {
-				return new ActionNone(comp, childActions, "nothing to fork. " + rb.getVersion() + " " + rb.getStatus());
+				return new ActionNone(comp, childActions, "nothing to fork. " + getReleaseBranchDetailsStr(rb, rbs));
 			}
-			return new SCMActionBuild(comp, childActions, ReleaseReason.NEW_FEATURES, rb.getVersion(), options);
+			return new SCMActionBuild(comp, rb, childActions, ReleaseReason.NEW_FEATURES, rb.getVersion(), options);
 		}
 
 		if (hasForkChildActions(childActions)) {
 			skipAllBuilds(childActions);
 			if (actionKind == ActionKind.FORK) {
 				return new ActionNone(comp, childActions, "nothing to build. " + rb.getVersion() + " " + rb.getStatus());
 			}
-			return new SCMActionFork(comp, childActions, rbs, rbs, options);
+			return new SCMActionFork(comp, rb, childActions, rbs, rbs, options);
 		}
 
-		return new ActionNone(comp, childActions, rb.getVersion().toString() + " " + rbs.toString());
+		return new ActionNone(comp, childActions, getReleaseBranchDetailsStr(rb, rbs));
+	}
+
+	private String getReleaseBranchDetailsStr(ReleaseBranch rb, ReleaseBranchStatus rbs) {
+		return rb.getName() + " " + rbs + ", target version " + rb.getVersion();
 	}
 
 	private boolean needToActualizeMDeps(ReleaseBranch currentCompRB) {
@@ -158,12 +161,12 @@ private boolean needToActualizeMDeps(ReleaseBranch currentCompRB) {
 			mDepRB = new ReleaseBranch(mDep);
 			ReleaseBranchStatus rbs = mDepRB.getStatus();
 			if (rbs == ReleaseBranchStatus.MDEPS_ACTUAL) {
-				if (!mDepRB.getCurrentVersion().equals(mDep.getVersion())) {
+				if (!mDepRB.getHeadVersion().equals(mDep.getVersion())) {
 					return true;
 				}
 
 			} else if (rbs == ReleaseBranchStatus.ACTUAL) {
-				if (!mDepRB.getCurrentVersion().toPreviousPatch().equals(mDep.getVersion())) {
+				if (!mDepRB.getHeadVersion().toPreviousPatch().equals(mDep.getVersion())) {
 					return true;
 				}
 			} else {
@@ -225,7 +228,6 @@ public IAction getTagReleaseAction(String compName) {
 	}
 
 	private IAction getTagReleaseActionRoot(Component comp, List<IAction> childActions) {
-		ReleaseBranch rb = new ReleaseBranch(comp);
 		DelayedTagsFile cf = new DelayedTagsFile();
 		IVCS vcs = comp.getVCS();
 
@@ -234,24 +236,24 @@ private IAction getTagReleaseActionRoot(Component comp, List<IAction> childActio
 		if (delayedRevisionToTag == null) {
 			return new ActionNone(comp, childActions, "no delayed tags");
 		}
-		
+
+		ReleaseBranch rb = new ReleaseBranch(comp);
 		List<VCSTag> tagsOnRevision = vcs.getTagsOnRevision(delayedRevisionToTag);
 		if (tagsOnRevision.isEmpty()) {
-			return new SCMActionTagRelease(comp, childActions, options);
+			return new SCMActionTagRelease(comp, rb, childActions, options);
 		}
 		Version delayedTagVersion = new Version(vcs.getFileContent(rb.getName(), SCMReleaser.VER_FILE_NAME, delayedRevisionToTag));
 		for (VCSTag tag : tagsOnRevision) {
 			if (tag.getTagName().equals(delayedTagVersion.toReleaseString())) {
 				return new ActionNone(comp, childActions, "tag " + tag.getTagName() + " already exists");
 			}
 		}
-		return new SCMActionTagRelease(comp, childActions, options);
+		return new SCMActionTagRelease(comp, rb, childActions, options);
 	}
 
 	public static TagDesc getTagDesc(String verStr) {
-		String tagName = verStr;
-		String tagMessage = tagName + " release";
-		return new TagDesc(tagName, tagMessage);
+		String tagMessage = verStr + " release";
+		return new TagDesc(verStr, tagMessage);
 	}
 
 	public List<Option> getOptions() {

src/main/java/org/scm4j/releaser/branch/ReleaseBranch.java

@@ -21,6 +21,7 @@ public class ReleaseBranch {
 	private final String name;
 	private Map<String, Object> cache = new HashMap<>();
 
+	// comp version is ignored
 	public ReleaseBranch(Component comp, Version version) {
 		this.version = version.toRelease();
 		this.comp = comp;
@@ -44,10 +45,17 @@ public ReleaseBranch(final Component comp) {
 		vcs = comp.getVCS();
 		DevelopBranch db = new DevelopBranch(comp);
 
-		// if not product and not snapshot then will work with just one Release Branch which is related to provided version. 
-		// e.g 4.x -> release/4, 4.x-SNAPSHTOT -> release/* 
-		List<String> releaseBranches = new ArrayList<>(vcs.getBranches(
-				comp.getVcsRepository().getReleaseBranchPrefix() + (comp.getVersion().isSnapshot() ? "" : comp.getVersion().getReleaseNoPatchString())));
+		List<String> releaseBranches;
+		if (comp.getVersion().isEmpty() || comp.getVersion().isSnapshot()) {
+			releaseBranches = new ArrayList<>(vcs.getBranches(comp.getVcsRepository().getReleaseBranchPrefix()));
+		} else {
+			String exactReleaseBranchName = comp.getVcsRepository().getReleaseBranchPrefix() + comp.getVersion().getReleaseNoPatchString();
+			if (vcs.getBranches(comp.getVcsRepository().getReleaseBranchPrefix()).contains(exactReleaseBranchName)) {
+				releaseBranches = Arrays.asList(exactReleaseBranchName);
+			} else {
+				releaseBranches = new ArrayList<>();
+			}
+		}
 
 		if (releaseBranches.isEmpty()) {
 			this.version = db.getVersion().toRelease();
@@ -70,26 +78,43 @@ public int compare(String o1, String o2) {
 				return 1;
 			}
 		});
-		
+		/**
+		 * TODO: to test:
+		 * We have api 4.1 released and have new commits in api dev. Execute status git:4.1. 
+		 * We want to get api 4.1 ACTUAL since we provided exact git version but we get api 5.0 MISSING
+		 */
 		Version ver = new Version(vcs.getFileContent(releaseBranches.get(0), SCMReleaser.VER_FILE_NAME, null));
 		List<VCSCommit> commits = vcs.getCommitsRange(releaseBranches.get(0), null, WalkDirection.DESC, 2);
 		if (commits.size() == 2) {
 			List<VCSTag> tags = vcs.getTagsOnRevision(commits.get(1).getRevision());
 			if (!tags.isEmpty()) {
 				for (VCSTag tag : tags) {
 					if (tag.getTagName().equals(ver.toPreviousPatch().toReleaseString())) {
-						// if db MODIFIED and head-1 commit of last release branch tagged then all is built and we need new release. Use DB version.
-						// if db BRANCHED and head-1 commit of last release branch tagged then all is built and we need the built release. Use patch-- 
-						// otherwise we must return last built RB version.
-						if (comp.getVersion().isExact()) {
+						DevelopBranchStatus dbs = db.getStatus();
+						if(comp.getVersion().isExact()) {
+							/**
+							 * exact version provided and ACTUAL - result must be last ACTUAL despite the DevelopBranch.
+							 */
 							ver = ver.toPreviousPatch();
-						} else {
-							DevelopBranchStatus dbs = db.getStatus();
-							if (dbs == DevelopBranchStatus.BRANCHED) {
-								ver = ver.toPreviousPatch();
-							} else if(dbs == DevelopBranchStatus.MODIFIED) {
-								ver = db.getVersion().toRelease(); 
-							}
+						} else if (dbs == DevelopBranchStatus.BRANCHED ) {
+							/**
+							 *   * - scm-ver 3.0-SNAPSHOT
+							 *   |                         * - #scm-ver 2.1
+							 *   |                         * - #scm-ver 2.0, tag
+							 *   *------------------------/
+							 *   result must be 2.0 ACTUAL
+							 */
+							ver = ver.toPreviousPatch();
+						} else if (dbs == DevelopBranchStatus.MODIFIED) {
+							/**
+							 *   * - feature commit
+							 *   * - scm-ver 3.0-SNAPSHOT
+							 *   |                         * - #scm-ver 2.1
+							 *   |                         * - #scm-ver 2.0, tag
+							 *   *------------------------/
+							 *   result must be 3.0 MISSING
+							 */
+							ver = db.getVersion().toRelease();
 						}
 						break;
 					}
@@ -145,7 +170,7 @@ public ReleaseBranchStatus getStatus() {
 
 			if (mDepsFrozen()) {
 				if (mDepsActual()) {
-					if (isPreHeadCommitTaggedWithVersion() || isPreHeadCommitTagDelayed()) {
+					if (isActual()) {
 						return ReleaseBranchStatus.ACTUAL;
 					}
 					return ReleaseBranchStatus.MDEPS_ACTUAL;
@@ -159,6 +184,10 @@ public ReleaseBranchStatus getStatus() {
 		}
 	}
 
+	private boolean isActual() {
+		return isPreHeadCommitTaggedWithVersion() || isPreHeadCommitTagDelayed();
+	}
+
 	private boolean mDepsActual() {
 		List<Component> mDeps = getMDeps();
 		if (mDeps.isEmpty()) {
@@ -167,10 +196,10 @@ private boolean mDepsActual() {
 		ReleaseBranch mDepRB;
 		for (Component mDep : mDeps) {
 			mDepRB = new ReleaseBranch(mDep, mDep.getVersion());
-			if (!mDepRB.isPreHeadCommitTaggedWithVersion() && !mDepRB.isPreHeadCommitTagDelayed()) {
+			if (!mDepRB.isActual()) {
 				return false;
 			}
-			if (!mDep.getVersion().equals(mDepRB.getCurrentVersion().toPreviousPatch())) {
+			if (!mDep.getVersion().equals(mDepRB.getHeadVersion().toPreviousPatch())) {
 				return false;
 			}
 		}
@@ -188,7 +217,7 @@ private boolean isPreHeadCommitTagDelayed() {
 		return commits.size() >= 2 && commits.get(1).getRevision().equals(delayedTagRevision);
 	}
 
-	protected boolean isPreHeadCommitTaggedWithVersion() {
+	private boolean isPreHeadCommitTaggedWithVersion() {
 		List<VCSCommit> commits = getLast2Commits();
 		if (commits.size() < 2) {
 			return false;
@@ -198,7 +227,7 @@ protected boolean isPreHeadCommitTaggedWithVersion() {
 			return false;
 		}
 		for (VCSTag tag : tags) {
-			if (tag.getTagName().equals(getCurrentVersion().toPreviousPatch().toReleaseString())) {
+			if (tag.getTagName().equals(getHeadVersion().toPreviousPatch().toReleaseString())) {
 				return true;
 			}
 		}
@@ -261,7 +290,7 @@ public String getName() {
 		return name;
 	}
 
-	public Version getCurrentVersion() {
+	public Version getHeadVersion() {
 		return new Version(comp.getVCS().getFileContent(getName(), SCMReleaser.VER_FILE_NAME, null).trim());
 	}