|
| 1 | +import copy |
| 2 | +import json |
| 3 | + |
| 4 | +from socketsecurity.config import CliConfig |
| 5 | +from socketsecurity.core import Core |
| 6 | +from socketsecurity.core.classes import Diff, Issue, Package |
| 7 | +from socketsecurity.core.messages import Messages |
| 8 | +from socketsecurity.core.report_output import build_socket_json_report |
| 9 | + |
| 10 | + |
| 11 | +def _package( |
| 12 | + package_id: str, |
| 13 | + *, |
| 14 | + name: str = "widget", |
| 15 | + version: str = "1.0.0", |
| 16 | + ecosystem: str = "npm", |
| 17 | + namespace: str | None = None, |
| 18 | + direct: bool = False, |
| 19 | + ancestors: list[str] | None = None, |
| 20 | + manifests: list[dict[str, str]] | None = None, |
| 21 | + purl: str = "", |
| 22 | +) -> Package: |
| 23 | + package = Package( |
| 24 | + type=ecosystem, |
| 25 | + namespace=namespace, |
| 26 | + name=name, |
| 27 | + version=version, |
| 28 | + id=package_id, |
| 29 | + score={}, |
| 30 | + alerts=[], |
| 31 | + direct=direct, |
| 32 | + topLevelAncestors=ancestors, |
| 33 | + manifestFiles=manifests, |
| 34 | + purl=purl, |
| 35 | + ) |
| 36 | + return package |
| 37 | + |
| 38 | + |
| 39 | +def _issue(introduced_by: list[tuple[str, str]]) -> Issue: |
| 40 | + return Issue( |
| 41 | + pkg_type="npm", |
| 42 | + pkg_name="leaf", |
| 43 | + pkg_version="1.0.0", |
| 44 | + category="supplyChainRisk", |
| 45 | + type="envVars", |
| 46 | + severity="low", |
| 47 | + pkg_id="npm/leaf@1.0.0", |
| 48 | + props={}, |
| 49 | + key="fixture-alert", |
| 50 | + error=False, |
| 51 | + warn=True, |
| 52 | + ignore=False, |
| 53 | + monitor=False, |
| 54 | + description="Fixture alert", |
| 55 | + title="Fixture alert", |
| 56 | + emoji="!", |
| 57 | + next_step_title="Review package", |
| 58 | + suggestion="", |
| 59 | + introduced_by=introduced_by, |
| 60 | + purl="pkg:npm/leaf@1.0.0", |
| 61 | + url="https://socket.dev/npm/package/leaf/alerts/1.0.0", |
| 62 | + ) |
| 63 | + |
| 64 | + |
| 65 | +def test_source_data_preserves_scopes_and_maven_groups_and_consumers(): |
| 66 | + first = _package("first", namespace="@one", manifests=[{"file": "package.json"}]) |
| 67 | + second = _package("second", namespace="@two", manifests=[{"file": "package.json"}]) |
| 68 | + maven = _package( |
| 69 | + "maven", |
| 70 | + ecosystem="maven", |
| 71 | + namespace="com.one", |
| 72 | + manifests=[{"file": "pom.xml"}], |
| 73 | + ) |
| 74 | + child = _package("child", ancestors=["first", "second", "maven"]) |
| 75 | + packages = {package.id: package for package in (first, second, maven, child)} |
| 76 | + before = copy.deepcopy(packages) |
| 77 | + |
| 78 | + sources = Core.get_source_data(child, packages) |
| 79 | + |
| 80 | + assert sources == [ |
| 81 | + ("npm/@one/widget@1.0.0", "package.json"), |
| 82 | + ("npm/@two/widget@1.0.0", "package.json"), |
| 83 | + ("maven/com.one/widget@1.0.0", "pom.xml"), |
| 84 | + ] |
| 85 | + assert packages == before |
| 86 | + issue = _issue(sources[:2]) |
| 87 | + _, raw = Messages.create_sources(issue, "raw") |
| 88 | + _, console = Messages.create_sources(issue, "console") |
| 89 | + _, markdown = Messages.create_sources(issue, "md") |
| 90 | + assert raw == "npm/@one/widget@1.0.0;npm/@two/widget@1.0.0" |
| 91 | + assert console == raw |
| 92 | + assert "npm/@one/widget@1.0.0" in markdown |
| 93 | + assert "npm/@two/widget@1.0.0" in markdown |
| 94 | + |
| 95 | + report = build_socket_json_report( |
| 96 | + Diff(new_alerts=[issue]), CliConfig(api_token="", repo="fixture") |
| 97 | + ) |
| 98 | + serialized = json.loads(json.dumps(report)) |
| 99 | + assert serialized["new_alerts"][0]["introduced_by"] == [ |
| 100 | + ["npm/@one/widget@1.0.0", "package.json"], |
| 101 | + ["npm/@two/widget@1.0.0", "package.json"], |
| 102 | + ] |
| 103 | + assert len(serialized) == 18 |
| 104 | + |
| 105 | + |
| 106 | +def test_source_data_preserves_unscoped_direct_missing_and_order_behavior(): |
| 107 | + unscoped = _package( |
| 108 | + "root", |
| 109 | + ecosystem="pypi", |
| 110 | + namespace=None, |
| 111 | + manifests=[{"file": "requirements.in"}, {"file": "requirements.txt"}], |
| 112 | + ) |
| 113 | + empty = _package( |
| 114 | + "empty", |
| 115 | + ecosystem="pypi", |
| 116 | + namespace="", |
| 117 | + manifests=[{"file": "pyproject.toml"}], |
| 118 | + ) |
| 119 | + direct = _package( |
| 120 | + "direct", |
| 121 | + direct=True, |
| 122 | + manifests=[{"file": "one.json"}, {"file": "two.json"}], |
| 123 | + ) |
| 124 | + no_manifest = _package("no-manifest", manifests=[]) |
| 125 | + child = _package( |
| 126 | + "child", ancestors=["root", "empty", "missing", "root", "no-manifest"] |
| 127 | + ) |
| 128 | + packages = {item.id: item for item in (unscoped, empty, direct, no_manifest, child)} |
| 129 | + |
| 130 | + assert Core.get_source_data(child, packages) == [ |
| 131 | + ("pypi/widget@1.0.0", "requirements.in;requirements.txt"), |
| 132 | + ("pypi/widget@1.0.0", "pyproject.toml"), |
| 133 | + ("pypi/widget@1.0.0", "requirements.in;requirements.txt"), |
| 134 | + ] |
| 135 | + assert Core.get_source_data(direct, packages) == [("direct", "one.json;two.json")] |
| 136 | + assert Core.get_source_data(_package("orphan", ancestors=[]), packages) == [] |
| 137 | + assert ( |
| 138 | + Core.get_source_data(_package("missing", ancestors=["absent"]), packages) == [] |
| 139 | + ) |
| 140 | + |
| 141 | + |
| 142 | +def test_source_data_uses_structured_identity_without_mutating_purls_or_traversing(): |
| 143 | + artifact = { |
| 144 | + "id": "socket", |
| 145 | + "type": "npm", |
| 146 | + "namespace": "@one", |
| 147 | + "name": "widget", |
| 148 | + "version": "1.0.0", |
| 149 | + "score": {}, |
| 150 | + "alerts": [], |
| 151 | + "topLevelAncestors": [], |
| 152 | + "manifestFiles": [{"file": "package.json"}], |
| 153 | + } |
| 154 | + socket_package = Package.from_socket_artifact(artifact) |
| 155 | + comparison_package = _package( |
| 156 | + "comparison", |
| 157 | + namespace="@one", |
| 158 | + purl="@one/widget@1.0.0", |
| 159 | + manifests=[{"file": "package.json"}], |
| 160 | + ) |
| 161 | + Core.update_package_values(comparison_package) |
| 162 | + child = _package("child", ancestors=["socket", "comparison", "socket", "child"]) |
| 163 | + socket_package.topLevelAncestors = ["comparison"] |
| 164 | + comparison_package.topLevelAncestors = ["socket"] |
| 165 | + packages = {item.id: item for item in (socket_package, comparison_package, child)} |
| 166 | + original_purls = (socket_package.purl, comparison_package.purl) |
| 167 | + original = copy.deepcopy(packages) |
| 168 | + |
| 169 | + assert Core.get_source_data(child, packages) == [ |
| 170 | + ("npm/@one/widget@1.0.0", "package.json"), |
| 171 | + ("npm/@one/widget@1.0.0", "package.json"), |
| 172 | + ("npm/@one/widget@1.0.0", "package.json"), |
| 173 | + ] |
| 174 | + assert Core.get_source_data(socket_package, packages) == [ |
| 175 | + ("npm/@one/widget@1.0.0", "package.json") |
| 176 | + ] |
| 177 | + assert socket_package.purl == original_purls[0] |
| 178 | + assert comparison_package.purl == original_purls[1] |
| 179 | + assert packages == original |
0 commit comments