Merge pull request #329 from qmfrederik/fixes/timestamp

AArnott · web-flow · commit 99df816b26c6 · 2019-05-27T14:36:42.000-06:00
Add a GitCommitDate property to ThisAssembly
diff --git a/src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs b/src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs
@@ -740,6 +740,18 @@ public async Task AssemblyInfo(bool isVB, bool includeNonVersionAttributes, bool
         Assert.Equal(result.AssemblyCopyright, thisAssemblyClass.GetField("AssemblyCopyright", fieldFlags)?.GetValue(null));
         Assert.Equal(result.GitCommitId, thisAssemblyClass.GetField("GitCommitId", fieldFlags)?.GetValue(null) ?? string.Empty);
 
+        if (gitRepo)
+        {
+            Assert.True(long.TryParse(result.GitCommitDateTicks, out _), $"Invalid value for GitCommitDateTicks: '{result.GitCommitDateTicks}'");
+            DateTimeOffset gitCommitDate = new DateTimeOffset(long.Parse(result.GitCommitDateTicks), TimeSpan.Zero);
+            Assert.Equal(gitCommitDate, thisAssemblyClass.GetProperty("GitCommitDate", fieldFlags)?.GetValue(null) ?? thisAssemblyClass.GetField("GitCommitDate", fieldFlags)?.GetValue(null) ?? string.Empty);
+        }
+        else
+        {
+            Assert.Empty(result.GitCommitDateTicks);
+            Assert.Null(thisAssemblyClass.GetProperty("GitCommitDate", fieldFlags));
+        }
+
         // Verify that it doesn't have key fields
         Assert.Null(thisAssemblyClass.GetField("PublicKey", fieldFlags));
         Assert.Null(thisAssemblyClass.GetField("PublicKeyToken", fieldFlags));
@@ -936,6 +948,7 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
         Assert.Equal(idAsVersion.Build.ToString(), buildResult.BuildVersionNumberComponent);
         Assert.Equal($"{idAsVersion.Major}.{idAsVersion.Minor}.{idAsVersion.Build}", buildResult.BuildVersionSimple);
         Assert.Equal(this.Repo.Head.Commits.First().Id.Sha, buildResult.GitCommitId);
+        Assert.Equal(this.Repo.Head.Commits.First().Author.When.UtcTicks.ToString(CultureInfo.InvariantCulture), buildResult.GitCommitDateTicks);
         Assert.Equal(commitIdShort, buildResult.GitCommitIdShort);
         Assert.Equal(versionHeight.ToString(), buildResult.GitVersionHeight);
         Assert.Equal($"{version.Major}.{version.Minor}", buildResult.MajorMinorVersion);
@@ -1138,6 +1151,7 @@ internal BuildResults(BuildResult buildResult, IReadOnlyList<BuildEventArgs> log
         public string MajorMinorVersion => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("MajorMinorVersion");
         public string BuildVersionNumberComponent => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("BuildVersionNumberComponent");
         public string GitCommitIdShort => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("GitCommitIdShort");
+        public string GitCommitDateTicks => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("GitCommitDateTicks");
         public string GitVersionHeight => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("GitVersionHeight");
         public string SemVerBuildSuffix => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("SemVerBuildSuffix");
         public string BuildVersion3Components => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("BuildVersion3Components");
diff --git a/src/NerdBank.GitVersioning/VersionOracle.cs b/src/NerdBank.GitVersioning/VersionOracle.cs
@@ -83,6 +83,7 @@ public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, LibG
             this.VersionOptions = committedVersion ?? workingVersion;
 
             this.GitCommitId = commit?.Id.Sha ?? cloudBuild?.GitCommitId ?? null;
+            this.GitCommitDate = commit?.Author.When;
             this.VersionHeight = CalculateVersionHeight(relativeRepoProjectDirectory, commit, committedVersion, workingVersion);
             this.BuildingRef = cloudBuild?.BuildingTag ?? cloudBuild?.BuildingBranch ?? repo?.Head.CanonicalName;
 
@@ -256,6 +257,11 @@ public IEnumerable<string> BuildMetadataWithCommitId
         /// </summary>
         public string GitCommitIdShort { get; }
 
+        /// <summary>
+        /// Gets the Git revision control commit date for HEAD (the current source code version).
+        /// </summary>
+        public DateTimeOffset? GitCommitDate { get; }
+
         /// <summary>
         /// Gets the number of commits in the longest single path between
         /// the specified commit and the most distant ancestor (inclusive)
diff --git a/src/Nerdbank.GitVersioning.Tasks/AssemblyVersionInfo.cs b/src/Nerdbank.GitVersioning.Tasks/AssemblyVersionInfo.cs
@@ -71,6 +71,8 @@ the code is regenerated.
 
         public string GitCommitId { get; set; }
 
+        public string GitCommitDateTicks { get; set; }
+
 #if NET461
         public override bool Execute()
         {
@@ -123,7 +125,7 @@ private CodeTypeDeclaration CreateThisAssemblyClass()
                 IsPartial = true,
                 TypeAttributes = TypeAttributes.NotPublic | TypeAttributes.Sealed,
             };
-            
+
             var codeAttributeDeclarationCollection = new CodeAttributeDeclarationCollection();
             codeAttributeDeclarationCollection.Add(new CodeAttributeDeclaration("System.CodeDom.Compiler.GeneratedCode",
                 new CodeAttributeArgument(new CodePrimitiveExpression(GeneratorName)),
@@ -151,6 +153,12 @@ private CodeTypeDeclaration CreateThisAssemblyClass()
                     { "AssemblyConfiguration", this.AssemblyConfiguration },
                     { "GitCommitId", this.GitCommitId },
                 }).ToArray());
+
+            if (long.TryParse(this.GitCommitDateTicks, out long gitCommitDateTicks))
+            {
+                thisAssembly.Members.AddRange(CreateCommitDateProperty(gitCommitDateTicks).ToArray());
+            }
+
             if (hasKeyInfo)
             {
                 thisAssembly.Members.AddRange(CreateFields(new Dictionary<string, string>
@@ -215,6 +223,38 @@ private static CodeMemberField CreateField(string name, string value)
             };
         }
 
+        private static IEnumerable<CodeTypeMember> CreateCommitDateProperty(long ticks)
+        {
+            // internal static System.DateTimeOffset GitCommitDate {{ get; }} = new System.DateTimeOffset({ticks}, System.TimeSpan.Zero);");
+            yield return new CodeMemberField(typeof(DateTimeOffset), "gitCommitDate")
+            {
+                Attributes = MemberAttributes.Private,
+                InitExpression = new CodeObjectCreateExpression(
+                     typeof(DateTimeOffset),
+                     new CodePrimitiveExpression(ticks),
+                     new CodePropertyReferenceExpression(
+                         new CodeTypeReferenceExpression(typeof(TimeSpan)),
+                         nameof(TimeSpan.Zero)))
+            };
+
+            var property = new CodeMemberProperty()
+            {
+                Attributes = MemberAttributes.Assembly,
+                Type = new CodeTypeReference(typeof(DateTimeOffset)),
+                Name = "GitCommitDate",
+                HasGet = true,
+                HasSet = false,
+            };
+
+            property.GetStatements.Add(
+                new CodeMethodReturnStatement(
+                    new CodeFieldReferenceExpression(
+                        null,
+                        "gitCommitDate")));
+
+            yield return property;
+        }
+
         private static CodeAttributeDeclaration DeclareAttribute(Type attributeType, params CodeAttributeArgument[] arguments)
         {
             var assemblyTypeReference = new CodeTypeReference(attributeType);
@@ -325,6 +365,11 @@ private void GenerateThisAssemblyClass()
                 }
             }
 
+            if (long.TryParse(this.GitCommitDateTicks, out long gitCommitDateTicks))
+            {
+                this.generator.AddCommitDateProperty(gitCommitDateTicks);
+            }
+
             // These properties should be defined even if they are empty.
             this.generator.AddThisAssemblyMember("RootNamespace", this.RootNamespace);
 
@@ -380,6 +425,8 @@ internal void AddBlankLine()
                 this.codeBuilder.AppendLine();
             }
 
