@soos-io/soos-sbom 1.0.1-pre.2 → 1.0.1-pre.4

package/README.md

@@ -38,4 +38,6 @@ Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sbom/bin
 | `--operatingEnvironment`|                                     | Set Operating environment for information purposes only.                                                                           |
 | `--otherOptions`        |                                     | Other Options to pass to syft.                                                                                                      |
 | `--projectName`         |                                        | Project Name - this is what will be displayed in the SOOS app.                                                                     |
-| `sbomPath`              |                                        | The SBOM File to scan, it could be the location of the file or the file itself. When location is specified only the first file found will be scanned. |
+| `--directoriesToExclude` | `**/node_modules/**, "**/bin/**", "**/obj/**", "**/lib/**` | Listing of directories or patterns to exclude from the search for SBOM files. eg: **bin/start/**, **/start/**                                         |
+| `--filesToExclude` |  | Listing of files or patterns patterns to exclude from the search for SBOM files. eg: **/int**.cdx.json/, **/internal.cdx.json                         |
+| `sbomPath`              |                                        | The SBOM file or folder to scan. When a folder is specified all SBOMs found in the folder and sub-folders will be scanned. |

package/bin/constants.d.ts

@@ -1,5 +1,8 @@
 export declare const SOOS_SBOM_CONSTANTS: {
     FileRegex: RegExp;
+    FileSyncPattern: string;
     MaxSbomsPerScan: number;
     UploadBatchSize: number;
+    DefaultDirectoriesToExclude: string[];
+    SoosDirectoryToExclude: string;
 };

package/bin/constants.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SOOS_SBOM_CONSTANTS = void 0;
 exports.SOOS_SBOM_CONSTANTS = {
     FileRegex: /\.(cdx|spdx)\.json$/,
+    FileSyncPattern: "**/*.@(cdx.json|spdx.json)",
     MaxSbomsPerScan: 50,
     UploadBatchSize: 10,
+    DefaultDirectoriesToExclude: ["**/node_modules/**", "**/bin/**", "**/obj/**", "**/lib/**"],
+    SoosDirectoryToExclude: "**/soos/**",
 };

package/bin/index.js

@@ -11,6 +11,8 @@ const AnalysisArgumentParser_1 = tslib_1.__importDefault(require("@soos-io/api-c
 const package_json_1 = require("../package.json");
 const AnalysisService_1 = tslib_1.__importDefault(require("@soos-io/api-client/dist/services/AnalysisService"));
 const constants_1 = require("./constants");
+const utilities_2 = require("./utilities");
+const Glob = tslib_1.__importStar(require("glob"));
 class SOOSSBOMAnalysis {
     constructor(args) {
         this.args = args;
@@ -18,8 +20,23 @@ class SOOSSBOMAnalysis {
     static parseArgs() {
         const analysisArgumentParser = AnalysisArgumentParser_1.default.create(api_client_1.IntegrationName.SoosSbom, api_client_1.IntegrationType.Script, api_client_1.ScanType.SBOM, package_json_1.version);
         analysisArgumentParser.addBaseScanArguments();
+        analysisArgumentParser.argumentParser.add_argument("--directoriesToExclude", {
+            help: "Listing of directories or patterns to exclude from the search for SBOM files. eg: **bin/start/**, **/start/**",
+            type: (value) => {
+                return (0, utilities_2.removeDuplicates)(value.split(",").map((pattern) => pattern.trim()));
+            },
+            default: constants_1.SOOS_SBOM_CONSTANTS.DefaultDirectoriesToExclude,
+            required: false,
+        });
+        analysisArgumentParser.argumentParser.add_argument("--filesToExclude", {
+            help: "Listing of files or patterns patterns to exclude from the search for SBOM files. eg: **/int**.cdx.json/, **/internal.cdx.json",
+            type: (value) => {
+                return value.split(",").map((pattern) => pattern.trim());
+            },
+            required: false,
+        });
         analysisArgumentParser.argumentParser.add_argument("sbomPath", {
-            help: "The SBOM File to scan, it could be the location of the file or the file itself. When location is specified only the first file found will be scanned.",
+            help: "The SBOM file or folder to scan. When a folder is specified all SBOMs found in the folder and sub-folders will be scanned.",
         });
         api_client_1.soosLogger.info("Parsing arguments");
         return analysisArgumentParser.parseArguments();
@@ -128,12 +145,21 @@ class SOOSSBOMAnalysis {
     async findSbomFilePaths() {
         const sbomPathStat = await FileSystem.statSync(this.args.sbomPath);
         if (sbomPathStat.isDirectory()) {
-            const files = await FileSystem.promises.readdir(this.args.sbomPath);
-            const sbomFiles = files.filter((file) => constants_1.SOOS_SBOM_CONSTANTS.FileRegex.test(file));
+            const searchPattern = this.args.sbomPath.endsWith("/") || this.args.sbomPath.endsWith("\\")
+                ? `${this.args.sbomPath}${constants_1.SOOS_SBOM_CONSTANTS.FileSyncPattern}`
+                : `${this.args.sbomPath}/${constants_1.SOOS_SBOM_CONSTANTS.FileSyncPattern}`;
+            const sbomFiles = Glob.sync(searchPattern, {
+                ignore: [
+                    ...(this.args.filesToExclude || []),
+                    ...(this.args.directoriesToExclude || []),
+                    constants_1.SOOS_SBOM_CONSTANTS.SoosDirectoryToExclude,
+                ],
+                nocase: true,
+            });
             if (!sbomFiles || sbomFiles.length == 0) {
                 throw new Error("No SBOM files found in the directory.");
             }
-            return sbomFiles.map((sbomFile) => Path.join(this.args.sbomPath, sbomFile));
+            return sbomFiles;
         }
         if (!constants_1.SOOS_SBOM_CONSTANTS.FileRegex.test(this.args.sbomPath)) {
             throw new Error("The file does not match the required SBOM pattern.");

package/bin/utilities.d.ts

@@ -0,0 +1 @@
+export declare const removeDuplicates: <T>(list: Array<T>) => Array<T>;

package/bin/utilities.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeDuplicates = void 0;
+const removeDuplicates = (list) => [...new Set(list)];
+exports.removeDuplicates = removeDuplicates;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soos-io/soos-sbom",
-  "version": "1.0.1-pre.2",
+  "version": "1.0.1-pre.4",
   "description": "SOOS wrapper script to upload SBOMs.",
   "main": "bin/index.js",
   "scripts": {