refactored diagnostics to provide consistent approach to report building and testing.

mwhelan · mwhelan · commit 6356877b68c0 · 2013-07-22T15:47:48.000+01:00
diff --git a/TestStack.BDDfy.Tests/Processors/Diagnostics/DiagnosticsReportBuilderSpecs.cs b/TestStack.BDDfy.Tests/Processors/Diagnostics/DiagnosticsReportBuilderSpecs.cs
@@ -0,0 +1,28 @@
+﻿using System.Collections.Generic;
+using NSubstitute;
+using NUnit.Framework;
+using TestStack.BDDfy.Processors;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
+using TestStack.BDDfy.Processors.Reports.Serializers;
+using TestStack.BDDfy.Tests.Processors.Reports;
+
+namespace TestStack.BDDfy.Tests.Processors.Diagnostics
+{
+    [TestFixture]
+    public class DiagnosticsReportBuilderSpecs
+    {
+        [Test]
+        public void ShouldSerializeDiagnosticDataToSpecifiedFormat()
+        {
+            var serializer = Substitute.For<ISerializer>();
+            var model = new FileReportModel(
+                new ReportTestData().CreateTwoStoriesEachWithTwoScenariosWithThreeStepsOfFiveMilliseconds());
+            var sut = new DiagnosticsReportBuilder(serializer);
+
+            sut.CreateReport(model);
+            
+            serializer.Received().Serialize(Arg.Any<IList<StoryDiagnostic>>());
+        }
+
+    }
+}
diff --git a/TestStack.BDDfy.Tests/Processors/Diagnostics/DiagnosticsReporterSpecs.cs b/TestStack.BDDfy.Tests/Processors/Diagnostics/DiagnosticsReporterSpecs.cs
@@ -3,22 +3,24 @@
 using NSubstitute;
 using NUnit.Framework;
 using TestStack.BDDfy.Processors;
