apply report parameter pattern to stepdefinition report too

Author: gasparnagy

Reporting/NUnitExecutionReport/NUnitExecutionReportGenerator.cs

@@ -13,9 +13,9 @@ public class NUnitExecutionReportGenerator
     {
         private ReportElements.NUnitExecutionReport report;
         private readonly SpecFlowProject specFlowProject;
-        private readonly TestExecutionReportParameters reportParameters;        
+        private readonly NUnitExecutionReportParameters reportParameters;        
 
-        public NUnitExecutionReportGenerator(TestExecutionReportParameters reportParameters)
+        public NUnitExecutionReportGenerator(NUnitExecutionReportParameters reportParameters)
         {            
             specFlowProject = MsBuildProjectReader.LoadSpecFlowProjectFromMsBuild(reportParameters.ProjectFile);            
             this.reportParameters = reportParameters;

Reporting/NUnitExecutionReport/NUnitExecutionReportParameters.cs

@@ -0,0 +1,17 @@
+using System.IO;
+
+namespace TechTalk.SpecFlow.Reporting.NUnitExecutionReport
+{
+    public class NUnitExecutionReportParameters : ReportParameters
+    {
+        public string LabelledTestOutput { get; private set; }
+        public string XmlTestResult { get; private set; }
+
+        public NUnitExecutionReportParameters(string projectFile, string xmlTestResult, string labelledTestOutput, string outputFile, string xsltFile)
+            : base(projectFile, outputFile, xsltFile)
+        {
+            this.XmlTestResult = Path.GetFullPath(xmlTestResult);
+            this.LabelledTestOutput = Path.GetFullPath(labelledTestOutput);
+        }
+    }
+}

Reporting/ReportParameters.cs

@@ -0,0 +1,18 @@
+using System.IO;
+
+namespace TechTalk.SpecFlow.Reporting
+{
+    public abstract class ReportParameters
+    {
+        public string XsltFile { get; private set; }
+        public string OutputFile { get; private set; }
+        public string ProjectFile { get; private set; }
+
+        protected ReportParameters(string projectFile, string outputFile, string xsltFile)
+        {
+            this.ProjectFile = projectFile;
+            this.OutputFile = Path.GetFullPath(outputFile);
+            this.XsltFile = Path.GetFullPath(xsltFile);
+        }
+    }
+}

Reporting/StepDefinitionReport/StepDefinitionReportGenerator.cs

@@ -6,9 +6,7 @@
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
-using System.Xml;
 using System.Xml.Serialization;
-using System.Xml.Xsl;
 using TechTalk.SpecFlow.Generator.Configuration;
 using TechTalk.SpecFlow.Parser.SyntaxElements;
 using TechTalk.SpecFlow.Reporting.StepDefinitionReport.ReportElements;
@@ -17,42 +15,33 @@ namespace TechTalk.SpecFlow.Reporting.StepDefinitionReport
 {
     public class StepDefinitionReportGenerator
     {
+        public StepDefinitionReportParameters ReportParameters { get; set; }
         private readonly SpecFlowProject specFlowProject;
         private readonly List<BindingInfo> bindings;
         private readonly List<Feature> parsedFeatures;
-        private readonly bool showBindingsWithoutInsance;
 
         private ReportElements.StepDefinitionReport report;
         private Dictionary<BindingInfo, StepDefinition> stepDefByBinding;
         private Dictionary<StepDefinition, BindingInfo> bindingByStepDef;
         private readonly List<StepDefinition> stepDefsWithNoBinding = new List<StepDefinition>();
 
-        public StepDefinitionReportGenerator(string projectFile, string binFolder, bool showBindingsWithoutInsance)
+        public StepDefinitionReportGenerator(StepDefinitionReportParameters reportParameters)
         {
-            specFlowProject = MsBuildProjectReader.LoadSpecFlowProjectFromMsBuild(projectFile);
+            ReportParameters = reportParameters;
 
+            specFlowProject = MsBuildProjectReader.LoadSpecFlowProjectFromMsBuild(reportParameters.ProjectFile);
             parsedFeatures = ParserHelper.GetParsedFeatures(specFlowProject);
 
-            var basePath = Path.Combine(specFlowProject.ProjectFolder, binFolder);
+            var basePath = Path.Combine(specFlowProject.ProjectFolder, reportParameters.BinFolder);
             bindings = BindingCollector.CollectBindings(specFlowProject, basePath);
-
-            this.showBindingsWithoutInsance = showBindingsWithoutInsance;
-        }
-
-        public StepDefinitionReportGenerator(SpecFlowProject specFlowProject, List<BindingInfo> bindings, List<Feature> parsedFeatures, bool showBindingsWithoutInsance)
-        {
-            this.specFlowProject = specFlowProject;
-            this.showBindingsWithoutInsance = showBindingsWithoutInsance;
-            this.bindings = bindings;
-            this.parsedFeatures = parsedFeatures;
         }
 
         public ReportElements.StepDefinitionReport GenerateReport()
         {
             report = new ReportElements.StepDefinitionReport();
             report.ProjectName = specFlowProject.ProjectName;
             report.GeneratedAt = DateTime.Now.ToString("g", CultureInfo.InvariantCulture);
-            report.ShowBindingsWithoutInsance = showBindingsWithoutInsance;
+            report.ShowBindingsWithoutInsance = ReportParameters.ShowBindingsWithoutInsance;
 
             stepDefByBinding = new Dictionary<BindingInfo, StepDefinition>();
             bindingByStepDef = new Dictionary<StepDefinition, BindingInfo>();
@@ -215,17 +204,17 @@ private string GetSampleText(BindingInfo bindingInfo)
             return sampleText;
         }
 
-        public void TransformReport(string outputFilePath, string xsltFile)
+        public void TransformReport()
         {
             XmlSerializer serializer = new XmlSerializer(typeof(ReportElements.StepDefinitionReport), ReportElements.StepDefinitionReport.XmlNamespace);
 
-            if (XsltHelper.IsXmlOutput(outputFilePath))
+            if (XsltHelper.IsXmlOutput(ReportParameters.OutputFile))
             {
-                XsltHelper.TransformXml(serializer, report, outputFilePath);
+                XsltHelper.TransformXml(serializer, report, ReportParameters.OutputFile);
             }
             else
             {
-                XsltHelper.TransformHtml(serializer, report, GetType(), outputFilePath, specFlowProject.GeneratorConfiguration, xsltFile);
+                XsltHelper.TransformHtml(serializer, report, GetType(), ReportParameters.OutputFile, specFlowProject.GeneratorConfiguration, ReportParameters.XsltFile);
             }
         }
 
@@ -355,5 +344,12 @@ private ScenarioStep CloneTo(ScenarioStep step, string currentBlock)
             newStep.TableArg = Clone(step.TableArg);
             return newStep;
         }
+
+
+        public void GenerateAndTransformReport()
+        {
+            GenerateReport();
+            TransformReport();
+        }
     }
 }

Reporting/StepDefinitionReport/StepDefinitionReportParameters.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace TechTalk.SpecFlow.Reporting.StepDefinitionReport
+{
+    public class StepDefinitionReportParameters : ReportParameters
+    {
+        public string BinFolder { get; private set; }
+        public bool ShowBindingsWithoutInsance { get; private set; }
+
+        public StepDefinitionReportParameters(string projectFile, string outputFile, string xsltFile, string binFolder, bool showBindingsWithoutInsance) 
+            : base(projectFile, outputFile, xsltFile)
+        {
+            BinFolder = binFolder;
+            ShowBindingsWithoutInsance = showBindingsWithoutInsance;
+        }
+    }
+}

Reporting/TechTalk.SpecFlow.Reporting.csproj

@@ -60,6 +60,7 @@
     <Compile Include="NUnitExecutionReport\NUnitExecutionReportGenerator.cs" />
     <Compile Include="NUnitExecutionReport\ReportElements\NUnitExecutionReport.cs" />
     <Compile Include="NUnitExecutionReport\ReportElements\ScenarioOutput.cs" />
+    <Compile Include="ReportParameters.cs" />
     <Compile Include="ParserHelper.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
@@ -73,7 +74,8 @@
     <Compile Include="StepDefinitionReport\ReportElements\StepDefinitionReport.cs" />
     <Compile Include="ResourceXmlReader.cs" />
     <Compile Include="StepDefinitionReport\StepDefinitionReportGenerator.cs" />
-    <Compile Include="TestExecutionReportParameters.cs" />
+    <Compile Include="NUnitExecutionReport\NUnitExecutionReportParameters.cs" />
+    <Compile Include="StepDefinitionReport\StepDefinitionReportParameters.cs" />
     <Compile Include="XmlResourceResolver.cs" />
     <Compile Include="XsltHelper.cs" />
   </ItemGroup>

Reporting/TestExecutionReportParameters.cs

@@ -3,7 +3,6 @@
 using NConsoler;
 using TechTalk.SpecFlow.Generator;
 using TechTalk.SpecFlow.Generator.Configuration;
-using TechTalk.SpecFlow.Reporting;
 using TechTalk.SpecFlow.Reporting.NUnitExecutionReport;
 using TechTalk.SpecFlow.Reporting.StepDefinitionReport;
 using MsBuildProjectReader = TechTalk.SpecFlow.Generator.Configuration.MsBuildProjectReader;
@@ -38,9 +37,10 @@ public static void StepDefinitionReport(
             [Optional("bin\\Debug", Description = @"Path for Spec dll e.g. Company.Specs.dll. Defaults to bin\Debug ")] string binFolder,
             [Optional("StepDefinitionReport.html", "out", Description = "Generated Output File. Defaults to StepDefinitionReport.html")] string outputFile)
         {
-            var generator = new StepDefinitionReportGenerator(projectFile, binFolder, true);
-            generator.GenerateReport();
-            generator.TransformReport(Path.GetFullPath(outputFile), xsltFile);
+            StepDefinitionReportParameters reportParameters = 
+                new StepDefinitionReportParameters(projectFile, outputFile, xsltFile, binFolder, true);
+            var generator = new StepDefinitionReportGenerator(reportParameters);
+            generator.GenerateAndTransformReport();
         }
 
         [Action("Formats an NUnit execution report to SpecFlow style")]
@@ -50,8 +50,8 @@ public static void NUnitExecutionReport([Required(Description = "Visual Studio P
             [Optional("TestResult.txt", "testOutput")] string labeledTestOutput,
             [Optional("TestResult.html", "out", Description = "Generated Output File. Defaults to TestResult.html")] string outputFile)
         {
-            TestExecutionReportParameters reportParameters = new TestExecutionReportParameters
-                                    (projectFile, xmlTestResult, labeledTestOutput, outputFile, xsltFile);         
+            NUnitExecutionReportParameters reportParameters = 
+                new NUnitExecutionReportParameters(projectFile, xmlTestResult, labeledTestOutput, outputFile, xsltFile);         
             var generator = new NUnitExecutionReportGenerator(reportParameters);
             generator.GenerateAndTransformReport();
         }