Merge pull request #660 from MarkZuber/feature/assemblyInfoUpdates

Add support and tests for AssemblyInformationalVersion configurability

Author: JakeGinnivan

src/GitVersionCore.Tests/ConfigProviderTests.cs

@@ -43,6 +43,7 @@ public void CanReadDocumentAndMigrate()
 
         var config = ConfigurationProvider.Provide(repoPath, fileSystem);
         config.AssemblyVersioningScheme.ShouldBe(AssemblyVersioningScheme.MajorMinor);
+        config.AssemblyInformationalFormat.ShouldBe(null);
         config.NextVersion.ShouldBe("2.0.0");
         config.TagPrefix.ShouldBe("[vV|version-]");
         config.VersioningMode.ShouldBe(VersioningMode.ContinuousDelivery);
@@ -110,13 +111,42 @@ public void CanWriteOutEffectiveConfiguration()
         Approvals.Verify(config);
     }
 
+    [Test]
+    public void CanUpdateAssemblyInformationalVersioningScheme()
+    {
+        const string text = @"
+assembly-versioning-scheme: MajorMinor
+assembly-informational-format: '{NugetVersion}'";
+
+        SetupConfigFileContent(text);
+
+        var config = ConfigurationProvider.Provide(repoPath, fileSystem);
+        config.AssemblyVersioningScheme.ShouldBe(AssemblyVersioningScheme.MajorMinor);
+        config.AssemblyInformationalFormat.ShouldBe("{NugetVersion}");
+    }
+
+    [Test]
+    public void CanUpdateAssemblyInformationalVersioningSchemeWithMultipleVariables()
+    {
+        const string text = @"
+assembly-versioning-scheme: MajorMinor
+assembly-informational-format: '{Major}.{Minor}.{Patch}'";
+
+        SetupConfigFileContent(text);
+
+        var config = ConfigurationProvider.Provide(repoPath, fileSystem);
+        config.AssemblyVersioningScheme.ShouldBe(AssemblyVersioningScheme.MajorMinor);
+        config.AssemblyInformationalFormat.ShouldBe("{Major}.{Minor}.{Patch}");
+    }
+
     [Test]
     public void CanReadDefaultDocument()
     {
         const string text = "";
         SetupConfigFileContent(text);
         var config = ConfigurationProvider.Provide(repoPath, fileSystem);
         config.AssemblyVersioningScheme.ShouldBe(AssemblyVersioningScheme.MajorMinorPatch);
+        config.AssemblyInformationalFormat.ShouldBe(null);
         config.Branches["dev(elop)?(ment)?$"].Tag.ShouldBe("unstable");
         config.Branches["releases?[/-]"].Tag.ShouldBe("beta");
         config.TagPrefix.ShouldBe(ConfigurationProvider.DefaultTagPrefix);

src/GitVersionCore.Tests/TestEffectiveConfiguration.cs

@@ -6,6 +6,7 @@ public class TestEffectiveConfiguration : EffectiveConfiguration
     {
         public TestEffectiveConfiguration(
             AssemblyVersioningScheme assemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch, 
+            string assemblyInformationalFormat = null,
             VersioningMode versioningMode = VersioningMode.ContinuousDelivery, 
             string gitTagPrefix = "v", 
             string tag = "",
@@ -21,7 +22,7 @@ public TestEffectiveConfiguration(
             CommitMessageIncrementMode commitMessageMode = CommitMessageIncrementMode.Enabled,
             int legacySemVerPadding = 4,
             int buildMetaDataPadding = 4) : 
-                base(assemblyVersioningScheme, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch, 
+                base(assemblyVersioningScheme, assemblyInformationalFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch, 
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage,

src/GitVersionCore/AssemblyVersionsGenerator.cs

@@ -21,8 +21,6 @@ public static string GetAssemblyVersion(
                 default:
                     throw new ArgumentException(string.Format("Unexpected value ({0}).", scheme), "scheme");
             }
-
         }
-
     }
 }

src/GitVersionCore/Configuration/Config.cs

@@ -11,6 +11,9 @@ public class Config
         [YamlMember(Alias = "assembly-versioning-scheme")]
         public AssemblyVersioningScheme? AssemblyVersioningScheme { get; set; }
 
+        [YamlMember(Alias = "assembly-informational-format")]
+        public string AssemblyInformationalFormat { get; set; }
+
         [YamlMember(Alias = "mode")]
         public VersioningMode? VersioningMode { get; set; }
 

src/GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -24,6 +24,7 @@ public static void ApplyDefaultsTo(Config config)
             MigrateBranches(config);
 
             config.AssemblyVersioningScheme = config.AssemblyVersioningScheme ?? AssemblyVersioningScheme.MajorMinorPatch;
+            config.AssemblyInformationalFormat = config.AssemblyInformationalFormat;
             config.TagPrefix = config.TagPrefix ?? DefaultTagPrefix;
             config.VersioningMode = config.VersioningMode ?? VersioningMode.ContinuousDelivery;
             config.ContinuousDeploymentFallbackTag = config.ContinuousDeploymentFallbackTag ?? "ci";

src/GitVersionCore/EffectiveConfiguration.cs

@@ -7,6 +7,7 @@ public class EffectiveConfiguration
     {
         public EffectiveConfiguration(
             AssemblyVersioningScheme assemblyVersioningScheme, 
+            string assemblyInformationalFormat,
             VersioningMode versioningMode, string gitTagPrefix, 
             string tag, string nextVersion, IncrementStrategy increment, 
             string branchPrefixToTrim, 
@@ -23,6 +24,7 @@ int buildMetaDataPadding
             )
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
+            AssemblyInformationalFormat = assemblyInformationalFormat;
             VersioningMode = versioningMode;
             GitTagPrefix = gitTagPrefix;
             Tag = tag;
@@ -44,6 +46,7 @@ int buildMetaDataPadding
         public VersioningMode VersioningMode { get; private set; }
 
         public AssemblyVersioningScheme AssemblyVersioningScheme { get; private set; }
+        public string AssemblyInformationalFormat { get; private set; }
 
         /// <summary>
         /// Git tag prefix

src/GitVersionCore/GitVersionContext.cs

@@ -103,6 +103,7 @@ void CalculateEffectiveConfiguration()
 
             var nextVersion = configuration.NextVersion;
             var assemblyVersioningScheme = configuration.AssemblyVersioningScheme.Value;
+            var assemblyInformationalFormat = configuration.AssemblyInformationalFormat;
             var gitTagPrefix = configuration.TagPrefix;
             var majorMessage = configuration.MajorVersionBumpMessage;
             var minorMessage = configuration.MinorVersionBumpMessage;
@@ -111,7 +112,7 @@ void CalculateEffectiveConfiguration()
             var commitMessageVersionBump = currentBranchConfig.Value.CommitMessageIncrementing ?? configuration.CommitMessageIncrementing.Value;
 
             Configuration = new EffectiveConfiguration(
-                assemblyVersioningScheme, versioningMode, gitTagPrefix, 
+                assemblyVersioningScheme, assemblyInformationalFormat, versioningMode, gitTagPrefix, 
                 tag, nextVersion, incrementStrategy, currentBranchConfig.Key, 
                 preventIncrementForMergedBranchVersion, 
                 tagNumberPattern, configuration.ContinuousDeploymentFallbackTag,

src/GitVersionCore/GitVersionCore.csproj

@@ -47,6 +47,7 @@
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="System.Web" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="Microsoft.CSharp" />
@@ -117,6 +118,8 @@
     <Compile Include="OutputVariables\VersionVariables.cs" />
     <Compile Include="Extensions\ExtensionMethods.git.cs" />
     <Compile Include="SemanticVersionExtensions.cs" />
+    <Compile Include="SemanticVersionFormatValues.cs" />
+    <Compile Include="StringFormatWith.cs" />
     <Compile Include="VersionCalculation\BaseVersionCalculator.cs" />
     <Compile Include="VersionCalculation\BaseVersionCalculators\BaseVersion.cs" />
     <Compile Include="VersionCalculation\BaseVersionCalculators\ConfigNextVersionBaseVersionStrategy.cs" />

src/GitVersionCore/OutputVariables/VariableProvider.cs

@@ -1,5 +1,7 @@
 namespace GitVersion
 {
+    using System;
+
     public static class VariableProvider
     {
         public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion, EffectiveConfiguration config, bool isCurrentCommitTagged)
@@ -18,25 +20,47 @@ public static VersionVariables GetVariablesFor(SemanticVersion semanticVersion,
                 semanticVersion.BuildMetaData.CommitsSinceTag = null;
             }
 
+            var semverFormatValues = new SemanticVersionFormatValues(semanticVersion, config);
+
+            string informationalVersion;
+
+            if (string.IsNullOrEmpty(config.AssemblyInformationalFormat))
+            {
+                informationalVersion = semverFormatValues.DefaultInformationalVersion;
+            }
+            else
+            {
+                try
+                {
+                    informationalVersion = config.AssemblyInformationalFormat.FormatWith(semverFormatValues);
+                }
+                catch (FormatException formex)
+                {
+                    throw new WarningException(string.Format("Unable to format AssemblyInformationalVersion.  Check your format string: {0}", formex.Message));
+                }
+            }
+
             var variables = new VersionVariables(
-                major: semanticVersion.Major.ToString(),
-                minor: semanticVersion.Minor.ToString(),
-                patch: semanticVersion.Patch.ToString(),
-                preReleaseTag: semanticVersion.PreReleaseTag,
-                preReleaseTagWithDash: semanticVersion.PreReleaseTag.HasTag() ? "-" + semanticVersion.PreReleaseTag : null,
-                buildMetaData: semanticVersion.BuildMetaData,
-                buildMetaDataPadded: semanticVersion.BuildMetaData.ToString("p" + config.BuildMetaDataPadding),
-                fullBuildMetaData: semanticVersion.BuildMetaData.ToString("f"),
-                majorMinorPatch: string.Format("{0}.{1}.{2}", semanticVersion.Major, semanticVersion.Minor, semanticVersion.Patch),
-                semVer: semanticVersion.ToString(),
-                legacySemVer: semanticVersion.ToString("l"),
-                legacySemVerPadded: semanticVersion.ToString("lp" + config.LegacySemVerPadding),
-                assemblySemVer: semanticVersion.GetAssemblyVersion(config.AssemblyVersioningScheme),
-                fullSemVer: semanticVersion.ToString("f"),
-                informationalVersion: semanticVersion.ToString("i"),
-                branchName: semanticVersion.BuildMetaData.Branch,
-                sha: semanticVersion.BuildMetaData.Sha,
-                commitDate: semanticVersion.BuildMetaData.CommitDate.UtcDateTime.ToString("yyyy-MM-dd"));
+                semverFormatValues.Major,
+                semverFormatValues.Minor,
+                semverFormatValues.Patch,
+                semverFormatValues.BuildMetaData,
+                semverFormatValues.BuildMetaDataPadded,
+                semverFormatValues.FullBuildMetaData,
+                semverFormatValues.BranchName,
+                semverFormatValues.Sha,
+                semverFormatValues.MajorMinorPatch,
+                semverFormatValues.SemVer,
+                semverFormatValues.LegacySemVer,
+                semverFormatValues.LegacySemVerPadded,
+                semverFormatValues.FullSemVer,
+                semverFormatValues.AssemblySemVer,
+                semverFormatValues.PreReleaseTag,
+                semverFormatValues.PreReleaseTagWithDash,
+                informationalVersion,
+                semverFormatValues.CommitDate,
+                semverFormatValues.NuGetVersion,
+                semverFormatValues.NuGetVersionV2);
 
             return variables;
         }

src/GitVersionCore/OutputVariables/VersionVariables.cs

@@ -7,7 +7,7 @@
     public class VersionVariables : IEnumerable<KeyValuePair<string, string>>
     {
         public VersionVariables(string major, string minor, string patch, string buildMetaData, string buildMetaDataPadded, string fullBuildMetaData, string branchName, string sha, string majorMinorPatch, string semVer, string legacySemVer, string legacySemVerPadded, string fullSemVer, string assemblySemVer, string preReleaseTag, string preReleaseTagWithDash, string informationalVersion,
-            string commitDate)
+            string commitDate, string nugetVersion, string nugetVersionV2)
         {
             Major = major;
             Minor = minor;
@@ -27,6 +27,8 @@ public VersionVariables(string major, string minor, string patch, string buildMe
             PreReleaseTagWithDash = preReleaseTagWithDash;
             InformationalVersion = informationalVersion;
             CommitDate = commitDate;
+            NuGetVersion = nugetVersion;
+            NuGetVersionV2 = nugetVersionV2;
         }
 
         public string Major { get; private set; }
@@ -46,11 +48,8 @@ public VersionVariables(string major, string minor, string patch, string buildMe
         public string InformationalVersion { get; private set; }
         public string BranchName { get; private set; }
         public string Sha { get; private set; }
-
-        // Synonyms
-        // TODO When NuGet 3 is released: public string NuGetVersionV3 { get { return ??; } }
-        public string NuGetVersionV2 { get { return LegacySemVerPadded.ToLower(); } }
-        public string NuGetVersion { get { return NuGetVersionV2; } }
+        public string NuGetVersionV2 { get; private set; }
+        public string NuGetVersion { get; private set; }
 
         public static IEnumerable<string> AvailableVariables
         {