@fabasoad/sarif-to-slack 1.3.5 → 1.4.2

package/tests/representations/CompactGroupBySarifPerSeverityRepresentation.spec.ts

@@ -0,0 +1,133 @@
+import CompactGroupBySarifPerSeverityRepresentation from '../../src/representations/CompactGroupBySarifPerSeverityRepresentation';
+import FindingArray from '../../src/model/FindingArray';
+import type Finding from '../../src/model/Finding';
+import { SecurityLevel, SecuritySeverity } from '../../src/types';
+import type { RunData, SarifModel } from '../../src/types';
+
+function mockFinding(opts: {
+  sarifPath?: string,
+  runId?: number,
+  toolName?: string,
+  level?: SecurityLevel,
+  severity?: SecuritySeverity,
+}): Finding {
+  const finding: Finding = {
+    get sarifPath() { return opts.sarifPath ?? '/default.sarif' },
+    get runId() { return opts.runId ?? 1 },
+    get toolName() { return opts.toolName ?? 'Tool' },
+    get cvssScore() { return undefined },
+    get level() { return opts.level ?? SecurityLevel.Unknown },
+    get severity() { return opts.severity ?? SecuritySeverity.Unknown },
+    clone() { return mockFinding(opts) },
+  };
+  return finding;
+}
+
+function buildModel(
+  sarifFiles: string[],
+  findings: Finding[],
+): SarifModel {
+  const arr = new FindingArray();
+  findings.forEach(f => arr.push(f));
+  return {
+    sarifFiles,
+    runs: [{ id: 1, toolName: 'Tool', run: {} as RunData['run'] }],
+    findings: arr,
+  };
+}
+
+describe('(unit): CompactGroupBySarifPerSeverityRepresentation', (): void => {
+  describe('compose()', (): void => {
+    test('should return "No vulnerabilities found" when there are no sarif files', (): void => {
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(buildModel([], []));
+      expect(repr.compose()).toBe('No vulnerabilities found');
+    })
+
+    test('should return group header with "No vulnerabilities found" when file has no findings', (): void => {
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel(['/path/to/results.sarif'], []),
+      );
+      expect(repr.compose()).toBe('_[File 1]_ *results.sarif*\nNo vulnerabilities found');
+    })
+
+    test('should compose single finding with correct severity label', (): void => {
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel(
+          ['/path/to/grype.sarif'],
+          [mockFinding({ sarifPath: '/path/to/grype.sarif', severity: SecuritySeverity.Critical })],
+        ),
+      );
+      expect(repr.compose()).toBe('_[File 1]_ *grype.sarif*\n*Critical*: 1');
+    })
+
+    test('should group and sort findings by severity descending', (): void => {
+      const sarifPath = '/scans/results.sarif';
+      const findings = [
+        mockFinding({ sarifPath, severity: SecuritySeverity.Low }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.Critical }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.High }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.High }),
+      ];
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel([sarifPath], findings),
+      );
+      expect(repr.compose()).toBe('_[File 1]_ *results.sarif*\n*Critical*: 1, *High*: 2, *Low*: 1');
+    })
+
+    test('should compose multiple sarif files with incrementing indices', (): void => {
+      const file1 = '/scans/grype-01.sarif';
+      const file2 = '/scans/grype-02.sarif';
+      const findings = [
+        mockFinding({ sarifPath: file1, severity: SecuritySeverity.High }),
+        mockFinding({ sarifPath: file2, severity: SecuritySeverity.Medium }),
+      ];
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel([file1, file2], findings),
+      );
+      expect(repr.compose()).toBe(
+        '_[File 1]_ *grype-01.sarif*\n*High*: 1\n\n_[File 2]_ *grype-02.sarif*\n*Medium*: 1',
+      );
+    })
+
+    test('should show "No vulnerabilities found" for a file that has no matching findings', (): void => {
+      const file1 = '/scans/grype-01.sarif';
+      const file2 = '/scans/grype-02.sarif';
+      const findings = [mockFinding({ sarifPath: file1, severity: SecuritySeverity.Critical })];
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel([file1, file2], findings),
+      );
+      expect(repr.compose()).toBe(
+        '_[File 1]_ *grype-01.sarif*\n*Critical*: 1\n\n_[File 2]_ *grype-02.sarif*\nNo vulnerabilities found',
+      );
+    })
+
+    test('should use only basename for the group title', (): void => {
+      const sarifPath = '/very/long/path/to/nested/scan-results.sarif';
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel(
+          [sarifPath],
+          [mockFinding({ sarifPath, severity: SecuritySeverity.Medium })],
+        ),
+      );
+      expect(repr.compose()).toBe('_[File 1]_ *scan-results.sarif*\n*Medium*: 1');
+    })
+
+    test('should handle all severity variants correctly', (): void => {
+      const sarifPath = '/scans/all-severities.sarif';
+      const findings = [
+        mockFinding({ sarifPath, severity: SecuritySeverity.Critical }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.High }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.Medium }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.Low }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.None }),
+        mockFinding({ sarifPath, severity: SecuritySeverity.Unknown }),
+      ];
+      const repr = new CompactGroupBySarifPerSeverityRepresentation(
+        buildModel([sarifPath], findings),
+      );
+      expect(repr.compose()).toBe(
+        '_[File 1]_ *all-severities.sarif*\n*Critical*: 1, *High*: 1, *Medium*: 1, *Low*: 1, *None*: 1, *Unknown*: 1',
+      );
+    })
+  })
+})

