-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathtest_output.py
More file actions
338 lines (264 loc) · 11.4 KB
/
test_output.py
File metadata and controls
338 lines (264 loc) · 11.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
import pytest
from socketsecurity.output import OutputHandler
from socketsecurity.core.classes import Diff, Issue
import json
class TestOutputHandler:
@pytest.fixture
def handler(self):
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = False
config.sarif_file = None
config.sarif_reachable_only = False
config.sbom_file = None
return OutputHandler(config, Mock())
def test_report_pass_with_blocking_issues(self, handler):
diff = Diff()
diff.new_alerts = [Issue(error=True)]
assert not handler.report_pass(diff)
def test_report_pass_with_blocking_disabled(self):
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = True
config.strict_blocking = False
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = [Issue(error=True)]
assert handler.report_pass(diff)
def test_json_output_format(self, handler, caplog):
import logging
diff = Diff()
diff.id = "test-scan-id"
diff.diff_url = "https://socket.dev/test"
test_issue = Issue(
title="Test",
severity="high",
description="Test description",
error=True,
key="test-key",
type="test-type",
pkg_type="npm",
pkg_name="test-package",
pkg_version="1.0.0",
purl="pkg:npm/test-package@1.0.0"
)
diff.new_alerts = [test_issue]
with caplog.at_level(logging.INFO, logger="socketcli"):
handler.output_console_json(diff)
output = json.loads(caplog.messages[-1])
assert output["new_alerts"][0]["title"] == "Test"
assert output["new_alerts"][0]["severity"] == "high"
assert output["new_alerts"][0]["error"] is True
assert output["new_alerts"][0]["description"] == "Test description"
def test_sbom_file_saving(self, handler, tmp_path):
# Test SBOM file is created correctly
diff = Diff()
diff.sbom = {"test": "data"}
sbom_path = tmp_path / "test.json"
handler.save_sbom_file(diff, str(sbom_path))
assert sbom_path.exists()
def test_report_pass_with_strict_blocking_new_alerts(self):
"""Test that strict-blocking fails on new blocking alerts"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
# Create config with strict_blocking
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = True
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = [Issue(error=True, warn=False)]
diff.unchanged_alerts = []
assert not handler.report_pass(diff)
def test_report_pass_with_strict_blocking_unchanged_alerts(self):
"""Test that strict-blocking fails on unchanged blocking alerts"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = True
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = []
diff.unchanged_alerts = [Issue(error=True, warn=False)]
assert not handler.report_pass(diff)
def test_report_pass_with_strict_blocking_both_alerts(self):
"""Test that strict-blocking fails when both new and unchanged alerts exist"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = True
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = [Issue(error=True, warn=False)]
diff.unchanged_alerts = [Issue(error=True, warn=False)]
assert not handler.report_pass(diff)
def test_report_pass_with_strict_blocking_only_warnings(self):
"""Test that strict-blocking passes when only warnings (not errors) exist"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = True
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = [Issue(error=False, warn=True)]
diff.unchanged_alerts = [Issue(error=False, warn=True)]
assert handler.report_pass(diff)
def test_report_pass_strict_blocking_disabled(self):
"""Test that strict-blocking without the flag passes with unchanged alerts"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = False
config.strict_blocking = False # Flag not set
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = []
diff.unchanged_alerts = [Issue(error=True, warn=False)]
# Should pass because strict_blocking is False
assert handler.report_pass(diff)
def test_disable_blocking_overrides_strict_blocking(self):
"""Test that disable-blocking takes precedence over strict-blocking"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.disable_blocking = True
config.strict_blocking = True
handler = OutputHandler(config, Mock())
diff = Diff()
diff.new_alerts = [Issue(error=True, warn=False)]
diff.unchanged_alerts = [Issue(error=True, warn=False)]
# Should pass because disable_blocking takes precedence
assert handler.report_pass(diff)
def test_sarif_file_output(self, tmp_path):
"""Test that --sarif-file writes SARIF report to a file"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
sarif_path = tmp_path / "report.sarif"
config = Mock(spec=CliConfig)
config.sarif_file = str(sarif_path)
config.sbom_file = None
handler = OutputHandler(config, Mock())
diff = Diff()
diff.id = "test-scan-id"
diff.new_alerts = [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",
pkg_type="npm",
key="test-key",
purl="pkg:npm/test-package@1.0.0",
error=True,
)]
handler.output_console_sarif(diff)
assert sarif_path.exists()
with open(sarif_path) as f:
sarif_data = json.load(f)
assert sarif_data["version"] == "2.1.0"
def test_sarif_reachable_only_filters_non_blocking(self, tmp_path):
"""Test that --sarif-reachable-only excludes non-blocking (unreachable) alerts"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
sarif_path = tmp_path / "report.sarif"
config = Mock(spec=CliConfig)
config.sarif_file = str(sarif_path)
config.sarif_reachable_only = True
config.sbom_file = None
handler = OutputHandler(config, Mock())
def make_issue(name, error):
return Issue(
pkg_name=name,
pkg_version="1.0.0",
severity="high",
title=f"Vuln in {name}",
description="test",
type="vulnerability",
manifests="package.json",
pkg_type="npm",
key=f"key-{name}",
purl=f"pkg:npm/{name}@1.0.0",
error=error,
)
diff = Diff()
diff.id = "test-scan-id"
diff.new_alerts = [
make_issue("reachable-pkg", error=True),
make_issue("unreachable-pkg", error=False),
]
handler.output_console_sarif(diff)
with open(sarif_path) as f:
sarif_data = json.load(f)
rule_ids = [r["ruleId"] for r in sarif_data["runs"][0]["results"]]
assert any("reachable-pkg" in r for r in rule_ids)
assert not any("unreachable-pkg" in r for r in rule_ids)
def test_sarif_reachable_only_false_includes_all(self, tmp_path):
"""Test that without --sarif-reachable-only all alerts are included"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
sarif_path = tmp_path / "report.sarif"
config = Mock(spec=CliConfig)
config.sarif_file = str(sarif_path)
config.sarif_reachable_only = False
config.sbom_file = None
handler = OutputHandler(config, Mock())
diff = Diff()
diff.id = "test-scan-id"
diff.new_alerts = [
Issue(pkg_name="blocking-pkg", pkg_version="1.0.0", severity="high",
title="Vuln", description="test", type="vulnerability",
manifests="package.json", pkg_type="npm", key="k1",
purl="pkg:npm/blocking-pkg@1.0.0", error=True),
Issue(pkg_name="non-blocking-pkg", pkg_version="1.0.0", severity="low",
title="Vuln", description="test", type="vulnerability",
manifests="package.json", pkg_type="npm", key="k2",
purl="pkg:npm/non-blocking-pkg@1.0.0", error=False),
]
handler.output_console_sarif(diff)
with open(sarif_path) as f:
sarif_data = json.load(f)
rule_ids = [r["ruleId"] for r in sarif_data["runs"][0]["results"]]
assert any("blocking-pkg" in r for r in rule_ids)
assert any("non-blocking-pkg" in r for r in rule_ids)
assert "$schema" in sarif_data
assert len(sarif_data["runs"]) == 1
def test_sarif_no_file_when_not_configured(self, tmp_path):
"""Test that no file is written when --sarif-file is not set"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
config = Mock(spec=CliConfig)
config.sarif_file = None
config.sbom_file = None
handler = OutputHandler(config, Mock())
diff = Diff()
diff.id = "test-scan-id"
diff.new_alerts = []
handler.output_console_sarif(diff)
# No files should be created in tmp_path
assert list(tmp_path.iterdir()) == []
def test_sarif_file_nested_directory(self, tmp_path):
"""Test that --sarif-file creates parent directories if needed"""
from socketsecurity.config import CliConfig
from unittest.mock import Mock
sarif_path = tmp_path / "nested" / "dir" / "report.sarif"
config = Mock(spec=CliConfig)
config.sarif_file = str(sarif_path)
config.sbom_file = None
handler = OutputHandler(config, Mock())
diff = Diff()
diff.id = "test-scan-id"
diff.new_alerts = []
handler.output_console_sarif(diff)
assert sarif_path.exists()
with open(sarif_path) as f:
sarif_data = json.load(f)
assert sarif_data["version"] == "2.1.0"