overhauled reporting

kkozmic · kkozmic · commit ab75360f18e3 · 2013-08-18T15:46:40.000+10:00
ConventionResult now holds formatted result and recommended file extension. This will save us from having to have a copy of text renderer in almost any other renderer.
Also this gives us flexibility to either use existing result, or overwrite it (or ignore and render your own, but not save it back for validation, like HTML renderer does
diff --git a/TestStack.ConventionTests.Tests/CsvReportTests.Can_run_convention_with_simple_reporter.approved.csv b/TestStack.ConventionTests.Tests/CsvReportTests.Can_run_convention_with_simple_reporter.approved.csv
@@ -0,0 +1,5 @@
+﻿collection,item,can add,can remove
+TestAssembly.Collections.Branch,TestAssembly.Collections.Leaf,False,False
+TestAssembly.Collections.Forest,TestAssembly.Collections.Tree,True,True
+TestAssembly.Collections.Tree,TestAssembly.Collections.Branch,True,False
+TestAssembly.Collections.Tree,TestAssembly.Collections.Leaf,False,False
diff --git a/TestStack.ConventionTests.Tests/CsvReportTests.cs b/TestStack.ConventionTests.Tests/CsvReportTests.cs
@@ -5,21 +5,21 @@
     using NUnit.Framework;
     using TestAssembly.Collections;
     using TestStack.ConventionTests.ConventionData;
+    using TestStack.ConventionTests.Reporting;
     using TestStack.ConventionTests.Tests.TestConventions;
 
     [UseReporter(typeof(DiffReporter))]
     public class CsvReportTests
     {
         [Test]
-        [Explicit("This is work in progress so ignoring for now")]
         public void Can_run_convention_with_simple_reporter()
         {
             Convention.IsWithApprovedExeptions(new CollectionsRelationsConvention(), new Types("Entities")
             {
                 TypesToVerify =
                     typeof (Leaf).Assembly.GetExportedTypes()
                         .Where(t => t.Namespace == typeof (Leaf).Namespace).ToArray()
-            });
+            }, new CsvReporter());
         }
     }
 }
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj.approved.txt
@@ -1,4 +1,4 @@
 ﻿'Project must not reference dlls from bin or obj directories' for 'TestStack.ConventionTests.Tests'
 ---------------------------------------------------------------------------------------------------
 
-	bin\Debug\ApprovalTests.dll
+	bin\Debug\ApprovalTests.dll
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj_with_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.assemblies_referencing_bin_obj_with_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
 ﻿'Project must not reference dlls from bin or obj directories' for 'TestStack.ConventionTests.Tests'
 ---------------------------------------------------------------------------------------------------
 
-	bin\Debug\ApprovalTests.dll
+	bin\Debug\ApprovalTests.dll
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources.approved.txt
@@ -1,4 +1,4 @@
 ﻿'.sql Files must be embedded resources' for 'TestStack.ConventionTests.Tests'
 -----------------------------------------------------------------------------
 
-	Scripts\Script2.sql
+	Scripts\Script2.sql
diff --git a/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources_with_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/ProjectBasedConventions.scripts_not_embedded_resources_with_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
 ﻿'.sql Files must be embedded resources' for 'TestStack.ConventionTests.Tests'
 -----------------------------------------------------------------------------
 
-	Scripts\Script2.sql
+	Scripts\Script2.sql
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor.approved.txt
@@ -2,4 +2,4 @@
 ------------------------------------------------------------------
 
 	TestAssembly.ClassWithNoDefaultCtor
-	TestAssembly.ClassWithPrivateDefaultCtor
+	TestAssembly.ClassWithPrivateDefaultCtor
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_classes_have_default_constructor_wth_approved_exceptions.approved.txt
@@ -2,4 +2,4 @@
 ------------------------------------------------------------------
 
 	TestAssembly.ClassWithNoDefaultCtor
