fix: windows support

Signed-off-by: Ilona Shishov <[email protected]>
RHEcosystemAppEng · Jul 15, 2024 · 26bd5af · 26bd5af
1 parent 7ac4384
commit 26bd5af
Show file tree

Hide file tree

Showing 20 changed files with 61 additions and 49 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -4,8 +4,8 @@ on:
   pull_request:
 
 jobs:
-  lint:
-    name: Run ESLint
+  lint-and-test:
+    name: Lint and Test
     runs-on: ubuntu-latest
 
     steps:
@@ -25,6 +25,9 @@ jobs:
 
       - name: Run lint
         run: npm run lint
+
+      - name: Run test
+        run: npm run test
 
   check-dist:
     name: Check Distribution

diff --git a/.github/workflows/scan_docker.yaml b/.github/workflows/scan_docker.yaml
@@ -42,7 +42,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/docker
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_go.yaml b/.github/workflows/scan_go.yaml
@@ -32,7 +32,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/golang
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_gradle.yaml b/.github/workflows/scan_gradle.yaml
@@ -33,7 +33,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/gradle
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_maven.yaml b/.github/workflows/scan_maven.yaml
@@ -33,7 +33,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/maven
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_npm.yaml b/.github/workflows/scan_npm.yaml
@@ -32,7 +32,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/npm
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_podman.yaml b/.github/workflows/scan_podman.yaml
@@ -42,7 +42,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/podman
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/.github/workflows/scan_python.yaml b/.github/workflows/scan_python.yaml
@@ -35,7 +35,7 @@ jobs:
 
       - name: RHDA Scan
         id: rhda_scan
-        uses: RHEcosystemAppEng/rhda-github-action@main
+        uses: RHEcosystemAppEng/rhda-github-action@chore/unit-tests
         with:
           manifest_directory: manifests/python
           manifest_file: ${{ matrix.manifest_file }}