+            internal abstract void AddCommitDateProperty(long ticks);
+
             protected void AddCodeComment(string comment, string token)
             {
                 var sr = new StringReader(comment);
@@ -414,6 +461,11 @@ internal override void DeclareAttribute(Type type, string arg)
                 this.codeBuilder.AppendLine($"[<assembly: {type.FullName}(\"{arg}\")>]");
             }
 
+            internal override void AddCommitDateProperty(long ticks)
+            {
+                this.codeBuilder.AppendLine($"    static member internal GitCommitDate = new DateTimeOffset({ticks}, TimeZpan.Zero)");
+            }
+
             internal override void EndThisAssemblyClass()
             {
                 this.codeBuilder.AppendLine("do()");
@@ -450,6 +502,11 @@ internal override void AddThisAssemblyMember(string name, string value)
                 this.codeBuilder.AppendLine($"    internal const string {name} = \"{value}\";");
             }
 
+            internal override void AddCommitDateProperty(long ticks)
+            {
+                this.codeBuilder.AppendLine($"    internal static readonly System.DateTimeOffset GitCommitDate = new System.DateTimeOffset({ticks}, System.TimeSpan.Zero);");
+            }
+
             internal override void EndThisAssemblyClass()
             {
                 this.codeBuilder.AppendLine("}");
@@ -479,6 +536,11 @@ internal override void AddThisAssemblyMember(string name, string value)
                 this.codeBuilder.AppendLine($"    Friend Const {name} As String = \"{value}\"");
             }
 
