-
Notifications
You must be signed in to change notification settings - Fork 28
Expand file tree
/
Copy pathresult_test.go
More file actions
1525 lines (1312 loc) · 57.1 KB
/
result_test.go
File metadata and controls
1525 lines (1312 loc) · 57.1 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
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//go:build !integration
package commands
import (
"bytes"
"encoding/json"
"fmt"
"io"
"os"
"reflect"
"regexp"
"strings"
"testing"
"github.com/checkmarx/ast-cli/internal/commands/util/printer"
errorConstants "github.com/checkmarx/ast-cli/internal/constants/errors"
params "github.com/checkmarx/ast-cli/internal/params"
"github.com/checkmarx/ast-cli/internal/wrappers"
"github.com/checkmarx/ast-cli/internal/wrappers/mock"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"gotest.tools/assert"
)
const fileName = "cx_result"
const (
resultsCommand = "results"
codeBashingCommand = "codebashing"
vulnerabilityValue = "Reflected XSS All Clients"
languageValue = "PHP"
cweValue = "79"
jsonValue = "json"
tableValue = "table"
listValue = "list"
secretDetectionLine = "| Secret Detection 0 1 1 0 0 Completed |"
)
func flag(f string) string {
return "--" + f
}
func TestResultHelp(t *testing.T) {
execCmdNilAssertion(t, "help", "results")
}
func TestResultsExitCode_CompletedScan_PrintCorrectInfoToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{ID: "MOCK", Status: wrappers.ScanCompleted, Engines: []string{params.ScaType, params.SastType, params.KicsType}}
results := getScannerResponse("", &model)
assert.Equal(t, len(results), 1, "")
assert.Equal(t, results[0].ScanID, "MOCK", "")
assert.Equal(t, results[0].Status, wrappers.ScanCompleted, "")
}
func TestResultsExitCode_OnFailedKicsScanner_PrintCorrectFailedScannerInfoToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-kics-scanner-fail",
Status: wrappers.ScanFailed,
StatusDetails: []wrappers.StatusInfo{
{
Status: wrappers.ScanFailed,
Name: "kics",
Details: "error message from kics scanner",
ErrorCode: 1234,
},
{Status: wrappers.ScanFailed, Name: "general", Details: "timeout", ErrorCode: 1234},
},
}
results := getScannerResponse("", &model)
assert.Equal(t, len(results), 2, "Scanner results should be empty")
assert.Equal(t, results[0].Name, "kics", "")
assert.Equal(t, results[0].ErrorCode, "1234", "")
assert.Equal(t, results[1].Name, "general", "")
assert.Equal(t, results[1].ErrorCode, "1234", "")
assert.Equal(t, results[1].Details, "timeout", "")
}
func TestResultsExitCode_OnFailedKicsAndScaScanners_PrintCorrectFailedScannersInfoToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-multiple-scanner-fails",
Status: wrappers.ScanFailed,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanFailed, Name: "kics", Details: "error message from kics scanner", ErrorCode: 2344},
{Status: wrappers.ScanFailed, Name: "sca", Details: "error message from sca scanner", ErrorCode: 4343},
{Status: wrappers.ScanFailed, Name: "general", Details: "timeout", ErrorCode: 1234},
},
}
results := getScannerResponse("", &model)
assert.Equal(t, len(results), 3, "Scanner results should be empty")
assert.Equal(t, results[0].Name, "kics", "")
assert.Equal(t, results[0].ErrorCode, "2344", "")
assert.Equal(t, results[1].Name, "sca", "")
assert.Equal(t, results[1].ErrorCode, "4343", "")
assert.Equal(t, results[2].Name, "general", "")
assert.Equal(t, results[2].ErrorCode, "1234", "")
assert.Equal(t, results[2].Details, "timeout", "")
}
func TestResultsExitCode_OnRequestedFailedScanner_PrintCorrectFailedScannerInfoToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-multiple-scanner-fails",
Status: wrappers.ScanFailed,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanFailed, Name: "kics", Details: "error message from kics scanner", ErrorCode: 2344},
{Status: wrappers.ScanFailed, Name: "sca", Details: "error message from sca scanner", ErrorCode: 4343},
{Status: wrappers.ScanFailed, Name: "general", Details: "timeout", ErrorCode: 1234},
},
}
results := getScannerResponse("sca", &model)
assert.Equal(t, len(results), 1, "Scanner results should be empty")
assert.Equal(t, results[0].Name, "sca", "")
assert.Equal(t, results[0].ErrorCode, "4343", "")
}
func TestResultsExitCode_OnPartialScan_PrintOnlyFailedScannersInfoToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-sca-fail-partial-id",
Status: wrappers.ScanPartial,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanCompleted, Name: "sast"},
{Status: wrappers.ScanCanceled, Name: "sca", Details: "error message from sca scanner", ErrorCode: 4343},
{Status: wrappers.ScanCompleted, Name: "general"},
},
}
results := getScannerResponse("", &model)
assert.Equal(t, len(results), 1, "Scanner results should be empty")
assert.Equal(t, results[0].ScanID, "fake-scan-id-sca-fail-partial-id", "")
assert.Equal(t, results[0].Status, "Partial", "")
}
func runScanCommand(t *testing.T, agent, scanID string) *wrappers.ScanResultsCollection {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
_, err := executeRedirectedOsStdoutTestCommand(createASTTestCommand(),
"results", "show", "--scan-id", scanID, "--report-format", "json", "--agent", agent)
assert.NilError(t, err)
file, err := os.Open(fileName + ".json")
if err != nil {
t.Fatalf("failed to open file: %v", err)
}
defer func() {
file.Close()
os.Remove(fileName + ".json")
}()
fileContents, err := io.ReadAll(file)
if err != nil {
t.Fatalf("failed to read file: %v", err)
}
var results wrappers.ScanResultsCollection
err = json.Unmarshal(fileContents, &results)
assert.NilError(t, err)
return &results
}
func TestRunScsResultsShow_ASTCLI_AgentShouldShowAllResults(t *testing.T) {
clearFlags()
mock.HasScs = true
mock.ScsScanPartial = false
mock.ScorecardScanned = true
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
execCmdNilAssertion(t, "results", "show", "--scan-id", "SCS_ONLY", "--report-format", "json", "--agent", params.DefaultAgent)
assertTypePresentJSON(t, params.SCSScorecardType, 1)
assertTypePresentJSON(t, params.SCSSecretDetectionType, 2)
assertTotalCountJSON(t, 3)
removeFileBySuffix(t, printer.FormatJSON)
mock.SetScsMockVarsToDefault()
}
func TestRunScsResultsShow_VSCode_AgentShouldNotShowScorecardResults(t *testing.T) {
clearFlags()
mock.HasScs = true
mock.ScsScanPartial = false
mock.ScorecardScanned = true
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
execCmdNilAssertion(t, "results", "show", "--scan-id", "SCS_ONLY", "--report-format", "json", "--agent", params.VSCodeAgent)
assertTypePresentJSON(t, params.SCSScorecardType, 0)
assertTypePresentJSON(t, params.SCSSecretDetectionType, 2)
assertTotalCountJSON(t, 2)
removeFileBySuffix(t, printer.FormatJSON)
mock.SetScsMockVarsToDefault()
}
func TestRunScsResultsShow_Other_AgentsShouldNotShowScsResults(t *testing.T) {
clearFlags()
mock.HasScs = true
mock.ScsScanPartial = false
mock.ScorecardScanned = true
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
execCmdNilAssertion(t, "results", "show", "--scan-id", "SCS_ONLY", "--report-format", "json", "--agent", params.JetbrainsAgent)
assertTypePresentJSON(t, params.SCSScorecardType, 0)
assertTypePresentJSON(t, params.SCSSecretDetectionType, 0)
assertTotalCountJSON(t, 0)
removeFileBySuffix(t, printer.FormatJSON)
mock.SetScsMockVarsToDefault()
}
func TestRunWithoutScsResults_Other_AgentsShouldNotShowScsResults(t *testing.T) {
clearFlags()
mock.HasScs = true
mock.ScsScanPartial = false
mock.ScorecardScanned = true
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
execCmdNilAssertion(t, "results", "show", "--scan-id", "SAST_ONLY", "--report-format", "json", "--agent", params.EclipseAgent)
assertTypePresentJSON(t, params.SCSScorecardType, 0)
assertTypePresentJSON(t, params.SCSSecretDetectionType, 0)
assertTotalCountJSON(t, 1)
removeFileBySuffix(t, printer.FormatJSON)
mock.SetScsMockVarsToDefault()
}
func TestRunNilResults_Other_AgentsShouldNotShowAnyResults(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.SCSEngineCLIEnabled, Status: true}
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK_NO_VULNERABILITIES", "--report-format", "json", "--agent", params.VisualStudioAgent)
assertTypePresentJSON(t, params.SCSScorecardType, 0)
assertTypePresentJSON(t, params.SCSSecretDetectionType, 0)
assertTotalCountJSON(t, 0)
removeFileBySuffix(t, printer.FormatJSON)
}
func TestResultsExitCode_OnCanceledScan_PrintOnlyScanIDAndStatusCanceledToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-kics-fail-sast-canceled-id",
Status: wrappers.ScanCanceled,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanCompleted, Name: "general"},
{Status: wrappers.ScanCompleted, Name: "sast"},
{Status: wrappers.ScanFailed, Name: "kics", Details: "error message from kics scanner", ErrorCode: 6455},
},
}
results := getScannerResponse("", &model)
assert.Equal(t, len(results), 1, "Scanner results should be empty")
assert.Equal(t, results[0].ScanID, "fake-scan-id-kics-fail-sast-canceled-id", "")
assert.Equal(t, results[0].Status, wrappers.ScanCanceled, "")
}
func TestResultsExitCode_OnCanceledScanWithRequestedSuccessfulScanner_PrintOnlyScanIDAndStatusCanceledToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-kics-fail-sast-canceled-id",
Status: wrappers.ScanCanceled,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanCompleted, Name: "general"},
{Status: wrappers.ScanCompleted, Name: "sast"},
{Status: wrappers.ScanFailed, Name: "kics", Details: "error message from kics scanner", ErrorCode: 6455},
},
}
results := getScannerResponse("sast", &model)
assert.Equal(t, len(results), 1, "Scanner results should be empty")
assert.Equal(t, results[0].ScanID, "fake-scan-id-kics-fail-sast-canceled-id", "")
assert.Equal(t, results[0].Status, wrappers.ScanCanceled, "")
}
func TestResultsExitCode_OnCanceledScanWithRequestedFailedScanner_PrintOnlyScanIDAndStatusCanceledToConsole(t *testing.T) {
model := wrappers.ScanResponseModel{
ID: "fake-scan-id-kics-fail-sast-canceled-id",
Status: wrappers.ScanCanceled,
StatusDetails: []wrappers.StatusInfo{
{Status: wrappers.ScanCompleted, Name: "general"},
{Status: wrappers.ScanCompleted, Name: "sast"},
{Status: wrappers.ScanFailed, Name: "kics", Details: "error message from kics scanner", ErrorCode: 6455},
},
}
results := getScannerResponse("kics", &model)
assert.Equal(t, len(results), 1, "Scanner results should be empty")
assert.Equal(t, results[0].ScanID, "fake-scan-id-kics-fail-sast-canceled-id", "")
assert.Equal(t, results[0].Status, wrappers.ScanCanceled, "")
}
func TestResultsExitCode_NoScanIdSent_FailCommandWithError(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "exit-code")
assert.Equal(t, err.Error(), errorConstants.ScanIDRequired, "Wrong expected error message")
}
func TestResultsExitCode_OnErrorScan_FailCommandWithError(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "exit-code", "--scan-id", "fake-error-id")
assert.Equal(t, err.Error(), "Failed showing a scan: fake error message", "Wrong expected error message")
}
func TestRunGetResultsByScanIdSarifFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sarif")
// Remove generated sarif file
removeFileBySuffix(t, printer.FormatSarif)
}
func TestRunGetResultsByScanIdSarifFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sarif")
// Remove generated sarif file
removeFileBySuffix(t, printer.FormatSarif)
}
func TestParseSarifEmptyResultSast(t *testing.T) {
emptyResult := &wrappers.ScanResult{}
result := parseSarifResultSast(emptyResult, nil)
if result != nil {
t.Errorf("Expected nil result for empty ScanResultData.Nodes, got %v", result)
}
}
func TestRunGetResultsByScanIdSonarFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sonar")
// Remove generated sonar file
removeFile(t, fileName+"_"+printer.FormatSonar, printer.FormatJSON)
}
func TestRunGetResultsByScanIdSonarFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sonar")
// Remove generated sonar file
removeFile(t, fileName+"_"+printer.FormatSonar, printer.FormatJSON)
}
func TestRunGetResultsByScanIdJsonFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json")
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestDecodeHTMLEntitiesInResults(t *testing.T) {
// Setup: Creating test data with HTML entities
results := createTestScanResultsCollection()
decodeHTMLEntitiesInResults(results)
expectedFullName := `SomeClass<T>`
expectedName := `Name with "quotes"`
if results.Results[0].ScanResultData.Nodes[0].FullName != expectedFullName {
t.Errorf("expected FullName to be %q, got %q", expectedFullName, results.Results[0].ScanResultData.Nodes[0].FullName)
}
if results.Results[0].ScanResultData.Nodes[0].Name != expectedName {
t.Errorf("expected Name to be %q, got %q", expectedName, results.Results[0].ScanResultData.Nodes[0].Name)
}
}
func TestRunGetResultsByScanIdJsonFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json")
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunGetResultsByScanIdJsonFormatWithSastRedundancy(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json", "--sast-redundancy")
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunGetResultsByScanIdSummaryJsonFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryJSON")
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunGetResultsByScanIdSummaryJsonFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryJSON")
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunGetResultsByScanIdSummaryHtmlFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryHTML")
// Remove generated html file
removeFileBySuffix(t, printer.FormatHTML)
}
func TestRunGetResultsByScanIdSummaryHtmlFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryHTML")
// Remove generated html file
removeFileBySuffix(t, printer.FormatHTML)
}
func TestRunGetResultsByScanIdSummaryConsoleFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryConsole")
}
func TestRunGetResultsByScanIdSummaryMarkdownFormatWithContainers(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "markdown")
// Remove generated md file
removeFileBySuffix(t, "md")
}
func TestRunGetResultsByScanIdSummaryConsoleFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "summaryConsole")
}
func TestRunGetResultsByScanIdSummaryMarkdownFormat(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "markdown")
// Remove generated md file
removeFileBySuffix(t, "md")
}
func createTestScanResultsCollection() *wrappers.ScanResultsCollection {
return &wrappers.ScanResultsCollection{
Results: []*wrappers.ScanResult{
{
Description: "Vulnerability in SomeComponent",
DescriptionHTML: "Description with quotes",
ScanResultData: wrappers.ScanResultData{
Nodes: []*wrappers.ScanResultNode{
{
FullName: "SomeClass<T>",
Name: "Name with "quotes"",
},
},
},
},
},
}
}
func removeFileBySuffix(t *testing.T, suffix string) {
switch suffix {
case printer.FormatSonar:
removeFile(t, fileName+sonarTypeLabel, printer.FormatJSON)
default:
removeFile(t, fileName, suffix)
}
}
func removeFile(t *testing.T, prefix, suffix string) {
err := os.Remove(fmt.Sprintf("%s.%s", prefix, suffix))
assert.NilError(t, err, "Error removing file, check if report file created")
}
func TestRunGetResultsByScanIdPDFFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "pdf")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName, printer.FormatPDF))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatPDF)
// Remove generated pdf file
removeFileBySuffix(t, printer.FormatPDF)
}
func TestRunGetResultsByScanIdPDFFormatWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "pdf")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName, printer.FormatPDF))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatPDF)
// Remove generated pdf file
removeFileBySuffix(t, printer.FormatPDF)
}
func TestRunGetResultsByScanIdWrongFormat(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "invalidFormat")
assert.Equal(t, err.Error(), "bad report format invalidFormat", "Wrong expected error message")
}
func TestRunGetResultsByScanIdWithWrongFilterFormat(t *testing.T) {
_ = execCmdNotNilAssertion(
t,
"results",
"show",
"--scan-id",
"MOCK",
"--report-format",
"sarif",
"--filter",
"limit40",
)
}
func TestRunGetResultsByScanIdWithMissingOrEmptyScanId(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "show")
assert.Equal(t, err.Error(), "Failed listing results: Please provide a scan ID", "Wrong expected error message")
err = execCmdNotNilAssertion(t, "results", "show", "--scan-id", "")
assert.Equal(t, err.Error(), "Failed listing results: Please provide a scan ID", "Wrong expected error message")
}
func TestRunGetResultsByScanIdWithEmptyOutputPath(t *testing.T) {
_ = execCmdNotNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--output-path", "")
}
func TestRunGetCodeBashingWithoutLanguage(t *testing.T) {
err := execCmdNotNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.CweIDFlag),
cweValue,
flag(params.VulnerabilityTypeFlag),
vulnerabilityValue)
assert.Equal(t, err.Error(), "required flag(s) \"language\" not set", "Wrong expected error message")
}
func TestRunGetCodeBashingWithoutVulnerabilityType(t *testing.T) {
err := execCmdNotNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.CweIDFlag),
cweValue,
flag(params.LanguageFlag),
languageValue)
assert.Equal(t, err.Error(), "required flag(s) \"vulnerability-type\" not set", "Wrong expected error message")
}
func TestRunGetCodeBashingWithoutCweId(t *testing.T) {
err := execCmdNotNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.VulnerabilityTypeFlag),
vulnerabilityValue,
flag(params.LanguageFlag),
languageValue)
assert.Equal(t, err.Error(), "required flag(s) \"cwe-id\" not set", "Wrong expected error message")
}
func TestRunGetCodeBashingWithFormatJson(t *testing.T) {
execCmdNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.VulnerabilityTypeFlag),
vulnerabilityValue,
flag(params.LanguageFlag),
languageValue,
flag(params.CweIDFlag),
cweValue,
flag(params.FormatFlag),
jsonValue)
}
func TestRunGetCodeBashingWithFormatTable(t *testing.T) {
execCmdNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.VulnerabilityTypeFlag),
vulnerabilityValue,
flag(params.LanguageFlag),
languageValue,
flag(params.CweIDFlag),
cweValue,
flag(params.FormatFlag),
tableValue)
}
func TestRunGetCodeBashingWithFormatList(t *testing.T) {
execCmdNilAssertion(
t,
resultsCommand,
codeBashingCommand,
flag(params.VulnerabilityTypeFlag),
vulnerabilityValue,
flag(params.LanguageFlag),
languageValue,
flag(params.CweIDFlag),
cweValue,
flag(params.FormatFlag),
listValue)
}
func TestResultBflHelp(t *testing.T) {
execCmdNilAssertion(t, "help", "results bfl")
}
func TestRunGetBflWithMissingOrEmptyScanIdAndQueryId(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "bfl")
assert.Equal(t, err.Error(), "required flag(s) \"query-id\", \"scan-id\" not set")
err = execCmdNotNilAssertion(t, "results", "bfl", "--scan-id", "")
assert.Equal(t, err.Error(), "required flag(s) \"query-id\" not set")
err = execCmdNotNilAssertion(t, "results", "bfl", "--query-id", "")
assert.Equal(t, err.Error(), "required flag(s) \"scan-id\" not set")
}
func TestRunGetBflWithMultipleScanIdsAndQueryIds(t *testing.T) {
err := execCmdNotNilAssertion(t, "results", "bfl", "--scan-id", "MOCK1,MOCK2", "--query-id", "MOCK")
assert.Equal(t, err.Error(), "Multiple scan-ids are not allowed.")
err = execCmdNotNilAssertion(t, "results", "bfl", "--scan-id", "MOCK1", "--query-id", "MOCK1,MOCK2")
assert.Equal(t, err.Error(), "Multiple query-ids are not allowed.")
}
func TestRunGetBFLByScanIdAndQueryId(t *testing.T) {
cmd := createASTTestCommand()
err := executeTestCommand(cmd, "results", "bfl", "--scan-id", "MOCK", "--query-id", "MOCK")
assert.NilError(t, err)
}
func TestRunGetBFLByScanIdAndQueryIdWithFormatJson(t *testing.T) {
cmd := createASTTestCommand()
err := executeTestCommand(cmd, "results", "bfl", "--scan-id", "MOCK", "--query-id", "MOCK", "--format", "JSON")
assert.NilError(t, err)
}
func TestRunGetBFLByScanIdAndQueryIdWithFormatList(t *testing.T) {
cmd := createASTTestCommand()
err := executeTestCommand(cmd, "results", "bfl", "--scan-id", "MOCK", "--query-id", "MOCK", "--format", "List")
assert.NilError(t, err)
}
func TestRunGetResultsGeneratingPdfReportWithInvalidEmail(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: false}
err := execCmdNotNilAssertion(t,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-email", "ab@cd.pt,invalid")
assert.Equal(t, err.Error(), "report not sent, invalid email address: invalid", "Wrong expected error message")
}
func TestRunGetResultsGeneratingPdfReportWithInvalidOptions(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: false}
err := execCmdNotNilAssertion(t,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-options", "invalid")
assert.Equal(t, err.Error(), "report option \"invalid\" unavailable", "Wrong expected error message")
}
func TestRunGetResultsGeneratingPdfReportWithInvalidImprovedOptions(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: false}
err := execCmdNotNilAssertion(t,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-options", "scan-information")
assert.Equal(t, err.Error(), "report option \"scan-information\" unavailable", "Wrong expected error message")
}
func TestRunGetResultsGeneratingPdfReportWithEmailAndOptions(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: false}
cmd := createASTTestCommand()
err := executeTestCommand(cmd,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-email", "ab@cd.pt,test@test.pt",
"--report-pdf-options", "Iac-Security,Sast,Sca,ScanSummary")
assert.NilError(t, err)
}
func TestRunGetResultsGeneratingPdfReportWithOptionsImprovedMappingHappens(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: true}
cmd := createASTTestCommand()
err := executeTestCommand(cmd,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-email", "ab@cd.pt,test@test.pt",
"--report-pdf-options", "Iac-Security,Sast,Sca,scansummary,scanresults")
assert.NilError(t, err)
}
func TestRunGetResultsGeneratingPdfReportWithInvalidOptionsImproved(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: true}
cmd := createASTTestCommand()
err := executeTestCommand(cmd,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--report-pdf-email", "ab@cd.pt,test@test.pt",
"--report-pdf-options", "Iac-Security,Sast,Sca,scan-information")
assert.Error(t, err, "report option \"scan-information\" unavailable")
}
func TestRunGetResultsGeneratingPdfReportWithOptions(t *testing.T) {
clearFlags()
mock.Flag = wrappers.FeatureFlagResponseModel{Name: wrappers.NewScanReportEnabled, Status: false}
cmd := createASTTestCommand()
err := executeTestCommand(cmd,
"results", "show",
"--report-format", "pdf",
"--scan-id", "MOCK",
"--output-name", fileName,
"--report-pdf-options", "Iac-Security,Sast,Sca,ScanSummary")
defer func() {
removeFileBySuffix(t, printer.FormatPDF)
fmt.Println("test file removed!")
}()
assert.NilError(t, err)
_, err = os.Stat(fmt.Sprintf("%s.%s", fileName, printer.FormatPDF))
assert.NilError(t, err, "report file should exist: "+fileName+printer.FormatPDF)
}
func TestSBOMReportInvalidSBOMOption(t *testing.T) {
err := execCmdNotNilAssertion(t,
"results", "show",
"--report-format", "sbom",
"--scan-id", "MOCK",
"--report-sbom-format", "invalid")
assert.Equal(t, err.Error(), "invalid SBOM option: invalid", "Wrong expected error message")
}
func TestSBOMReportJson(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sbom")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatJSON))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatJSON)
// Remove generated json file
os.Remove(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatJSON))
}
func TestSBOMReportXML(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sbom", "--report-sbom-format", "CycloneDxXml")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatXML))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatXML)
// Remove generated json file
os.Remove(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatXML))
}
func TestSBOMReportJsonWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sbom")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatJSON))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatJSON)
// Remove generated json file
os.Remove(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatJSON))
}
func TestSBOMReportXMLWithContainers(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "sbom", "--report-sbom-format", "CycloneDxXml")
_, err := os.Stat(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatXML))
assert.NilError(t, err, "Report file should exist for extension "+printer.FormatXML)
// Remove generated json file
os.Remove(fmt.Sprintf("%s.%s", fileName+"_"+printer.FormatSbom, printer.FormatXML))
}
func TestRunGetResultsByScanIdGLFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "gl-sast")
// Run test for gl-sast report type
os.Remove(fmt.Sprintf("%s.%s", fileName, printer.FormatGLSast))
}
func TestRunResultsShow_jetbrainsIsNotSupported_excludeContainersResult(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json", "--agent", "jetbrains")
assertTypePresentJSON(t, params.ContainersType, 0)
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunResultsShow_EclipseIsNotSupported_excludeContainersResult(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json", "--agent", "Eclipse")
assertTypePresentJSON(t, params.ContainersType, 0)
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunResultsShow_VsCodeIsNotSupported_excludeContainersResult(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json", "--agent", "vs code")
assertTypePresentJSON(t, params.ContainersType, 0)
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func TestRunResultsShow_VisualStudioIsNotSupported_excludeContainersResult(t *testing.T) {
clearFlags()
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "json", "--agent", "Visual Studio")
assertTypePresentJSON(t, params.ContainersType, 0)
// Remove generated json file
removeFileBySuffix(t, printer.FormatJSON)
}
func assertTypePresentJSON(t *testing.T, resultType string, expectedResultTypeCount int) {
reportBytes, err := os.ReadFile(fileName + "." + printer.FormatJSON)
assert.NilError(t, err, "Error reading file")
// Unmarshal the JSON data into the ScanResultsCollection struct
var scanResultsCollection *wrappers.ScanResultsCollection
err = json.Unmarshal(reportBytes, &scanResultsCollection)
assert.NilError(t, err, "Error unmarshalling JSON data")
actualResultTypeCount := 0
for i := range scanResultsCollection.Results {
scanResult := scanResultsCollection.Results[i]
if scanResult.Type == resultType {
actualResultTypeCount++
}
}
assert.Equal(t, actualResultTypeCount, expectedResultTypeCount,
fmt.Sprintf("Expected %s result count to be %d, but found %d results", resultType, expectedResultTypeCount, actualResultTypeCount))
}
func assertTotalCountJSON(t *testing.T, expectedResultTypeCount uint) {
reportBytes, err := os.ReadFile(fileName + "." + printer.FormatJSON)
assert.NilError(t, err, "Error reading file")
// Unmarshal the JSON data into the ScanResultsCollection struct
var scanResultsCollection *wrappers.ScanResultsCollection
err = json.Unmarshal(reportBytes, &scanResultsCollection)
assert.NilError(t, err, "Error unmarshalling JSON data")
assert.Equal(t, scanResultsCollection.TotalCount, expectedResultTypeCount,
fmt.Sprintf("Expected total count to be %d, but actual total count is %d", expectedResultTypeCount, scanResultsCollection.TotalCount))
}
func assertTypePresentSonar(t *testing.T, resultType string, expectedResultTypeCount int) {
reportBytes, err := os.ReadFile(fileName + sonarTypeLabel + "." + printer.FormatJSON)
assert.NilError(t, err, "Error reading file")
// Unmarshal the JSON data into the ScanResultsCollection struct
var scanResultsCollection *wrappers.ScanResultsSonar
err = json.Unmarshal(reportBytes, &scanResultsCollection)
assert.NilError(t, err, "Error unmarshalling JSON data")
actualResultTypeCount := 0
for i := range scanResultsCollection.Results {
scanResult := scanResultsCollection.Results[i]
if scanResult.EngineID == resultType {
actualResultTypeCount++
}
}
assert.Equal(t, actualResultTypeCount, expectedResultTypeCount,
fmt.Sprintf("Expected %s result count to be %d, but found %d results", resultType, expectedResultTypeCount, actualResultTypeCount))
}
func assertTypePresentSarif(t *testing.T, resultType string, expectedResultTypeCount int) {
reportBytes, err := os.ReadFile(fileName + "." + printer.FormatSarif)
assert.NilError(t, err, "Error reading file")
// Unmarshal the JSON data into the ScanResultsCollection struct
var scanResultsCollection *wrappers.SarifResultsCollection
err = json.Unmarshal(reportBytes, &scanResultsCollection)
assert.NilError(t, err, "Error unmarshalling SARIF data")
resultTypeRuleSuffix := fmt.Sprintf("(%s)", resultType)
actualResultTypeCount := 0
for i := range scanResultsCollection.Runs[0].Results {
scanResult := scanResultsCollection.Runs[0].Results[i]
if strings.HasSuffix(scanResult.RuleID, resultTypeRuleSuffix) {
actualResultTypeCount++
assertRulePresentSarif(t, scanResult.RuleID, scanResultsCollection)
}
}
assert.Equal(t, actualResultTypeCount, expectedResultTypeCount,
fmt.Sprintf("Expected %s result count to be %d, but found %d results", resultType, expectedResultTypeCount, actualResultTypeCount))
}
func assertRulePresentSarif(t *testing.T, ruleID string, scanResultsCollection *wrappers.SarifResultsCollection) {
for i := range scanResultsCollection.Runs[0].Tool.Driver.Rules {
rule := scanResultsCollection.Runs[0].Tool.Driver.Rules[i]
if rule.ID == ruleID {
return
}
}
assert.Assert(t, false, fmt.Sprintf("RuleID %s found in SARIF result not found in rules of SARIF report", ruleID))
}
func assertResultsPresentSummaryJSON(t *testing.T, isResultsEnabled bool, scanType string, numberOfIssues *int) {
reportBytes, err := os.ReadFile(fileName + "." + printer.FormatJSON)
assert.NilError(t, err, "Error reading file")
// Unmarshal the JSON data into the ScanResultsCollection struct
var scanResultSummary *wrappers.ResultSummary
err = json.Unmarshal(reportBytes, &scanResultSummary)
assert.NilError(t, err, "Error unmarshalling JSON data")
// Test presence of Issues field
scanTypeCapitalized := cases.Title(language.Und).String(scanType)
IssuesFieldName := scanTypeCapitalized + "Issues"
reflectedScanResultSummary := reflect.ValueOf(scanResultSummary).Elem()
IssuesField := reflectedScanResultSummary.FieldByName(IssuesFieldName)
assert.Equal(t, IssuesField.IsValid(), true, fmt.Sprintf("field %s not found in ResultSummary struct definition", IssuesFieldName))
assert.Equal(t, !IssuesField.IsNil(), isResultsEnabled, fmt.Sprintf("Expected field %s to be present: %t", IssuesFieldName, isResultsEnabled))
if !IssuesField.IsNil() && numberOfIssues != nil {
assert.Equal(t, *IssuesField.Interface().(*int), *numberOfIssues, fmt.Sprintf("Expected field %s to have value: %d", IssuesFieldName, *numberOfIssues))
}
// Test presence of Scs Overview field
if scanType == params.ScsType {
ScsOverviewField := reflectedScanResultSummary.FieldByName("SCSOverview")
assert.Equal(t, ScsOverviewField.IsValid(), true, fmt.Sprintf("field %s not found in ResultSummary struct definition ", ScsOverviewField))
assert.Equal(t, !ScsOverviewField.IsNil(), isResultsEnabled, fmt.Sprintf("Expected field %s to be present: %t", ScsOverviewField, isResultsEnabled))
}
for engine := range scanResultSummary.EnginesResult {
if !isResultsEnabled && engine == scanType {
assert.Assert(t, false, fmt.Sprintf("%s result summary should not be present", scanType))
} else if isResultsEnabled && engine == scanType {
return
}
}
if isResultsEnabled {
assert.Assert(t, false, "%s result summary should be present", scanType)
}
}
func TestRunGetResultsByScanIdGLSastAndAScaFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "gl-sast,gl-sca")
// Run test for gl-sast report type
os.Remove(fmt.Sprintf("%s.%s", fileName, printer.FormatGLSast))
os.Remove(fmt.Sprintf("%s.%s", fileName, printer.FormatGLSca))
}
func TestRunGetResultsByScanIdGLScaFormat(t *testing.T) {
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK", "--report-format", "gl-sca")
// Run test for gl-sca report type
os.Remove(fmt.Sprintf("%s.%s", fileName, printer.FormatGLSca))
}
func Test_addPackageInformation(t *testing.T) {
var dependencyPath = wrappers.DependencyPath{ID: "test-1"}
var dependencyArray = [][]wrappers.DependencyPath{{dependencyPath}}
resultsModel := &wrappers.ScanResultsCollection{
Results: []*wrappers.ScanResult{
{
Type: "sca", // Assuming this matches commonParams.ScaType
ScanResultData: wrappers.ScanResultData{
PackageIdentifier: "pkg-123",
},
ID: "CVE-2021-23-424",
VulnerabilityDetails: wrappers.VulnerabilityDetails{
CvssScore: 5.0,
CveName: "cwe-789",
},
},
},
}
scaPackageModel := &[]wrappers.ScaPackageCollection{
{
ID: "pkg-123",
FixLink: "",
DependencyPathArray: dependencyArray,
},
}
scaTypeModel := &[]wrappers.ScaTypeCollection{
{}}
resultsModel = addPackageInformation(resultsModel, scaPackageModel, scaTypeModel)
expectedFixLink := "https://devhub.checkmarx.com/cve-details/CVE-2021-23-424"
actualFixLink := resultsModel.Results[0].ScanResultData.ScaPackageCollection.FixLink
assert.Equal(t, expectedFixLink, actualFixLink, "FixLink should match the result ID")
}
func TestRunGetResultsByScanIdGLSastFormat_NoVulnerabilities_Success(t *testing.T) {
// Execute the command and perform nil assertion
execCmdNilAssertion(t, "results", "show", "--scan-id", "MOCK_NO_VULNERABILITIES", "--report-format", "gl-sast")
// Run test for gl-sast report type
// Check if the file exists and vulnerabilities is empty, then delete the file
if _, err := os.Stat(fmt.Sprintf("%s.%s-report.json", fileName, printer.FormatGLSast)); err == nil {
t.Logf("File exists: %s.%s", fileName, printer.FormatGLSast)
resultsData, err := os.ReadFile(fmt.Sprintf("%s.%s-report.json", fileName, printer.FormatGLSast))
if err != nil {
t.Logf("Failed to read file: %v", err)
}
var results wrappers.GlSastResultsCollection
if err := json.Unmarshal(resultsData, &results); err != nil {
t.Logf("Failed to unmarshal JSON: %v", err)
}
assert.Equal(t, len(results.Vulnerabilities), 0, "No vulnerabilities should be found")
if err := os.Remove(fmt.Sprintf("%s.%s-report.json", fileName, printer.FormatGLSast)); err != nil {
t.Logf("Failed to delete file: %v", err)
}
t.Log("File deleted successfully.")
}
}
func TestRunGetResultsByScanIdGLScaFormat_NoVulnerabilities_Success(t *testing.T) {
// Execute the command and perform nil assertion