feat: add toogle to prefer tags for versioning instead of branches

qoomon · qoomon · commit d3666739a657 · 2019-10-30T07:46:39.000+01:00
diff --git a/build.gradle b/build.gradle
@@ -11,7 +11,7 @@ plugins {
 }
 
 group 'me.qoomon'
-version '1.2.3'
+version '1.3.0'
 
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
diff --git a/src/main/java/me/qoomon/gitversioning/GitVersioning.java b/src/main/java/me/qoomon/gitversioning/GitVersioning.java
@@ -31,63 +31,32 @@ public static GitVersionDetails determineVersion(
             final GitRepoSituation repoSituation,
             final VersionDescription commitVersionDescription,
             final List<VersionDescription> branchVersionDescriptions,
-            final List<VersionDescription> tagVersionDescriptions) {
+            final List<VersionDescription> tagVersionDescriptions,
+            final boolean preferTags) {
 
         requireNonNull(repoSituation);
         requireNonNull(commitVersionDescription);
         requireNonNull(branchVersionDescriptions);
         requireNonNull(tagVersionDescriptions);
 
-        // default versioning
-        String gitRefType = "commit";
-        String gitRefName = repoSituation.getHeadCommit();
-        VersionDescription versionDescription = commitVersionDescription;
+        final VersioningInfo versioningInfo = getVersioningInfo(repoSituation, commitVersionDescription, branchVersionDescriptions, tagVersionDescriptions, preferTags);
 
-        if (repoSituation.getHeadBranch() != null) {
-            // branch versioning
-            for (final VersionDescription branchVersionDescription : branchVersionDescriptions) {
-                Optional<String> versionBranch = Optional.of(repoSituation.getHeadBranch())
-                        .filter(branch -> branch.matches(branchVersionDescription.getPattern()));
-                if (versionBranch.isPresent()) {
-                    gitRefType = "branch";
-                    gitRefName = versionBranch.get();
-                    versionDescription = branchVersionDescription;
-                    break;
-                }
-            }
-        } else if (!repoSituation.getHeadTags().isEmpty()) {
-            // tag versioning
-            for (final VersionDescription tagVersionDescription : tagVersionDescriptions) {
-                Optional<String> versionTag = repoSituation.getHeadTags().stream()
-                        .filter(tag -> tag.matches(tagVersionDescription.getPattern()))
-                        .max(comparing(DefaultArtifactVersion::new));
-                if (versionTag.isPresent()) {
-                    gitRefType = "tag";
-                    gitRefName = versionTag.get();
-                    versionDescription = tagVersionDescription;
-                    break;
-                }
-            }
-        }
-
-        final VersionDescription finalVersionDescription = versionDescription;
-
-        final Map<String, String> refData = valueGroupMap(versionDescription.getPattern(), gitRefName);
+        final Map<String, String> refData = valueGroupMap(versioningInfo.description.getPattern(), versioningInfo.gitRefName);
 
         final Map<String, String> gitDataMap = new HashMap<>();
         gitDataMap.put("commit", repoSituation.getHeadCommit());
         gitDataMap.put("commit.short", repoSituation.getHeadCommit().substring(0, 7));
         gitDataMap.put("commit.timestamp", Long.toString(repoSituation.getHeadCommitTimestamp()));
         gitDataMap.put("commit.timestamp.datetime", formatHeadCommitTimestamp(repoSituation.getHeadCommitTimestamp()));
-        gitDataMap.put("ref", gitRefName);
-        gitDataMap.put(gitRefType, gitRefName);
+        gitDataMap.put("ref", versioningInfo.gitRefName);
+        gitDataMap.put(versioningInfo.gitRefType, versioningInfo.gitRefName);
         gitDataMap.putAll(refData);
 
         final VersionTransformer versionTransformer = currentVersion -> {
             final Map<String, String> dataMap = new HashMap<>(gitDataMap);
             dataMap.put("version", currentVersion);
             dataMap.put("version.release", currentVersion.replaceFirst("-SNAPSHOT$", ""));
-            return substituteText(finalVersionDescription.getVersionFormat(), dataMap)
+            return substituteText(versioningInfo.description.getVersionFormat(), dataMap)
                     .replace("/", "-");
         };
 
@@ -96,19 +65,67 @@ public static GitVersionDetails determineVersion(
             dataMap.put("version", currentVersion);
             dataMap.put("version.release", currentVersion.replaceFirst("-SNAPSHOT$", ""));
             return transformProperties(
-                    currentProperties, finalVersionDescription.getPropertyDescriptions(), dataMap);
+                    currentProperties, versioningInfo.description.getPropertyDescriptions(), dataMap);
         };
 
         return new GitVersionDetails(
                 repoSituation.isClean(),
                 repoSituation.getHeadCommit(),
-                gitRefType,
-                gitRefName,
+                versioningInfo.gitRefType,
+                versioningInfo.gitRefName,
                 versionTransformer,
                 propertiesTransformer
         );
     }
 