-using TestStack.BDDfy.Processors.Diagnostics;
+using TestStack.BDDfy.Processors.Reports;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
+using TestStack.BDDfy.Processors.Reports.Serializers;
+using TestStack.BDDfy.Processors.Reports.Writers;
 
 namespace TestStack.BDDfy.Tests.Processors.Diagnostics
 {
     [TestFixture]
     public class DiagnosticsReporterSpecs
     {
-        private IDiagnosticsCalculator _calculator;
-        private ISerializer _serializer;
+        private IReportBuilder _builder;
         private IReportWriter _writer;
 
         [Test]
         public void ShouldCreateReportIfProcessingSucceeds()
         {
             var sut = CreateSut();
-            _serializer.Serialize(Arg.Any<object>()).Returns("Report Data");
+            _builder.CreateReport(Arg.Any<FileReportModel>()).Returns("Report Data");
 
             sut.Process(new List<Core.Story>());
 
@@ -29,35 +31,18 @@ public void ShouldCreateReportIfProcessingSucceeds()
         public void ShouldPrintErrorInReportIfProcessingFails()
         {
             var sut = CreateSut();
-            _serializer.Serialize(Arg.Any<object>()).Returns(x => { throw new Exception("Error occurred."); });
+            _builder.CreateReport(Arg.Any<FileReportModel>()).Returns(x => { throw new Exception("Error occurred."); });
 
             sut.Process(new List<Core.Story>());
 
             _writer.Received().OutputReport("There was an error compiling the json report: Error occurred.", Arg.Any<string>());
         }
 
-        [Test]
-        public void ShouldGetDiagnosticDataFromStories()
-        {
-            var sut = CreateSut();
-            sut.Process(new List<Core.Story>());
-            _calculator.Received().GetDiagnosticData(Arg.Any<FileReportModel>());
-        }
-
-        [Test]
-        public void ShouldSerializeDiagnosticDataToSpecifiedFormat()
-        {
-            var sut = CreateSut();
-            sut.Process(new List<Core.Story>());
-            _serializer.Received().Serialize(Arg.Any<IList<StoryDiagnostic>>());
-        }
-
         private DiagnosticsReporter CreateSut()
         {
-            _calculator = Substitute.For<IDiagnosticsCalculator>();
-            _serializer = Substitute.For<ISerializer>();
+            _builder = Substitute.For<IReportBuilder>();
             _writer = Substitute.For<IReportWriter>();
-            return new DiagnosticsReporter(_calculator, _serializer, _writer);
+            return new DiagnosticsReporter(_builder, _writer);
         }
     }
 }
diff --git a/TestStack.BDDfy.Tests/Processors/Diagnostics/WhenBuildingReportDiagnostics.cs b/TestStack.BDDfy.Tests/Processors/Diagnostics/WhenBuildingReportDiagnostics.cs
@@ -1,23 +1,23 @@
-﻿using System;
-using System.Collections.Generic;
+﻿using System.Collections.Generic;
 using System.Linq;
 using NUnit.Framework;
 using TestStack.BDDfy.Processors;
-using TestStack.BDDfy.Processors.Diagnostics;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
+using TestStack.BDDfy.Processors.Reports.MarkDown;
 using TestStack.BDDfy.Tests.Processors.Reports;
 
 namespace TestStack.BDDfy.Tests.Processors.Diagnostics
 {
     [TestFixture]
-    public class DiagnosticsCalculatorSpecs
+    public class WhenBuildingReportDiagnostics
     {
-        private DiagnosticsCalculator _sut;
+        private DiagnosticsReportBuilder _sut;
         private IEnumerable<Core.Story> _stories; 
         private IList<StoryDiagnostic> _result;
             
-        public void GivenADiagnosticsCalculator()
+        public void GivenADiagnosticsReportBuilder()
         {
-            _sut = new DiagnosticsCalculator();
+            _sut = new DiagnosticsReportBuilder();
         }
 
         public void AndGivenTwoStoriesEachWithTwoScenariosWithThreeStepsOfFiveMilliseconds()
diff --git a/TestStack.BDDfy.Tests/Processors/Reports/MarkDown/MarkDownReporterSpecs.cs b/TestStack.BDDfy.Tests/Processors/Reports/MarkDown/MarkDownReporterSpecs.cs
@@ -3,8 +3,9 @@
 using NSubstitute;
 using NUnit.Framework;
 using TestStack.BDDfy.Processors;
-using TestStack.BDDfy.Processors.Diagnostics;
 using TestStack.BDDfy.Processors.Reports;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
+using TestStack.BDDfy.Processors.Reports.Writers;
 
 namespace TestStack.BDDfy.Tests.Processors.Reports.MarkDown
 {
diff --git a/TestStack.BDDfy.Tests/TestStack.BDDfy.Tests.csproj b/TestStack.BDDfy.Tests/TestStack.BDDfy.Tests.csproj
@@ -77,7 +77,8 @@
       <SubType>Code</SubType>
     </Compile>
     <Compile Include="HumanizerTests.cs" />
-    <Compile Include="Processors\Diagnostics\DiagnosticsCalculatorSpecs.cs" />
+    <Compile Include="Processors\Diagnostics\DiagnosticsReportBuilderSpecs.cs" />
+    <Compile Include="Processors\Diagnostics\WhenBuildingReportDiagnostics.cs" />
     <Compile Include="Processors\Diagnostics\DiagnosticsReporterSpecs.cs" />
     <Compile Include="Processors\Reports\MarkDown\MarkDownReportBuilderSpecs.cs" />
     <Compile Include="Processors\Reports\MarkDown\MarkDownReporterSpecs.cs" />
diff --git a/TestStack.BDDfy/Configuration/BatchProcessors.cs b/TestStack.BDDfy/Configuration/BatchProcessors.cs
@@ -2,8 +2,8 @@
 using System.Linq;
 using TestStack.BDDfy.Core;
 using TestStack.BDDfy.Processors;
-using TestStack.BDDfy.Processors.Diagnostics;
 using TestStack.BDDfy.Processors.HtmlReporter;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
 
 namespace TestStack.BDDfy.Configuration
 {
diff --git a/TestStack.BDDfy/Processors/Diagnostics/IDiagnosticsCalculator.cs b/TestStack.BDDfy/Processors/Diagnostics/IDiagnosticsCalculator.cs
diff --git a/TestStack.BDDfy/Processors/MarkDownReporter.cs b/TestStack.BDDfy/Processors/MarkDownReporter.cs
@@ -1,9 +1,10 @@
 ﻿using System;
 using System.Collections.Generic;
 using TestStack.BDDfy.Core;
-using TestStack.BDDfy.Processors.Diagnostics;
 using TestStack.BDDfy.Processors.Reports;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
 using TestStack.BDDfy.Processors.Reports.MarkDown;
+using TestStack.BDDfy.Processors.Reports.Writers;
 
 namespace TestStack.BDDfy.Processors
 {
diff --git a/TestStack.BDDfy/Processors/Reports/Diagnostics/DiagnosticsReportBuilder.cs b/TestStack.BDDfy/Processors/Reports/Diagnostics/DiagnosticsReportBuilder.cs
@@ -1,10 +1,27 @@
-﻿using System.Collections.Generic;
+﻿using System;
+using System.Collections.Generic;
 using System.Linq;
+using TestStack.BDDfy.Processors.Reports.Serializers;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Diagnostics
 {
-    public class DiagnosticsCalculator : IDiagnosticsCalculator
+    public class DiagnosticsReportBuilder : IReportBuilder
     {
+        private readonly ISerializer _serializer;
+
+        public DiagnosticsReportBuilder() : this(new JsonSerializer()) { }
+
+        public DiagnosticsReportBuilder(ISerializer serializer)
+        {
+            _serializer = serializer;
+        }
+
+        public string CreateReport(FileReportModel model)
+        {
+            var graph = GetDiagnosticData(model);
+            return _serializer.Serialize(graph);
+        }
+
         public IList<StoryDiagnostic> GetDiagnosticData(FileReportModel viewModel)
         {
             var graph = new List<StoryDiagnostic>();
diff --git a/TestStack.BDDfy/Processors/Reports/Diagnostics/DiagnosticsReporter.cs b/TestStack.BDDfy/Processors/Reports/Diagnostics/DiagnosticsReporter.cs
@@ -1,21 +1,20 @@
 ﻿using System;
 using System.Collections.Generic;
 using TestStack.BDDfy.Core;
+using TestStack.BDDfy.Processors.Reports.Writers;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Diagnostics
 {
     public class DiagnosticsReporter : IBatchProcessor
     {
-        private readonly IDiagnosticsCalculator _calculator;
-        private readonly ISerializer _serializer;
+        private readonly IReportBuilder _builder;
         private readonly IReportWriter _writer;
 
-        public DiagnosticsReporter() : this(new DiagnosticsCalculator(),  new JsonSerializer(), new FileWriter()) { }
+        public DiagnosticsReporter() : this(new DiagnosticsReportBuilder(), new FileWriter()) { }
 
-        public DiagnosticsReporter(IDiagnosticsCalculator calculator,  ISerializer serializer, IReportWriter writer)
+        public DiagnosticsReporter(IReportBuilder builder, IReportWriter writer)
         {
-            _calculator = calculator;
-            _serializer = serializer;
+            _builder = builder;
             _writer = writer;
         }
 
@@ -27,8 +26,7 @@ public void Process(IEnumerable<Core.Story> stories)
 
             try
             {
-                var data = _calculator.GetDiagnosticData(viewModel);
-                report = _serializer.Serialize(data);
+                report = _builder.CreateReport(viewModel);
             }
             catch (Exception ex)
             {
diff --git a/TestStack.BDDfy/Processors/Reports/Diagnostics/StoryDiagnostic.cs b/TestStack.BDDfy/Processors/Reports/Diagnostics/StoryDiagnostic.cs
@@ -1,6 +1,6 @@
 ﻿using System.Collections.Generic;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Diagnostics
 {
     public class StoryDiagnostic
     {
diff --git a/TestStack.BDDfy/Processors/Reports/Serializers/ISerializer.cs b/TestStack.BDDfy/Processors/Reports/Serializers/ISerializer.cs
@@ -1,4 +1,4 @@
-﻿namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Serializers
 {
     public interface ISerializer
     {
diff --git a/TestStack.BDDfy/Processors/Reports/Serializers/JsonFormatter.cs b/TestStack.BDDfy/Processors/Reports/Serializers/JsonFormatter.cs
@@ -1,6 +1,6 @@
-﻿using System.Text;
+using System.Text;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Serializers
 {
     // http://www.limilabs.com/blog/json-net-formatter
     public class JsonFormatter
diff --git a/TestStack.BDDfy/Processors/Reports/Serializers/JsonSerializer.cs b/TestStack.BDDfy/Processors/Reports/Serializers/JsonSerializer.cs
@@ -1,6 +1,6 @@
-﻿using System.Web.Script.Serialization;
+using System.Web.Script.Serialization;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Serializers
 {
     public class JsonSerializer : ISerializer
     {
diff --git a/TestStack.BDDfy/Processors/Reports/Writers/FileWriter.cs b/TestStack.BDDfy/Processors/Reports/Writers/FileWriter.cs
@@ -1,7 +1,8 @@
-﻿using System;
+using System;
 using System.IO;
+using TestStack.BDDfy.Processors.Reports.Diagnostics;
 
-namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Writers
 {
     public class FileWriter : IReportWriter
     {
diff --git a/TestStack.BDDfy/Processors/Reports/Writers/IReportWriter.cs b/TestStack.BDDfy/Processors/Reports/Writers/IReportWriter.cs
@@ -1,4 +1,4 @@
-﻿namespace TestStack.BDDfy.Processors.Diagnostics
+namespace TestStack.BDDfy.Processors.Reports.Writers
 {
     public interface IReportWriter
     {
diff --git a/TestStack.BDDfy/TestStack.BDDfy.csproj b/TestStack.BDDfy/TestStack.BDDfy.csproj
@@ -72,15 +72,9 @@
     <Compile Include="Configuration\StepScannerFactory.cs" />
     <Compile Include="Core\IBatchProcessor.cs" />
     <Compile Include="Processors\ConsoleReporter.cs" />
-    <Compile Include="Processors\Diagnostics\DiagnosticsCalculator.cs" />
-    <Compile Include="Processors\Diagnostics\DiagnosticsReporter.cs" />
-    <Compile Include="Processors\Diagnostics\FileWriter.cs" />
-    <Compile Include="Processors\Diagnostics\IDiagnosticsCalculator.cs" />
-    <Compile Include="Processors\Diagnostics\IReportWriter.cs" />
-    <Compile Include="Processors\Diagnostics\ISerializer.cs" />
-    <Compile Include="Processors\Diagnostics\JsonFormatter.cs" />
-    <Compile Include="Processors\Diagnostics\JsonSerializer.cs" />
-    <Compile Include="Processors\Diagnostics\StoryDiagnostic.cs" />
+    <Compile Include="Processors\Reports\Diagnostics\DiagnosticsReportBuilder.cs" />
+    <Compile Include="Processors\Reports\Diagnostics\DiagnosticsReporter.cs" />
+    <Compile Include="Processors\Reports\Diagnostics\StoryDiagnostic.cs" />
     <Compile Include="Processors\FileReportModel.cs" />
     <Compile Include="Processors\FileReportSummaryModel.cs" />
     <Compile Include="Processors\HtmlReporter\DefaultHtmlReportConfiguration.cs" />
@@ -98,6 +92,11 @@
     <Compile Include="Processors\MarkDownReporter.cs" />
     <Compile Include="Processors\Reports\IReportBuilder.cs" />
     <Compile Include="Processors\Reports\MarkDown\MarkDownReportBuilder.cs" />
+    <Compile Include="Processors\Reports\Serializers\ISerializer.cs" />
+    <Compile Include="Processors\Reports\Serializers\JsonFormatter.cs" />
+    <Compile Include="Processors\Reports\Serializers\JsonSerializer.cs" />
+    <Compile Include="Processors\Reports\Writers\FileWriter.cs" />
+    <Compile Include="Processors\Reports\Writers\IReportWriter.cs" />
     <Compile Include="Processors\StoryCache.cs" />
     <Compile Include="Core\ExecutionOrder.cs" />
     <Compile Include="Core\IHasScanner.cs" />

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`	`using System.Linq;`
`3`	`3`	`using TestStack.BDDfy.Core;`
`4`	`4`	`using TestStack.BDDfy.Processors;`
`5`		`-using TestStack.BDDfy.Processors.Diagnostics;`
`6`	`5`	`using TestStack.BDDfy.Processors.HtmlReporter;`
	`6`	`+using TestStack.BDDfy.Processors.Reports.Diagnostics;`
`7`	`7`
`8`	`8`	`namespace TestStack.BDDfy.Configuration`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,21 +1,20 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using TestStack.BDDfy.Core;`
	`4`	`+using TestStack.BDDfy.Processors.Reports.Writers;`
`4`	`5`
`5`		`-namespace TestStack.BDDfy.Processors.Diagnostics`
	`6`	`+namespace TestStack.BDDfy.Processors.Reports.Diagnostics`
`6`	`7`	`{`
`7`	`8`	`public class DiagnosticsReporter : IBatchProcessor`
`8`	`9`	`{`
`9`		`- private readonly IDiagnosticsCalculator _calculator;`
`10`		`- private readonly ISerializer _serializer;`
	`10`	`+ private readonly IReportBuilder _builder;`
`11`	`11`	`private readonly IReportWriter _writer;`
`12`	`12`
`13`		`- public DiagnosticsReporter() : this(new DiagnosticsCalculator(), new JsonSerializer(), new FileWriter()) { }`
	`13`	`+ public DiagnosticsReporter() : this(new DiagnosticsReportBuilder(), new FileWriter()) { }`
`14`	`14`
`15`		`- public DiagnosticsReporter(IDiagnosticsCalculator calculator, ISerializer serializer, IReportWriter writer)`
	`15`	`+ public DiagnosticsReporter(IReportBuilder builder, IReportWriter writer)`
`16`	`16`	`{`
`17`		`- _calculator = calculator;`
`18`		`- _serializer = serializer;`
	`17`	`+ _builder = builder;`
`19`	`18`	`_writer = writer;`
`20`	`19`	`}`
`21`	`20`
`@@ -27,8 +26,7 @@ public void Process(IEnumerable<Core.Story> stories)`
`27`	`26`
`28`	`27`	`try`
`29`	`28`	`{`
`30`		`- var data = _calculator.GetDiagnosticData(viewModel);`
`31`		`- report = _serializer.Serialize(data);`
	`29`	`+ report = _builder.CreateReport(viewModel);`
`32`	`30`	`}`
`33`	`31`	`catch (Exception ex)`
`34`	`32`	`{`