Merge branch 'finnnewick-justgiving-master'

pact-foundation · Jan 10, 2016 · e227c5c · e227c5c
2 parents 200a024 + 64d4205
commit e227c5c
Show file tree

Hide file tree

Showing 11 changed files with 125 additions and 40 deletions.
diff --git a/PactNet.Tests/PactNet.Tests.csproj b/PactNet.Tests/PactNet.Tests.csproj
@@ -137,6 +137,7 @@
     <Compile Include="PactUriOptionsTests.cs" />
     <Compile Include="ProviderServicePactFileTests.cs" />
     <Compile Include="PactVerifierTests.cs" />
+    <Compile Include="Reporters\Outputters\FileReportOutputterTests.cs" />
     <Compile Include="Reporters\ReporterTests.cs" />
     <Compile Include="Mocks\MockHttpService\Comparers\ProviderServiceResponseComparerTests.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

diff --git a/PactNet.Tests/Reporters/Outputters/FileReportOutputterTests.cs b/PactNet.Tests/Reporters/Outputters/FileReportOutputterTests.cs
@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using NSubstitute;
+using PactNet.Logging;
+using PactNet.Reporters;
+using PactNet.Reporters.Outputters;
+using Xunit;
+
+namespace PactNet.Tests.Reporters.Outputters
+{
+    public class FileReportOutputterTests
+    {
+        private ILog _log;
+
+        private IReportOutputter GetSubject()
+        {
+            _log = Substitute.For<ILog>();
+
+            return new FileReportOutputter(() => _log);
+        }
+
+        [Fact]
+        public void Write_WithReport_CallsDebugOnTheLoggerWithReport()
+        {
+            const string report = "Hello!";
+            var outputter = GetSubject();
+
+            outputter.Write(report);
+
+            _log.Received(1).Debug(report);
+        }
+    }
+}
diff --git a/PactNet.Tests/Reporters/ReporterTests.cs b/PactNet.Tests/Reporters/ReporterTests.cs
@@ -3,19 +3,20 @@
 using NSubstitute;
 using PactNet.Comparers;
 using PactNet.Reporters;
+using PactNet.Reporters.Outputters;
 using Xunit;
 
 namespace PactNet.Tests.Reporters
 {
     public class ReporterTests
     {
-        private Action<string> _reportOutputter;
+        private IReportOutputter _reportOutputter;
 
         private IReporter GetSubject()
         {
-            _reportOutputter = Substitute.For<Action<string>>();
+            _reportOutputter = Substitute.For<IReportOutputter>();
 
-            return new Reporter(new List<Action<string>> { _reportOutputter });
+            return new Reporter(new List<IReportOutputter> { _reportOutputter });
         }
 
         [Fact]
@@ -28,7 +29,7 @@ public void Flush_WithReportedInfo_CallsOutputterWithEmptyString()
 
             reporter.Flush();
 
-            _reportOutputter.Received(1)(message);
+            _reportOutputter.Received(1).Write(message);
         }
 
         [Fact]
@@ -46,7 +47,7 @@ public void Flush_WithAReportedSummaryThatContainsFailuresOnTheComparisonResult_
             reporter.ReportSummary(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.Received(1)(expectedMessage);
+            _reportOutputter.Received(1).Write(expectedMessage);
         }
 
         [Fact]
@@ -65,7 +66,7 @@ public void Flush_WithAReportedSummaryThatContainsMultipleFailuresOnTheCompariso
             reporter.ReportSummary(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.Received(1)(expectedMessage);
+            _reportOutputter.Received(1).Write(expectedMessage);
         }
 
         [Fact]
@@ -80,7 +81,7 @@ public void Flush_WithWithAReportedSummaryThatContainsNoFailuresOnTheComparisonR
             reporter.ReportSummary(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.Received(1)(comparisonMessage);
+            _reportOutputter.Received(1).Write(comparisonMessage);
         }
 
         [Fact]
@@ -102,7 +103,7 @@ public void Flush_WithAReportedSummaryThatContainsAChildResultWithMultipleFailur
             reporter.ReportSummary(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.Received(1)(Arg.Is<string>(x => x.Contains(comparisonMessage1 + " (FAILED - 1)") && x.Contains(comparisonMessage2 + " (FAILED - 2)")));
+            _reportOutputter.Received(1).Write(Arg.Is<string>(x => x.Contains(comparisonMessage1 + " (FAILED - 1)") && x.Contains(comparisonMessage2 + " (FAILED - 2)")));
         }
 
         [Fact]
@@ -122,7 +123,7 @@ public void Flush_WithReportedFailureReasonThatContainsFailuresOnTheComparisonRe
             reporter.ReportFailureReasons(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.Received(1)(Arg.Is<string>(x => x.Contains("1) " + comparisonFailureMessage1) && x.Contains("2) " + comparisonFailureMessage2)));
+            _reportOutputter.Received(1).Write(Arg.Is<string>(x => x.Contains("1) " + comparisonFailureMessage1) && x.Contains("2) " + comparisonFailureMessage2)));
         }
 
         [Fact]
@@ -137,7 +138,7 @@ public void Flush_WithReportedFailureReasonThatContainsNoFailuresOnTheComparison
             reporter.ReportFailureReasons(comparisonResult);
             reporter.Flush();
 
-            _reportOutputter.DidNotReceive()(Arg.Any<string>());
+            _reportOutputter.DidNotReceive().Write(Arg.Any<string>());
         }
     }
 }