-	TestAssembly.ClassWithPrivateDefaultCtor
+	TestAssembly.ClassWithPrivateDefaultCtor
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual.approved.txt
@@ -1,4 +1,4 @@
 ﻿'Methods must be virtual' for 'nHibernate Entitites'
 ----------------------------------------------------
 
-	TestAssembly.SampleDomainClass.TestNonVirtual
+	TestAssembly.SampleDomainClass.TestNonVirtual
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.all_methods_are_virtual_wth_approved_exceptions.approved.txt
@@ -1,4 +1,4 @@
 ﻿'Methods must be virtual' for 'nHibernate Entitites'
 ----------------------------------------------------
 
-	TestAssembly.SampleDomainClass.TestNonVirtual
+	TestAssembly.SampleDomainClass.TestNonVirtual
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace.approved.txt
@@ -3,8 +3,7 @@
 
 	TestAssembly.SomeDto
 
-
 'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly types'
 ---------------------------------------------------------------------------------------
 
-	TestAssembly.Dtos.AnotherClass
+	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace1.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace1.approved.txt
@@ -0,0 +1,4 @@
+﻿'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly types'
+---------------------------------------------------------------------------------------
+
+	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions.approved.txt
@@ -2,9 +2,3 @@
 -------------------------------------------------------------------------------
 
 	TestAssembly.SomeDto
-
-
-'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly types'
----------------------------------------------------------------------------------------
-
-	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions1.approved.txt b/TestStack.ConventionTests.Tests/TypeBasedConventions.dtos_exists_in_dto_namespace_wth_approved_exceptions1.approved.txt
@@ -0,0 +1,4 @@
+﻿'Non-Dtos must not be under the 'TestAssembly.Dtos' namespace' for 'TestAssembly types'
+---------------------------------------------------------------------------------------
+
+	TestAssembly.Dtos.AnotherClass
diff --git a/TestStack.ConventionTests/Convention.cs b/TestStack.ConventionTests/Convention.cs
@@ -19,52 +19,60 @@ static Convention()
                 new ProjectReferenceFormatter(),
                 new ProjectFileFormatter(),
                 new MethodInfoDataFormatter(),
-                new StringDataFormatter()
+                new StringDataFormatter(),
+                new ConvertibleFormatter(),
+                new FallbackFormatter()
             };
         }
 
         public static IList<IReportDataFormatter> Formatters { get; set; }
 
-        public static void Is<TDataSource>(IConvention<TDataSource> convention, TDataSource data)
+        static string AssemblyDirectory
+        {
+            get
+            {
+                // http://stackoverflow.com/questions/52797/c-how-do-i-get-the-path-of-the-assembly-the-code-is-in#answer-283917
+                var codeBase = Assembly.GetExecutingAssembly().CodeBase;
+                var uri = new UriBuilder(codeBase);
+                var path = Uri.UnescapeDataString(uri.Path);
+                return Path.GetDirectoryName(path);
+            }
+        }
+
+        public static void Is<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
+            params IResultsProcessor[] extraResultProcessors)
             where TDataSource : IConventionData
         {
-            Is(convention, data, new IResultsProcessor[]
+            var processors = new List<IResultsProcessor>(extraResultProcessors)
             {
+                new ConventionReportTextRenderer(),
                 HtmlRenderer,
                 new ConventionReportTraceRenderer(),
                 new ThrowOnFailureResultsProcessor()
-            });
+            };
+            Execute(convention, data, processors.ToArray());
         }
 
-        public static void Is<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
+        static void Execute<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
             IResultsProcessor[] processors)
             where TDataSource : IConventionData
         {
             var context = new ConventionContext(data.Description, Formatters, processors);
             context.Execute(convention, data);
         }
 
