#497: Added coverage date to summary reports (for Cobertura and JaCoC…

…o coverage files)
danielpalme · Mar 10, 2022 · 4bc9f98 · 4bc9f98
1 parent f99a1f2
commit 4bc9f98
Show file tree

Hide file tree

Showing 11 changed files with 178 additions and 0 deletions.
diff --git a/src/Readme.txt b/src/Readme.txt
@@ -72,6 +72,8 @@ CHANGELOG
     * New: #433: Added report types Html_Light, Html_Dark and HtmlInline_AzurePipelines_Light
     * New: HTML reports: Replaced tabular data with cards
     * New: Added method coverage to summary table (PRO version only)
+    * New: #497: Added coverage date to summary reports (for Cobertura and JaCoCo coverage files)
+    * New: #494: Fixed MSBuild task
 
 5.0.4.0
 

diff --git a/src/ReportGenerator.Core/Parser/Analysis/SummaryResult.cs b/src/ReportGenerator.Core/Parser/Analysis/SummaryResult.cs
@@ -16,6 +16,8 @@ public class SummaryResult
         public SummaryResult(ParserResult parserResult)
             : this(parserResult.Assemblies, parserResult.ParserName, parserResult.SupportsBranchCoverage, parserResult.SourceDirectories)
         {
+            this.MinimumTimeStamp = parserResult.MinimumTimeStamp;
+            this.MaximumTimeStamp = parserResult.MaximumTimeStamp;
         }
 
         /// <summary>
@@ -65,6 +67,16 @@ public SummaryResult(IReadOnlyCollection<Assembly> assemblies, string usedParser
         /// </value>
         public IReadOnlyCollection<string> SourceDirectories { get; }
 
+        /// <summary>
+        /// Gets the timestamp on which the coverage report was generated.
+        /// </summary>
+        public DateTime? MinimumTimeStamp { get; }
+
+        /// <summary>
+        /// Gets the timestamp on which the coverage report was generated.
+        /// </summary>
+        public DateTime? MaximumTimeStamp { get; }
+
         /// <summary>
         /// Gets the number of covered lines.
         /// </summary>
@@ -171,5 +183,31 @@ public SummaryResult(IReadOnlyCollection<Assembly> assemblies, string usedParser
                 .GroupBy(m => m.Name)
                 .Select(g => new Metric(g.Key, g.First().ExplanationUrl, MetricType.CoverageAbsolute, g.Sum(m => m.Value)))
                 .ToList();
+
+        /// <summary>
+        /// Get the coverage date(s) based on the minimum and maximum timestamp.
+        /// </summary>
+        /// <returns> The coverage date(s).</returns>
+        public string CoverageDate()
+        {
+            string value = null;
+
+            if (this.MinimumTimeStamp.HasValue)
+            {
+                value = $"{this.MinimumTimeStamp.Value.ToShortDateString()} - {this.MinimumTimeStamp.Value.ToLongTimeString()}";
+
+                if (this.MaximumTimeStamp.HasValue
+                    && !this.MinimumTimeStamp.Value.Equals(this.MaximumTimeStamp.Value))
+                {
+                    value += $" - {this.MaximumTimeStamp.Value.ToShortDateString()} - {this.MaximumTimeStamp.Value.ToLongTimeString()}";
+                }
+            }
+            else if (this.MaximumTimeStamp.HasValue)
+            {
+                value = $"{this.MaximumTimeStamp.Value.ToShortDateString()} - {this.MaximumTimeStamp.Value.ToLongTimeString()}";
+            }
+
+            return value;
+        }
     }
 }
diff --git a/src/ReportGenerator.Core/Parser/CoberturaParser.cs b/src/ReportGenerator.Core/Parser/CoberturaParser.cs
@@ -85,6 +85,22 @@ public ParserResult Parse(XContainer report)
                 result.AddSourceDirectory(sourceElement.Value);
             }
 
+            if (report.Element("sources").Parent.Attribute("timestamp") != null)
+            {
+                try
+                {
+                    DateTime timeStamp = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
+                    timeStamp = timeStamp.AddSeconds(double.Parse(report.Element("sources").Parent.Attribute("timestamp").Value)).ToLocalTime();
+
+                    result.MinimumTimeStamp = timeStamp;
+                    result.MaximumTimeStamp = timeStamp;
+                }
+                catch (Exception)
+                {
+                    // Ignore since timestamp is not relevant. If timestamp is missing or in wrong format the information is just missing in the report(s)
+                }
+            }
+
             return result;
         }
 

