cleanup

nameof

Record innerexception

backwards comp

Added Support for UseFileVersion and OverwriteFileVersion

Author: asherber

AssemblyToProcess/AssemblyInfo.cs

@@ -3,4 +3,5 @@
 [assembly: AssemblyTitle("AssemblyToProcess")]
 [assembly: AssemblyProduct("AssemblyToProcess")]
 [assembly: AssemblyVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("4.5.6.7")]
 //[assembly: AssemblyInformationalVersionAttribute("1.0.0.0/aString")]

AssemblyToProcessExistingAttribute/AssemblyInfo.cs

@@ -3,4 +3,5 @@
 [assembly: AssemblyTitle("AssemblyToProcessExistingAttribute")]
 [assembly: AssemblyProduct("AssemblyToProcessExistingAttribute")]
 [assembly: AssemblyVersion("1.0.0")]
+[assembly: AssemblyFileVersion("4.5.6.7")]
 [assembly: AssemblyInformationalVersionAttribute("%version3%+%branch%.%githash% %haschanges% %utcnow% %now:yyMMdd%")]

Fody/Configuration.cs

@@ -3,8 +3,11 @@
 
 public class Configuration
 {
-    public bool UseProject;
-    public string ChangeString = "HasChanges";
+    public bool UseProject { get; set; }
+    public bool UseFileVersion { get; set; }
+    public bool OverwriteFileVersion { get; set; } = true;
+
+    public string ChangeString { get; set; } = "HasChanges";
 
     public Configuration(XElement config)
     {
@@ -14,22 +17,50 @@ public Configuration(XElement config)
         }
 
         var attr = config.Attribute("UseProjectGit");
-        if (attr != null)
+        if (HasValue(attr))
         {
-            try
-            {
-                UseProject = Convert.ToBoolean(attr.Value);
-            }
-            catch (Exception)
-            {
-                throw new WeavingException($"Unable to parse '{attr.Value}' as a boolean, please use true or false.");
-            }
+            UseProject = ConvertAndThrowIfNotBoolean(attr.Value);
+        }
+
+        attr = config.Attribute("UseFileVersion");
+        if (HasValue(attr))
+        {
+            UseFileVersion = ConvertAndThrowIfNotBoolean(attr.Value);
         }
 
         attr = config.Attribute("ChangeString");
-        if (!string.IsNullOrWhiteSpace(attr?.Value))
+        if (HasValue(attr))
         {
             ChangeString = attr.Value;
         }
+
+        if (UseFileVersion)
+            OverwriteFileVersion = false;
+        else
+        {
+            attr = config.Attribute("OverwriteFileVersion");
+            if (HasValue(attr))
+            {
+                OverwriteFileVersion = ConvertAndThrowIfNotBoolean(attr.Value);
+            }
+        }
+    }
+
+    private static bool HasValue(XAttribute attr)
+    {
+        return !string.IsNullOrWhiteSpace(attr?.Value);
+    }
+
+    private static bool ConvertAndThrowIfNotBoolean(string value)
+    {
+        try
+        {
+            var result = Convert.ToBoolean(value);
+            return result;
+        }
+        catch
+        {
+            throw new WeavingException($"Unable to parse '{value}' as a boolean; please use 'true' or 'false'.");
+        }
     }
 }

Fody/Internal/FormatStringTokenResolver.cs

@@ -1,11 +1,12 @@
 using System;
 using System.Text.RegularExpressions;
 using LibGit2Sharp;