+    private static VersioningInfo getVersioningInfo(GitRepoSituation repoSituation, VersionDescription commitVersionDescription, List<VersionDescription> branchVersionDescriptions, List<VersionDescription> tagVersionDescriptions, boolean preferTags) {
+
+        // tags take precedence over branches
+        VersioningInfo versioningInfo = null;
+        if (preferTags) {
+            versioningInfo = getTagVersioningInfo(repoSituation, tagVersionDescriptions);
+        }
+        if (versioningInfo == null) {
+            versioningInfo = getBranchVersioningInfo(repoSituation, branchVersionDescriptions);
+        }
+        if (versioningInfo == null && !preferTags) {
+            versioningInfo = getTagVersioningInfo(repoSituation, tagVersionDescriptions);
+        }
+
+        // default versioning: commit
+        if (versioningInfo == null) {
+            versioningInfo = new VersioningInfo("commit", repoSituation.getHeadCommit(), commitVersionDescription);
+        }
+        return versioningInfo;
+    }
+
+    private static VersioningInfo getTagVersioningInfo(GitRepoSituation repoSituation, List<VersionDescription> tagVersionDescriptions) {
+        if (!repoSituation.getHeadTags().isEmpty()) {
+            for (final VersionDescription tagVersionDescription : tagVersionDescriptions) {
+                Optional<String> versionTag = repoSituation.getHeadTags().stream()
+                        .filter(tag -> tag.matches(tagVersionDescription.getPattern()))
+                        .max(comparing(DefaultArtifactVersion::new));
+                if (versionTag.isPresent()) {
+                    return new VersioningInfo("tag", versionTag.get(), tagVersionDescription);
+                }
+            }
+        }
+        return null;
+    }
+
+    private static VersioningInfo getBranchVersioningInfo(GitRepoSituation repoSituation, List<VersionDescription> branchVersionDescriptions) {
+        if (repoSituation.getHeadBranch() != null) {
+            for (final VersionDescription branchVersionDescription : branchVersionDescriptions) {
+                Optional<String> versionBranch = Optional.of(repoSituation.getHeadBranch())
+                        .filter(branch -> branch.matches(branchVersionDescription.getPattern()));
+                if (versionBranch.isPresent()) {
+                    return new VersioningInfo("branch", versionBranch.get(), branchVersionDescription);
+                }
+            }
+        }
+        return null;
+    }
+
     private static Map<String, String> transformProperties(Map<String, String> currentProperties,
                                                            List<PropertyDescription> propertyDescriptions,
                                                            Map<String, String> dataMap) {
@@ -148,4 +165,16 @@ private static String formatHeadCommitTimestamp(long headCommitDate) {
                 .withZone(ZoneOffset.UTC)
                 .format(Instant.ofEpochSecond(headCommitDate));
     }
+
+    private static class VersioningInfo {
+        private final String gitRefType;
+        private final String gitRefName;
+        private final VersionDescription description;
+
+        private VersioningInfo(String gitRefType, String gitRefName, VersionDescription versionDescription) {
+            this.gitRefType = gitRefType;
+            this.gitRefName = gitRefName;
+            this.description = versionDescription;
+        }
+    }
 }