package/tests/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "..",
+    "types": ["node", "vitest/globals"]
+  },
+  "include": [".."]
+}

package/tests/vitest.d.ts

@@ -0,0 +1 @@
+/// <reference types="vitest/globals" />

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "types": ["node"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "tests"]
+}

package/tsconfig.json

@@ -6,7 +6,7 @@
     "declaration": true,
     "declarationDir": "dist",
     "declarationMap": true,
-    "emitDecoratorMetadata": true,
+    "emitDecoratorMetadata": false,
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "forceConsistentCasingInFileNames": true,
@@ -14,7 +14,7 @@
     "lib": ["es2024"],
     "module": "es2022",
     "moduleResolution": "bundler",
-    "rootDir": "src",
+    "rootDir": ".",
     "newLine": "lf",
     "noFallthroughCasesInSwitch": true,
     "noImplicitAny": true,
@@ -29,8 +29,8 @@
     "stripInternal": true,
     "target": "es2024",
     "typeRoots": ["node_modules/@types", "@types"],
-    "types": ["node", "jest"]
+    "types": ["node"]
   },
-  "include": ["src"],
-  "exclude": ["node_modules", "dist", "tests"]
+  "include": ["src", "tests"],
+  "exclude": ["node_modules", "dist"]
 }

package/tsconfig.test.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "types": ["node", "vitest/globals"]
+  },
+  "include": ["src", "tests"]
+}

package/vitest.config.ts

@@ -0,0 +1,22 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    clearMocks: true,
+    coverage: {
+      include: ['**/*.ts'],
+      exclude: ['**/*.d.ts', '**/node_modules/**'],
+      reporter: ['lcov', 'text', 'text-summary'],
+      thresholds: {
+        branches: 10,
+        functions: 40,
+        lines: 25,
+        statements: 30,
+      },
+    },
+    environment: 'node',
+    include: ['**/*.spec.ts'],
+    testTimeout: 20000,
+  },
+});

package/dist/Logger.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=Logger.d.ts.map

package/dist/Logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../src/Logger.ts"],"names":[],"mappings":""}

package/dist/Logger.js