diff --git a/PactNet/PactNet.csproj b/PactNet/PactNet.csproj
@@ -189,8 +189,10 @@
     <Compile Include="Mocks\MockHttpService\Comparers\ProviderServiceRequestComparer.cs" />
     <Compile Include="Models\ProviderState.cs" />
     <Compile Include="Models\ProviderStates.cs" />
-    <Compile Include="Reporters\FileReportOutputter.cs" />
+    <Compile Include="Reporters\Outputters\ConsoleReportOutputter.cs" />
+    <Compile Include="Reporters\Outputters\FileReportOutputter.cs" />
     <Compile Include="Reporters\IReporter.cs" />
+    <Compile Include="Reporters\Outputters\IReportOutputter.cs" />
     <Compile Include="Reporters\Reporter.cs" />
     <Compile Include="Validators\IPactValidator.cs" />
   </ItemGroup>

diff --git a/PactNet/PactVerifierConfig.cs b/PactNet/PactVerifierConfig.cs
@@ -1,14 +1,24 @@
+using System.Collections.Generic;
+using PactNet.Reporters.Outputters;
+
 namespace PactNet
 {
     public class PactVerifierConfig
     {
         public string LogDir { get; set; }
 
+        public IList<IReportOutputter> ReportOutputters { get; private set; }
+
         internal string LoggerName;
 
         public PactVerifierConfig()
         {
             LogDir = Constants.DefaultLogDir;
+            ReportOutputters = new List<IReportOutputter>
+            {
+                new ConsoleReportOutputter(),
+                new FileReportOutputter(() => LoggerName)
+            };
         }
     }
 }
