Html Encoding step titles

Author: Jake Ginnivan

TestStack.BDDfy.Tests/Reporters/MarkDown/MarkDownReportBuilderTests.ShouldProduceExpectedMarkdownWithExamples.approved.txt

@@ -4,15 +4,15 @@
  **So that I can get money when the bank is closed**  
 
 ### Example Scenario
-  Given a <sign> account balance  
+  Given a &lt;sign&gt; account balance  
   When the account holder requests money  
-  Then money <action> dispensed  
+  Then money &lt;action&gt; dispensed  
 
 ### Examples: 
 
-    | sign     | action | Result | Errors                                                                                 |
-    | positive | is     | Passed |                                                                                        |
-    | negative | is not | Failed | Step: Then money <action> dispensed failed with exception: [Boom] [Details at 1 below] |
+    | sign     | action | Result | Errors                                                                                       |
+    | positive | is     | Passed |                                                                                              |
+    | negative | is not | Failed | Step: Then money &lt;action&gt; dispensed failed with exception: [Boom] [Details at 1 below] |
 
 #### Exceptions:
     1. Boom
@@ -24,9 +24,9 @@
  **So that I can be happy**  
 
 ### Example Scenario
-  Given a <sign> account balance  
+  Given a &lt;sign&gt; account balance  
   When the account holder requests money  
-  Then money <action> dispensed  
+  Then money &lt;action&gt; dispensed  
 
 ### Examples: 
 

TestStack.BDDfy.Tests/TestStack.BDDfy.Tests.csproj

@@ -174,6 +174,7 @@
     <Content Include="Reporters\Html\ClassicReportBuilderTests.ShouldProduceExpectedHtmlWithExamples.approved.txt" />
     <Content Include="Reporters\Html\MetroReportBuilderTests.ShouldProduceExpectedHtmlWithExamples.approved.txt" />
     <Content Include="Reporters\MarkDown\MarkDownReportBuilderTests.ShouldProduceExpectedMarkdown.approved.txt" />
+    <Content Include="Reporters\MarkDown\MarkDownReportBuilderTests.ShouldProduceExpectedMarkdownWithExamples.approved.txt" />
     <Content Include="Reporters\TextReporter\TextReporterTests.ShouldProduceExpectedMarkdownWithExamples.approved.txt" />
     <Content Include="Reporters\TextReporter\TextReporterTests.ShouldProduceExpectedReport.approved.txt" />
   </ItemGroup>

TestStack.BDDfy/Reporters/MarkDown/MarkDownReportBuilder.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Web;
 
 namespace TestStack.BDDfy.Reporters.MarkDown
 {
@@ -40,7 +41,7 @@ public string CreateReport(FileReportModel model)
                         if (exampleScenario.Steps.Any())
                         {
                             foreach (var step in exampleScenario.Steps.Where(s => s.ShouldReport))
-                                report.AppendLine("  " + step.Title + "  ");
+                                report.AppendLine("  " + HttpUtility.HtmlEncode(step.Title) + "  ");
                         }
 
                         report.AppendLine(); // separator
@@ -53,7 +54,7 @@ public string CreateReport(FileReportModel model)
                             report.AppendLine(string.Format("### {0}", scenario.Title));
 
                             foreach (var step in scenario.Steps)
-                                report.AppendLine("  " + step.Title + "  ");
+                                report.AppendLine("  " + HttpUtility.HtmlEncode(step.Title) + "  ");
 
                             report.AppendLine(); // separator
                         }
@@ -108,7 +109,7 @@ private void WriteExamples(StringBuilder report, Scenario exampleScenario, IEnum
                 var failingStep = scenario.Steps.FirstOrDefault(s => s.Result == Result.Failed);
                 var error = failingStep == null
                     ? null
-                    : string.Format("Step: {0} failed with exception: {1}", failingStep.Title, CreateExceptionMessage(failingStep));
+                    : string.Format("Step: {0} failed with exception: {1}", HttpUtility.HtmlEncode(failingStep.Title), CreateExceptionMessage(failingStep));
 
                 addRow(scenario.Example.Values.Select(e => e.GetValueAsString()), scenario.Result.ToString(), error);
             }