|
| 1 | +import fs from "node:fs"; |
| 2 | +import os from "node:os"; |
| 3 | +import path from "node:path"; |
| 4 | +import { readBaseline, writeBaseline, filterNewFindings } from "../src/utils/baseline.js"; |
| 5 | +import type { Finding } from "../src/types.js"; |
| 6 | + |
| 7 | +function makeTempDir(): string { |
| 8 | + return fs.mkdtempSync(path.join(os.tmpdir(), "cve-lite-baseline-test-")); |
| 9 | +} |
| 10 | + |
| 11 | +function removeDir(dir: string): void { |
| 12 | + fs.rmSync(dir, { recursive: true, force: true }); |
| 13 | +} |
| 14 | + |
| 15 | +function makeFinding(name: string, version: string, advisoryIds: string[]): Finding { |
| 16 | + return { |
| 17 | + pkg: { name, version, ecosystem: "npm" }, |
| 18 | + vulnerabilities: advisoryIds.map(id => ({ id, aliases: [], summary: "" })), |
| 19 | + severity: "high", |
| 20 | + cveAliases: [], |
| 21 | + dependencyPaths: [["project", name]], |
| 22 | + relationship: "direct", |
| 23 | + firstFixedVersion: null, |
| 24 | + }; |
| 25 | +} |
| 26 | + |
| 27 | +describe("baseline utilities", () => { |
| 28 | + it("readBaseline returns null when file does not exist", () => { |
| 29 | + const dir = makeTempDir(); |
| 30 | + try { |
| 31 | + expect(readBaseline(dir)).toBeNull(); |
| 32 | + } finally { |
| 33 | + removeDir(dir); |
| 34 | + } |
| 35 | + }); |
| 36 | + |
| 37 | + it("writeBaseline creates .cve-lite directory and baseline.json", () => { |
| 38 | + const dir = makeTempDir(); |
| 39 | + try { |
| 40 | + const findings = [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]; |
| 41 | + writeBaseline(dir, findings); |
| 42 | + expect(fs.existsSync(path.join(dir, ".cve-lite", "baseline.json"))).toBe(true); |
| 43 | + } finally { |
| 44 | + removeDir(dir); |
| 45 | + } |
| 46 | + }); |
| 47 | + |
| 48 | + it("readBaseline returns written baseline", () => { |
| 49 | + const dir = makeTempDir(); |
| 50 | + try { |
| 51 | + const findings = [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]; |
| 52 | + writeBaseline(dir, findings); |
| 53 | + const baseline = readBaseline(dir); |
| 54 | + expect(baseline).not.toBeNull(); |
| 55 | + expect(baseline!.version).toBe(1); |
| 56 | + expect(baseline!.findings).toHaveLength(1); |
| 57 | + expect(baseline!.findings[0]).toEqual({ name: "lodash", version: "4.17.20", advisoryIds: ["GHSA-xxx"] }); |
| 58 | + } finally { |
| 59 | + removeDir(dir); |
| 60 | + } |
| 61 | + }); |
| 62 | + |
| 63 | + it("writeBaseline overwrites existing baseline", () => { |
| 64 | + const dir = makeTempDir(); |
| 65 | + try { |
| 66 | + writeBaseline(dir, [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]); |
| 67 | + writeBaseline(dir, [makeFinding("axios", "0.21.1", ["GHSA-yyy"])]); |
| 68 | + const baseline = readBaseline(dir); |
| 69 | + expect(baseline!.findings).toHaveLength(1); |
| 70 | + expect(baseline!.findings[0].name).toBe("axios"); |
| 71 | + } finally { |
| 72 | + removeDir(dir); |
| 73 | + } |
| 74 | + }); |
| 75 | + |
| 76 | + it("filterNewFindings suppresses findings present in baseline", () => { |
| 77 | + const dir = makeTempDir(); |
| 78 | + try { |
| 79 | + const findings = [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]; |
| 80 | + writeBaseline(dir, findings); |
| 81 | + const baseline = readBaseline(dir)!; |
| 82 | + const { newFindings, suppressedCount } = filterNewFindings(findings, baseline); |
| 83 | + expect(newFindings).toHaveLength(0); |
| 84 | + expect(suppressedCount).toBe(1); |
| 85 | + } finally { |
| 86 | + removeDir(dir); |
| 87 | + } |
| 88 | + }); |
| 89 | + |
| 90 | + it("filterNewFindings surfaces findings for packages not in baseline", () => { |
| 91 | + const dir = makeTempDir(); |
| 92 | + try { |
| 93 | + writeBaseline(dir, [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]); |
| 94 | + const baseline = readBaseline(dir)!; |
| 95 | + const newPkg = makeFinding("axios", "0.21.1", ["GHSA-yyy"]); |
| 96 | + const { newFindings, suppressedCount } = filterNewFindings([newPkg], baseline); |
| 97 | + expect(newFindings).toHaveLength(1); |
| 98 | + expect(suppressedCount).toBe(0); |
| 99 | + } finally { |
| 100 | + removeDir(dir); |
| 101 | + } |
| 102 | + }); |
| 103 | + |
| 104 | + it("filterNewFindings surfaces findings with new advisory IDs not in baseline", () => { |
| 105 | + const dir = makeTempDir(); |
| 106 | + try { |
| 107 | + writeBaseline(dir, [makeFinding("lodash", "4.17.20", ["GHSA-xxx"])]); |
| 108 | + const baseline = readBaseline(dir)!; |
| 109 | + const findingWithNewAdvisory = makeFinding("lodash", "4.17.20", ["GHSA-xxx", "GHSA-new"]); |
| 110 | + const { newFindings, suppressedCount } = filterNewFindings([findingWithNewAdvisory], baseline); |
| 111 | + expect(newFindings).toHaveLength(1); |
| 112 | + expect(suppressedCount).toBe(0); |
| 113 | + } finally { |
| 114 | + removeDir(dir); |
| 115 | + } |
| 116 | + }); |
| 117 | + |
| 118 | + it("filterNewFindings suppresses when all advisory IDs are in baseline", () => { |
| 119 | + const dir = makeTempDir(); |
| 120 | + try { |
| 121 | + writeBaseline(dir, [makeFinding("lodash", "4.17.20", ["GHSA-xxx", "GHSA-yyy"])]); |
| 122 | + const baseline = readBaseline(dir)!; |
| 123 | + const finding = makeFinding("lodash", "4.17.20", ["GHSA-xxx", "GHSA-yyy"]); |
| 124 | + const { newFindings, suppressedCount } = filterNewFindings([finding], baseline); |
| 125 | + expect(newFindings).toHaveLength(0); |
| 126 | + expect(suppressedCount).toBe(1); |
| 127 | + } finally { |
| 128 | + removeDir(dir); |
| 129 | + } |
| 130 | + }); |
| 131 | +}); |
0 commit comments