-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathtest_gitlab_format.py
More file actions
393 lines (330 loc) · 13.1 KB
/
test_gitlab_format.py
File metadata and controls
393 lines (330 loc) · 13.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
import pytest
from socketsecurity.core.messages import Messages
from socketsecurity.core.classes import Diff, Issue
class TestGitLabFormat:
"""Test suite for GitLab Security Dashboard format generation"""
def test_gitlab_report_structure(self):
"""Test basic GitLab report structure is valid"""
diff = Diff()
diff.new_alerts = []
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
report = Messages.create_security_comment_gitlab(diff)
# Verify required top-level fields
assert "version" in report
assert "scan" in report
assert "vulnerabilities" in report
# Verify scan structure
assert report["scan"]["type"] == "dependency_scanning"
assert "analyzer" in report["scan"]
assert "scanner" in report["scan"]
assert report["scan"]["analyzer"]["id"] == "socket-security"
assert report["scan"]["scanner"]["id"] == "socket-cli"
assert report["scan"]["status"] == "success"
def test_vulnerability_mapping(self):
"""Test Socket Issue maps correctly to GitLab vulnerability"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="test-package",
pkg_version="1.0.0",
severity="high",
title="Test Vulnerability",
description="Test description",
type="malware",
url="https://socket.dev/test",
manifests="package.json",
props={"cve": ["CVE-2024-1234"]},
pkg_type="npm",
key="test-key",
purl="pkg:npm/test-package@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
assert len(report["vulnerabilities"]) == 1
vuln = report["vulnerabilities"][0]
assert vuln["category"] == "dependency_scanning"
assert vuln["name"] == "Test Vulnerability"
assert vuln["severity"] == "High"
assert vuln["location"]["file"] == "package.json"
assert vuln["location"]["dependency"]["package"]["name"] == "test-package"
assert vuln["location"]["dependency"]["version"] == "1.0.0"
assert vuln["message"] == "test-package@1.0.0: Test Vulnerability"
def test_identifier_extraction_with_cve(self):
"""Test CVE identifiers are correctly extracted"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="vulnerable-pkg",
pkg_version="2.0.0",
type="vulnerability",
severity="critical",
title="Known CVE",
props={"cve": ["CVE-2024-5678", "CVE-2024-9012"]},
pkg_type="npm",
key="test-key",
purl="pkg:npm/vulnerable-pkg@2.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
# Should have socket_alert identifier + 2 CVE identifiers
assert len(vuln["identifiers"]) >= 3
cve_identifiers = [i for i in vuln["identifiers"] if i["type"] == "cve"]
assert len(cve_identifiers) == 2
assert any(i["value"] == "CVE-2024-5678" for i in cve_identifiers)
assert any(i["value"] == "CVE-2024-9012" for i in cve_identifiers)
def test_identifier_extraction_with_single_cve_string(self):
"""Test single CVE identifier as string"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="vulnerable-pkg",
pkg_version="2.0.0",
type="vulnerability",
severity="high",
title="Single CVE",
props={"cve": "CVE-2024-1111"},
pkg_type="npm",
key="test-key",
purl="pkg:npm/vulnerable-pkg@2.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
cve_identifiers = [i for i in vuln["identifiers"] if i["type"] == "cve"]
assert len(cve_identifiers) == 1
assert cve_identifiers[0]["value"] == "CVE-2024-1111"
def test_dependency_chain_handling_transitive(self):
"""Test transitive dependency path is captured"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="transitive-dep",
pkg_version="1.5.0",
type="supply-chain-risk",
severity="medium",
title="Supply Chain Risk",
introduced_by=[
["top-level > intermediate > transitive-dep", "package.json"]
],
pkg_type="npm",
key="test-key",
purl="pkg:npm/transitive-dep@1.5.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert vuln["location"]["file"] == "package.json"
assert vuln["location"]["dependency"]["direct"] is False
def test_dependency_chain_handling_direct(self):
"""Test direct dependency is correctly identified"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="direct-dep",
pkg_version="3.0.0",
type="malware",
severity="critical",
title="Malware Found",
introduced_by=[
["direct-dep", "package.json"]
],
pkg_type="npm",
key="test-key",
purl="pkg:npm/direct-dep@3.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert vuln["location"]["dependency"]["direct"] is True
def test_severity_mapping(self):
"""Test all Socket severities map to GitLab severities"""
severity_tests = [
("critical", "Critical"),
("high", "High"),
("medium", "Medium"),
("middle", "Medium"), # Old format
("low", "Low"),
("unknown", "Unknown")
]
for socket_sev, gitlab_sev in severity_tests:
result = Messages.map_socket_severity_to_gitlab(socket_sev)
assert result == gitlab_sev, f"Failed for severity: {socket_sev}"
def test_empty_alerts(self):
"""Test report with no vulnerabilities"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
diff.new_alerts = []
report = Messages.create_security_comment_gitlab(diff)
assert len(report["vulnerabilities"]) == 0
assert report["scan"]["status"] == "success"
def test_multiple_manifest_files(self):
"""Test handling of multiple manifest files (semicolon-separated)"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="multi-manifest-pkg",
pkg_version="1.0.0",
type="supply-chain-risk",
severity="high",
title="Multiple Manifests",
introduced_by=[
["multi-manifest-pkg", "package.json;package-lock.json"]
],
pkg_type="npm",
key="test-key",
purl="pkg:npm/multi-manifest-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
# Should use first manifest file
assert vuln["location"]["file"] == "package.json"
def test_solution_field_included(self):
"""Test solution field is included when suggestion is present"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="fixable-pkg",
pkg_version="1.0.0",
type="vulnerability",
severity="high",
title="Fixable Issue",
suggestion="Update to version 2.0.0",
pkg_type="npm",
key="test-key",
purl="pkg:npm/fixable-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert "solution" in vuln
assert vuln["solution"] == "Update to version 2.0.0"
def test_solution_field_omitted_when_no_suggestion(self):
"""Test solution field is omitted when no suggestion"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="unfixable-pkg",
pkg_version="1.0.0",
type="vulnerability",
severity="high",
title="No Fix Available",
pkg_type="npm",
key="test-key",
purl="pkg:npm/unfixable-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert "solution" not in vuln
def test_uuid_generation_is_deterministic(self):
"""Test UUID generation is deterministic for same vulnerability"""
test_issue = Issue(
pkg_name="test-pkg",
pkg_version="1.0.0",
type="malware",
severity="high",
title="Test",
pkg_type="npm",
key="test-key",
purl="pkg:npm/test-pkg@1.0.0"
)
uuid1 = Messages.generate_uuid_from_alert_gitlab(test_issue)
uuid2 = Messages.generate_uuid_from_alert_gitlab(test_issue)
assert uuid1 == uuid2
def test_uuid_generation_differs_for_different_vulnerabilities(self):
"""Test UUID generation differs for different vulnerabilities"""
issue1 = Issue(
pkg_name="test-pkg",
pkg_version="1.0.0",
type="malware",
severity="high",
title="Test",
pkg_type="npm",
key="test-key",
purl="pkg:npm/test-pkg@1.0.0"
)
issue2 = Issue(
pkg_name="test-pkg",
pkg_version="1.0.0",
type="vulnerability",
severity="high",
title="Test",
pkg_type="npm",
key="test-key",
purl="pkg:npm/test-pkg@1.0.0"
)
uuid1 = Messages.generate_uuid_from_alert_gitlab(issue1)
uuid2 = Messages.generate_uuid_from_alert_gitlab(issue2)
assert uuid1 != uuid2
def test_missing_title_falls_back_to_type(self):
"""Test vulnerability name falls back to type when title missing"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="no-title-pkg",
pkg_version="1.0.0",
type="malware",
severity="high",
pkg_type="npm",
key="test-key",
purl="pkg:npm/no-title-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert "malware" in vuln["name"].lower()
assert "no-title-pkg" in vuln["name"]
def test_links_array_includes_socket_url(self):
"""Test links array includes Socket.dev URL"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="linked-pkg",
pkg_version="1.0.0",
type="malware",
severity="high",
title="Test",
url="https://socket.dev/npm/package/linked-pkg",
pkg_type="npm",
key="test-key",
purl="pkg:npm/linked-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert len(vuln["links"]) == 1
assert vuln["links"][0]["url"] == "https://socket.dev/npm/package/linked-pkg"
def test_manifests_attribute_fallback(self):
"""Test location extraction falls back to manifests attribute"""
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
pkg_name="manifest-fallback-pkg",
pkg_version="1.0.0",
type="malware",
severity="high",
title="Test",
manifests="requirements.txt",
pkg_type="pypi",
key="test-key",
purl="pkg:pypi/manifest-fallback-pkg@1.0.0"
)
diff.new_alerts = [test_issue]
report = Messages.create_security_comment_gitlab(diff)
vuln = report["vulnerabilities"][0]
assert vuln["location"]["file"] == "requirements.txt"