diff --git a/__tests__/sbom.mock.ts b/__tests__/sbom.mock.ts index 134e720..00725a9 100644 --- a/__tests__/sbom.mock.ts +++ b/__tests__/sbom.mock.ts @@ -1,8 +1,8 @@ -import { Sbom } from '../src/utils/sbom.utils'; +import { SBOM } from '../src/utils/sbom.utils'; -export const sbomMock: Sbom[] = [ +export const sbomMock: SBOM[] = [ { - components: [] // empty sbom + components: [] // empty SBOM }, { components: [ diff --git a/__tests__/undeclared-policy-check.test.ts b/__tests__/undeclared-policy-check.test.ts index 01a755d..6a10353 100644 --- a/__tests__/undeclared-policy-check.test.ts +++ b/__tests__/undeclared-policy-check.test.ts @@ -3,7 +3,7 @@ import { ScannerResults } from '../src/services/result.interfaces'; import * as github from '@actions/github'; import { resultsMock } from './results.mock'; import { UndeclaredPolicyCheck } from '../src/policies/undeclared-policy-check'; -import * as sbom from '../src/utils/sbom.utils'; +import * as sbomUtils from '../src/utils/sbom.utils'; import { sbomMock } from './sbom.mock'; describe('UndeclaredPolicyCheck', () => { @@ -24,14 +24,14 @@ describe('UndeclaredPolicyCheck', () => { }); it('should pass the policy check when undeclared components are not found', async () => { - jest.spyOn(sbom, 'parseSbom').mockImplementation(async _ => Promise.resolve(sbomMock[1])); + jest.spyOn(sbomUtils, 'parseSBOM').mockImplementation(async _ => Promise.resolve(sbomMock[1])); await undeclaredPolicyCheck.run(scannerResults); expect(undeclaredPolicyCheck.conclusion).toEqual(CONCLUSION.Success); }); it('should fail the policy check when undeclared components are found', async () => { - jest.spyOn(sbom, 'parseSbom').mockImplementation(async _ => Promise.resolve(sbomMock[0])); + jest.spyOn(sbomUtils, 'parseSBOM').mockImplementation(async _ => Promise.resolve(sbomMock[0])); await undeclaredPolicyCheck.run(scannerResults); expect(undeclaredPolicyCheck.conclusion).toEqual(CONCLUSION.Neutral); diff --git a/action.yml b/action.yml index 48c6042..b72c58b 100644 --- a/action.yml +++ b/action.yml @@ -17,15 +17,15 @@ inputs: required: false default: true sbom.enabled: - description: 'Enable Sbom Identify' + description: 'Enable SBOM Identify' required: false default: true sbom.filepath: - description: 'Sbom filepath' + description: 'SBOM filepath' required: false default: 'sbom.json' sbom.type: - description: 'Sbom type (identify | ignore)' + description: 'SBOM type (identify | ignore)' required: false default: 'identify' api.key: diff --git a/dist/index.js b/dist/index.js index f828700..7117fbb 100644 --- a/dist/index.js +++ b/dist/index.js @@ -126128,7 +126128,7 @@ class UndeclaredPolicyCheck extends policy_check_1.PolicyCheck { super.run(scannerResults); const nonDeclaredComponents = []; const comps = (0, result_service_1.getComponents)(scannerResults); - const sbom = await (0, sbom_utils_1.parseSbom)(inputs.SBOM_FILEPATH); + const sbom = await (0, sbom_utils_1.parseSBOM)(inputs.SBOM_FILEPATH); comps.forEach(c => { if (!sbom.components.some(component => component.purl === c.purl)) { nonDeclaredComponents.push(c); @@ -126478,11 +126478,11 @@ class ScanService { return `docker run -v "${this.options.inputFilepath}":"/scanoss" ghcr.io/scanoss/scanoss-py:v1.9.0 scan . --output ${this.options.outputFilepath} ${this.options.dependenciesEnabled ? `--dependencies` : ''} - ${await this.detectSbom()} + ${await this.detectSBOM()} ${this.options.apiUrl ? `--apiurl ${this.options.apiUrl}` : ''} ${this.options.apiKey ? `--key ${this.options.apiKey}` : ''}`.replace(/\n/gm, ' '); } - async detectSbom() { + async detectSBOM() { if (!this.options.sbomEnabled || !this.options.sbomFilepath) return ''; try { @@ -126598,12 +126598,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", ({ value: true })); -exports.parseSbom = void 0; +exports.parseSBOM = void 0; const fs_1 = __importDefault(__nccwpck_require__(57147)); -async function parseSbom(filepath) { +async function parseSBOM(filepath) { return JSON.parse(await fs_1.default.promises.readFile(filepath, 'utf-8')); } -exports.parseSbom = parseSbom; +exports.parseSBOM = parseSBOM; /***/ }), diff --git a/src/policies/undeclared-policy-check.ts b/src/policies/undeclared-policy-check.ts index f1cb7e8..f233b02 100644 --- a/src/policies/undeclared-policy-check.ts +++ b/src/policies/undeclared-policy-check.ts @@ -3,7 +3,7 @@ import { CHECK_NAME } from '../app.config'; import { ScannerResults } from '../services/result.interfaces'; import { Component, getComponents } from '../services/result.service'; import * as inputs from '../app.input'; -import { parseSbom } from '../utils/sbom.utils'; +import { parseSBOM } from '../utils/sbom.utils'; import { generateTable } from '../utils/markdown.utils'; export class UndeclaredPolicyCheck extends PolicyCheck { @@ -17,7 +17,7 @@ export class UndeclaredPolicyCheck extends PolicyCheck { const nonDeclaredComponents: Component[] = []; const comps = getComponents(scannerResults); - const sbom = await parseSbom(inputs.SBOM_FILEPATH); + const sbom = await parseSBOM(inputs.SBOM_FILEPATH); comps.forEach(c => { if (!sbom.components.some(component => component.purl === c.purl)) { diff --git a/src/services/scan.service.ts b/src/services/scan.service.ts index b339971..aafaf9d 100644 --- a/src/services/scan.service.ts +++ b/src/services/scan.service.ts @@ -55,12 +55,12 @@ export class ScanService { return `docker run -v "${this.options.inputFilepath}":"/scanoss" ghcr.io/scanoss/scanoss-py:v1.9.0 scan . --output ${this.options.outputFilepath} ${this.options.dependenciesEnabled ? `--dependencies` : ''} - ${await this.detectSbom()} + ${await this.detectSBOM()} ${this.options.apiUrl ? `--apiurl ${this.options.apiUrl}` : ''} ${this.options.apiKey ? `--key ${this.options.apiKey}` : ''}`.replace(/\n/gm, ' '); } - private async detectSbom(): Promise { + private async detectSBOM(): Promise { if (!this.options.sbomEnabled || !this.options.sbomFilepath) return ''; try { diff --git a/src/utils/sbom.utils.ts b/src/utils/sbom.utils.ts index 6e1f44c..3fd00be 100644 --- a/src/utils/sbom.utils.ts +++ b/src/utils/sbom.utils.ts @@ -1,11 +1,11 @@ import fs from 'fs'; -export interface Sbom { +export interface SBOM { components: { purl: string; }[]; } -export async function parseSbom(filepath: string): Promise { - return JSON.parse(await fs.promises.readFile(filepath, 'utf-8')) as Sbom; +export async function parseSBOM(filepath: string): Promise { + return JSON.parse(await fs.promises.readFile(filepath, 'utf-8')) as SBOM; }