@@ -1,66 +0,0 @@
-import { Logger as TSLogger } from 'tslog';
-import { z } from 'zod';
-import { isDebug } from './system';
-const LogLevelItems = ['silly', 'trace', 'debug', 'info', 'warning', 'error', 'fatal'];
-/**
- * Logger class for managing logging operations.
- * @internal
- */
-export default class Logger {
-    static APP_NAME = '@fabasoad/sarif-to-slack';
-    static DEFAULT_LOG_LEVEL = 'info';
-    static DEFAULT_LOG_TEMPLATE = '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ';
-    static DEFAULT_LOG_COLORED = true;
-    _instance;
-    isLogLevel(v) {
-        return LogLevelItems.includes(v);
-    }
-    getMinLevel() {
-        let result = Logger.DEFAULT_LOG_LEVEL;
-        if (isDebug()) {
-            result = 'silly';
-        }
-        else {
-            const parseResult = z
-                .string()
-                .refine((v) => this.isLogLevel(v))
-                .transform((v) => v)
-                .safeParse(process.env.SARIF_TO_SLACK_LOG_LEVEL);
-            if (parseResult.success) {
-                result = parseResult.data;
-            }
-        }
-        return LogLevelItems.findIndex((v) => v === result);
-    }
-    getLogTemplate() {
-        const result = z.string().safeParse(process.env.SARIF_TO_SLACK_LOG_TEMPLATE);
-        return result.success ? result.data : Logger.DEFAULT_LOG_TEMPLATE;
-    }
-    getLogColored() {
-        const result = z.stringbool().safeParse(process.env.SARIF_TO_SLACK_LOG_COLORED);
-        return result.success ? result.data : Logger.DEFAULT_LOG_COLORED;
-    }
-    constructor(memberName) {
-        this._instance = new TSLogger({
-            name: `${Logger.APP_NAME}${memberName === undefined ? '' : `::${memberName}`}`,
-            minLevel: this.getMinLevel(),
-            type: 'pretty',
-            prettyLogTimeZone: 'UTC',
-            prettyLogTemplate: this.getLogTemplate(),
-            stylePrettyLogs: this.getLogColored(),
-        });
-    }
-    info(...args) {
-        this._instance.info(...args);
-    }
-    warn(...args) {
-        this._instance.warn(...args);
-    }
-    trace(...args) {
-        this._instance.trace(...args);
-    }
-    debug(...args) {
-        this._instance.debug(...args);
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL0xvZ2dlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQWdCLE1BQU0sSUFBSSxRQUFRLEVBQUUsTUFBTSxPQUFPLENBQUE7QUFDeEQsT0FBTyxFQUFFLENBQUMsRUFBMkIsTUFBTSxLQUFLLENBQUM7QUFDakQsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUVuQyxNQUFNLGFBQWEsR0FBRyxDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsT0FBTyxFQUFFLE9BQU8sQ0FBVSxDQUFDO0FBR2hHOzs7R0FHRztBQUNILE1BQU0sQ0FBQyxPQUFPLE9BQU8sTUFBTTtJQUNqQixNQUFNLENBQUMsUUFBUSxHQUFXLDBCQUEwQixDQUFDO0lBQ3JELE1BQU0sQ0FBQyxpQkFBaUIsR0FBYSxNQUFNLENBQUM7SUFDNUMsTUFBTSxDQUFDLG9CQUFvQixHQUFXLCtDQUErQyxDQUFDO0lBQ3RGLE1BQU0sQ0FBQyxtQkFBbUIsR0FBWSxJQUFJLENBQUM7SUFFbEMsU0FBUyxDQUFvQjtJQUV0QyxVQUFVLENBQUMsQ0FBUztRQUMxQixPQUFRLGFBQXVDLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzlELENBQUM7SUFFTyxXQUFXO1FBQ2pCLElBQUksTUFBTSxHQUFhLE1BQU0sQ0FBQyxpQkFBaUIsQ0FBQztRQUVoRCxJQUFJLE9BQU8sRUFBRSxFQUFFLENBQUM7WUFDZCxNQUFNLEdBQUcsT0FBTyxDQUFDO1FBQ25CLENBQUM7YUFBTSxDQUFDO1lBQ04sTUFBTSxXQUFXLEdBQWlDLENBQUM7aUJBQ2hELE1BQU0sRUFBRTtpQkFDUixNQUFNLENBQUMsQ0FBQyxDQUFTLEVBQVcsRUFBRSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUM7aUJBQ2xELFNBQVMsQ0FBQyxDQUFDLENBQVMsRUFBWSxFQUFFLENBQUMsQ0FBYSxDQUFDO2lCQUNqRCxTQUFTLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyx3QkFBd0IsQ0FBQyxDQUFDO1lBQ25ELElBQUksV0FBVyxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUN4QixNQUFNLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQztZQUM1QixDQUFDO1FBQ0gsQ0FBQztRQUVELE9BQU8sYUFBYSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQVcsRUFBVyxFQUFFLENBQUMsQ0FBQyxLQUFLLE1BQU0sQ0FBQyxDQUFDO0lBQ3pFLENBQUM7SUFFTyxjQUFjO1FBQ3BCLE1BQU0sTUFBTSxHQUNWLENBQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQywyQkFBMkIsQ0FBQyxDQUFDO1FBQ2hFLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLG9CQUFvQixDQUFDO0lBQ3BFLENBQUM7SUFFTyxhQUFhO1FBQ25CLE1BQU0sTUFBTSxHQUNWLENBQUMsQ0FBQyxVQUFVLEVBQUUsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQywwQkFBMEIsQ0FBQyxDQUFDO1FBQ25FLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLG1CQUFtQixDQUFDO0lBQ25FLENBQUM7SUFFRCxZQUFtQixVQUFtQjtRQUNwQyxJQUFJLENBQUMsU0FBUyxHQUFHLElBQUksUUFBUSxDQUFDO1lBQzVCLElBQUksRUFBRSxHQUFHLE1BQU0sQ0FBQyxRQUFRLEdBQUcsVUFBVSxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxLQUFLLFVBQVUsRUFBRSxFQUFFO1lBQzlFLFFBQVEsRUFBRSxJQUFJLENBQUMsV0FBVyxFQUFFO1lBQzVCLElBQUksRUFBRSxRQUFRO1lBQ2QsaUJBQWlCLEVBQUUsS0FBSztZQUN4QixpQkFBaUIsRUFBRSxJQUFJLENBQUMsY0FBYyxFQUFFO1lBQ3hDLGVBQWUsRUFBRSxJQUFJLENBQUMsYUFBYSxFQUFFO1NBQ3RDLENBQUMsQ0FBQTtJQUNKLENBQUM7SUFFTSxJQUFJLENBQUMsR0FBRyxJQUFlO1FBQzVCLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDL0IsQ0FBQztJQUVNLElBQUksQ0FBQyxHQUFHLElBQWU7UUFDNUIsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFJLENBQUMsQ0FBQztJQUMvQixDQUFDO0lBRU0sS0FBSyxDQUFDLEdBQUcsSUFBZTtRQUM3QixJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDO0lBQ2hDLENBQUM7SUFFTSxLQUFLLENBQUMsR0FBRyxJQUFlO1FBQzdCLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDaEMsQ0FBQyJ9

package/jest.config.json

@@ -1,33 +0,0 @@
-{
-  "clearMocks": true,
-  "collectCoverageFrom": [
-    "**/*.ts",
-    "!**/*.d.ts",
-    "!**/node_modules/**"
-  ],
-  "coverageReporters": [
-    "lcov", "text", "text-summary"
-  ],
-  "coverageThreshold": {
-    "global": {
-      "branches": 3,
-      "functions": 3,
-      "lines": 15,
-      "statements": 15
-    }
-  },
-  "moduleFileExtensions": [
-    "js",
-    "ts"
-  ],
-  "testEnvironment": "node",
-  "testMatch": [
-    "**/*.spec.ts"
-  ],
-  "testRunner": "jest-circus/runner",
-  "testTimeout": 20000,
-  "transform": {
-    "^.+\\.ts$": "ts-jest"
-  },
-  "verbose": true
-}

package/src/Logger.ts

@@ -1,81 +0,0 @@
-import { type ILogObj, Logger as TSLogger } from 'tslog'
-import { z, type ZodSafeParseResult } from 'zod';
-import { isDebug } from './system';
-
-const LogLevelItems = ['silly', 'trace', 'debug', 'info', 'warning', 'error', 'fatal'] as const;
-type LogLevel = (typeof LogLevelItems)[number];
-
-/**
- * Logger class for managing logging operations.
- * @internal
- */
-export default class Logger {
-  private static APP_NAME: string = '@fabasoad/sarif-to-slack';
-  private static DEFAULT_LOG_LEVEL: LogLevel = 'info';
-  private static DEFAULT_LOG_TEMPLATE: string = '[{{logLevelName}}] [{{name}}] {{dateIsoStr}} ';
-  private static DEFAULT_LOG_COLORED: boolean = true;
-
-  private readonly _instance: TSLogger<ILogObj>;
-
-  private isLogLevel(v: string): v is LogLevel {
-    return (LogLevelItems as ReadonlyArray<string>).includes(v);
-  }
-
-  private getMinLevel(): number {
-    let result: LogLevel = Logger.DEFAULT_LOG_LEVEL;
-
-    if (isDebug()) {
-      result = 'silly';
-    } else {
-      const parseResult: ZodSafeParseResult<LogLevel> = z
-        .string()
-        .refine((v: string): boolean => this.isLogLevel(v))
-        .transform((v: string): LogLevel => v as LogLevel)
-        .safeParse(process.env.SARIF_TO_SLACK_LOG_LEVEL);
-      if (parseResult.success) {
-        result = parseResult.data;
-      }
-    }
-
-    return LogLevelItems.findIndex((v: LogLevel): boolean => v === result);
-  }
-
-  private getLogTemplate(): string {
-    const result: ZodSafeParseResult<string> =
-      z.string().safeParse(process.env.SARIF_TO_SLACK_LOG_TEMPLATE);
-    return result.success ? result.data : Logger.DEFAULT_LOG_TEMPLATE;
-  }
-
-  private getLogColored(): boolean {
-    const result: ZodSafeParseResult<boolean> =
-      z.stringbool().safeParse(process.env.SARIF_TO_SLACK_LOG_COLORED);
-    return result.success ? result.data : Logger.DEFAULT_LOG_COLORED;
-  }
-
-  public constructor(memberName?: string) {
-    this._instance = new TSLogger({
-      name: `${Logger.APP_NAME}${memberName === undefined ? '' : `::${memberName}`}`,
-      minLevel: this.getMinLevel(),
-      type: 'pretty',
-      prettyLogTimeZone: 'UTC',
-      prettyLogTemplate: this.getLogTemplate(),
-      stylePrettyLogs: this.getLogColored(),
-    })
-  }
-
-  public info(...args: unknown[]): void {
-    this._instance.info(...args);
-  }
-
-  public warn(...args: unknown[]): void {
-    this._instance.warn(...args);
-  }
-
-  public trace(...args: unknown[]): void {
-    this._instance.trace(...args);
-  }
-
-  public debug(...args: unknown[]): void {
-    this._instance.debug(...args);
-  }
-}