-using Mono.Cecil;
 
 namespace Stamp.Fody.Internal
 {
-    internal class FormatStringTokenResolver
+    using Version = System.Version;
+
+    internal static class FormatStringTokenResolver
     {
         private static Regex reEnvironmentToken = new Regex(@"%env\[([^\]]+)]%");
         private static Regex reNow = new Regex(@"%now:([^%]+)%");
@@ -14,16 +15,15 @@ internal class FormatStringTokenResolver
         private static DateTime now = DateTime.Now;
         private static DateTime utcNow = DateTime.UtcNow;
 
-        public string ReplaceTokens(string template, ModuleDefinition moduleDefinition, Repository repo, string changestring)
+        public static string ReplaceTokens(string template, Version version, Repository repo, string changestring)
         {
-            var assemblyVersion = moduleDefinition.Assembly.Name.Version;
             var branch = repo.Head;
 
-            template = template.Replace("%version%", assemblyVersion.ToString());
-            template = template.Replace("%version1%", assemblyVersion.ToString(1));
-            template = template.Replace("%version2%", assemblyVersion.ToString(2));
-            template = template.Replace("%version3%", assemblyVersion.ToString(3));
-            template = template.Replace("%version4%", assemblyVersion.ToString(4));
+            template = template.Replace("%version%", version.ToString());
+            template = template.Replace("%version1%", version.ToString(1));
+            template = template.Replace("%version2%", version.ToString(2));
+            template = template.Replace("%version3%", version.ToString(3));
+            template = template.Replace("%version4%", version.ToString(4));
 
             template = template.Replace("%now%", now.ToShortDateString());
             template = template.Replace("%utcnow%", utcNow.ToShortDateString());

Fody/ModuleWeaver.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.IO;
 using System.Linq;
 
@@ -15,16 +16,18 @@
 public class ModuleWeaver : BaseModuleWeaver
 {
     private static bool isPathSet;
-    private readonly FormatStringTokenResolver formatStringTokenResolver;
     private string assemblyInfoVersion;
-    private Version assemblyVersion;
+    private Version versionToUse;
     private bool dotGitDirExists;
 
+    
+    private const string InfoAttributeName = nameof(System.Reflection.AssemblyInformationalVersionAttribute);
+    private const string FileAttributeName = nameof(System.Reflection.AssemblyFileVersionAttribute);
+
     public ModuleWeaver()
     {
         LogInfo = s => { };
         LogWarning = s => { };
-        formatStringTokenResolver = new FormatStringTokenResolver();
     }
 
     public override void Execute()
@@ -57,13 +60,16 @@ public override void Execute()
                 return;
             }
 
-            assemblyVersion = ModuleDefinition.Assembly.Name.Version;
+            if (!config.UseFileVersion)
+                versionToUse = ModuleDefinition.Assembly.Name.Version;
+            else
+                versionToUse = GetAssemblyFileVersion(customAttributes);
 
-            var customAttribute = customAttributes.FirstOrDefault(x => x.AttributeType.Name == "AssemblyInformationalVersionAttribute");
+            var customAttribute = GetCustomAttribute(customAttributes, InfoAttributeName);
             if (customAttribute != null)
             {
                 assemblyInfoVersion = (string)customAttribute.ConstructorArguments[0].Value;
-                assemblyInfoVersion = formatStringTokenResolver.ReplaceTokens(assemblyInfoVersion, ModuleDefinition, repo, config.ChangeString);
+                assemblyInfoVersion = FormatStringTokenResolver.ReplaceTokens(assemblyInfoVersion, versionToUse, repo, config.ChangeString);
                 VerifyStartsWithVersion(assemblyInfoVersion);
                 customAttribute.ConstructorArguments[0] = new CustomAttributeArgument(ModuleDefinition.TypeSystem.String, assemblyInfoVersion);
             }
@@ -73,14 +79,32 @@ public override void Execute()
                 var constructor = ModuleDefinition.ImportReference(versionAttribute.Methods.First(x => x.IsConstructor));
                 customAttribute = new CustomAttribute(constructor);
 
-                assemblyInfoVersion = $"{assemblyVersion} Head:'{repo.Head.FriendlyName}' Sha:{branch.Tip.Sha}{(repo.IsClean() ? "" : " " + config.ChangeString)}";
+                assemblyInfoVersion = $"{versionToUse} Head:'{repo.Head.FriendlyName}' Sha:{branch.Tip.Sha}{(repo.IsClean() ? "" : " " + config.ChangeString)}";
 
                 customAttribute.ConstructorArguments.Add(new CustomAttributeArgument(ModuleDefinition.TypeSystem.String, assemblyInfoVersion));
                 customAttributes.Add(customAttribute);
             }
         }
     }
 