diff --git a/src/ReportGenerator.Core/Parser/JaCoCoParser.cs b/src/ReportGenerator.Core/Parser/JaCoCoParser.cs
@@ -68,6 +68,23 @@ public ParserResult Parse(XContainer report)
             }
 
             var result = new ParserResult(assemblies.OrderBy(a => a.Name).ToList(), true, this.ToString());
+
+            if (report.Element("sessioninfo")?.Attribute("start") != null)
+            {
+                try
+                {
+                    DateTime timeStamp = new DateTime(1970, 1, 1, 0, 0, 0, 0, DateTimeKind.Utc);
+                    timeStamp = timeStamp.AddMilliseconds(double.Parse(report.Element("sessioninfo").Attribute("start").Value)).ToLocalTime();
+
+                    result.MinimumTimeStamp = timeStamp;
+                    result.MaximumTimeStamp = timeStamp;
+                }
+                catch (Exception)
+                {
+                    // Ignore since timestamp is not relevant. If timestamp is missing or in wrong format the information is just missing in the report(s)
+                }
+            }
+
             return result;
         }
 

diff --git a/src/ReportGenerator.Core/Parser/ParserResult.cs b/src/ReportGenerator.Core/Parser/ParserResult.cs
@@ -78,6 +78,16 @@ public ParserResult(List<Assembly> assemblies, bool supportsBranchCoverage, stri
         /// </value>
         public bool SupportsBranchCoverage { get; private set; }
 
+        /// <summary>
+        /// Gets the timestamp on which the coverage report was generated.
+        /// </summary>
+        public DateTime? MinimumTimeStamp { get; internal set; }
+
+        /// <summary>
+        /// Gets the timestamp on which the coverage report was generated.
+        /// </summary>
+        public DateTime? MaximumTimeStamp { get; internal set; }
+
         /// <summary>
         /// Gets the names of the parsers.
         /// </summary>
@@ -147,6 +157,66 @@ internal void Merge(ParserResult parserResult)
 
             this.SupportsBranchCoverage |= parserResult.SupportsBranchCoverage;
             this.parserNames.AddRange(parserResult.parserNames);
+
+            if (this.MinimumTimeStamp.HasValue)
+            {
+                if (parserResult.MinimumTimeStamp.HasValue)
+                {
+                    this.MinimumTimeStamp = Min(this.MinimumTimeStamp.Value, parserResult.MinimumTimeStamp.Value);
+                }
+            }
+            else
+            {
+                this.MinimumTimeStamp = parserResult.MinimumTimeStamp;
+            }
+
+            if (this.MaximumTimeStamp.HasValue)
+            {
+                if (parserResult.MaximumTimeStamp.HasValue)
+                {
+                    this.MaximumTimeStamp = Max(this.MaximumTimeStamp.Value, parserResult.MaximumTimeStamp.Value);
+                }
+            }
+            else
+            {
+                this.MaximumTimeStamp = parserResult.MaximumTimeStamp;
+            }
+        }
+
+        /// <summary>
+        /// Returns the minimum date.
+        /// </summary>
+        /// <param name="first">The first date.</param>
+        /// <param name="second">The second date.</param>
+        /// <returns>The minimum of the two dates.</returns>
+        private static DateTime Min(DateTime first, DateTime second)
+        {
+            if (first < second)
+            {
+                return first;
+            }
+            else
+            {
+                return second;
+            }
+        }
+
+        /// <summary>
+        /// Returns the maximum date.
+        /// </summary>
+        /// <param name="first">The first date.</param>
+        /// <param name="second">The second date.</param>
+        /// <returns>The maximum of the two dates.</returns>
+        private static DateTime Max(DateTime first, DateTime second)
+        {
+            if (first > second)
+            {
+                return first;
+            }
+            else
+            {
+                return second;
+            }
         }
     }
 }
diff --git a/src/ReportGenerator.Core/Properties/ReportResources.Designer.cs b/src/ReportGenerator.Core/Properties/ReportResources.Designer.cs
diff --git a/src/ReportGenerator.Core/Properties/ReportResources.resx b/src/ReportGenerator.Core/Properties/ReportResources.resx
@@ -381,4 +381,7 @@
   <data name="MethodCoverageProVersion" xml:space="preserve">
     <value>Method coverage is only available for sponsors.</value>
   </data>
+  <data name="CoverageDate" xml:space="preserve">
+    <value>Coverage date:</value>
+  </data>
 </root>