diff --git a/dist/index.js b/dist/index.js
@@ -137975,7 +137975,6 @@ function escapeWindowsPathForActionsOutput(path) {
 async function zipFile(file) {
     const fileContents = await external_fs_.readFileSync(file, 'utf-8');
     const zippedContents = (await external_zlib_.gzipSync(fileContents)).toString('base64');
-    // ghCore.info(`Zipped upload size: ${utils.convertToHumanFileSize(zippedContents.length)}`);
     return zippedContents;
 }
 /**
@@ -138037,8 +138036,6 @@ const UTM_SOURCE = 'github-actions';
 const SARIF_SCHEMA_URL = 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json';
 // Version of the SARIF schema.
 const SARIF_SCHEMA_VERSION = '2.1.0';
-// Default directory to look for manifest files.
-const DEFAULT_MANIFEST_DIR = '.';
 // Supported manifests and files
 const GO_MOD = 'go.mod';
 const POM_XML = 'pom.xml';
@@ -138088,7 +138085,9 @@ async function resolveManifestFilePath() {
     if (!manifestDirInput) {
         core.info(`"${Inputs.MANIFEST_DIRECTORY}" not provided. Using working directory "${process.cwd()}"`);
     }
-    const manifestDir = manifestDirInput || DEFAULT_MANIFEST_DIR;
+    const manifestDir = manifestDirInput
+        ? external_path_default().resolve(manifestDirInput)
+        : process.cwd();
     let manifestFilename;
     if (manifestFileInput) {
         manifestFilename = manifestFileInput;
@@ -138098,7 +138097,7 @@ async function resolveManifestFilePath() {
     }
     else {
         core.info(`"${Inputs.MANIFEST_FILE}" input not provided. Auto-detecting manifest file`);
-        core.info(`🔍 Looking for manifest in "${external_path_default().join(process.cwd(), manifestDir)}"...`);
+        core.info(`🔍 Looking for manifest in "${manifestDir}"...`);
         manifestFilename = await autoDetectManifest(manifestDir);
     }
     const resolvedManifestPath = external_path_default().join(manifestDir, manifestFilename);
@@ -140934,7 +140933,6 @@ function imageAnalysisService(images, options) {
 async function stackAnalysisService(pathToManifest, options) {
     try {
         // Get stack analysis in JSON format
-        console.log(`pathToManifest: ${pathToManifest}`);
         const stackAnalysisReportJson = await src.stackAnalysis(pathToManifest, false, options);
         return stackAnalysisReportJson;
     }
@@ -141111,7 +141109,7 @@ async function generateRHDAReport(manifestFilePath, ecosystem) {
     else {
         rhdaReportJson = await stackAnalysisService(manifestFilePath, getDependencyAnalysisConfig());
     }
-    const rhdaReportJsonFilePath = `${process.cwd()}/${core.getInput(Inputs.RHDA_REPORT_NAME)}.json`;
+    const rhdaReportJsonFilePath = `${process.cwd()}${getOS() === 'windows' ? '\\' : '/'}${core.getInput(Inputs.RHDA_REPORT_NAME)}.json`;
     await writeToFile(JSON.stringify(rhdaReportJson, null, 4), rhdaReportJsonFilePath);
     core.info(`✍️ Setting output "${Outputs.RHDA_REPORT_JSON}" to ${rhdaReportJsonFilePath}`);
     core.setOutput(Outputs.RHDA_REPORT_JSON, rhdaReportJsonFilePath);
@@ -141306,7 +141304,7 @@ function fetchResult(ruleId, textMessage, manifestFilePath, startLine) {
         text: textMessage,
     };
     const artifactLocation = {
-        uri: manifestFilePath.split((external_path_default()).sep).join((external_path_default()).posix.sep),
+        uri: 'file:///' + manifestFilePath.split((external_path_default()).sep).join((external_path_default()).posix.sep),
     };
     const region = {
         startLine: startLine,
@@ -141787,7 +141785,7 @@ async function waitForUploadToFinish(ghToken, sarifId) {
 async function handleSarif(rhdaReportJson, manifestFilePath, ecosystem, sha, ref, analysisStartTime, prData) {
     core.info(`⏳ Converting RHDA report JSON to SARIF...`);
     const { sarifObject: rhdaReportSarif, vulSeverity: vulSeverity } = await generateSarif(rhdaReportJson, manifestFilePath, ecosystem);
-    const rhdaReportSarifFilePath = `${process.cwd()}/${core.getInput(Inputs.RHDA_REPORT_NAME)}.sarif`;
+    const rhdaReportSarifFilePath = `${process.cwd()}${getOS() === 'windows' ? '\\' : '/'}${core.getInput(Inputs.RHDA_REPORT_NAME)}.sarif`;
     await writeToFile(JSON.stringify(rhdaReportSarif, null, 4), rhdaReportSarifFilePath);
     core.info(`✅ Successfully converted RHDA report JSON to SARIF`);
     core.info(`✍️ Setting output "${Outputs.RHDA_REPORT_SARIF}" to ${rhdaReportSarifFilePath}`);

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/constants.ts b/src/constants.ts
@@ -8,9 +8,6 @@ export const SARIF_SCHEMA_URL =
 // Version of the SARIF schema.
 export const SARIF_SCHEMA_VERSION = '2.1.0';
 
-// Default directory to look for manifest files.
-export const DEFAULT_MANIFEST_DIR = '.';
-
 // Supported manifests and files
 const GO_MOD = 'go.mod';
 const POM_XML = 'pom.xml';

diff --git a/src/exhortServices.ts b/src/exhortServices.ts
@@ -59,7 +59,6 @@ async function stackAnalysisService(
 ): Promise<string | exhort.AnalysisReport> {
     try {
         // Get stack analysis in JSON format
-        console.log(`pathToManifest: ${pathToManifest}`)
         const stackAnalysisReportJson = await exhort.stackAnalysis(
             pathToManifest,
             false,

diff --git a/src/manifestHandler.ts b/src/manifestHandler.ts
@@ -3,10 +3,7 @@ import path from 'path';
 import { promises as fs } from 'fs';
 
 import { Inputs } from './generated/inputs-outputs.js';
-import {
-    fileNameToEcosystemMappings,
-    DEFAULT_MANIFEST_DIR,
-} from './constants.js';
+import { fileNameToEcosystemMappings } from './constants.js';
 
 /**
  * Resolves the manifest file path and its corresponding ecosystem.
@@ -25,7 +22,9 @@ export async function resolveManifestFilePath(): Promise<{
             `"${Inputs.MANIFEST_DIRECTORY}" not provided. Using working directory "${process.cwd()}"`,
         );
     }
-    const manifestDir = manifestDirInput || DEFAULT_MANIFEST_DIR;
+    const manifestDir = manifestDirInput
+        ? path.resolve(manifestDirInput)
+        : process.cwd();
 
     let manifestFilename: string;
     if (manifestFileInput) {
@@ -38,9 +37,7 @@ export async function resolveManifestFilePath(): Promise<{
         ghCore.info(
             `"${Inputs.MANIFEST_FILE}" input not provided. Auto-detecting manifest file`,
         );
-        ghCore.info(
-            `🔍 Looking for manifest in "${path.join(process.cwd(), manifestDir)}"...`,
-        );
+        ghCore.info(`🔍 Looking for manifest in "${manifestDir}"...`);
 
         manifestFilename = await autoDetectManifest(manifestDir);
     }

diff --git a/src/rhda.ts b/src/rhda.ts
@@ -57,7 +57,7 @@ export async function generateRHDAReport(
         );
     }
 
-    const rhdaReportJsonFilePath: string = `${process.cwd()}/${ghCore.getInput(Inputs.RHDA_REPORT_NAME)}.json`;
+    const rhdaReportJsonFilePath: string = `${process.cwd()}${utils.getOS() === 'windows' ? '\\' : '/'}${ghCore.getInput(Inputs.RHDA_REPORT_NAME)}.json`;
     await utils.writeToFile(
         JSON.stringify(rhdaReportJson, null, 4),
         rhdaReportJsonFilePath,

diff --git a/src/sarif/handler.ts b/src/sarif/handler.ts
@@ -41,7 +41,7 @@ export async function handleSarif(
             ecosystem,
         );
 
-    const rhdaReportSarifFilePath: string = `${process.cwd()}/${ghCore.getInput(Inputs.RHDA_REPORT_NAME)}.sarif`;
+    const rhdaReportSarifFilePath: string = `${process.cwd()}${utils.getOS() === 'windows' ? '\\' : '/'}${ghCore.getInput(Inputs.RHDA_REPORT_NAME)}.sarif`;
     await utils.writeToFile(
         JSON.stringify(rhdaReportSarif, null, 4),
         rhdaReportSarifFilePath,

diff --git a/src/sarif/results.ts b/src/sarif/results.ts
@@ -111,7 +111,7 @@ function fetchResult(
         text: textMessage,
     };
     const artifactLocation: sarif.ArtifactLocation = {
-        uri: manifestFilePath.split(path.sep).join(path.posix.sep),
+        uri: 'file:///' + manifestFilePath.split(path.sep).join(path.posix.sep),
     };
     const region: sarif.Region = {
         startLine: startLine,

diff --git a/src/utils.ts b/src/utils.ts
@@ -127,7 +127,6 @@ export async function zipFile(file: string): Promise<string> {
     const zippedContents = (await zlib.gzipSync(fileContents)).toString(
         'base64',
     );
-    // ghCore.info(`Zipped upload size: ${utils.convertToHumanFileSize(zippedContents.length)}`);
 
     return zippedContents;
 }

diff --git a/test/manifestHandler.test.ts b/test/manifestHandler.test.ts
@@ -5,10 +5,7 @@ import { Dirent, promises as fs } from 'fs';
 
 import { resolveManifestFilePath } from '../src/manifestHandler';
 import { Inputs } from '../src/generated/inputs-outputs';
-import {
-    fileNameToEcosystemMappings,
-    DEFAULT_MANIFEST_DIR,
-} from '../src/constants';
+import { fileNameToEcosystemMappings } from '../src/constants';
 
 vi.mock('@actions/core', () => ({
     getInput: vi.fn(),
@@ -43,7 +40,7 @@ describe('resolveManifestFilePath', () => {
             `"${Inputs.MANIFEST_DIRECTORY}" not provided. Using working directory "${process.cwd()}"`,
         );
         expect(result).toEqual({
-            manifestFilePath: path.join(DEFAULT_MANIFEST_DIR, 'package.json'),
+            manifestFilePath: path.join(process.cwd(), 'package.json'),
             ecosystem: fileNameToEcosystemMappings['package.json'],
         });
     });
@@ -88,14 +85,14 @@ describe('resolveManifestFilePath', () => {
         );
         expect(ghCore.info).toHaveBeenNthCalledWith(
             3,
-            `🔍 Looking for manifest in "${path.join(process.cwd(), DEFAULT_MANIFEST_DIR)}"...`,
+            `🔍 Looking for manifest in "${process.cwd()}"...`,
         );
         expect(ghCore.info).toHaveBeenNthCalledWith(
             4,
-            `ℹ️ Manifest file path is "${path.join(DEFAULT_MANIFEST_DIR, 'package.json')}"`,
+            `ℹ️ Manifest file path is "${path.join(process.cwd(), 'package.json')}"`,
         );
         expect(result).toEqual({
-            manifestFilePath: path.join(DEFAULT_MANIFEST_DIR, 'package.json'),
+            manifestFilePath: path.join(process.cwd(), 'package.json'),
             ecosystem: fileNameToEcosystemMappings['package.json'],
         });
     });
@@ -116,7 +113,7 @@ describe('resolveManifestFilePath', () => {
         ] as unknown as Dirent[]);
 
         await expect(resolveManifestFilePath()).rejects.toThrow(
-            `Failed to find a manifest file in "${DEFAULT_MANIFEST_DIR}" matching one of the expected project types. Expected to find one of: ${Object.keys(fileNameToEcosystemMappings).join(', ')}`,
+            `Failed to find a manifest file in "${process.cwd()}" matching one of the expected project types. Expected to find one of: ${Object.keys(fileNameToEcosystemMappings).join(', ')}`,
         );
     });
 });
diff --git a/test/rhda.test.ts b/test/rhda.test.ts
@@ -24,6 +24,7 @@ vi.mock('../src/imageAnalysis', () => ({
 
 vi.mock('../src/utils', () => ({
     writeToFile: vi.fn(),
+    getOS: vi.fn().mockImplementation(() => 'linux'),
 }));
 
 describe('generateRHDAReport', () => {

diff --git a/test/sarif/results.test.ts b/test/sarif/results.test.ts
@@ -1,4 +1,5 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
+import path from 'path';
 
 import { rhdaToResult } from '../../src/sarif/results';
 import * as types from '../../src/sarif/types';
@@ -79,7 +80,11 @@ describe('rhdaToResult', () => {
                         {
                             physicalLocation: {
                                 artifactLocation: {
-                                    uri: manifestFilePath,
+                                    uri:
+                                        'file:///' +
+                                        manifestFilePath
+                                            .split(path.sep)
+                                            .join(path.posix.sep),
                                 },
                                 region: {
                                     startLine: startLine,
@@ -103,7 +108,11 @@ describe('rhdaToResult', () => {
                         {
                             physicalLocation: {
                                 artifactLocation: {
-                                    uri: manifestFilePath,
+                                    uri:
+                                        'file:///' +
+                                        manifestFilePath
+                                            .split(path.sep)
+                                            .join(path.posix.sep),
                                 },
                                 region: {
                                     startLine: startLine,
@@ -176,7 +185,11 @@ describe('rhdaToResult', () => {
                         {
                             physicalLocation: {
                                 artifactLocation: {
-                                    uri: manifestFilePath,
+                                    uri:
+                                        'file:///' +
+                                        manifestFilePath
+                                            .split(path.sep)
+                                            .join(path.posix.sep),
                                 },
                                 region: {
                                     startLine: startLine,
@@ -200,7 +213,11 @@ describe('rhdaToResult', () => {
                         {
                             physicalLocation: {
                                 artifactLocation: {
-                                    uri: manifestFilePath,
+                                    uri:
+                                        'file:///' +
+                                        manifestFilePath
+                                            .split(path.sep)
+                                            .join(path.posix.sep),
                                 },
                                 region: {
                                     startLine: startLine,
@@ -252,7 +269,11 @@ describe('rhdaToResult', () => {
                         {
                             physicalLocation: {
                                 artifactLocation: {
-                                    uri: manifestFilePath,
+                                    uri:
+                                        'file:///' +
+                                        manifestFilePath
+                                            .split(path.sep)
+                                            .join(path.posix.sep),
                                 },
                                 region: {
                                     startLine: startLine,