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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
|
package internal
import (
"os"
"path/filepath"
"strings"
"testing"
"time"
)
// TestHtmlStatusBadge tests the htmlStatusBadge function.
func TestHtmlStatusBadge(t *testing.T) {
tests := []struct {
status nagiosCode
expected string
}{
{nagiosOk, `<span class="OK">OK</span>`},
{nagiosWarning, `<span class="WARNING">WARNING</span>`},
{nagiosCritical, `<span class="CRITICAL">CRITICAL</span>`},
{nagiosUnknown, `<span class="UNKNOWN">UNKNOWN</span>`},
}
for _, tt := range tests {
result := htmlStatusBadge(tt.status)
if result != tt.expected {
t.Errorf("htmlStatusBadge(%v) = %q, want %q", tt.status, result, tt.expected)
}
}
}
// TestHtmlHeader tests the htmlHeader function.
func TestHtmlHeader(t *testing.T) {
subject := "GOGIOS Report [C:1 W:2 U:3 S:4 OK:5]"
result := htmlHeader(subject, 1, 2, 3, 4, 5)
// Check that the header contains expected elements
expectedElements := []string{
"<!DOCTYPE html>",
`<html lang="en">`,
"<head>",
`<meta charset="UTF-8">`,
`<meta name="viewport"`,
"<title>",
subject,
`<meta http-equiv="refresh" content="300">`,
"<style>",
".CRITICAL { color: #dc3545; }",
".WARNING { color: #ff8c00; }",
"Gogios Status Report",
"C:1 W:2 U:3 S:4 OK:5",
"Last Updated:",
}
for _, elem := range expectedElements {
if !strings.Contains(result, elem) {
t.Errorf("htmlHeader() missing expected element: %q", elem)
}
}
}
// TestHtmlFooter tests the htmlFooter function.
func TestHtmlFooter(t *testing.T) {
result := htmlFooter()
expectedElements := []string{
"Generated by Gogios at",
"</div>",
"</body>",
"</html>",
}
for _, elem := range expectedElements {
if !strings.Contains(result, elem) {
t.Errorf("htmlFooter() missing expected element: %q", elem)
}
}
}
// TestHtmlReportBy tests the htmlReportBy method with various filters.
func TestHtmlReportBy(t *testing.T) {
now := time.Now().Unix()
staleEpoch := now - 7200 // 2 hours ago
s := state{
staleEpoch: staleEpoch,
checks: map[string]checkState{
"check1": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Service is down",
},
"check2": {
Status: nagiosWarning,
PrevStatus: nagiosWarning,
Epoch: now,
Output: "High load",
},
"check3": {
Status: nagiosOk,
PrevStatus: nagiosOk,
Epoch: staleEpoch - 100, // stale
Output: "All good",
},
},
}
// Test critical filter
var sb strings.Builder
count := s.htmlReportBy(&sb, false, false, func(cs checkState) bool {
return cs.Status == nagiosCritical
})
if count != 1 {
t.Errorf("htmlReportBy(critical filter) count = %d, want 1", count)
}
result := sb.String()
if !strings.Contains(result, "check1") {
t.Error("htmlReportBy(critical filter) missing check1")
}
if !strings.Contains(result, "Service is down") {
t.Error("htmlReportBy(critical filter) missing output text")
}
if !strings.Contains(result, "CRITICAL") {
t.Error("htmlReportBy(critical filter) missing CRITICAL status")
}
// Test status change filter
sb.Reset()
count = s.htmlReportBy(&sb, true, false, func(cs checkState) bool {
return cs.Status == nagiosCritical && cs.changed()
})
if count != 1 {
t.Errorf("htmlReportBy(changed filter) count = %d, want 1", count)
}
result = sb.String()
if !strings.Contains(result, "→") {
t.Error("htmlReportBy(changed filter) missing status change arrow")
}
if !strings.Contains(result, "OK") {
t.Error("htmlReportBy(changed filter) missing previous OK status")
}
}
// TestHtmlReportChanged tests the htmlReportChanged method.
func TestHtmlReportChanged(t *testing.T) {
now := time.Now().Unix()
s := state{
staleEpoch: now - 3600,
checks: map[string]checkState{
"check1": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Service failed",
},
"check2": {
Status: nagiosOk,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Still OK",
},
},
}
var sb strings.Builder
changed := s.htmlReportChanged(&sb)
if !changed {
t.Error("htmlReportChanged() returned false, want true")
}
result := sb.String()
if !strings.Contains(result, "check1") {
t.Error("htmlReportChanged() missing changed check")
}
if strings.Contains(result, "check2") {
t.Error("htmlReportChanged() should not include unchanged check")
}
}
// TestHtmlReport tests the complete HTML report generation.
func TestHtmlReport(t *testing.T) {
now := time.Now().Unix()
staleEpoch := now - 3600
s := state{
staleEpoch: staleEpoch,
checks: map[string]checkState{
"critical_check": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Service is down",
},
"warning_check": {
Status: nagiosWarning,
PrevStatus: nagiosWarning,
Epoch: now,
Output: "High CPU usage",
},
"ok_check": {
Status: nagiosOk,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Everything fine",
},
"stale_check": {
Status: nagiosOk,
PrevStatus: nagiosOk,
Epoch: staleEpoch - 100,
Output: "Not updated recently",
},
},
}
subject := "GOGIOS Report [C:1 W:1 U:0 S:1 OK:2]"
result := s.htmlReport(subject)
// Check that all major sections are present
expectedSections := []string{
"<!DOCTYPE html>",
"Gogios Status Report",
"Alerts with status changed",
"Unhandled alerts",
"Stale alerts",
"Generated by Gogios",
"</html>",
}
for _, section := range expectedSections {
if !strings.Contains(result, section) {
t.Errorf("htmlReport() missing section: %q", section)
}
}
// Check that check names appear
if !strings.Contains(result, "critical_check") {
t.Error("htmlReport() missing critical_check")
}
if !strings.Contains(result, "warning_check") {
t.Error("htmlReport() missing warning_check")
}
// Check status summary
if !strings.Contains(result, "C:1 W:1 U:0 S:1 OK:2") {
t.Error("htmlReport() missing correct status summary")
}
}
// TestHtmlEscaping tests that HTML special characters are properly escaped.
func TestHtmlEscaping(t *testing.T) {
now := time.Now().Unix()
s := state{
staleEpoch: now - 3600,
checks: map[string]checkState{
"<script>alert('xss')</script>": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Output with <tags> & \"quotes\"",
},
},
}
var sb strings.Builder
s.htmlReportBy(&sb, false, false, func(cs checkState) bool {
return cs.Status == nagiosCritical
})
result := sb.String()
// Check that HTML is escaped
if strings.Contains(result, "<script>") {
t.Error("htmlReportBy() did not escape <script> tag in check name")
}
if !strings.Contains(result, "<script>") {
t.Error("htmlReportBy() missing escaped <script> tag")
}
if strings.Contains(result, "<tags>") && !strings.Contains(result, "<tags>") {
t.Error("htmlReportBy() did not escape <tags> in output")
}
}
// TestPersistHTMLReport tests the file creation and atomic write.
func TestPersistHTMLReport(t *testing.T) {
// Create a temporary directory for testing
tmpDir := t.TempDir()
htmlFile := filepath.Join(tmpDir, "subdir", "status.html")
conf := config{
HTMLStatusFile: htmlFile,
}
now := time.Now().Unix()
s := state{
staleEpoch: now - 3600,
checks: map[string]checkState{
"test_check": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Test output",
},
},
}
subject := "GOGIOS Report [C:1 W:0 U:0 S:0 OK:0]"
// Test that the function creates the directory and file
err := persistHTMLReport(s, subject, conf)
if err != nil {
t.Fatalf("persistHTMLReport() error = %v", err)
}
// Check that the file was created
if _, err := os.Stat(htmlFile); os.IsNotExist(err) {
t.Error("persistHTMLReport() did not create the HTML file")
}
// Check that the temp file was removed
tmpFile := htmlFile + ".tmp"
if _, err := os.Stat(tmpFile); !os.IsNotExist(err) {
t.Error("persistHTMLReport() did not clean up temporary file")
}
// Read and verify the content
content, err := os.ReadFile(htmlFile)
if err != nil {
t.Fatalf("Failed to read HTML file: %v", err)
}
contentStr := string(content)
if !strings.Contains(contentStr, "<!DOCTYPE html>") {
t.Error("HTML file missing DOCTYPE declaration")
}
if !strings.Contains(contentStr, "test_check") {
t.Error("HTML file missing test check")
}
if !strings.Contains(contentStr, "Test output") {
t.Error("HTML file missing check output")
}
if !strings.Contains(contentStr, "C:1 W:0 U:0 S:0 OK:0") {
t.Error("HTML file missing status summary")
}
}
// TestFederatedChecks tests HTML generation for federated checks.
func TestFederatedChecks(t *testing.T) {
now := time.Now().Unix()
s := state{
staleEpoch: now - 3600,
checks: map[string]checkState{
"remote_check": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Remote service down",
FederatedFrom: "remote.example.com",
},
},
}
var sb strings.Builder
s.htmlReportBy(&sb, false, false, func(cs checkState) bool {
return cs.Status == nagiosCritical
})
result := sb.String()
if !strings.Contains(result, "federated from") {
t.Error("htmlReportBy() missing federated indicator")
}
if !strings.Contains(result, "remote.example.com") {
t.Error("htmlReportBy() missing federated hostname")
}
}
// TestW3CCompliance tests that generated HTML meets W3C HTML5 standards.
func TestW3CCompliance(t *testing.T) {
now := time.Now().Unix()
s := state{
staleEpoch: now - 3600,
checks: map[string]checkState{
"test_check": {
Status: nagiosCritical,
PrevStatus: nagiosOk,
Epoch: now,
Output: "Test output",
},
},
}
subject := "GOGIOS Report [C:1 W:0 U:0 S:0 OK:0]"
html := s.htmlReport(subject)
// W3C HTML5 Required Elements
requiredElements := map[string]string{
"DOCTYPE": "<!DOCTYPE html>",
"html with lang": `<html lang="en">`,
"charset meta": `<meta charset="UTF-8">`,
"viewport meta": `<meta name="viewport"`,
"title": "<title>",
"closing html": "</html>",
"closing head": "</head>",
"closing body": "</body>",
"proper html close": "</html>",
}
for name, elem := range requiredElements {
if !strings.Contains(html, elem) {
t.Errorf("W3C compliance check failed: missing %s (%q)", name, elem)
}
}
// Check that DOCTYPE is at the very beginning
if !strings.HasPrefix(html, "<!DOCTYPE html>") {
t.Error("W3C compliance: DOCTYPE must be the first line")
}
// Check proper tag nesting (basic validation)
htmlTagStart := strings.Index(html, "<html")
htmlTagEnd := strings.LastIndex(html, "</html>")
if htmlTagStart == -1 || htmlTagEnd == -1 {
t.Error("W3C compliance: missing <html> or </html> tag")
}
if htmlTagStart > htmlTagEnd {
t.Error("W3C compliance: </html> appears before <html>")
}
headStart := strings.Index(html, "<head>")
headEnd := strings.Index(html, "</head>")
if headStart == -1 || headEnd == -1 {
t.Error("W3C compliance: missing <head> or </head> tag")
}
if headStart > headEnd {
t.Error("W3C compliance: </head> appears before <head>")
}
bodyStart := strings.Index(html, "<body>")
bodyEnd := strings.LastIndex(html, "</body>")
if bodyStart == -1 || bodyEnd == -1 {
t.Error("W3C compliance: missing <body> or </body> tag")
}
if bodyStart > bodyEnd {
t.Error("W3C compliance: </body> appears before <body>")
}
// Head should come before body
if headEnd > bodyStart {
t.Error("W3C compliance: <head> section should be closed before <body> starts")
}
// Check for proper character encoding in meta tag
if !strings.Contains(html, `charset="UTF-8"`) {
t.Error("W3C compliance: charset should be UTF-8")
}
// Verify no common HTML errors
commonErrors := []string{
"<<", // Double tag opening
">>", // Double tag closing
"< ", // Space after tag opening
" >", // Space before tag closing (in tag name)
"<//>", // Malformed closing tag
"</ >", // Empty closing tag
"< >", // Empty tag
}
for _, err := range commonErrors {
if strings.Contains(html, err) {
t.Errorf("W3C compliance: found malformed HTML pattern: %q", err)
}
}
// Verify all div tags are properly closed
divOpen := strings.Count(html, "<div")
divClose := strings.Count(html, "</div>")
if divOpen != divClose {
t.Errorf("W3C compliance: mismatched div tags (open: %d, close: %d)", divOpen, divClose)
}
// Verify all span tags are properly closed
spanOpen := strings.Count(html, "<span")
spanClose := strings.Count(html, "</span>")
if spanOpen != spanClose {
t.Errorf("W3C compliance: mismatched span tags (open: %d, close: %d)", spanOpen, spanClose)
}
}
|
