Merge pull request #45 from JakeGinnivan/DetectWhenConventionDoesNotSetResult

Fixed issue #38 - should detect when result not set

Author: kkozmic

TestStack.ConventionTests.Tests/ConventionFixture.cs

@@ -0,0 +1,34 @@
+namespace TestStack.ConventionTests.Tests
+{
+    using System;
+    using System.Linq;
+    using NUnit.Framework;
+    using TestStack.ConventionTests.ConventionData;
+    using TestStack.ConventionTests.Internal;
+
+    [TestFixture]
+    public class ConventionFixture
+    {
+        [Test]
+        public void ShouldThrowWhenConventionDoesNotSetResult()
+        {
+            Assert.Throws<ResultNotSetException>(() => 
+                Convention.Is(new CustomConventionWhichDoesNothing(), Types.InAssemblyOf<ConventionFixture>()));
+        }
+
+        // ReSharper disable once UnusedVariable
+        class CustomConventionWhichDoesNothing : IConvention<Types>
+        {
+            public void Execute(Types data, IConventionResultContext result)
+            {
+                var failingTypes = data.TypesToVerify.Where(IsBroken);
+                // Oops, I forgot to set the result
+            }
+
+            bool IsBroken(Type type)
+            {
+                return true;
+            }
+        }
+    }
+}

TestStack.ConventionTests.Tests/TestStack.ConventionTests.Tests.csproj

@@ -61,6 +61,7 @@
     <Compile Include="Autofac\TestTypes\IBar.cs" />
     <Compile Include="Autofac\TestTypes\IFoo.cs" />
     <Compile Include="ConventionAssertionClassTests.cs" />
+    <Compile Include="ConventionFixture.cs" />
     <Compile Include="CsvReportTests.cs" />
     <Compile Include="MvcConventions.cs" />
     <Compile Include="ProjectBasedConventions.cs" />

TestStack.ConventionTests/Internal/ConventionContext.cs

@@ -13,6 +13,7 @@ public class ConventionContext : IConventionResultContext, IConventionFormatCont
         readonly IList<IResultsProcessor> processors;
         readonly ITestResultProcessor testResultProcessor;
         readonly IList<ConventionResult> results = new List<ConventionResult>();
+        bool resultSet;
 
         public ConventionContext(string dataDescription, IList<IReportDataFormatter> formatters,
             IList<IResultsProcessor> processors, ITestResultProcessor testResultProcessor)
@@ -59,6 +60,7 @@ IReportDataFormatter GetReportDataFormatterFor(object data)
 
         void IConventionResultContext.Is<TResult>(string resultTitle, IEnumerable<TResult> failingData)
         {
+            resultSet = true;
             // ReSharper disable PossibleMultipleEnumeration
             results.Add(new ConventionResult(
                 typeof (TResult),
@@ -71,6 +73,7 @@ void IConventionResultContext.IsSymmetric<TResult>(
             string firstSetFailureTitle, IEnumerable<TResult> firstSetFailureData,
             string secondSetFailureTitle, IEnumerable<TResult> secondSetFailureData)
         {
+            resultSet = true;
             results.Add(new ConventionResult(
                 typeof (TResult), firstSetFailureTitle,
                 dataDescription,
@@ -103,6 +106,9 @@ public void Execute<TDataSource>(IConvention<TDataSource> convention, TDataSourc
                 throw new ConventionSourceInvalidException(String.Format("{0} has no data", data.Description));
             convention.Execute(data, this);
 
+            if (!resultSet) 
+                throw new ResultNotSetException("{0} did not set a result, conventions must always set a result");
+
             foreach (IResultsProcessor resultsProcessor in processors)
             {
                 resultsProcessor.Process(this, ConventionResults);

TestStack.ConventionTests/Internal/ResultNotSetException.cs

@@ -0,0 +1,20 @@
+namespace TestStack.ConventionTests.Internal
+{
+    using System;
+    using System.Runtime.Serialization;
+
+    [Serializable]
+    public class ResultNotSetException : Exception
+    {
+        public ResultNotSetException() { }
+        public ResultNotSetException(string message) : base(message) { }
+        public ResultNotSetException(string message, Exception inner) : base(message, inner) { }
+
+        protected ResultNotSetException(
+            SerializationInfo info,
+            StreamingContext context)
+            : base(info, context)
+        {
+        }
+    }
+}

TestStack.ConventionTests/TestStack.ConventionTests.csproj

@@ -115,6 +115,7 @@
     <Compile Include="Reporting\TestResult.cs" />
     <Compile Include="Reporting\StringDataFormatter.cs" />
     <Compile Include="Reporting\TypeDataFormatter.cs" />
+    <Compile Include="Internal\ResultNotSetException.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />