|
| 1 | +"""The Slack formatter keys on "medium"; the API sends "middle". |
| 2 | +
|
| 3 | +Every severity lookup in ``socketsecurity/plugins/formatters/slack.py`` is keyed |
| 4 | +on ``medium``, but ``middle`` is what the API actually emits -- it is the value |
| 5 | +in the OpenAPI spec's ``SocketIssueSeverity`` and in the SDK enum. Unnormalized, |
| 6 | +a mid-severity finding fell through every one of them at once: |
| 7 | +
|
| 8 | +* it was not counted, so the summary always read ``Medium: 0`` |
| 9 | +* it was excluded from ``total_findings``, which can drive ``omitted_count`` |
| 10 | + negative when mid-severity findings are the ones being displayed |
| 11 | +* it sorted at the default order of 4, below ``low``, so it was truncated out of |
| 12 | + the message first when the block limit was reached |
| 13 | +
|
| 14 | +Two other call sites already handle both spellings (``Messages.map_socket_ |
| 15 | +severity_to_gitlab`` and the GitLab severity map); this formatter did not. |
| 16 | +""" |
| 17 | + |
| 18 | +import unittest |
| 19 | + |
| 20 | +from socketsecurity.plugins.formatters.slack import ( |
| 21 | + SEVERITY_EMOJI, |
| 22 | + SEVERITY_ORDER, |
| 23 | + _extract_alert_info, |
| 24 | + format_socket_facts_for_slack, |
| 25 | +) |
| 26 | + |
| 27 | + |
| 28 | +def _component(severity: str) -> dict: |
| 29 | + return { |
| 30 | + "name": "example-package", |
| 31 | + "version": "1.0.0", |
| 32 | + "alerts": [{"title": "Example alert", "severity": severity, "props": {}}], |
| 33 | + } |
| 34 | + |
| 35 | + |
| 36 | +class TestSeverityNormalization(unittest.TestCase): |
| 37 | + def test_middle_normalizes_to_medium(self): |
| 38 | + info = _extract_alert_info(_component("middle"), {"severity": "middle"}) |
| 39 | + self.assertEqual(info["severity"], "medium") |
| 40 | + |
| 41 | + def test_middle_gets_the_medium_order_not_the_default(self): |
| 42 | + info = _extract_alert_info(_component("middle"), {"severity": "middle"}) |
| 43 | + self.assertEqual(info["severity_order"], SEVERITY_ORDER["medium"]) |
| 44 | + # Regression: the default of 4 sorted mid-severity below "low". |
| 45 | + self.assertLess(info["severity_order"], SEVERITY_ORDER["low"]) |
| 46 | + |
| 47 | + def test_middle_gets_the_medium_emoji_not_the_fallback(self): |
| 48 | + info = _extract_alert_info(_component("middle"), {"severity": "middle"}) |
| 49 | + self.assertEqual(info["severity_emoji"], SEVERITY_EMOJI["medium"]) |
| 50 | + self.assertNotEqual(info["severity_emoji"], SEVERITY_EMOJI["low"]) |
| 51 | + |
| 52 | + def test_medium_still_works(self): |
| 53 | + info = _extract_alert_info(_component("medium"), {"severity": "medium"}) |
| 54 | + self.assertEqual(info["severity"], "medium") |
| 55 | + self.assertEqual(info["severity_order"], SEVERITY_ORDER["medium"]) |
| 56 | + |
| 57 | + def test_middle_findings_are_counted_in_the_summary(self): |
| 58 | + result = format_socket_facts_for_slack([_component("middle")]) |
| 59 | + self.assertEqual(len(result), 1) |
| 60 | + self.assertIn("🟡 Medium: 1", result[0]["summary"]) |
| 61 | + |
| 62 | + def test_middle_findings_reach_total_findings(self): |
| 63 | + # Regression: excluded from the total, omitted_count could go negative. |
| 64 | + result = format_socket_facts_for_slack([_component("middle")]) |
| 65 | + self.assertEqual(result[0]["total_findings"], 1) |
| 66 | + |
| 67 | + def test_unrecognized_severity_still_falls_back(self): |
| 68 | + info = _extract_alert_info( |
| 69 | + _component("brand-new-level"), {"severity": "brand-new-level"} |
| 70 | + ) |
| 71 | + self.assertEqual(info["severity_order"], 4) |
| 72 | + self.assertEqual(info["severity_emoji"], "⚪") |
| 73 | + |
| 74 | + |
| 75 | +if __name__ == "__main__": |
| 76 | + unittest.main() |
0 commit comments