Upgrades version to 0.2.4

scanoss · Dec 18, 2024 · f7f5381 · f7f5381
1 parent 166bbbe
commit f7f5381
Show file tree

Hide file tree

Showing 6 changed files with 212 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ For example workflow runs, check out our
 | licenses.copyleft.exclude  | List of Copyleft licenses to remove from default list. Provide licenses as a comma-separated list.                                                       | Optional     | -                                    |
 | licenses.copyleft.explicit | Explicit list of Copyleft licenses to consider. Provide licenses as a comma-separated list.                                                              | Optional     | -                                    |
 | runtimeContainer           | Runtime URL                                                                                                                                              | Optional     | `ghcr.io/scanoss/scanoss-py:v1.15.0` |
-| skipSnippets               | Skip the generation of snippets. (scan_files option must be enabled)                                                                                     | Optional     | `false`                              |
+| skipSnippets               | Skip the generation of snippets. (scanFiles option must be enabled)                                                                                      | Optional     | `false`                              |
 | scanFiles                  | Enable or disable file and snippet scanning                                                                                                              | Optional     | `true`                               |
 | scanossSettings            | Settings file to use for scanning. See the SCANOSS settings [documentation](https://scanoss.readthedocs.io/projects/scanoss-py/en/latest/#settings-file) | Optional     | `true`                               |
 | settingsFilepath           | Filepath of the SCANOSS settings to be used for scanning                                                                                                 | Optional     | `scanoss.json`                       |

diff --git a/__tests__/data/test-results.json b/__tests__/data/test-results.json
diff --git a/__tests__/undeclared-policy-check.test.ts b/__tests__/undeclared-policy-check.test.ts
@@ -37,7 +37,7 @@ describe('UndeclaredPolicyCheck', () => {
     scannerResults = JSON.parse(resultsMock[3].content);
 
     undeclaredPolicyCheck = new UndeclaredPolicyCheck();
-  });
+  }, 30000);
 
   it('should pass the policy check when undeclared components are not found', async () => {
     const TEST_DIR = __dirname;
@@ -50,7 +50,7 @@ describe('UndeclaredPolicyCheck', () => {
 
     await undeclaredPolicyCheck.run();
     expect(undeclaredPolicyCheck.conclusion).toEqual(CONCLUSION.Success);
-  });
+  }, 30000);
 
   it('should fail the policy check when undeclared components are found', async () => {
     const TEST_DIR = __dirname;
@@ -63,5 +63,5 @@ describe('UndeclaredPolicyCheck', () => {
 
     await undeclaredPolicyCheck.run();
     expect(undeclaredPolicyCheck.conclusion).toEqual(CONCLUSION.Neutral);
-  });
+  }, 30000);
 });
diff --git a/dist/index.js b/dist/index.js
diff --git a/policy-check-undeclared-results.md b/policy-check-undeclared-results.md
@@ -0,0 +1,25 @@
+5 undeclared component(s) were found.
+Add the following snippet into your `sbom.json` file
+
+```json
+{
+  "components": [
+    {
+      "purl": "pkg:github/scanoss/wfp"
+    },
+    {
+      "purl": "pkg:github/scanoss/scanner.c"
+    },
+    {
+      "purl": "pkg:npm/%40grpc/grpc-js"
+    },
+    {
+      "purl": "pkg:npm/abort-controller"
+    },
+    {
+      "purl": "pkg:npm/adm-zip"
+    }
+  ]
+}
+```
+
diff --git a/src/services/scan.service.ts b/src/services/scan.service.ts
@@ -346,6 +346,7 @@ export class ScanService {
   private async detectSBOM(): Promise<string[]> {
     // Overrides sbom file if is set
     if (this.options.scanossSettings) {
+      core.debug(`[SCANOSS SETTINGS ENABLED] ${this.options.sbomFilepath}, ${this.options.sbomFilepath}`);
       try {
         await fs.promises.access(this.options.settingsFilePath, fs.constants.F_OK);
         return ['--settings', this.options.settingsFilePath];
@@ -358,9 +359,10 @@ export class ScanService {
     }
 
     if (!this.options.sbomEnabled || !this.options.sbomFilepath) return [];
-
+    core.debug(`[SBOM ENABLED] ${this.options.sbomFilepath}, ${this.options.sbomFilepath}`);
     try {
       await fs.promises.access(this.options.sbomFilepath, fs.constants.F_OK);
+      core.debug(`[SBOM ENABLED] - Adding sbom to scan parameters`);
       return [`--${this.options.sbomType?.toLowerCase()}`, this.options.sbomFilepath];
     } catch (error: any) {
       core.error(error.message);