Added support for assembly-versioning-format, updated testcase for FormatWith, updated docs

ruhullahshah · ruhullahshah · commit b4f6e8af409c · 2018-03-21T15:31:01.000+01:00
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -81,6 +81,9 @@ Example Syntax #2: `'{Major}.{Minor}.{Patch}.{$JENKINS_BUILD_NUMBER}'`.  Uses `J
 if available in the environment otherwise the parsing fails.
 String interpolation is supported as in `assembly-informational-format`
 
+### assembly-versioning-format
+Follows the same semantics as `assembly-file-versioning-format` and overwrites the value of `assembly-versioning-scheme`.
+
 ### assembly-informational-format
 Set this to any of the available [variables](/more-info/variables) to change the
 value of the `AssemblyInformationalVersion` attribute. Default set to
diff --git a/src/GitVersionCore.Tests/CommitDateTests.cs b/src/GitVersionCore.Tests/CommitDateTests.cs
@@ -27,7 +27,7 @@ public void CommitDateFormatTest(string format, string expectedOutcome)
 
                                     },
                                     new EffectiveConfiguration(
-                                        AssemblyVersioningScheme.MajorMinorPatch, AssemblyFileVersioningScheme.MajorMinorPatch, "", "", VersioningMode.ContinuousDelivery, "", "", "", IncrementStrategy.Inherit,
+                                        AssemblyVersioningScheme.MajorMinorPatch, AssemblyFileVersioningScheme.MajorMinorPatch, "", "", "", VersioningMode.ContinuousDelivery, "", "", "", IncrementStrategy.Inherit,
                                         "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format)
                                 );
 
diff --git a/src/GitVersionCore.Tests/StringFormatWithExtensionTests.cs b/src/GitVersionCore.Tests/StringFormatWithExtensionTests.cs
@@ -71,5 +71,48 @@ public void FormatWith_UnsetEnvVarTokenWithFallback()
             var actual = target.FormatWith(propertyObject);
             Assert.AreEqual(expected, actual);
         }
+
+        [Test]
+        public void FormatWith_MultipleEnvVars()
+        {
+            Environment.SetEnvironmentVariable("GIT_VERSION_TEST_VAR_1", "Val-1");
+            Environment.SetEnvironmentVariable("GIT_VERSION_TEST_VAR_2", "Val-2");
+            var propertyObject = new { };
+            var target = "{$GIT_VERSION_TEST_VAR_1} and {$GIT_VERSION_TEST_VAR_2}";
+            var expected = "Val-1 and Val-2";
+            var actual = target.FormatWith(propertyObject);
+            Assert.AreEqual(expected, actual);
+        }
+
+        [Test]
+        public void FormatWith_MultipleEnvChars()
+        {
+            var propertyObject = new { };
+            //Test the greediness of the regex in matching $ char
+            var target = "{$$GIT_VERSION_TEST_VAR_1} and {$DUMMY_VAR??fallback}";
+            var expected = "{$$GIT_VERSION_TEST_VAR_1} and fallback";
+            var actual = target.FormatWith(propertyObject);
+            Assert.AreEqual(expected, actual);
+        }
+
+        [Test]
+        public void FormatWith_MultipleFallbackChars()
+        {
+            var propertyObject = new { };
+            //Test the greediness of the regex in matching $ and ?? chars
+            var target = "{$$GIT_VERSION_TEST_VAR_1} and {$DUMMY_VAR???fallback}";
+            var actual = target.FormatWith(propertyObject);
+            Assert.AreEqual(target, actual);
+        }
+
+        [Test]
+        public void FormatWith_SingleFallbackChar()
+        {
+            var propertyObject = new { };
+            //Test the sanity of the regex when there is a grammar mismatch
+            var target = "SomeNumbers and {$DUMMY_VAR?fallback}";
+            var actual = target.FormatWith(propertyObject);
+            Assert.AreEqual(target, actual);
+        }
     }
 }