-        public static void IsWithApprovedExeptions<TDataSource>(IConvention<TDataSource> convention, TDataSource data)
+        public static void IsWithApprovedExeptions<TDataSource>(IConvention<TDataSource> convention, TDataSource data,
+            params IResultsProcessor[] extraResultProcessors)
             where TDataSource : IConventionData
         {
-            Is(convention, data, new IResultsProcessor[]
+            var processors = new List<IResultsProcessor>(extraResultProcessors)
             {
+                new ConventionReportTextRenderer(),
                 HtmlRenderer,
                 new ConventionReportTraceRenderer(),
                 new ApproveResultsProcessor()
-            });
-        }
-
-        // http://stackoverflow.com/questions/52797/c-how-do-i-get-the-path-of-the-assembly-the-code-is-in#answer-283917
-        static string AssemblyDirectory
-        {
-            get
-            {
-                string codeBase = Assembly.GetExecutingAssembly().CodeBase;
-                var uri = new UriBuilder(codeBase);
-                string path = Uri.UnescapeDataString(uri.Path);
-                return Path.GetDirectoryName(path);
-            }
+            };
+            Execute(convention, data, processors.ToArray());
         }
     }
 }
diff --git a/TestStack.ConventionTests/Internal/ConventionContext.cs b/TestStack.ConventionTests/Internal/ConventionContext.cs
@@ -39,10 +39,12 @@ ConventionReportFailure IConventionFormatContext.FormatData(object failingData)
             return formatter.Format(failingData);
         }
 