diff --git a/src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPlugin.java b/src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPlugin.java
@@ -11,31 +11,44 @@
 import java.util.Map.Entry;
 import java.util.stream.Collectors;
 
+import static java.lang.Boolean.parseBoolean;
 import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
 import static java.util.Optional.ofNullable;
 import static java.util.stream.Collectors.toList;
 
 public class GitVersioningPlugin implements Plugin<Project> {
+    private static final String OPTION_NAME_GIT_TAG = "git.tag";
+    private static final String OPTION_NAME_GIT_BRANCH = "git.branch";
+    private static final String OPTION_NAME_DISABLE = "versioning.disable";
+    private static final String OPTION_PREFER_TAGS = "versioning.preferTags";
 
     public void apply(@Nonnull Project rootProject) {
         rootProject.getAllprojects().forEach(it -> it.getTasks().create("version", VersionTask.class));
 
         GitVersioningPluginExtension config = rootProject.getExtensions()
                 .create("gitVersioning", GitVersioningPluginExtension.class, rootProject);
+
+        if (parseBoolean(getOption(rootProject, OPTION_NAME_DISABLE))) {
+            rootProject.getLogger().warn("skip - versioning is disabled");
+            return;
+        }
+
         rootProject.afterEvaluate(evaluatedProject -> {
 
             GitRepoSituation repoSituation = GitUtil.situation(rootProject.getProjectDir());
-            String providedTag = getOption(rootProject, "git.tag");
+            String providedTag = getOption(rootProject, OPTION_NAME_GIT_TAG);
             if (providedTag != null) {
                 repoSituation.setHeadBranch(null);
                 repoSituation.setHeadTags(providedTag.isEmpty() ? emptyList() : singletonList(providedTag));
             }
-            String providedBranch = getOption(rootProject, "git.branch");
+            String providedBranch = getOption(rootProject, OPTION_NAME_GIT_BRANCH);
             if (providedBranch != null) {
                 repoSituation.setHeadBranch(providedBranch.isEmpty() ? null : providedBranch);
             }
 
+            final boolean preferTags = config.preferTags || parseBoolean(getOption(rootProject, OPTION_PREFER_TAGS));
+
             GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                     ofNullable(config.commit)
                             .map(it -> new VersionDescription(null, it.versionFormat, mapPropertyDescription(it.properties)))
@@ -45,7 +58,8 @@ public void apply(@Nonnull Project rootProject) {
                             .collect(toList()),
                     config.tags.stream()
                             .map(it -> new VersionDescription(it.pattern, it.versionFormat, mapPropertyDescription(it.properties)))
-                            .collect(toList()));
+                            .collect(toList()),
+                    preferTags);
 
 
             final Map<String, Object> originVersionMap = rootProject.getAllprojects().stream().collect(Collectors.toMap(Project::getPath, p -> p.getVersion()));
@@ -119,7 +133,12 @@ private PropertyValueDescription mapPropertyValueDescription(GitVersioningPlugin
     private String getOption(final Project project, final String name) {
         String value = (String) project.getProperties().get(name);
         if (value == null) {
-            value = System.getenv("VERSIONING_" + name.replaceAll("\\.", "_").toUpperCase());
+            String plainName = name.replaceFirst("^versioning\\.", "");
+            String environmentVariableName = "VERSIONING_"
+                    + String.join("_", plainName.split("(?=\\p{Lu})"))
+                    .replaceAll("\\.", "_")
+                    .toUpperCase();
+            value = System.getenv(environmentVariableName);
         }
         return value;
     }
diff --git a/src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPluginExtension.java b/src/main/java/me/qoomon/gradle/gitversioning/GitVersioningPluginExtension.java
@@ -14,6 +14,8 @@ public class GitVersioningPluginExtension {
     public final List<VersionDescription> branches = new ArrayList<>();
     public final List<VersionDescription> tags = new ArrayList<>();
 
+    public boolean preferTags = false;
+
     public GitVersioningPluginExtension(Project project) {
     }
 
diff --git a/src/test/java/me/qoomon/gitversioning/GitVersioningTest.java b/src/test/java/me/qoomon/gitversioning/GitVersioningTest.java
@@ -30,7 +30,8 @@ void determineVersion_forBranch() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 singletonList(new VersionDescription(null, "${branch}-branch")),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
@@ -69,7 +70,8 @@ void determineVersionWithProperties_forBranch() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 singletonList(branchVersionDescription),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
         Map<String, String> gitProperties = gitVersionDetails.getPropertiesTransformer().apply(currentProperties, currentVersion);
@@ -102,7 +104,8 @@ void determineVersion_forBranchWithTag() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 singletonList(new VersionDescription(null, "${branch}-branch")),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
@@ -128,7 +131,8 @@ void determineVersion_detachedHead() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(null, "${commit}-commit"),
                 emptyList(),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
@@ -155,7 +159,8 @@ void determineVersion_detachedHeadWithTag() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 emptyList(),
-                singletonList(new VersionDescription("v.*", "${tag}-tag")));
+                singletonList(new VersionDescription("v.*", "${tag}-tag")),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
@@ -184,7 +189,8 @@ void determineVersion_forBranchWithTimestamp() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 singletonList(new VersionDescription(null, "${commit.timestamp}-branch")),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
@@ -213,7 +219,8 @@ void determineVersion_forBranchWithDateTime() {
         GitVersionDetails gitVersionDetails = GitVersioning.determineVersion(repoSituation,
                 new VersionDescription(),
                 singletonList(new VersionDescription(null, "${commit.timestamp.datetime}-branch")),
-                emptyList());
+                emptyList(),
+                false);
 
         String gitVersion = gitVersionDetails.getVersionTransformer().apply(currentVersion);
 
diff --git a/src/test/resources/testProjects/multiModuleProject/build.gradle b/src/test/resources/testProjects/multiModuleProject/build.gradle
@@ -16,7 +16,11 @@ gitVersioning {
         versionFormat = '${version}_${user}_${feature}'
     }
 
-
+    tag {
+        pattern = 'version/(.*)'
+        versionFormat = '${1}'
+    }
+    
 }
 
 allprojects {

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ plugins {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`group 'me.qoomon'`
`14`		`-version '1.2.3'`
	`14`	`+version '1.3.0'`
`15`	`15`
`16`	`16`	`sourceCompatibility = JavaVersion.VERSION_1_8`
`17`	`17`	`targetCompatibility = JavaVersion.VERSION_1_8`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ public class GitVersioningPluginExtension {`
`14`	`14`	`public final List<VersionDescription> branches = new ArrayList<>();`
`15`	`15`	`public final List<VersionDescription> tags = new ArrayList<>();`
`16`	`16`
	`17`	`+ public boolean preferTags = false;`
	`18`	`+`
`17`	`19`	`public GitVersioningPluginExtension(Project project) {`
`18`	`20`	`}`
`19`	`21`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,11 @@ gitVersioning {`
`16`	`16`	`versionFormat = '${version}_${user}_${feature}'`
`17`	`17`	`}`
`18`	`18`
`19`		`-`
	`19`	`+ tag {`
	`20`	`+ pattern = 'version/(.*)'`
	`21`	`+ versionFormat = '${1}'`
	`22`	`+ }`
	`23`	`+`
`20`	`24`	`}`
`21`	`25`
`22`	`26`	`allprojects {`