+            internal override void AddCommitDateProperty(long ticks)
+            {
+                this.codeBuilder.AppendLine($"    Friend Shared ReadOnly GitCommitDate As System.DateTimeOffset = New System.DateTimeOffset({ticks}, System.TimeSpan.Zero)");
+            }
+
             internal override void EndThisAssemblyClass()
             {
                 this.codeBuilder.AppendLine("End Class");
diff --git a/src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs b/src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs
@@ -132,9 +132,19 @@ public GetBuildVersion()
         [Output]
         public string GitCommitId { get; private set; }
 
+        /// <summary>
+        /// Gets the first several characters of the Git revision control commit id for HEAD (the current source code version).
+        /// </summary>
         [Output]
         public string GitCommitIdShort { get; private set; }
 
+        /// <summary>
+        /// Gets the Git revision control commit date for HEAD (the current source code version), expressed as the number of 100-nanosecond
+        /// intervals that have elapsed since January 1, 0001 at 00:00:00.000 in the Gregorian calendar.
+        /// </summary>
+        [Output]
+        public string GitCommitDateTicks { get; private set; }
+
         /// <summary>
         /// Gets the number of commits in the longest single path between
         /// the specified commit and the most distant ancestor (inclusive)
@@ -213,6 +223,7 @@ protected override bool ExecuteInner()
                 this.PrereleaseVersion = oracle.PrereleaseVersion;
                 this.GitCommitId = oracle.GitCommitId;
                 this.GitCommitIdShort = oracle.GitCommitIdShort;
+                this.GitCommitDateTicks = oracle.GitCommitDate != null ? oracle.GitCommitDate.Value.Ticks.ToString(CultureInfo.InvariantCulture) : null;
                 this.GitVersionHeight = oracle.VersionHeight;
                 this.BuildMetadataFragment = oracle.BuildMetadataFragment;
                 this.CloudBuildNumber = oracle.CloudBuildNumberEnabled ? oracle.CloudBuildNumber : null;
diff --git a/src/Nerdbank.GitVersioning.Tasks/build/Nerdbank.GitVersioning.targets b/src/Nerdbank.GitVersioning.Tasks/build/Nerdbank.GitVersioning.targets
@@ -79,6 +79,7 @@
       <Output TaskParameter="AssemblyVersion" PropertyName="AssemblyVersion" />
       <Output TaskParameter="GitCommitId" PropertyName="GitCommitId" />
       <Output TaskParameter="GitCommitIdShort" PropertyName="GitCommitIdShort" />
+      <Output TaskParameter="GitCommitDateTicks" PropertyName="GitCommitDateTicks" />
       <Output TaskParameter="GitVersionHeight" PropertyName="GitVersionHeight" />
       <Output TaskParameter="BuildNumber" PropertyName="BuildNumber" />
       <Output TaskParameter="BuildNumber" PropertyName="BuildVersionNumberComponent" />
@@ -154,6 +155,7 @@
                   AssemblyCompany="$(AssemblyCompany)"
                   AssemblyConfiguration="$(Configuration)"
                   GitCommitId="$(GitCommitId)"
+                  GitCommitDateTicks="$(GitCommitDateTicks)"
                   EmitNonVersionCustomAttributes="$(NBGV_EmitNonVersionCustomAttributes)"
                   />
     <!-- Avoid applying the newly generated AssemblyVersionInfo.cs file to the build
