Merge pull request #40 from MehdiK/lean-StoryCache

Reduces memory footprint by disposing unnecessary objects in StoryCache

Author: mwhelan

Samples/TestStack.BDDfy.Samples/AsyncExample.cs

@@ -34,9 +34,19 @@ private async Task<Sut> CreateSut()
         [Test]
         public void Run()
         {
-            var engine = this.LazyBDDfy();
-            var exception = Assert.Throws<Exception>(() => engine.Run());
-            Assert.AreEqual("Exception in async void method!!", exception.Message);
+            try
+            {
+                // we need TestObject for this test; so I disable StoryCache processor for this one test
+                Configuration.Configurator.Processors.StoryCache.Disable();
+                var engine = this.LazyBDDfy();
+                var exception = Assert.Throws<Exception>(() => engine.Run());
+
+                Assert.AreEqual("Exception in async void method!!", exception.Message);
+            }
+            finally
+            {
+                Configuration.Configurator.Processors.StoryCache.Enable();
+            }
         }
 
         internal class Sut

TestStack.BDDfy.Tests/Disposer/DisposingScenarios.cs

@@ -57,12 +57,18 @@ public void Execute(ThrowingMethods throwingMethods)
             var bddifier = scenario.LazyBDDfy();
             try
             {
+                // we need TestObject for this test; so I disable StoryCache processor for this one test
+                BDDfy.Configuration.Configurator.Processors.StoryCache.Disable();
                 bddifier.Run();
             }
             catch (Exception)
             {
                 // there will be an exception but we do not care about it
             }
+            finally
+            {
+                BDDfy.Configuration.Configurator.Processors.StoryCache.Enable();                
+            }
             var story = bddifier.Story;
 
             Assert.That(story.Scenarios.All(s => ((DisposableScenario)s.TestObject).Disposed), Is.False);

TestStack.BDDfy.Tests/Story/StoryClassAndScenarioClassAreTheSame.cs

@@ -52,7 +52,17 @@ void andTheNarrativeIsReturnedAsExpected()
         [Test]
         public void Execute()
         {
-            this.BDDfy();
+            try
+            {
+                // we need TestObject for this test; so I disable StoryCache processor for this one test
+                BDDfy.Configuration.Configurator.Processors.StoryCache.Disable();
+
+                this.BDDfy();
+            }
+            finally
+            {
+                BDDfy.Configuration.Configurator.Processors.StoryCache.Enable();                
+            }
         }
     }
 }

TestStack.BDDfy/Core/Engine.cs

@@ -38,13 +38,13 @@ public Story Run()
 
             try
             {
-                //run processors in the right order regardless of the order they are provided to the Bddifer
-                foreach (var processor in processors.Where(p => p.ProcessType != ProcessType.Finally).OrderBy(p => (int)p.ProcessType))
+                //run processors in the right order regardless of the order they are provided to the Bddfier
+                foreach (var processor in processors.Where(p => p.ProcessType < ProcessType.Disposal).OrderBy(p => (int)p.ProcessType))
                     processor.Process(_story);
             }
             finally
             {
-                foreach (var finallyProcessor in processors.Where(p => p.ProcessType == ProcessType.Finally))
+                foreach (var finallyProcessor in processors.Where(p => p.ProcessType >= ProcessType.Disposal).OrderBy(p => (int)p.ProcessType))
                     finallyProcessor.Process(_story);
             }
 

TestStack.BDDfy/Core/ExecutionStep.cs

@@ -22,7 +22,7 @@ public ExecutionStep(
         }
 
         public Guid Id { get; private set; }
-        Action<object> StepAction { get; set; }
+        internal Action<object> StepAction { get; set; }
         public bool Asserts { get; private set; }
         public bool ShouldReport { get; private set; }
         public string StepTitle { get; private set; }

TestStack.BDDfy/Core/ProcessType.cs

@@ -8,6 +8,7 @@ public enum ProcessType
         Report = 4,
         AfterReport = 5,
         ProcessExceptions = 6,
-        Finally = 7,
+        Disposal = 7,
+        Finally = 8
     }
 }

TestStack.BDDfy/Core/Scenario.cs

@@ -18,7 +18,7 @@ public Scenario(object testObject, IEnumerable<ExecutionStep> steps, string scen
 
         public string Title { get; private set; }
         public TimeSpan Duration { get { return new TimeSpan(_steps.Sum(x => x.Duration.Ticks)); } }
-        public object TestObject { get; private set; }
+        public object TestObject { get; internal set; }
         public Guid Id { get; private set; }
 
         private readonly List<ExecutionStep> _steps;

TestStack.BDDfy/Processors/Disposer.cs

@@ -7,7 +7,7 @@ public class Disposer : IProcessor
     {
         public ProcessType ProcessType
         {
-            get { return ProcessType.Finally; }
+            get { return ProcessType.Disposal; }
         }
 
         public void Process(Story story)

TestStack.BDDfy/Processors/StoryCache.cs

@@ -14,6 +14,13 @@ public ProcessType ProcessType
 
         public void Process(Story story)
         {
+            foreach (var scenario in story.Scenarios)
+            {
+                scenario.TestObject = null;
+                foreach (var step in scenario.Steps)
+                    step.StepAction = null;
+            }
+
             Cache.Add(story);
         }