Merge pull request #51 from MehdiK/self-contained-html-report

makes html report self-contained: fixes #44 & #49

Author: mwhelan

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportBuilder.cs

@@ -40,14 +40,8 @@ private void HtmlHead()
             using(OpenTag(HtmlTag.head))
             {
                 AddLine("<meta charset='utf-8'/>");
-                AddLine(string.Format("<link href='BDDfy.css' rel='stylesheet'/>"));
-                if(_viewModel.UseCustomStylesheet)
-                    AddLine(string.Format("<link href='BDDfyCustom.css' rel='stylesheet'/>"));
-
-                AddLine("<script type='text/javascript' src='jquery-1.7.1.min.js'></script>");
-                AddLine(string.Format("<script type='text/javascript' src='BDDfy.js'></script>"));
-                if (_viewModel.UseCustomJavascript)
-                    AddLine(string.Format("<link href='BDDfyCustom.js' rel='stylesheet'/>"));
+                EmbedCssFile(HtmlReportResources.BDDfy_css);
+                EmbedCssFile(_viewModel.CustomStylesheet, HtmlReportResources.CustomStylesheetComment);
 
                 AddLine(string.Format("<title>BDDfy Test Result {0}</title>", DateTime.Now.ToShortDateString()));
             }
@@ -142,11 +136,15 @@ private void ResultDetails()
         private void Footer()
         {
             AddLine("<div class='footer'>Powered by <a href='https://github.com/TestStack/TestStack.BDDfy'>BDDfy</a> framework</div>");
+            
+            AddLine("<script type='text/javascript' src='https://code.jquery.com/jquery-1.11.0.min.js'></script>");
+            EmbedJavascriptFile(HtmlReportResources.BDDfy_js);
+            EmbedJavascriptFile(_viewModel.CustomJavascript, HtmlReportResources.CustomJavascriptComment);
         }
 
         private void AddStory(Story story)
         {
-            var scenariosInGroup = story.Scenarios;
+            var scenariosInGroup = story.Scenarios.ToList();
             var storyResult = (StepExecutionResult)scenariosInGroup.Max(s => (int)s.Result);
 
             using (OpenTag(HtmlTag.li))
@@ -265,5 +263,32 @@ private void AddLine(string line)
             int tabWidth = _tabCount * TabIndentation;
             _html.AppendLine(string.Empty.PadLeft(tabWidth) + line);
         }
+
+        private void EmbedCssFile(string cssContent, string htmlComment = null)
+        {
+            using (OpenTag("<style type='text/css'>", HtmlTag.style))
+            {
+                AddHtmlComment(htmlComment);
+                _html.AppendLine(cssContent);
+            }
+        }
+
+        private void EmbedJavascriptFile(string javascriptContent, string htmlComment = null)
+        {
+            using (OpenTag(HtmlTag.script))
+            {
+                AddHtmlComment(htmlComment);
+                _html.AppendLine(javascriptContent);
+            }
+        }
+
+        private void AddHtmlComment(string htmlComment)
+        {
+            if (string.IsNullOrWhiteSpace(htmlComment))
+                return;
+
+            _html.AppendFormat("/*{0}*/", htmlComment);
+            _html.AppendLine();
+        }
     }
 }

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportResources.Designer.cs

@@ -124,7 +124,10 @@
   <data name="BDDfy_js" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>BDDfy.js;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;utf-8</value>
   </data>
-  <data name="jquery_1_7_1_min" type="System.Resources.ResXFileRef, System.Windows.Forms">
-    <value>jquery-1.7.1.min.js;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;utf-8</value>
+  <data name="CustomJavascriptComment" xml:space="preserve">
+    <value>If you drop a custom Javascript named BDDfyCustom.js in your output folder it gets embedded here. This way you can apply some custom Javascript logic to your html report.</value>
+  </data>
+  <data name="CustomStylesheetComment" xml:space="preserve">
+    <value>If you drop a custom stylesheet named BDDfyCustom.css in your output folder it gets embedded here. This way you can apply some custom styles over your html report.</value>
   </data>
 </root>

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportResources.resx

@@ -11,8 +11,8 @@ public HtmlReportViewModel(IHtmlReportConfiguration configuration, IEnumerable<S
             Configuration = configuration;
         }
 
-        public bool UseCustomStylesheet { get; set; }
-        public bool UseCustomJavascript { get; set; }
+        public string CustomStylesheet { get; set; }
+        public string CustomJavascript { get; set; }
 
         public IHtmlReportConfiguration Configuration { get; private set; }
     }

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportViewModel.cs

@@ -24,17 +24,14 @@ public HtmlReporter(IHtmlReportConfiguration configuration, IReportBuilder build
 
         public void Process(IEnumerable<Story> stories)
         {
-            WriteOutScriptFiles();
-
             var allowedStories = stories.Where(s => _configuration.RunsOn(s)).ToList();
             WriteOutHtmlReport(allowedStories);
         }
 
-
         void WriteOutHtmlReport(IEnumerable<Story> stories)
         {
             var viewModel = new HtmlReportViewModel(_configuration, stories);
-            ShouldTheReportUseCustomization(viewModel);
+            LoadCustomScripts(viewModel);
             string report;
 
             try
@@ -49,20 +46,15 @@ void WriteOutHtmlReport(IEnumerable<Story> stories)
             _writer.OutputReport(report, _configuration.OutputFileName, _configuration.OutputPath);
         }
 
-        private void ShouldTheReportUseCustomization(HtmlReportViewModel viewModel)
+        private void LoadCustomScripts(HtmlReportViewModel viewModel)
         {
             var customStylesheet = Path.Combine(_configuration.OutputPath, "BDDfyCustom.css");
-            viewModel.UseCustomStylesheet = File.Exists(customStylesheet);
+            if (File.Exists(customStylesheet))
+                viewModel.CustomStylesheet = File.ReadAllText(customStylesheet);
 
             var customJavascript = Path.Combine(_configuration.OutputPath, "BDDfyCustom.js");
-            viewModel.UseCustomJavascript = File.Exists(customJavascript);
-        }
-
-        void WriteOutScriptFiles()
-        {
-            _writer.OutputReport(HtmlReportResources.BDDfy_css, "BDDfy.css", _configuration.OutputPath);
-            _writer.OutputReport(HtmlReportResources.jquery_1_7_1_min, "jquery-1.7.1.min.js", _configuration.OutputPath);
-            _writer.OutputReport(HtmlReportResources.BDDfy_js, "BDDfy.js", _configuration.OutputPath);
+            if(File.Exists(customJavascript))
+                viewModel.CustomJavascript = File.ReadAllText(customJavascript);
         }
     }
 }

TestStack.BDDfy/Processors/Reporters/Html/HtmlReporter.cs

@@ -11,7 +11,9 @@ public enum HtmlTag
         p,
         body,
         header,
-        section
+        section,
+        style,
+        script
     }
     // ReSharper restore InconsistentNaming
 }

TestStack.BDDfy/Processors/Reporters/Html/HtmlTag.cs

@@ -159,7 +159,6 @@
   <ItemGroup>
     <Content Include="Processors\Reporters\Html\BDDfy.css" />
     <Content Include="Processors\Reporters\Html\BDDfy.js" />
-    <Content Include="Processors\Reporters\Html\jquery-1.7.1.min.js" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="Processors\Reporters\Html\HtmlReportResources.resx">