SP-246 Changes Sbom to SBOM

scanoss · Mar 22, 2024 · 676d1c0 · 676d1c0
1 parent e42e41d
commit 676d1c0
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
diff --git 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
@@ -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<string> {
+  private async detectSBOM(): Promise<string> {
     if (!this.options.sbomEnabled || !this.options.sbomFilepath) return '';
 
     try {

diff --git 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<Sbom> {
-  return JSON.parse(await fs.promises.readFile(filepath, 'utf-8')) as Sbom;
+export async function parseSBOM(filepath: string): Promise<SBOM> {
+  return JSON.parse(await fs.promises.readFile(filepath, 'utf-8')) as SBOM;
 }