diff --git a/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs b/src/GitVersionCore.Tests/TestEffectiveConfiguration.cs
@@ -10,7 +10,8 @@ public class TestEffectiveConfiguration : EffectiveConfiguration
         public TestEffectiveConfiguration(
             AssemblyVersioningScheme assemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch,
             AssemblyFileVersioningScheme assemblyFileVersioningScheme = AssemblyFileVersioningScheme.MajorMinorPatch,
-            string assemblyFileVersioningSchemeFormat = null,
+            string assemblyVersioningFormat = null,
+            string assemblyFileVersioningFormat = null,
             string assemblyInformationalFormat = null,
             VersioningMode versioningMode = VersioningMode.ContinuousDelivery,
             string gitTagPrefix = "v",
@@ -33,7 +34,7 @@ public TestEffectiveConfiguration(
             bool tracksReleaseBranches = false,
             bool isRelease = false,
             string commitDateFormat = "yyyy-MM-dd") :
-            base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyFileVersioningSchemeFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
+            base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
diff --git a/src/GitVersionCore/Configuration/Config.cs b/src/GitVersionCore/Configuration/Config.cs
@@ -26,6 +26,9 @@ public Config()
         [YamlMember(Alias = "assembly-informational-format")]
         public string AssemblyInformationalFormat { get; set; }
 
+        [YamlMember(Alias = "assembly-versioning-format")]
+        public string AssemblyVersioningFormat { get; set; }
+
         [YamlMember(Alias = "assembly-file-versioning-format")]
         public string AssemblyFileVersioningFormat { get; set; }
 
diff --git a/src/GitVersionCore/Configuration/ConfigurationProvider.cs b/src/GitVersionCore/Configuration/ConfigurationProvider.cs
@@ -88,6 +88,7 @@ public static void ApplyDefaultsTo(Config config)
             config.AssemblyVersioningScheme = config.AssemblyVersioningScheme ?? AssemblyVersioningScheme.MajorMinorPatch;
             config.AssemblyFileVersioningScheme = config.AssemblyFileVersioningScheme ?? AssemblyFileVersioningScheme.MajorMinorPatch;
             config.AssemblyInformationalFormat = config.AssemblyInformationalFormat;
+            config.AssemblyVersioningFormat = config.AssemblyVersioningFormat;
             config.AssemblyFileVersioningFormat = config.AssemblyFileVersioningFormat;
             config.TagPrefix = config.TagPrefix ?? DefaultTagPrefix;
             config.VersioningMode = config.VersioningMode ?? VersioningMode.ContinuousDelivery;
diff --git a/src/GitVersionCore/EffectiveConfiguration.cs b/src/GitVersionCore/EffectiveConfiguration.cs
@@ -12,6 +12,7 @@ public EffectiveConfiguration(
             AssemblyVersioningScheme assemblyVersioningScheme,
             AssemblyFileVersioningScheme assemblyFileVersioningScheme,
             string assemblyInformationalFormat,
+            string assemblyVersioningFormat,
             string assemblyFileVersioningFormat,
             VersioningMode versioningMode, string gitTagPrefix,
             string tag, string nextVersion, IncrementStrategy increment,
@@ -36,6 +37,7 @@ public EffectiveConfiguration(
             AssemblyVersioningScheme = assemblyVersioningScheme;
             AssemblyFileVersioningScheme = assemblyFileVersioningScheme;
             AssemblyInformationalFormat = assemblyInformationalFormat;
+            AssemblyVersioningFormat = assemblyVersioningFormat;
             AssemblyFileVersioningFormat = assemblyFileVersioningFormat;
             VersioningMode = versioningMode;
             GitTagPrefix = gitTagPrefix;
@@ -69,6 +71,7 @@ public EffectiveConfiguration(
         public AssemblyVersioningScheme AssemblyVersioningScheme { get; private set; }
         public AssemblyFileVersioningScheme AssemblyFileVersioningScheme { get; private set; }
         public string AssemblyInformationalFormat { get; private set; }
+        public string AssemblyVersioningFormat { get; private set; }
         public string AssemblyFileVersioningFormat { get; private set; }
 
         /// <summary>
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
@@ -122,6 +122,7 @@ void CalculateEffectiveConfiguration()
             var assemblyVersioningScheme = FullConfiguration.AssemblyVersioningScheme.Value;
             var assemblyFileVersioningScheme = FullConfiguration.AssemblyFileVersioningScheme.Value;
             var assemblyInformationalFormat = FullConfiguration.AssemblyInformationalFormat;
+            var assemblyVersioningFormat = FullConfiguration.AssemblyVersioningFormat;
             var assemblyFileVersioningFormat = FullConfiguration.AssemblyFileVersioningFormat;
             var gitTagPrefix = FullConfiguration.TagPrefix;
             var majorMessage = FullConfiguration.MajorVersionBumpMessage;
@@ -133,7 +134,7 @@ void CalculateEffectiveConfiguration()
             var commitMessageVersionBump = currentBranchConfig.CommitMessageIncrementing ?? FullConfiguration.CommitMessageIncrementing.Value;
 
             Configuration = new EffectiveConfiguration(
-                assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix,
+                assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix,
                 tag, nextVersion, incrementStrategy,
                 currentBranchConfig.Regex,
                 preventIncrementForMergedBranchVersion,
diff --git a/src/GitVersionCore/OutputVariables/VariableProvider.cs b/src/GitVersionCore/OutputVariables/VariableProvider.cs
@@ -44,43 +44,16 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
             var semverFormatValues = new SemanticVersionFormatValues(semanticVersion, config);
 
             string informationalVersion;
+            CheckAndFormatString(config.AssemblyInformationalFormat, semverFormatValues, semverFormatValues.DefaultInformationalVersion,
+                "AssemblyInformationalVersion", out informationalVersion);
 
-            if (string.IsNullOrEmpty(config.AssemblyInformationalFormat))
-            {
-                informationalVersion = semverFormatValues.DefaultInformationalVersion;
-            }
-            else
-            {
-                try
-                {
-                    informationalVersion = config.AssemblyInformationalFormat.FormatWith<SemanticVersionFormatValues>(semverFormatValues);
-                }
-                catch (ArgumentException formex)
-                {
-                    throw new WarningException(string.Format("Unable to format AssemblyInformationalVersion.  Check your format string: {0}", formex.Message));
-                }
-            }
-
-            string assemblyFileVersioningFormat;
             string assemblyFileSemVer;
+            CheckAndFormatString(config.AssemblyFileVersioningFormat, semverFormatValues, semverFormatValues.AssemblyFileSemVer,
+                "AssemblyFileVersioningFormat", out assemblyFileSemVer);
 
-            if (!(string.IsNullOrEmpty(config.AssemblyFileVersioningFormat)))
-            {
-                //assembly-file-versioning-format value if provided in the config, overwrites the exisiting AssemblyFileSemVer
-                try
-                {
-                    assemblyFileVersioningFormat = config.AssemblyFileVersioningFormat.FormatWith<SemanticVersionFormatValues>(semverFormatValues);
-                    assemblyFileSemVer = assemblyFileVersioningFormat;
-                }
-                catch (ArgumentException formex)
-                {
-                    throw new WarningException(string.Format("Unable to format AssemblyFileVersioningFormat.  Check your format string: {0}", formex.Message));
-                }
-            }
-            else
-            {
-                assemblyFileSemVer = semverFormatValues.AssemblyFileSemVer;
-            }
+            string assemblySemVer;
+            CheckAndFormatString(config.AssemblyVersioningFormat, semverFormatValues, semverFormatValues.AssemblySemVer,
+                "AssemblyVersioningFormat", out assemblySemVer);
 
             var variables = new VersionVariables(
                 semverFormatValues.Major,
@@ -96,7 +69,7 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
                 semverFormatValues.LegacySemVer,
                 semverFormatValues.LegacySemVerPadded,
                 semverFormatValues.FullSemVer,
-                semverFormatValues.AssemblySemVer,
+                assemblySemVer,
                 assemblyFileSemVer,
                 semverFormatValues.PreReleaseTag,
                 semverFormatValues.PreReleaseTagWithDash,
@@ -121,5 +94,24 @@ static void PromoteNumberOfCommitsToTagNumber(SemanticVersion semanticVersion)
             semanticVersion.BuildMetaData.CommitsSinceVersionSource = semanticVersion.BuildMetaData.CommitsSinceTag ?? 0;
             semanticVersion.BuildMetaData.CommitsSinceTag = null;
         }
+
+        static void CheckAndFormatString<T>(string formatString, T source,  string defaultValue, string formatVarName, out string formattedString)
+        {
+            if (string.IsNullOrEmpty(formatString))
+            {
+                formattedString = defaultValue;
+            }
+            else
+            {
+                try
+                {
+                    formattedString = formatString.FormatWith(source);
+                }
+                catch (ArgumentException formex)
+                {
+                    throw new WarningException(string.Format("Unable to format {0}.  Check your format string: {1}", formatVarName, formex.Message));
+                }
+            }
+        }
     }
 }
