Add WriteHeader method; Refactor tests

Author: CharliePoole

src/NUnitCommon/nunit.common.tests/TextDisplay/ResultReporterTests.cs

@@ -15,7 +15,26 @@ namespace NUnit.TextDisplay
     public class ResultReporterTests
     {
         private XmlNode _result;
-        private StringBuilder _report;
+
+        private StringBuilder _reportBuilder;
+        private ExtendedTextWrapper _writer;
+
+        private string ReportOutput => _reportBuilder.ToString();
+
+        private List<string> ReportLines
+        {
+            get
+            {
+                var rdr = new StringReader(ReportOutput);
+
+                string? line;
+                var lines = new List<string>();
+                while ((line = rdr.ReadLine()) is not null)
+                    lines.Add(line);
+
+                return lines;
+            }
+        }
 
         [OneTimeSetUp]
         public void CreateResult()
@@ -44,19 +63,19 @@ public void CreateResult()
         }
 
         [SetUp]
-        public void CreateReporter()
+        public void SetUp()
         {
-            _report = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(_report));
+            _reportBuilder = new StringBuilder();
+            _writer = new ExtendedTextWrapper(new StringWriter(_reportBuilder));
         }
 
+        [TearDown]
+        public void TearDown() => _writer.Dispose();
+
         [Test]
         public void ReportSequenceTest()
         {
-            var sb = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(sb));
-            ResultReporter.ReportResults(new ResultSummary(_result), writer);
-            var report = sb.ToString();
+            ResultReporter.ReportResults(new ResultSummary(_result), _writer);
 
             var reportSequence = new[]
             {
@@ -69,7 +88,7 @@ public void ReportSequenceTest()
 
             foreach (string title in reportSequence)
             {
-                var index = report.IndexOf(title);
+                var index = ReportOutput.IndexOf(title);
                 Assert.That(index > 0, "Report not found: " + title);
                 Assert.That(index > last, "Report out of sequence: " + title);
                 last = index;
@@ -94,11 +113,8 @@ public void SummaryReportTest()
             };
 #pragma warning restore SA1137 // Elements should have the same indentation
 
-            var report = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(report));
-            ResultReporter.WriteSummaryReport(_result, new ResultSummary(_result), writer);
-            var lines = GetReportLines(report.ToString());
-            Assert.That(lines, Is.EqualTo(expected));
+            ResultReporter.WriteSummaryReport(new ResultSummary(_result), _writer);
+            Assert.That(ReportLines, Is.EqualTo(expected));
         }
 
         [Test]
@@ -123,14 +139,10 @@ public void ErrorsFailuresAndWarningsReportTest()
                 "No suitable constructor was found"
             };
 
-            var sb = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(sb));
-            ResultReporter.WriteErrorsFailuresAndWarningsReport(_result, writer);
-
-            var report = sb.ToString();
+            ResultReporter.WriteErrorsFailuresAndWarningsReport(_result, _writer);
 
             foreach (var item in expected)
-                Assert.That(report.Contains(item));
+                Assert.That(ReportOutput.Contains(item));
         }
 
         [Test]
@@ -162,11 +174,8 @@ public void TestsNotRunTest()
                 string.Empty
             };
 
-            var report = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(report));
-            ResultReporter.WriteNotRunReport(_result, writer);
-            var lines = GetReportLines(report.ToString());
-            Assert.That(lines, Is.EqualTo(expected));
+            ResultReporter.WriteNotRunReport(_result, _writer);
+            Assert.That(ReportLines, Is.EqualTo(expected));
         }
 
         [Test, Explicit("Displays failure behavior")]
@@ -186,28 +195,13 @@ public void TestParameterSettingsWrittenCorrectly()
                 "        2 -> |c|"
             };
 
-            var report = new StringBuilder();
-            var writer = new ExtendedTextWrapper(new StringWriter(report));
-            ResultReporter.WriteRunSettingsReport(_result, writer);
-            var lines = GetReportLines(report.ToString());
-            Assert.That(lines, Is.SupersetOf(expected));
+            ResultReporter.WriteRunSettingsReport(_result, _writer);
+            Assert.That(ReportLines, Is.SupersetOf(expected));
         }
 
         private static TestEngineResult AddMetadata(TestEngineResult input)
         {
             return input.Aggregate("test-run start-time=\"2015-10-19 02:12:28Z\" end-time=\"2015-10-19 02:12:29Z\" duration=\"0.348616\"", string.Empty, string.Empty, string.Empty);
         }
-
-        private static List<string> GetReportLines(string report)
-        {
-            var rdr = new StringReader(report.ToString());
-
-            string? line;
-            var lines = new List<string>();
-            while ((line = rdr.ReadLine()) is not null)
-                lines.Add(line);
-
-            return lines;
-        }
     }
 }

src/NUnitCommon/nunit.common/TextDisplay/ResultReporter.cs