diff --git a/PactNet/Reporters/FileReportOutputter.cs b/PactNet/Reporters/FileReportOutputter.cs
diff --git a/PactNet/Reporters/Outputters/ConsoleReportOutputter.cs b/PactNet/Reporters/Outputters/ConsoleReportOutputter.cs
@@ -0,0 +1,12 @@
+using System;
+
+namespace PactNet.Reporters.Outputters
+{
+    internal class ConsoleReportOutputter : IReportOutputter
+    {
+        public void Write(string report)
+        {
+            Console.WriteLine(report);
+        }
+    }
+}
diff --git a/PactNet/Reporters/Outputters/FileReportOutputter.cs b/PactNet/Reporters/Outputters/FileReportOutputter.cs
@@ -0,0 +1,25 @@
+using System;
+using PactNet.Logging;
+
+namespace PactNet.Reporters.Outputters
+{
+    internal class FileReportOutputter : IReportOutputter
+    {
+        private readonly Func<ILog> _logFactory;
+
+        internal FileReportOutputter(Func<ILog> logFactory)
+        {
+            _logFactory = logFactory;
+        }
+
+        public FileReportOutputter(Func<string> loggerNameGenerator)
+            : this(() => LogProvider.GetLogger(loggerNameGenerator()))
+        {
+        }
+
+        public void Write(string report)
+        {
+            _logFactory().Debug(report);
+        }
+    }
+}
diff --git a/PactNet/Reporters/Outputters/IReportOutputter.cs b/PactNet/Reporters/Outputters/IReportOutputter.cs
@@ -0,0 +1,7 @@
+namespace PactNet.Reporters.Outputters
+{
+    public interface IReportOutputter
+    {
+        void Write(string report);
+    }
+}
diff --git a/PactNet/Reporters/Reporter.cs b/PactNet/Reporters/Reporter.cs
@@ -3,30 +3,27 @@
 using System.Linq;
 using System.Text;
 using PactNet.Comparers;
+using PactNet.Reporters.Outputters;
 
 namespace PactNet.Reporters
 {
     internal class Reporter : IReporter
     {
-        private readonly IEnumerable<Action<string>> _outputters;
+        private readonly IEnumerable<IReportOutputter> _outputters;
 
         private int _currentTabDepth;
         private int _failureInfoCount;
         private int _failureCount;
 
         private readonly IList<string> _reportLines = new List<string>();
 
-        internal Reporter(IEnumerable<Action<string>> outputters)
+        internal Reporter(IEnumerable<IReportOutputter> outputters)
         {
             _outputters = outputters;
         }
 
         public Reporter(PactVerifierConfig config)
-            : this(new List<Action<string>>
-            {
-                Console.WriteLine, 
-                new FileReportOutputter(config.LoggerName).Write
-            })
+            : this(config.ReportOutputters)
         {
         }
 
@@ -57,14 +54,14 @@ public void ResetIndentation()
 
         public void Flush()
         {
-            if (!_reportLines.Any())
+            if (!_reportLines.Any() || _outputters == null)
             {
                 return;
             }
 
             foreach (var outputter in _outputters)
             {
-                outputter(String.Join(Environment.NewLine, _reportLines));
+                outputter.Write(String.Join(Environment.NewLine, _reportLines));
             }
         }
 

diff --git a/Samples/EventApi/Provider.Api.Web.Tests/EventAPITests.cs b/Samples/EventApi/Provider.Api.Web.Tests/EventAPITests.cs
@@ -1,16 +1,30 @@
 using Microsoft.Owin.Testing;
 using PactNet;
+using PactNet.Reporters.Outputters;
 using Xunit;
 
 namespace Provider.Api.Web.Tests
 {
+    public class CustomOutputter : IReportOutputter
+    {
+        public string Output { get; set; }
+
+        public void Write(string report)
+        {
+            Output += report;
+        }
+    }
+
     public class EventApiTests
     {
         [Fact]
         public void EnsureEventApiHonoursPactWithConsumer()
         {
             //Arrange
-            IPactVerifier pactVerifier = new PactVerifier(() => {}, () => {});
+            var outputter = new CustomOutputter();
+            var config = new PactVerifierConfig();
+            config.ReportOutputters.Add(outputter);
+            IPactVerifier pactVerifier = new PactVerifier(() => {}, () => {}, config);
 
             pactVerifier
                 .ProviderState(
@@ -30,6 +44,9 @@ public void EnsureEventApiHonoursPactWithConsumer()
                    .PactUri("../../../Consumer.Tests/pacts/consumer-event_api.json")
                    .Verify();
             }
+
+            // Verify that verifaction log is also sent to additional reporters defined in the config
+            Assert.Contains("Verifying a Pact between Consumer and Event API", outputter.Output);
         }
 
         private void EnsureOneDetailsViewEventExists()