-        void IConventionResultContext.Is<T>(string resultTitle, IEnumerable<T> failingData)
+        void IConventionResultContext.Is<TResult>(string resultTitle, IEnumerable<TResult> failingData)
         {
             // ReSharper disable PossibleMultipleEnumeration
-            results.Add(new ConventionResult(resultTitle,
+            results.Add(new ConventionResult(
+                typeof(TResult),
+                resultTitle,
                 dataDescription,
                 failingData.ToObjectArray()));
         }
@@ -51,10 +53,12 @@ void IConventionResultContext.IsSymmetric<TResult>(
             string firstSetFailureTitle, IEnumerable<TResult> firstSetFailureData,
             string secondSetFailureTitle, IEnumerable<TResult> secondSetFailureData)
         {
-            results.Add(new ConventionResult(firstSetFailureTitle,
+            results.Add(new ConventionResult(
+                typeof(TResult), firstSetFailureTitle,
                 dataDescription,
                 firstSetFailureData.ToObjectArray()));
-            results.Add(new ConventionResult(secondSetFailureTitle,
+            results.Add(new ConventionResult(
+                typeof(TResult), secondSetFailureTitle,
                 dataDescription,
                 secondSetFailureData.ToObjectArray()));
         }
diff --git a/TestStack.ConventionTests/Internal/ConventionResult.cs b/TestStack.ConventionTests/Internal/ConventionResult.cs
@@ -1,16 +1,20 @@
 ﻿namespace TestStack.ConventionTests.Internal
 {
+    using System;
     using System.Linq;
 
     public class ConventionResult
     {
-        public ConventionResult(string conventionTitle, string dataDescription, object[] data)
+        public ConventionResult(Type dataType, string conventionTitle, string dataDescription, object[] data)
         {
+            DataType = dataType;
             ConventionTitle = conventionTitle;
             DataDescription = dataDescription;
             Data = data;
         }
 
+        public string RecommendedFileExtension { get; private set; }
+        public Type DataType { get; private set; }
         public string ConventionTitle { get; private set; }
         public string DataDescription { get; private set; }
         public object[] Data { get; private set; }
@@ -19,5 +23,13 @@ public bool HasData
         {
             get { return Data.Any(); }
         }
+
+        public string FormattedResult { get; private set; }
+
+        public void WithFormattedResult(string formattedResult, string recommendedFileExtension = "txt")
+        {
+            FormattedResult = formattedResult;
+            RecommendedFileExtension = recommendedFileExtension;
+        }
     }
 }
diff --git a/TestStack.ConventionTests/Internal/ConventionTestsApprovalTextWriter.cs b/TestStack.ConventionTests/Internal/ConventionTestsApprovalTextWriter.cs
@@ -0,0 +1,35 @@
+﻿namespace TestStack.ConventionTests.Internal
+{
+    using ApprovalTests;
+    using ApprovalTests.Core;
+
+    public class ConventionTestsApprovalTextWriter : ApprovalTextWriter, IApprovalWriter
+    {
+        readonly int count;
+
+
+        public ConventionTestsApprovalTextWriter(string formattedResult, int count, string extensionWithoutDot)
+            : base(formattedResult, extensionWithoutDot)
+        {
+            this.count = count;
+        }
+
+        string IApprovalWriter.GetApprovalFilename(string basename)
+        {
+            if (count == 0)
+            {
+                return GetApprovalFilename(basename);
+            }
+            return GetApprovalFilename(basename + count);
+        }
+
+        string IApprovalWriter.GetReceivedFilename(string basename)
+        {
+            if (count == 0)
+            {
+                return GetReceivedFilename(basename);
+            }
+            return GetReceivedFilename(basename + count);
+        }
+    }
+}
diff --git a/TestStack.ConventionTests/Reporting/ApproveResultsProcessor.cs b/TestStack.ConventionTests/Reporting/ApproveResultsProcessor.cs
@@ -1,6 +1,8 @@
 ﻿namespace TestStack.ConventionTests.Reporting
 {
     using System;
+    using System.Collections.Generic;
+    using System.Linq;
     using ApprovalTests;
     using ApprovalTests.Core.Exceptions;
     using TestStack.ConventionTests.Internal;
@@ -9,20 +11,37 @@ public class ApproveResultsProcessor : IResultsProcessor
     {
         public void Process(IConventionFormatContext context, params ConventionResult[] results)
         {
-            try
+            var failedApprovals = new List<ApprovalException>();
+            for (var count = 0; count < results.Length; count++)
             {
-                var conventionReportTextRenderer = new ConventionReportTextRenderer();
-                conventionReportTextRenderer.Process(context, results);
-                Approvals.Verify(conventionReportTextRenderer.Output);
+                var result = results[count];
+                try
+                {
+                    Approvals.Verify(new ConventionTestsApprovalTextWriter(result.FormattedResult, count,result.RecommendedFileExtension));
+                }
+                catch (ApprovalException ex)
+                {
+                    failedApprovals.Add(ex);
+                }
             }
-            catch (ApprovalException ex)
+            if (failedApprovals.Count == 0)
             {
+                return;
+            }
+            if (failedApprovals.Count == 1)
+            {
+                var ex = failedApprovals[0];
                 throw new ConventionFailedException("Approved exceptions for convention differs" +
                                                     Environment.NewLine +
                                                     Environment.NewLine +
-                                                    ex.Message,
-                    ex);
+                                                    ex.Message, ex);
             }
+            throw new ConventionFailedException("Approved exceptions for convention differs" +
+                                                Environment.NewLine +
+                                                Environment.NewLine +
+                                                string.Join(Environment.NewLine,
+                                                    failedApprovals.Select(x => x.Message)),
+                new AggregateException(failedApprovals.ToArray()));
         }
     }
 }
diff --git a/TestStack.ConventionTests/Reporting/ConventionReportTextRenderer.cs b/TestStack.ConventionTests/Reporting/ConventionReportTextRenderer.cs
@@ -7,26 +7,24 @@ public class ConventionReportTextRenderer : IResultsProcessor
     {
         public void Process(IConventionFormatContext context, params ConventionResult[] results)
         {
-            var stringBuilder = new StringBuilder();
-
-            foreach (var conventionReport in results)
+            foreach (var result in results)
             {
-                var title = string.Format("'{0}' for '{1}'", conventionReport.ConventionTitle,
-                    conventionReport.DataDescription);
-                stringBuilder.AppendLine(title);
-                stringBuilder.AppendLine(string.Empty.PadRight(title.Length, '-'));
-                stringBuilder.AppendLine();
+                if (result.FormattedResult != null)
+                {
+                    continue;
+                }
+                var description = new StringBuilder();
+                var title = string.Format("'{0}' for '{1}'", result.ConventionTitle,
+                    result.DataDescription);
+                description.AppendLine(title);
+                description.AppendLine(string.Empty.PadRight(title.Length, '-'));
+                description.AppendLine();
 
-                RenderItems(conventionReport, stringBuilder, context);
-                stringBuilder.AppendLine();
-                stringBuilder.AppendLine();
+                RenderItems(result, description, context);
+                result.WithFormattedResult(description.ToString());
             }
-
-            Output = stringBuilder.ToString().TrimEnd();
         }
 
-        public string Output { get; private set; }
-
         static void RenderItems(ConventionResult resultInfo, StringBuilder stringBuilder, IConventionFormatContext context)
         {
             foreach (var conventionFailure in resultInfo.Data)
diff --git a/TestStack.ConventionTests/Reporting/ConventionReportTraceRenderer.cs b/TestStack.ConventionTests/Reporting/ConventionReportTraceRenderer.cs
diff --git a/TestStack.ConventionTests/Reporting/ConvertibleFormatter.cs b/TestStack.ConventionTests/Reporting/ConvertibleFormatter.cs
diff --git a/TestStack.ConventionTests/Reporting/CsvReporter.cs b/TestStack.ConventionTests/Reporting/CsvReporter.cs
diff --git a/TestStack.ConventionTests/Reporting/DefaultFormatter.cs b/TestStack.ConventionTests/Reporting/DefaultFormatter.cs
diff --git a/TestStack.ConventionTests/Reporting/FallbackFormatter.cs b/TestStack.ConventionTests/Reporting/FallbackFormatter.cs
diff --git a/TestStack.ConventionTests/Reporting/MethodInfoDataFormatter.cs b/TestStack.ConventionTests/Reporting/MethodInfoDataFormatter.cs
diff --git a/TestStack.ConventionTests/Reporting/ThrowOnFailureResultsProcessor.cs b/TestStack.ConventionTests/Reporting/ThrowOnFailureResultsProcessor.cs
diff --git a/TestStack.ConventionTests/TestStack.ConventionTests.csproj b/TestStack.ConventionTests/TestStack.ConventionTests.csproj

Original file line number	Diff line number	Diff line change
`@@ -5,21 +5,21 @@`
`5`	`5`	`using NUnit.Framework;`
`6`	`6`	`using TestAssembly.Collections;`
`7`	`7`	`using TestStack.ConventionTests.ConventionData;`
	`8`	`+ using TestStack.ConventionTests.Reporting;`
`8`	`9`	`using TestStack.ConventionTests.Tests.TestConventions;`
`9`	`10`
`10`	`11`	`[UseReporter(typeof(DiffReporter))]`
`11`	`12`	`public class CsvReportTests`
`12`	`13`	`{`
`13`	`14`	`[Test]`
`14`		`- [Explicit("This is work in progress so ignoring for now")]`
`15`	`15`	`public void Can_run_convention_with_simple_reporter()`
`16`	`16`	`{`
`17`	`17`	`Convention.IsWithApprovedExeptions(new CollectionsRelationsConvention(), new Types("Entities")`
`18`	`18`	`{`
`19`	`19`	`TypesToVerify =`
`20`	`20`	`typeof (Leaf).Assembly.GetExportedTypes()`
`21`	`21`	`.Where(t => t.Namespace == typeof (Leaf).Namespace).ToArray()`
`22`		`- });`
	`22`	`+ }, new CsvReporter());`
`23`	`23`	`}`
`24`	`24`	`}`
`25`	`25`	`}`