@@ -1,13 +1,30 @@
 // Copyright (c) Charlie Poole, Rob Prouse and Contributors. MIT License - see LICENSE.txt
 
 using System;
+using System.Diagnostics;
 using System.Globalization;
+using System.Reflection;
 using System.Xml;
 
 namespace NUnit.TextDisplay
 {
     public static class ResultReporter
     {
+        public static void WriteHeader(ExtendedTextWriter writer)
+        {
+            Assembly entryAssembly = Assembly.GetEntryAssembly() ?? Assembly.GetExecutingAssembly();
+            var versionBlock = FileVersionInfo.GetVersionInfo(entryAssembly.ManifestModule.FullyQualifiedName);
+
+            var header = $"{versionBlock.ProductName} {versionBlock.ProductVersion}";
+
+            var configurationAttributes = entryAssembly.GetCustomAttribute<AssemblyConfigurationAttribute>();
+
+            writer.WriteLine(ColorStyle.Header, header);
+            writer.WriteLine(ColorStyle.SubHeader, versionBlock.LegalCopyright ?? "No Copyright statement found");
+            writer.WriteLine(ColorStyle.SubHeader, DateTime.Now.ToString(CultureInfo.CurrentCulture.DateTimeFormat.FullDateTimePattern));
+            writer.WriteLine();
+        }
+
         /// <summary>
         /// Reports the results to the console
         /// </summary>
@@ -25,7 +42,7 @@ public static void ReportResults(ResultSummary summary, ExtendedTextWriter write
 
             WriteRunSettingsReport(topLevelResult, writer);
 
-            WriteSummaryReport(topLevelResult, summary, writer);
+            WriteSummaryReport(summary, writer);
         }
 
         public static void WriteRunSettingsReport(XmlNode topLevelResult, ExtendedTextWriter writer)
@@ -68,11 +85,13 @@ private static void WriteSettingsNode(XmlNode node, ExtendedTextWriter writer)
             }
         }
 
-        public static void WriteSummaryReport(XmlNode topLevelResult, ResultSummary summary, ExtendedTextWriter writer)
+        public static void WriteSummaryReport(ResultSummary summary, ExtendedTextWriter writer)
         {
             const string INDENT4 = "    ";
             const string INDENT8 = "        ";
 
+            var topLevelResult = summary.ResultNode;
+
             ColorStyle resultColor = summary.OverallResult == "Passed"
                 ? ColorStyle.Pass
                 : summary.OverallResult == "Failed" || summary.OverallResult == "Unknown"

src/NUnitConsole/nunit4-console/Program.cs

@@ -46,7 +46,7 @@ public static int Main(string[] args)
             }
             catch (OptionException ex)
             {
-                WriteHeader();
+                ResultReporter.WriteHeader(OutWriter);
                 WriteErrorMessage(string.Format(ex.Message, ex.OptionName));
                 return ConsoleRunner.INVALID_ARG;
             }
@@ -59,7 +59,7 @@ public static int Main(string[] args)
                 }
                 catch (Exception error)
                 {
-                    WriteHeader();
+                    ResultReporter.WriteHeader(OutWriter);
                     WriteErrorMessage(string.Format("Unsupported Encoding, {0}", error.Message));
                     return ConsoleRunner.INVALID_ARG;
                 }
@@ -68,7 +68,7 @@ public static int Main(string[] args)
             try
             {
                 if (Options.ShowVersion || !Options.NoHeader)
-                    WriteHeader();
+                    ResultReporter.WriteHeader(OutWriter);
 
                 if (Options.ShowHelp || args.Length == 0)
                 {
@@ -171,28 +171,6 @@ public static int Main(string[] args)
             }
         }
 
-        private static void WriteHeader()
-        {
-            Assembly entryAssembly = Assembly.GetEntryAssembly() ?? Assembly.GetExecutingAssembly();
-            var versionBlock = FileVersionInfo.GetVersionInfo(entryAssembly.ManifestModule.FullyQualifiedName);
-
-            var header = $"{versionBlock.ProductName} {versionBlock.ProductVersion}";
-
-            var configurationAttributes = entryAssembly.GetCustomAttributes<AssemblyConfigurationAttribute>().ToArray();
-
-            if (configurationAttributes.Length > 0)
-            {
-                string configuration = ((AssemblyConfigurationAttribute)configurationAttributes[0]).Configuration;
-                if (!string.IsNullOrEmpty(configuration))
-                    header += $" ({configuration})";
-            }
-
-            OutWriter.WriteLine(ColorStyle.Header, header);
-            OutWriter.WriteLine(ColorStyle.SubHeader, versionBlock.LegalCopyright ?? "No Copyright statement found");
-            OutWriter.WriteLine(ColorStyle.SubHeader, DateTime.Now.ToString(CultureInfo.CurrentCulture.DateTimeFormat.FullDateTimePattern));
-            OutWriter.WriteLine();
-        }
-
         private static void WriteHelpText()
         {
             OutWriter.WriteLine();