/
report.go
265 lines (248 loc) · 10.4 KB
/
report.go
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
// Copyright 2017 Intel Corporation.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package test
import (
"encoding/json"
"fmt"
"html/template"
"os"
"strconv"
"time"
)
// TeststuiteReport has information about all test results.
type TestsuiteReport struct {
Timestamp string
Tests []*TestcaseReportInfo
}
// TestcaseReportInfo has all info about test.
type TestcaseReportInfo struct {
TestName string
Status TestStatus
// Pktgen type tests
PktgenBenchdata []PktgenMeasurement `json:",omitempty"`
CoresStats *ReportCoresInfo `json:",omitempty"`
// Apache benchmark type tests
ABStats *ApacheBenchmarkStats `json:",omitempty"`
// Latency type tests
LatStats *LatencyStats `json:",omitempty"`
// Latency type tests
WStats *WrkBenchmarkStats `json:",omitempty"`
// Per application statistics
Apps []RunningApp `json:"-"`
}
// Report represents test report.
type Report struct {
output *os.File
t *template.Template
report TestsuiteReport
json *os.File
}
const (
statusTemplate = `{{define "statusLine"}}<font color="{{if eq . %d}}green{{else}}red{{end}}">{{.}}</font>{{end}}`
reportTemplate = `{{define "testreport"}}<!DOCTYPE html><html>
<head>
<meta charset="UTF-8">
<style>
table {
border: 3pt solid black;
border-collapse: collapse;
text-align: left;
}
table.bench {
border: 3pt solid black;
border-collapse: collapse;
text-align: right;
}
th {
text-align:center;
}
th.thinrborder {
border-right: 1pt solid grey;
border-bottom: 1pt solid grey;
}
th.rbborder {
border-right: 3pt solid black;
border-bottom: 1pt solid grey;
}
tr.test {
border-top: 3pt solid black;
}
td.rborder {
border-right: 3pt solid black;
}
td.thinrborder {
border-right: 1pt solid grey;
}
td.thinrborderstatnames {
border-right: 1pt solid grey;
text-align: left;
}
</style>
<script>
function toggleVisibility(buttonID, idArray) {
for(i = 0; i < idArray.length; i++) {
element = document.getElementById(idArray[i])
if (element.style.display=='none') {
element.style.display='table-row'
}
else {
element.style.display='none'
}
}
button = document.getElementById(buttonID);
if (button.value == "Show details") {
button.value = "Hide details";
} else {
button.value = "Show details";
}
}
</script>
<title>Test report from {{.Timestamp}}</title>
</head>
<body>
<h1>Test report from {{.Timestamp}}</h1>
<table style="width:100%">
{{range $testindex, $testelement := .Tests}}<tr class="test">
<td>
{{with $buttonid := genbuttonid $testindex}}<input onclick="toggleVisibility('{{$buttonid}}', [{{range $appindex, $appelement := $testelement.Apps}}'{{genappid $testindex $appindex}}', {{end}}])" type="button" value="Show details" id="{{$buttonid}}"></input>{{end}}
{{.TestName}}
</td><td>
{{block "statusLine" .Status}}{{end}}{{if .PktgenBenchdata}}{{with .PktgenBenchdata}}
<table class="bench">
<tr>
<th class="rbborder">Port</th>
{{range $index, $element := .}}<th colspan="4" class="rbborder">{{$index}}</th>{{end}}
<th colspan = "4" class="rbborder">Cores</th>
</tr><tr>
<th class="rbborder"></th>
{{range .}}<th class="thinrborder">Pkts TX</th><th class="thinrborder">Mbit TX</th><th class="thinrborder">Pkts RX</th><th class="rbborder">Mbit RX</th>{{end}}
<th class="thinrborder">Used</th><th class="thinrborder">Free</th><th class="thinrborder">Last</th><th class="rbborder">Decreased</th>
</tr><tr>
<td class="rborder">Average</td>{{range .}}<td>{{.PktsTX}}</td><td>{{.MbitsTX}}</td><td>{{.PktsRX}}</td><td class="rborder">{{.MbitsRX}}</td>{{end}}{{end}}{{/* end with .PktgenBenchdata */}}
<td class="thinrborder">{{.CoresStats.CoresUsed}}</td><td class="thinrborder">{{.CoresStats.CoresFree}}</td><td class="thinrborder">{{.CoresStats.CoreLastValue}}</td><td class="rborder">{{if .CoresStats.CoreDecreased}}YES{{else}}NO{{end}}</td>
</tr>
</table>{{end}}{{/* end if .PktgenBenchdata */}}{{if .ABStats}}{{with .ABStats}}
<table class="bench">
<tr>
<td class="thinrborderstatnames">Requests per second [#/sec] (mean)</td><td>{{index .Stats 0}}</td>
</tr><tr>
<td class="thinrborderstatnames">Time per request [ms] (mean)</td><td>{{index .Stats 1}}</td>
</tr><tr>
<td class="thinrborderstatnames">Time per request [ms] (mean, across all concurrent requests)</td><td>{{index .Stats 2}}</td>
</tr><tr>
<td class="thinrborderstatnames">Transfer rate [Kbytes/sec] received</td><td>{{index .Stats 3}}</td>
</tr>
</table>{{end}}{{/* end with .ABStats */}}{{end}}{{/* end if .ABStats */}}{{if .LatStats}}{{with .LatStats}}
<table class="bench">
<tr>
<td class="thinrborderstatnames">Received/sent [%]</td><td>{{index .Stats 0}}</td>
</tr><tr>
<td class="thinrborderstatnames">Median [us]</td><td>{{index .Stats 2}}</td>
</tr><tr>
<td class="thinrborderstatnames">Average [us]</td><td>{{index .Stats 3}}</td>
</tr><tr>
<td class="thinrborderstatnames">Stddev [us]</td><td>{{index .Stats 4}}</td>
</tr><tr>
<td class="thinrborderstatnames">Requested speed [Pkts/sec]</td><td>{{index .Stats 1}}</td>
</tr>
</table>{{end}}{{/* end with .LatStats */}}{{end}}{{/* end if .LatStats */}}{{if .WStats}}{{with .WStats}}
<table class="bench">
<tr>
<td class="thinrborderstatnames">Requests per second [#/sec]</td><td>{{index .Stats 0}}</td>
</tr><tr>
<td class="thinrborderstatnames">Transfer rate [Kbytes/sec] received</td><td>{{index .Stats 1}}</td>
</tr>
</table>{{end}}{{/* end with .WStats */}}{{end}}{{/* end if .WStats */}}
</td>
</tr>{{range $appindex, $appelement := .Apps}}<tr style='display:none' id='{{genappid $testindex $appindex}}'>
<td>
<a {{getloggerfile .}}>{{.String}}</a>
</td>
<td>
{{block "statusLine" .Status}}{{end}}{{with .PktgenBenchdata}}<table class="bench">{{range $index, $element := .}}{{if eq $index 0}}<tr>
<th class="rbborder">Port</th>
{{range $port, $e := $element}}<th colspan="4" class="rbborder">{{$port}}</th>{{end}}
</tr><tr>
<th class="rbborder"></th>
{{range $element}}<th class="thinrborder">Pkts TX</th><th class="thinrborder">Mbit TX</th><th class="thinrborder">Pkts RX</th><th class="rbborder">Mbit RX</th>{{end}}
</tr>{{end}}{{/* end of table header */}}<tr>
<td class="rborder">{{$index}}</td>{{range $element}}<td class="thinrborder">{{.PktsTX}}</td><td class="thinrborder">{{.MbitsTX}}</td><td class="thinrborder">{{.PktsRX}}</td><td class="rborder">{{.MbitsRX}}</td>{{end}}{{/* end range over pktgen data */}}
</tr>
{{end}}</table>{{end}}{{/* end with .PktgenBenchdata */}}{{with .CoresStats}}<table class="bench">
<tr>
<th class="rbborder"></th>
<th colspan="2" class="rbborder">Cores</th>
</tr>
<tr>
<th class="rbborder">Measurement</th>
<th class="thinrborder">Used</th><th class="thinrborder">Free</th>
</tr>{{range $index, $element := .}}<tr>
<td class="rborder">{{$index}}</td>
<td class="thinrborder">{{.CoresUsed}}</td><td class="thinrborder">{{.CoresFree}}</td>
</tr>{{end}}{{/* end range over cores array */}}
</table>{{end}}{{/* end with .CoresStats */}}
</td>
</tr>{{end}}{{/* end range over apps */}}{{end}}{{/* end range over tests */}}</table></body></html>{{end}}{{/* end template */}}`
)
var (
funcs = template.FuncMap{
"genbuttonid": func(index int) string { return "test-" + strconv.Itoa(index) },
"genappid": func(testindex, appindex int) string {
return "app-" + strconv.Itoa(testindex) + "-" + strconv.Itoa(appindex)
},
"getloggerfile": func(app RunningApp) template.HTMLAttr {
if app.Logger != nil {
return template.HTMLAttr("href=\"" + app.Logger.String() + "\"")
}
return ""
},
}
)
// StartReport initializes and starts report writing.
func StartReport(logdir string) *Report {
var r Report
var err error
// Parse report templates
r.t = template.New("report")
r.t, err = r.t.Parse(fmt.Sprintf(statusTemplate, TestReportedPassed))
if err != nil {
LogError("Report status template parse error:", err)
return nil
}
r.t, err = r.t.Funcs(funcs).Parse(reportTemplate)
if err != nil {
LogError("Report body template parse error:", err)
return nil
}
// Open html report file
htmlname := logdir + string(os.PathSeparator) + "index.html"
r.output, err = os.Create(htmlname)
if err != nil {
LogError("Failed to create report file", htmlname, err)
return nil
}
jsonname := logdir + string(os.PathSeparator) + "report.json"
r.json, err = os.Create(jsonname)
if err != nil {
LogError("Failed to create report file", jsonname, err)
return nil
}
r.report.Timestamp = time.Now().Format(time.RFC3339)
return &r
}
func (r *Report) AddTestResult(tr *TestcaseReportInfo) {
r.report.Tests = append(r.report.Tests, tr)
}
// FinishReport writes report into html and json files.
func (r *Report) FinishReport() {
err := r.t.ExecuteTemplate(r.output, "testreport", &r.report)
LogErrorsIfNotNil(err)
r.output.Close()
enc := json.NewEncoder(r.json)
enc.Encode(&r.report)
r.json.Close()
}
func (ts TestStatus) MarshalJSON() ([]byte, error) {
return json.Marshal(ts.String())
}