@soos-io/soos-sbom 0.1.12-pre.1 → 0.1.12-pre.2

package/bin/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const SOOS_SBOM_CONSTANTS: {
+    FileRegex: RegExp;
+};

package/bin/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOOS_SBOM_CONSTANTS = void 0;
+exports.SOOS_SBOM_CONSTANTS = {
+    FileRegex: /\.(cdx|spdx)\.json$/,
+};

package/bin/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/bin/index.js

@@ -0,0 +1,150 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const api_client_1 = require("@soos-io/api-client");
+const utilities_1 = require("@soos-io/api-client/dist/utilities");
+const FileSystem = tslib_1.__importStar(require("fs"));
+const Path = tslib_1.__importStar(require("path"));
+const process_1 = require("process");
+const AnalysisArgumentParser_1 = tslib_1.__importDefault(require("@soos-io/api-client/dist/services/AnalysisArgumentParser"));
+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");
+class SOOSSBOMAnalysis {
+    constructor(args) {
+        this.args = args;
+    }
+    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("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.",
+        });
+        api_client_1.soosLogger.info("Parsing arguments");
+        return analysisArgumentParser.parseArguments();
+    }
+    async runAnalysis() {
+        const scanType = api_client_1.ScanType.SBOM;
+        const soosAnalysisService = AnalysisService_1.default.create(this.args.apiKey, this.args.apiURL);
+        let projectHash;
+        let branchHash;
+        let analysisId;
+        let scanStatusUrl;
+        const sbomFilePath = await this.findSbomFilePath();
+        try {
+            const result = await soosAnalysisService.setupScan({
+                clientId: this.args.clientId,
+                projectName: this.args.projectName,
+                branchName: this.args.branchName,
+                commitHash: this.args.commitHash,
+                buildVersion: this.args.buildVersion,
+                buildUri: this.args.buildURI,
+                branchUri: this.args.branchURI,
+                operatingEnvironment: this.args.operatingEnvironment,
+                integrationName: this.args.integrationName,
+                integrationType: this.args.integrationType,
+                appVersion: this.args.appVersion,
+                scriptVersion: this.args.scriptVersion,
+                contributingDeveloperAudit: !this.args.contributingDeveloperId ||
+                    !this.args.contributingDeveloperSource ||
+                    !this.args.contributingDeveloperSourceName
+                    ? []
+                    : [
+                        {
+                            contributingDeveloperId: this.args.contributingDeveloperId,
+                            source: this.args.contributingDeveloperSource,
+                            sourceName: this.args.contributingDeveloperSourceName,
+                        },
+                    ],
+                scanType,
+                toolName: undefined,
+                toolVersion: undefined,
+            });
+            projectHash = result.projectHash;
+            branchHash = result.branchHash;
+            analysisId = result.analysisId;
+            scanStatusUrl = result.scanStatusUrl;
+            api_client_1.soosLogger.logLineSeparator();
+            api_client_1.soosLogger.info("Uploading SBOM File...");
+            const formData = await soosAnalysisService.getAnalysisFilesAsFormData([sbomFilePath], this.args.sbomPath);
+            const manifestUploadResponse = await soosAnalysisService.analysisApiClient.uploadManifestFiles({
+                clientId: this.args.clientId,
+                projectHash,
+                branchHash,
+                analysisId,
+                manifestFiles: formData,
+                hasMoreThanMaximumManifests: false,
+            });
+            api_client_1.soosLogger.info(` SBOM Files: \n`, `  ${manifestUploadResponse.message} \n`, manifestUploadResponse.manifests?.map((m) => `  ${m.name}: ${m.statusMessage}`).join("\n"));
+            api_client_1.soosLogger.logLineSeparator();
+            await soosAnalysisService.startScan({
+                clientId: this.args.clientId,
+                projectHash,
+                analysisId,
+                scanType,
+                scanUrl: result.scanUrl,
+            });
+            const scanStatus = await soosAnalysisService.waitForScanToFinish({
+                scanStatusUrl: result.scanStatusUrl,
+                scanUrl: result.scanUrl,
+                scanType,
+            });
+            const exitCodeWithMessage = (0, utilities_1.getAnalysisExitCodeWithMessage)(scanStatus, this.args.integrationName, this.args.onFailure);
+            api_client_1.soosLogger.always(`${exitCodeWithMessage.message} - exit ${exitCodeWithMessage.exitCode}`);
+            (0, process_1.exit)(exitCodeWithMessage.exitCode);
+        }
+        catch (error) {
+            if (projectHash && branchHash && analysisId) {
+                await soosAnalysisService.updateScanStatus({
+                    clientId: this.args.clientId,
+                    projectHash,
+                    branchHash,
+                    scanType,
+                    analysisId: analysisId,
+                    status: api_client_1.ScanStatus.Error,
+                    message: "Error while performing scan.",
+                    scanStatusUrl,
+                });
+            }
+            api_client_1.soosLogger.error(error);
+            api_client_1.soosLogger.always(`${error} - exit 1`);
+            (0, process_1.exit)(1);
+        }
+    }
+    async findSbomFilePath() {
+        const sbomPathStat = await FileSystem.statSync(this.args.sbomPath);
+        if (sbomPathStat.isDirectory()) {
+            const files = await FileSystem.promises.readdir(this.args.sbomPath);
+            const sbomFile = files.find((file) => constants_1.SOOS_SBOM_CONSTANTS.FileRegex.test(file));
+            if (!sbomFile) {
+                throw new Error("No SBOM file found in the directory.");
+            }
+            return Path.join(this.args.sbomPath, sbomFile);
+        }
+        if (!constants_1.SOOS_SBOM_CONSTANTS.FileRegex.test(this.args.sbomPath)) {
+            throw new Error("The file does not match the required SBOM pattern.");
+        }
+        return this.args.sbomPath;
+    }
+    static async createAndRun() {
+        api_client_1.soosLogger.info("Starting SOOS SBOM Analysis");
+        api_client_1.soosLogger.logLineSeparator();
+        try {
+            const args = this.parseArgs();
+            api_client_1.soosLogger.setMinLogLevel(args.logLevel);
+            api_client_1.soosLogger.setVerbose(args.verbose);
+            api_client_1.soosLogger.info("Configuration read");
+            api_client_1.soosLogger.verboseDebug(JSON.stringify((0, utilities_1.obfuscateProperties)(args, ["apiKey"]), null, 2));
+            api_client_1.soosLogger.logLineSeparator();
+            const soosSBOMAnalysis = new SOOSSBOMAnalysis(args);
+            await soosSBOMAnalysis.runAnalysis();
+        }
+        catch (error) {
+            api_client_1.soosLogger.error(`Error on createAndRun: ${error}`);
+            api_client_1.soosLogger.always(`Error on createAndRun: ${error} - exit 1`);
+            (0, process_1.exit)(1);
+        }
+    }
+}
+SOOSSBOMAnalysis.createAndRun();

package/package.json

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