+    private static CustomAttribute GetCustomAttribute(ICollection<CustomAttribute> attributes, string attributeName)
+    {
+        return attributes.FirstOrDefault(x => x.AttributeType.Name == attributeName);
+    }
+
+    private Version GetAssemblyFileVersion(ICollection<CustomAttribute> customAttributes)
+    {
+        var afvAttribute = GetCustomAttribute(customAttributes, FileAttributeName);
+        if (afvAttribute == null)
+        {
+            throw new WeavingException("AssemblyFileVersion attribute could not be found.");
+        }
+
+        var assemblyFileVersionString = (string) afvAttribute.ConstructorArguments[0].Value;
+        VerifyStartsWithVersion(assemblyFileVersionString);
+        return Version.Parse(assemblyFileVersionString);
+    }
+
     private void VerifyStartsWithVersion(string versionString)
     {
         var prefix = new string(versionString.TakeWhile(x => char.IsDigit(x) || x == '.').ToArray());
@@ -166,15 +190,15 @@ public override void AfterWeaving()
                 var versions = reader.Read();
 
                 var fixedFileInfo = versions.FixedFileInfo.Value;
-                fixedFileInfo.FileVersion = assemblyVersion;
-                fixedFileInfo.ProductVersion = assemblyVersion;
+                fixedFileInfo.FileVersion = versionToUse;
+                fixedFileInfo.ProductVersion = versionToUse;
                 versions.FixedFileInfo = fixedFileInfo;
 
                 foreach (var stringTable in versions.StringFileInfo)
                 {
                     if (stringTable.Values.ContainsKey("FileVersion"))
                     {
-                        stringTable.Values["FileVersion"] = assemblyVersion.ToString();
+                        stringTable.Values["FileVersion"] = versionToUse.ToString();
                     }
 
                     if (stringTable.Values.ContainsKey("ProductVersion"))

Fody/WeavingException.cs

@@ -7,4 +7,9 @@ public WeavingException(string message)
     {
 
     }
+
+    /// <inheritdoc />
+    public WeavingException(string message, Exception innerException) : base(message, innerException)
+    {
+    }
 }

README.md

@@ -34,7 +34,7 @@ Extracts the git information from disk, combines it with the assembly version, a
 So if your assembly version is `1.0.0.0`, the working branch is `master` and the last commit is `759e9ddb53271dfa9335a3b27e452749a9b22280` then the following attribute will be added to the assembly.
 
 ```c#
-[assembly: AssemblyInformationalVersion("1.0.0.0 Head:'master' Sha:759e9ddb53271dfa9335a3b27e452749a9b22280")]
+    [assembly: AssemblyInformationalVersion("1.0.0.0 Head:'master' Sha:759e9ddb53271dfa9335a3b27e452749a9b22280")]
 ```
 
 
@@ -52,6 +52,8 @@ The tokens are:
 - `%version4%` is replaced with the major, minor, revision, and build version (`1.0.0.0`)
 - `%now%` is replaced with the current short date
 - `%utcnow%` is replaced with the current utc short date
+- `%now%` is replaced with the current short date
+- `%utcnow%` is replaced with the current utc short date
 - `%githash%` is replaced with the SHA1 hash of the branch tip of the repository
 - `%shorthash%` is replaced with the first eight characters of `%githash%`
 - `%branch%` is replaced with the branch name of the repository
@@ -78,7 +80,6 @@ Define the string used to indicate that the code was built from a non clean repo
 <Stamp ChangeString="New text" />
 ```
 
-
 ### UseProjectGit
 
 Define if you want to start Stamp to start searching for the Git repository in the ProjectDir (`true`) or the SolutionDir (`false`).
@@ -89,6 +90,28 @@ Define if you want to start Stamp to start searching for the Git repository in t
 <Stamp UseProjectGit='true' />
 ```
 
+### OverwriteFileVersion
+
+(new in 2.0)
+
+By default, Stamp will overwrite the `AssemblyFileVersion` with the `AssemblyVersion`. Setting this to `false` will preserve the existing `AssemblyFileVersion`.
+
+*Default is `true`*
+
+```xml
+<Stamp OverwriteFileVersion='false' />
+```
+
+### UseFileVersion
+
+(new in 2.0)
+
+By default, Stamp uses the value from `AssemblyVersion` to construct the `AssemblyInformationalVersion`. Set this to `true` to use the `AssemblyFileVersion` instead. **Note:** If this is set to `true`, `OverwriteFileVersion` will be `false` and will ignore any value explicitly set.
+
+*Default is `false`*
+```xml
+<Stamp UseFileVersion='true' />
+```
 
 ## Icon
 

Tests/TaskTests.cs

@@ -4,6 +4,8 @@
 using System.Reflection;
 using Mono.Cecil;
 using NUnit.Framework;
+using System.Xml.Linq;
+using System;
 
 [TestFixture]
 public class TaskTests
@@ -12,19 +14,25 @@ public class TaskTests
     // ReSharper disable once PrivateFieldCanBeConvertedToLocalVariable
     private string beforeAssemblyPath;
     private string afterAssemblyPath;
+    protected XElement config;
 
-    public TaskTests()
+    [OneTimeSetUp]
+    public void Setup()
     {
         beforeAssemblyPath = Path.GetFullPath(Path.Combine(TestContext.CurrentContext.TestDirectory, @"..\..\..\AssemblyToProcess\bin\Debug\AssemblyToProcess.dll"));
 #if (!DEBUG)
         beforeAssemblyPath = beforeAssemblyPath.Replace("Debug", "Release");
 #endif
 
-        afterAssemblyPath = beforeAssemblyPath.Replace(".dll", "2.dll");
+        afterAssemblyPath = beforeAssemblyPath.Replace(".dll", $"{Guid.NewGuid().ToString()}.dll");
         File.Copy(beforeAssemblyPath, afterAssemblyPath, true);
 
         using (var moduleDefinition = ModuleDefinition.ReadModule(beforeAssemblyPath))
         {
+
+            var versionInfo = FileVersionInfo.GetVersionInfo(afterAssemblyPath);
+            Trace.WriteLine($"Before: AssemblyVersion={moduleDefinition.Assembly.Name.Version}, FileVersion={versionInfo.FileVersion}, Config={config}");
+
             var currentDirectory = AssemblyLocation.CurrentDirectory();
 
             var weavingTask = new ModuleWeaver
@@ -33,6 +41,7 @@ public TaskTests()
                 AddinDirectoryPath = currentDirectory,
                 SolutionDirectoryPath = currentDirectory,
                 AssemblyFilePath = afterAssemblyPath,
+                Config = config
             };
 
             weavingTask.Execute();
@@ -44,16 +53,15 @@ public TaskTests()
         assembly = Assembly.LoadFile(afterAssemblyPath);
     }
 
-
     [Test]
     public void EnsureAttributeExists()
     {
         var customAttributes = (AssemblyInformationalVersionAttribute)assembly
-            .GetCustomAttributes(typeof (AssemblyInformationalVersionAttribute), false)
+            .GetCustomAttributes(typeof(AssemblyInformationalVersionAttribute), false)
             .First();
         Assert.IsNotNull(customAttributes.InformationalVersion);
         Assert.IsNotEmpty(customAttributes.InformationalVersion);
-        Trace.WriteLine(customAttributes.InformationalVersion);
+        Trace.WriteLine($"InfoVersion: {customAttributes.InformationalVersion}");
     }
 
     [Test]
@@ -64,8 +72,8 @@ public void Win32Resource()
         Assert.IsNotEmpty(versionInfo.ProductVersion);
         Assert.IsNotNull(versionInfo.FileVersion);
         Assert.IsNotEmpty(versionInfo.FileVersion);
-        Trace.WriteLine(versionInfo.ProductVersion);
-        Trace.WriteLine(versionInfo.FileVersion);
+        Trace.WriteLine($"ProductVersion: {versionInfo.ProductVersion}");
+        Trace.WriteLine($"FileVersion: {versionInfo.FileVersion}");
     }
 
 
@@ -77,4 +85,22 @@ public void PeVerify()
     }
 #endif
 
+}
+
+[TestFixture]
+class UseFileVersionTests : TaskTests
+{
+    public UseFileVersionTests()
+    {
+        config = XElement.Parse("<Stamp UseFileVersion=\"true\" />");
+    }
+}
+
+[TestFixture]
+class OverwriteFileVersionTests : TaskTests
+{
+    public OverwriteFileVersionTests()
+    {
+        config = XElement.Parse("<Stamp OverwriteFileVersion=\"false\" />");
+    }
 }