forked from openshift-kni/rds-analyzer
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathanalyzer_test.go
More file actions
446 lines (387 loc) · 10.4 KB
/
analyzer_test.go
File metadata and controls
446 lines (387 loc) · 10.4 KB
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
package analyzer
import (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
"github.com/openshift-kni/rds-analyzer/pkg/types"
)
// testRulesYAML contains a minimal rules configuration for testing.
const testRulesYAML = `
version: "1.0"
description: "Test Rules"
settings:
default_impact: "NeedsReview"
default_severity: "MEDIUM"
label_annotation_rules:
labels: []
annotations: []
default_impact: "NotADeviation"
default_comment: "Labels and annotations are acceptable"
rules:
- id: "R001-test"
description: "Test rule"
match:
crName: "*"
conditions:
- type: "ExpectedFound"
contains: "name:"
impact: "NotImpacting"
comment: "Name changes are acceptable"
`
func createTestRulesFile(t *testing.T) string {
t.Helper()
tmpDir := t.TempDir()
rulesFile := filepath.Join(tmpDir, "rules.yaml")
if err := os.WriteFile(rulesFile, []byte(testRulesYAML), 0644); err != nil {
t.Fatalf("Failed to create test rules file: %v", err)
}
return rulesFile
}
func TestNew_ValidRulesFile(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if a == nil {
t.Fatal("expected analyzer, got nil")
}
}
func TestNew_WithVersion(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "4.19")
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if a == nil {
t.Fatal("expected analyzer, got nil")
}
if a.GetTargetVersion() != "4.19" {
t.Errorf("expected version 4.19, got %s", a.GetTargetVersion())
}
}
func TestNew_InvalidRulesFile(t *testing.T) {
_, err := New("/nonexistent/rules.yaml", "")
if err == nil {
t.Fatal("expected error for nonexistent rules file, got nil")
}
if !strings.Contains(err.Error(), "failed to initialize rule engine") {
t.Errorf("expected error message about rule engine, got: %v", err)
}
}
func TestNew_InvalidVersion(t *testing.T) {
rulesFile := createTestRulesFile(t)
// Invalid version format should fail
_, err := New(rulesFile, "invalid")
if err == nil {
t.Fatal("expected error for invalid version, got nil")
}
}
func TestAnalyze_TextFormat(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{
NumMissing: 0,
NumDiffCRs: 1,
TotalCRs: 10,
},
Diffs: []types.Diff{
{
DiffOutput: "- name: test\n+ name: changed",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
Description: "Test CR",
},
},
}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "text", "simple")
if err != nil {
t.Fatalf("Analyze failed: %v", err)
}
output := buf.String()
if output == "" {
t.Error("expected non-empty output")
}
}
func TestAnalyze_HTMLFormat(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{
NumMissing: 0,
NumDiffCRs: 1,
TotalCRs: 5,
},
Diffs: []types.Diff{
{
DiffOutput: "- value: old\n+ value: new",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
},
},
}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "html", "simple")
if err != nil {
t.Fatalf("Analyze failed: %v", err)
}
output := buf.String()
if !strings.Contains(output, "<!DOCTYPE html>") {
t.Error("expected HTML output")
}
}
func TestAnalyze_ReportingMode(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{
NumMissing: 0,
NumDiffCRs: 1,
TotalCRs: 5,
},
Diffs: []types.Diff{
{
DiffOutput: "- config: expected\n+ config: found",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
},
},
}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "text", "reporting")
if err != nil {
t.Fatalf("Analyze failed: %v", err)
}
output := buf.String()
if output == "" {
t.Error("expected non-empty output for reporting mode")
}
}
func TestAnalyze_UnsupportedFormat(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "unsupported", "simple")
if err == nil {
t.Fatal("expected error for unsupported format, got nil")
}
if !strings.Contains(err.Error(), "unsupported output format") {
t.Errorf("expected error about unsupported format, got: %v", err)
}
}
func TestGetTargetVersion_NoVersion(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
// Without specifying a version, GetTargetVersion might return empty or default
version := a.GetTargetVersion()
// Just ensure it doesn't panic and returns a string
_ = version
}
func TestGetTargetVersion_WithVersion(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "4.20")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
version := a.GetTargetVersion()
if version != "4.20" {
t.Errorf("expected version 4.20, got %s", version)
}
}
func TestAnalyze_EmptyReport(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "text", "simple")
if err != nil {
t.Fatalf("Analyze should handle empty report: %v", err)
}
}
func TestNewFromBytes_ValidRules(t *testing.T) {
a, err := NewFromBytes([]byte(testRulesYAML), "")
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if a == nil {
t.Fatal("expected analyzer, got nil")
}
}
func TestNewFromBytes_WithVersion(t *testing.T) {
a, err := NewFromBytes([]byte(testRulesYAML), "4.19")
if err != nil {
t.Fatalf("expected no error, got %v", err)
}
if a.GetTargetVersion() != "4.19" {
t.Errorf("expected version 4.19, got %s", a.GetTargetVersion())
}
}
func TestNewFromBytes_InvalidYAML(t *testing.T) {
_, err := NewFromBytes([]byte("not: [valid: yaml"), "")
if err == nil {
t.Fatal("expected error for invalid YAML, got nil")
}
}
func TestNewFromBytes_InvalidVersion(t *testing.T) {
_, err := NewFromBytes([]byte(testRulesYAML), "invalid")
if err == nil {
t.Fatal("expected error for invalid version, got nil")
}
}
func TestNewFromBytes_InvalidRegex(t *testing.T) {
invalidRules := `
version: "1.0"
settings:
default_impact: "NeedsReview"
rules:
- id: "bad-rule"
match: {}
conditions:
- type: "Any"
regex: "[unclosed"
impact: "Impacting"
comment: "bad regex"
`
_, err := NewFromBytes([]byte(invalidRules), "")
if err == nil {
t.Fatal("expected error for invalid regex, got nil")
}
if !strings.Contains(err.Error(), "failed to initialize rule engine") {
t.Errorf("expected rule engine error, got: %v", err)
}
}
func TestNewFromBytes_ProducesSameOutputAsNew(t *testing.T) {
rulesFile := createTestRulesFile(t)
fileAnalyzer, err := New(rulesFile, "4.20")
if err != nil {
t.Fatalf("Failed to create file analyzer: %v", err)
}
bytesAnalyzer, err := NewFromBytes([]byte(testRulesYAML), "4.20")
if err != nil {
t.Fatalf("Failed to create bytes analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{
NumDiffCRs: 1,
TotalCRs: 5,
},
Diffs: []types.Diff{
{
DiffOutput: "- name: test\n+ name: changed",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
},
},
}
var fileBuf, bytesBuf bytes.Buffer
if err := fileAnalyzer.Analyze(&fileBuf, report, "text", "simple"); err != nil {
t.Fatalf("File analyzer failed: %v", err)
}
if err := bytesAnalyzer.Analyze(&bytesBuf, report, "text", "simple"); err != nil {
t.Fatalf("Bytes analyzer failed: %v", err)
}
if fileBuf.String() != bytesBuf.String() {
t.Error("file-based and bytes-based analyzers produced different output")
}
}
func TestNewFromBytes_HTMLFormat(t *testing.T) {
a, err := NewFromBytes([]byte(testRulesYAML), "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{NumDiffCRs: 1, TotalCRs: 5},
Diffs: []types.Diff{
{
DiffOutput: "- value: old\n+ value: new",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
},
},
}
var buf bytes.Buffer
if err := a.Analyze(&buf, report, "html", "simple"); err != nil {
t.Fatalf("Analyze failed: %v", err)
}
if !strings.Contains(buf.String(), "<!DOCTYPE html>") {
t.Error("expected HTML output")
}
}
func TestNewFromBytes_ReportingMode(t *testing.T) {
a, err := NewFromBytes([]byte(testRulesYAML), "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{NumDiffCRs: 1, TotalCRs: 5},
Diffs: []types.Diff{
{
DiffOutput: "- config: expected\n+ config: found",
CorrelatedTemplate: "test/TestCR.yaml",
CRName: "v1_ConfigMap_default_test",
},
},
}
var buf bytes.Buffer
if err := a.Analyze(&buf, report, "text", "reporting"); err != nil {
t.Fatalf("Analyze failed: %v", err)
}
if buf.String() == "" {
t.Error("expected non-empty output for reporting mode")
}
}
func TestAnalyze_WithMissingCRs(t *testing.T) {
rulesFile := createTestRulesFile(t)
a, err := New(rulesFile, "")
if err != nil {
t.Fatalf("Failed to create analyzer: %v", err)
}
report := types.ValidationReport{
Summary: types.Summary{
NumMissing: 2,
NumDiffCRs: 0,
TotalCRs: 10,
ValidationIssues: types.ValidationIssues{
"required-config": {
"missing-cr": types.Deviation{
Msg: "Missing required CR",
CRs: []string{"required/TestCR.yaml"},
},
},
},
},
Diffs: []types.Diff{},
}
var buf bytes.Buffer
err = a.Analyze(&buf, report, "text", "simple")
if err != nil {
t.Fatalf("Analyze failed: %v", err)
}
output := buf.String()
if output == "" {
t.Error("expected non-empty output")
}
}