@soos-io/soos-sbom 1.1.3 → 1.1.4-pre.2

package/bin/constants.d.ts

@@ -1,6 +1,6 @@
 export declare const SOOS_SBOM_CONSTANTS: {
     FileRegex: RegExp;
-    FileSyncPattern: string;
+    FilePattern: string;
     MaxSbomsPerScan: number;
     UploadBatchSize: number;
     DefaultDirectoriesToExclude: string[];

package/bin/constants.js

@@ -3,7 +3,7 @@ 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)",
+    FilePattern: "**/*.@(cdx.json|spdx.json)",
     MaxSbomsPerScan: 50,
     UploadBatchSize: 10,
     DefaultDirectoriesToExclude: ["**/node_modules/**", "**/bin/**", "**/obj/**", "**/lib/**"],

package/bin/index.js

@@ -45,15 +45,6 @@ class SOOSSBOMAnalysis {
         let analysisId;
         let scanStatusUrl;
         let scanStatus;
-        let sbomFilePaths = await this.findSbomFilePaths();
-        const hasMoreThanMaximumManifests = sbomFilePaths.length > constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan;
-        if (hasMoreThanMaximumManifests) {
-            const filesToSkip = sbomFilePaths.slice(constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan);
-            sbomFilePaths = sbomFilePaths.slice(0, constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan);
-            const filesDetectedString = utilities_1.StringUtilities.pluralizeTemplate(sbomFilePaths.length, "file was", "files were");
-            const filesSkippedString = utilities_1.StringUtilities.pluralizeTemplate(filesToSkip.length, "file");
-            api_client_1.soosLogger.info(`The maximum number of SBOMs per scan is ${constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan}. ${filesDetectedString} detected, and ${filesSkippedString} will be not be uploaded. \n`, `The following SBOMs will not be included in the scan: \n`, filesToSkip.map((file) => `  "${Path.parse(file).base}": "${file}"`).join("\n"));
-        }
         try {
             const result = await soosAnalysisService.setupScan({
                 clientId: this.args.clientId,
@@ -87,6 +78,41 @@ class SOOSSBOMAnalysis {
             branchHash = result.branchHash;
             analysisId = result.analysisId;
             scanStatusUrl = result.scanStatusUrl;
+            const { sbomFilePaths, hasMoreThanMaximumManifests } = await this.findSbomFilePaths();
+            if (sbomFilePaths.length === 0) {
+                const noFilesMessage = `No SBOM files found. They need to match the pattern ${constants_1.SOOS_SBOM_CONSTANTS.FilePattern}. See https://kb.soos.io/getting-started-with-soos-sbom-manager for more information.`;
+                await soosAnalysisService.updateScanStatus({
+                    analysisId,
+                    clientId: this.args.clientId,
+                    projectHash,
+                    branchHash,
+                    scanType,
+                    status: api_client_1.ScanStatus.NoFiles,
+                    message: noFilesMessage,
+                    scanStatusUrl,
+                });
+                api_client_1.soosLogger.error(noFilesMessage);
+                api_client_1.soosLogger.always(`${noFilesMessage} - exit 1`);
+                (0, process_1.exit)(1);
+            }
+            if (sbomFilePaths.length === 1 &&
+                sbomFilePaths[0] === this.args.sbomPath &&
+                !constants_1.SOOS_SBOM_CONSTANTS.FileRegex.test(sbomFilePaths[0])) {
+                const noFilesMessage = `The file does not match the required SBOM pattern ${constants_1.SOOS_SBOM_CONSTANTS.FilePattern}. See https://kb.soos.io/getting-started-with-soos-sbom-manager for more information.`;
+                await soosAnalysisService.updateScanStatus({
+                    analysisId,
+                    clientId: this.args.clientId,
+                    projectHash,
+                    branchHash,
+                    scanType,
+                    status: api_client_1.ScanStatus.NoFiles,
+                    message: noFilesMessage,
+                    scanStatusUrl,
+                });
+                api_client_1.soosLogger.error(noFilesMessage);
+                api_client_1.soosLogger.always(`${noFilesMessage} - exit 1`);
+                (0, process_1.exit)(1);
+            }
             api_client_1.soosLogger.logLineSeparator();
             api_client_1.soosLogger.info("Uploading SBOM File(s)...");
             for (let i = 0; i < sbomFilePaths.length; i += constants_1.SOOS_SBOM_CONSTANTS.UploadBatchSize) {
@@ -100,7 +126,7 @@ class SOOSSBOMAnalysis {
                     manifestFiles: formData,
                     hasMoreThanMaximumManifests,
                 });
-                api_client_1.soosLogger.info(` SBOM Files: \n`, `  ${manifestUploadResponse.message} \n`, manifestUploadResponse.manifests
+                api_client_1.soosLogger.info(` SBOM File(s): \n`, `  ${manifestUploadResponse.message} \n`, manifestUploadResponse.manifests
                     ?.map((m) => `  ${m.name}: ${m.statusMessage}`)
                     .join("\n"));
             }
@@ -160,9 +186,9 @@ class SOOSSBOMAnalysis {
         const sbomPathStat = await FileSystem.statSync(this.args.sbomPath);
         if (sbomPathStat.isDirectory()) {
             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, {
+                ? `${this.args.sbomPath}${constants_1.SOOS_SBOM_CONSTANTS.FilePattern}`
+                : `${this.args.sbomPath}/${constants_1.SOOS_SBOM_CONSTANTS.FilePattern}`;
+            let sbomFilePaths = Glob.sync(searchPattern, {
                 ignore: [
                     ...(this.args.filesToExclude || []),
                     ...(this.args.directoriesToExclude || []),
@@ -170,15 +196,17 @@ class SOOSSBOMAnalysis {
                 ],
                 nocase: true,
             });
-            if (!sbomFiles || sbomFiles.length == 0) {
-                throw new Error("No SBOM files found in the directory.");
+            const hasMoreThanMaximumManifests = sbomFilePaths.length > constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan;
+            if (hasMoreThanMaximumManifests) {
+                const filesToSkip = sbomFilePaths.slice(constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan);
+                sbomFilePaths = sbomFilePaths.slice(0, constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan);
+                const filesDetectedString = utilities_1.StringUtilities.pluralizeTemplate(sbomFilePaths.length, "file was", "files were");
+                const filesSkippedString = utilities_1.StringUtilities.pluralizeTemplate(filesToSkip.length, "file");
+                api_client_1.soosLogger.info(`The maximum number of SBOMs per scan is ${constants_1.SOOS_SBOM_CONSTANTS.MaxSbomsPerScan}. ${filesDetectedString} detected, and ${filesSkippedString} will be not be uploaded. \n`, `The following SBOMs will not be included in the scan: \n`, filesToSkip.map((file) => `  "${Path.parse(file).base}": "${file}"`).join("\n"));
             }
-            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.");
+            return { sbomFilePaths, hasMoreThanMaximumManifests };
         }
-        return [this.args.sbomPath];
+        return { sbomFilePaths: [this.args.sbomPath], hasMoreThanMaximumManifests: false };
     }
     static async createAndRun() {
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soos-io/soos-sbom",
-  "version": "1.1.3",
+  "version": "1.1.4-pre.2",
   "description": "Upload your Software Bill of Materials (SBOM) to SOOS for vulnerability analysis, license matching and more. Register for a free trial today at https://app.soos.io/register",
   "main": "bin/index.js",
   "scripts": {
@@ -42,7 +42,7 @@
   },
   "homepage": "https://github.com/soos-io/soos-sbom#readme",
   "dependencies": {
-    "@soos-io/api-client": "1.3.12",
+    "@soos-io/api-client": "1.4.1",
     "glob": "^11.0.1",
     "tslib": "^2.6.3"
   },