diff --git a/src/ReportGenerator.Core/Reporting/Builders/HtmlReportBuilderBase.cs b/src/ReportGenerator.Core/Reporting/Builders/HtmlReportBuilderBase.cs
@@ -251,6 +251,11 @@ public virtual void CreateSummaryReport(IHtmlRenderer reportRenderer, SummaryRes
                 infoCardItems.Add(new CardLineItem(ReportResources.Tag, this.ReportContext.ReportConfiguration.Tag, null, CardLineItemAlignment.Left));
             }
 
+            if (summaryResult.MinimumTimeStamp.HasValue || summaryResult.MaximumTimeStamp.HasValue)
+            {
+                infoCardItems.Add(new CardLineItem(ReportResources.CoverageDate, summaryResult.CoverageDate(), null, CardLineItemAlignment.Left));
+            }
+
             var cards = new List<Card>()
             {
                 new Card(

diff --git a/src/ReportGenerator.Core/Reporting/Builders/LatexReportBuilderBase.cs b/src/ReportGenerator.Core/Reporting/Builders/LatexReportBuilderBase.cs
@@ -187,6 +187,12 @@ public virtual void CreateSummaryReport(ILatexRenderer reportRenderer, SummaryRe
 
             reportRenderer.BeginKeyValueTable();
             reportRenderer.KeyValueRow(ReportResources.GeneratedOn, DateTime.Now.ToShortDateString() + " - " + DateTime.Now.ToLongTimeString());
+
+            if (summaryResult.MinimumTimeStamp.HasValue || summaryResult.MaximumTimeStamp.HasValue)
+            {
+                reportRenderer.KeyValueRow(ReportResources.CoverageDate, summaryResult.CoverageDate());
+            }
+
             reportRenderer.KeyValueRow(ReportResources.Parser, summaryResult.UsedParser);
             reportRenderer.KeyValueRow(ReportResources.Assemblies2, summaryResult.Assemblies.Count().ToString(CultureInfo.InvariantCulture));
             reportRenderer.KeyValueRow(ReportResources.Classes, summaryResult.Assemblies.SelectMany(a => a.Classes).Count().ToString(CultureInfo.InvariantCulture));

diff --git a/src/ReportGenerator.Core/Reporting/Builders/MarkdownSummaryReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/MarkdownSummaryReportBuilder.cs
@@ -87,6 +87,12 @@ public void CreateSummaryReport(SummaryResult summaryResult)
                 reportTextWriter.WriteLine("|||");
                 reportTextWriter.WriteLine("|:---|:---|");
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.GeneratedOn, DateTime.Now.ToShortDateString() + " - " + DateTime.Now.ToLongTimeString());
+
+                if (summaryResult.MinimumTimeStamp.HasValue || summaryResult.MaximumTimeStamp.HasValue)
+                {
+                    reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.CoverageDate, summaryResult.CoverageDate());
+                }
+
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.Parser, summaryResult.UsedParser);
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.Assemblies2, summaryResult.Assemblies.Count().ToString(CultureInfo.InvariantCulture));
                 reportTextWriter.WriteLine("| {0} | {1} |", ReportResources.Classes, summaryResult.Assemblies.SelectMany(a => a.Classes).Count().ToString(CultureInfo.InvariantCulture));

diff --git a/src/ReportGenerator.Core/Reporting/Builders/TextSummaryReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/TextSummaryReportBuilder.cs
@@ -85,6 +85,12 @@ public void CreateSummaryReport(SummaryResult summaryResult)
             {
                 reportTextWriter.WriteLine(ReportResources.Summary);
                 reportTextWriter.WriteLine("  {0} {1}", ReportResources.GeneratedOn, DateTime.Now.ToShortDateString() + " - " + DateTime.Now.ToLongTimeString());
+
+                if (summaryResult.MinimumTimeStamp.HasValue || summaryResult.MaximumTimeStamp.HasValue)
+                {
+                    reportTextWriter.WriteLine("  {0} {1}", ReportResources.CoverageDate, summaryResult.CoverageDate());
+                }
+
                 reportTextWriter.WriteLine("  {0} {1}", ReportResources.Parser, summaryResult.UsedParser);
                 reportTextWriter.WriteLine("  {0} {1}", ReportResources.Assemblies2, summaryResult.Assemblies.Count().ToString(CultureInfo.InvariantCulture));
                 reportTextWriter.WriteLine("  {0} {1}", ReportResources.Classes, summaryResult.Assemblies.SelectMany(a => a.Classes).Count().ToString(CultureInfo.InvariantCulture));