-
Notifications
You must be signed in to change notification settings - Fork 84
/
ClassicReportBuilder.cs
389 lines (331 loc) · 15 KB
/
ClassicReportBuilder.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web;
using TestStack.BDDfy.Configuration;
namespace TestStack.BDDfy.Reporters.Html
{
public class ClassicReportBuilder : IReportBuilder
{
private HtmlReportModel _model;
readonly StringBuilder _html;
const int TabIndentation = 2;
int _tabCount;
public ClassicReportBuilder()
{
_html = new StringBuilder();
}
string IReportBuilder.CreateReport(FileReportModel model)
{
return CreateReport(model as HtmlReportModel);
}
public string CreateReport(HtmlReportModel model)
{
_model = model;
AddLine("<!DOCTYPE html>");
using (OpenTag(HtmlTag.html))
{
HtmlHead();
HtmlBody();
}
return _html.ToString();
}
private void HtmlHead()
{
using (OpenTag(HtmlTag.head))
{
AddLine("<meta charset='utf-8'/>");
EmbedCssFile(HtmlReportResources.classic_css_min);
EmbedCssFile(_model.CustomStylesheet, HtmlReportResources.CustomStylesheetComment);
AddLine(string.Format("<title>BDDfy Test Result {0}</title>", _model.RunDate.ToShortDateString()));
}
}
private void HtmlBody()
{
using (OpenTag(HtmlTag.body))
{
using (OpenTag("<div id='main'>", HtmlTag.div))
{
Header();
ResultSummary();
ResultDetails();
}
Footer();
}
}
private void Header()
{
using (OpenTag("<div class='header'>", HtmlTag.div))
{
AddLine(string.Format("<div id='BDDfyTitle'>{0}</div>", _model.Configuration.ReportHeader));
AddLine(string.Format("<div id='BDDfyDescription'>{0}</div>", _model.Configuration.ReportDescription));
}
}
private void ResultSummary()
{
using (OpenTag("<section class='summary'>", HtmlTag.section))
{
AddLine("<h3 class='label'>Summary:</h3>");
using (OpenTag("<ul class='resultSummary'>", HtmlTag.ul))
{
AddSummaryLine("storySummary", "Stories", _model.Summary.Stories);
AddSummaryLine("scenarioSummary", "Scenarios", _model.Summary.Scenarios);
AddSummaryLine("Passed", "Passed", _model.Summary.Passed);
AddSummaryLine("Inconclusive", "Inconclusive", _model.Summary.Inconclusive);
AddSummaryLine("NotImplemented", "Not Implemented", _model.Summary.NotImplemented);
AddSummaryLine("Failed", "Failed", _model.Summary.Failed);
}
}
}
private void AddSummaryLine(string cssClass, string label, int count)
{
using (OpenTag(string.Format("<li class='{0}'>", cssClass), HtmlTag.li))
{
using (OpenTag("<div class='summaryLine'>", HtmlTag.div))
{
AddLine(string.Format("<div class='summaryLabel'>{0}</div>", label));
AddLine(string.Format("<span class='summaryCount'>{0}</span>", count));
}
}
}
private void ExpandCollapse()
{
using (OpenTag("<div id='expandCollapse'>", HtmlTag.div))
{
AddLine("<a href='#' class='expandAll'>[expand all]</a>");
AddLine("<a href='#' class='collapseAll'>[collapse all]</a>");
}
}
private void ResultDetails()
{
using (OpenTag("<div id='testResult'>", HtmlTag.div))
{
using (OpenTag("<div id='detailsHeader'>", HtmlTag.div))
{
AddLine("<h3 id='detailsLable'>Details:</h3>");
ExpandCollapse();
}
using (OpenTag("<ul class='testResult'>", HtmlTag.ul))
{
foreach (var story in _model.Stories)
{
AddStory(story);
}
}
AddLine(string.Format("<p><span>Tested at: {0}</span></p>", _model.RunDate));
}
}
private void Footer()
{
AddLine("<div class='footer'>Powered by <a href='https://github.com/TestStack/TestStack.BDDfy'>BDDfy</a> framework</div>");
if (_model.Configuration.ResolveJqueryFromCdn)
AddLine("<script type='text/javascript' src='http://code.jquery.com/jquery-2.1.0.min.js'></script>");
else
EmbedJavascriptFile(HtmlReportResources.jquery_2_1_0_min);
EmbedJavascriptFile(HtmlReportResources.classic_js_min);
EmbedJavascriptFile(_model.CustomJavascript, HtmlReportResources.CustomJavascriptComment);
}
private void AddStory(Story story)
{
var scenariosInGroup = story.Scenarios.ToList();
var scenariosGroupedById = story.Scenarios.GroupBy(s => s.Id);
var storyResult = (Result)scenariosInGroup.Max(s => (int)s.Result);
using (OpenTag(HtmlTag.li))
{
using (OpenTag(string.Format("<div class='story {0}'>", storyResult), HtmlTag.div))
{
AddStoryMetadataAndNarrative(story);
using (OpenTag("<div class='scenarios'>", HtmlTag.div))
{
foreach (var scenario in scenariosGroupedById)
{
AddScenario(scenario.ToArray());
}
}
}
}
}
private void AddScenario(Scenario[] scenarioGroup)
{
using (OpenTag(string.Format("<div class='scenario'>"), HtmlTag.div))
{
if (scenarioGroup.First().Example == null)
AddScenario(scenarioGroup.Single());
else
AddScenarioWithExamples(scenarioGroup);
}
}
private void AddScenarioWithExamples(Scenario[] scenarioGroup)
{
var firstScenario = scenarioGroup.First();
var scenarioResult = (Result)scenarioGroup.Max(s => (int)s.Result);
AddLine(string.Format("<div class='{0} canToggle scenarioTitle' data-toggle-target='{1}'>{2}{3}</div>", scenarioResult, firstScenario.Id, HttpUtility.HtmlEncode(firstScenario.Title), FormatTags(firstScenario.Tags)));
using (OpenTag(string.Format("<ul class='steps' id='{0}'>", firstScenario.Id), HtmlTag.ul))
{
foreach (var step in firstScenario.Steps.Where(s => s.ShouldReport))
{
using (OpenTag(string.Format("<li class='step {0}'>", step.ExecutionOrder), HtmlTag.li))
{
var titleLines = HttpUtility.HtmlEncode(step.Title)
.Split(new[] { Environment.NewLine }, StringSplitOptions.None);
var title = titleLines[0];
AddLine(string.Format("<span>{0}</span>", title));
for (int i = 1; i < titleLines.Length; i++)
AddLine(string.Format("<div class='step-title-extra-lines'>{0}</div>", titleLines[i]));
}
}
AddExamples(scenarioGroup);
}
}
private string FormatTags(List<string> tags)
{
return string.Join(string.Empty, tags.Select(t => string.Format("<div class='tag'>{0}</div>", t)));
}
private void AddExamples(Scenario[] scenarioGroup)
{
var firstScenario = scenarioGroup.First();
var scenarioResult = (Result)scenarioGroup.Max(s => (int)s.Result);
using (OpenTag("<li class='step'>", HtmlTag.li))
{
AddLine("<span class='example-header'>Examples:</span>");
using (OpenTag(string.Format("<table class='examples' style='border-collapse: collapse;margin-left:10px''>"), HtmlTag.table))
{
using (OpenTag("<tr>", HtmlTag.tr))
{
AddLine(string.Format("<th></th>"));
foreach (var header in firstScenario.Example.Headers)
AddLine(string.Format("<th>{0}</th>", header));
if (scenarioResult == Result.Failed)
AddLine(string.Format("<th>Error</th>"));
}
foreach (var scenario in scenarioGroup)
AddExampleRow(scenario, scenarioResult);
}
}
}
private void AddExampleRow(Scenario scenario, Result scenarioResult)
{
using (OpenTag("<tr>", HtmlTag.tr))
{
AddLine(string.Format("<td><Span class='{0}' style='margin-right:4px;' /></td>", scenario.Result));
foreach (var exampleValue in scenario.Example.Values)
AddLine(string.Format("<td>{0}</td>", HttpUtility.HtmlEncode(exampleValue.GetValueAsString())));
if (scenarioResult != Result.Failed)
return;
using (OpenTag("<td>", HtmlTag.td))
{
var failingStep = scenario.Steps.FirstOrDefault(s => s.Result == Result.Failed);
if (failingStep == null)
return;
var exceptionId = Configurator.IdGenerator.GetStepId();
var encodedExceptionMessage = HttpUtility.HtmlEncode(failingStep.Exception.Message);
AddLine(string.Format("<span class='canToggle' data-toggle-target='{0}'>{1}</span>", exceptionId, encodedExceptionMessage));
using (OpenTag(string.Format("<div class='step' id='{0}'>", exceptionId), HtmlTag.div))
{
AddLine(string.Format("<code>{0}</code>", failingStep.Exception.StackTrace));
}
}
}
}
private void AddScenario(Scenario scenario)
{
AddLine(string.Format("<div class='{0} canToggle scenarioTitle' data-toggle-target='{1}'>{2}{3}</div>", scenario.Result, scenario.Id, scenario.Title, FormatTags(scenario.Tags)));
using (OpenTag(string.Format("<ul class='steps' id='{0}'>", scenario.Id), HtmlTag.ul))
{
foreach (var step in scenario.Steps.Where(s => s.ShouldReport))
{
string stepClass = string.Empty;
var reportException = step.Exception != null && step.Result == Result.Failed;
string canToggle = reportException ? "canToggle" : string.Empty;
using (OpenTag(string.Format("<li class='step {0} {1} {2} {3}' data-toggle-target='{4}' >", step.Result, stepClass, step.ExecutionOrder, canToggle, step.Id), HtmlTag.li))
{
var titleLines = step.Title.Split(new[] { Environment.NewLine }, StringSplitOptions.None);
var title = titleLines[0];
if (reportException)
{
stepClass = step.Result + "Exception";
if (!string.IsNullOrEmpty(step.Exception.Message))
title += " [Exception Message: '" + step.Exception.Message + "']";
}
AddLine(string.Format("<span>{0}</span>", title));
for (int i = 1; i < titleLines.Length; i++)
AddLine(string.Format("<div class='step-title-extra-lines'>{0}</div>", titleLines[i]));
if (reportException)
{
using (OpenTag(string.Format("<div class='step {0}' id='{1}'>", stepClass, step.Id), HtmlTag.div))
{
AddLine(string.Format("<code>{0}</code>", step.Exception.StackTrace));
}
}
}
}
}
}
private void AddStoryMetadataAndNarrative(Story story)
{
using (OpenTag("<div class='storyMetadata'>", HtmlTag.div))
{
AddLine(story.Metadata == null
? string.Format("<div class='namespaceName'>{0}</div>", story.Namespace)
: string.Format("<div class='storyTitle'>{0}{1}</div>", story.Metadata.TitlePrefix, story.Metadata.Title));
if (story.Metadata == null || string.IsNullOrEmpty(story.Metadata.Narrative1))
return;
using (OpenTag("<ul class='storyNarrative'>", HtmlTag.ul))
{
AddLine(string.Format("<li>{0}</li>", story.Metadata.Narrative1));
if (!string.IsNullOrEmpty(story.Metadata.Narrative2))
AddLine(string.Format("<li>{0}</li>", story.Metadata.Narrative2));
if (!string.IsNullOrEmpty(story.Metadata.Narrative3))
AddLine(string.Format("<li>{0}</li>", story.Metadata.Narrative3));
}
}
}
private HtmlReportTag OpenTag(string openingTag, HtmlTag tag)
{
AddLine(openingTag);
_tabCount++;
return new HtmlReportTag(tag, CloseTag);
}
private HtmlReportTag OpenTag(HtmlTag tag)
{
AddLine("<" + tag + ">");
_tabCount++;
return new HtmlReportTag(tag, CloseTag);
}
private void CloseTag(HtmlTag tag)
{
_tabCount--;
var tagName = "</" + tag + ">";
AddLine(tagName);
}
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();
}
}
}