Fix report options (#57)

jssblck · web-flow · commit ef29ba4cec2a · 2025-01-22T15:15:43.000-06:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -2,5 +2,5 @@
 
 # Checklist
 
-[ ] If I changed code, I ran `yarn build` and committed resulting changes.
-[ ] I added an example exercising this PRs functionality to `.github/workflows/test.yml` or explained why it doesn't make sense to do so.
+- [ ] If I changed code, I ran `yarn build` and committed resulting changes.
+- [ ] I added an example exercising this PRs functionality to `.github/workflows/test.yml` or explained why it doesn't make sense to do so.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,8 +12,6 @@ on:
 
 jobs:
   fossa-scan:
-    strategy:
-      fail-fast: false
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -88,5 +86,7 @@ jobs:
         with:
           api-key: ${{secrets.fossaApiKey}}
           generate-report: json
-      
-      - run: echo ${{ steps.example-generate-report.outputs.report }}
+
+      - name: Demonstrate report output
+        run: |
+          echo '${{ steps.example-generate-report.outputs.report }}' | jq
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ jobs:
           api-key: ${{secrets.fossaApiKey}}
           run-tests: true
           generate-report: html
-      - run: ${{ steps.fossa.outputs.report }} > report.html
+      - run: echo '${{ steps.fossa.outputs.report }}' > report.html
 ```
 
 ## `test-diff-revision`
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/index.ts b/src/index.ts
@@ -40,9 +40,9 @@ export async function analyze(): Promise<void> {
     POLICY,
   ];
 
-  const getArgs = (cmd: string) => [
+  const getArgs = (cmd: string[]) => [
     CONTAINER ? 'container' : null,
-    cmd,
+    ...cmd,
     ...getEndpointArgs(),
     ...getBranchArgs(),
     ...getProjectArgs(),
@@ -68,15 +68,15 @@ export async function analyze(): Promise<void> {
 
   if (!RUN_TESTS) {
     output = '';
-    const exitCode = await exec('fossa', [...getArgs('analyze'), CONTAINER], defaultOptions);
+    const exitCode = await exec('fossa', [...getArgs(['analyze']), CONTAINER], defaultOptions);
 
     // Check output or exitCode
     if (exitCode !== 0 || output.match(failedRegex)) {
       throw new Error(`FOSSA failed to scan`);
     }
   } else if (RUN_TESTS) {
     output = '';
-    const args = [...getArgs('test'), CONTAINER];
+    const args = [...getArgs(['test']), CONTAINER];
 
     if (TEST_DIFF_REV && TEST_DIFF_REV !== '') {
       args.push('--diff', TEST_DIFF_REV);
@@ -105,37 +105,40 @@ export async function report(): Promise<void> {
     REPORT_FORMAT,
   ];
 
-  const getArgs = (cmd: string) => [
-    cmd,
+  const getArgs = (cmd: string[]) => [
+    ...cmd,
     ...getEndpointArgs(),
     ...getProjectArgs(),
     ...getFormatArgs(),
     DEBUG ? '--debug' : null,
   ].filter(arg => arg);
 
   // Setup listeners
-  let output;
-  const collectOutput = (data: Buffer) => {
-    output += data.toString();
+  let stdout = '';
+  let stderr = '';
+  const collectStdout = (data: Buffer) => {
+    stdout += data.toString();
+  };
+  const collectStderr = (data: Buffer) => {
+    stderr += data.toString();
   };
 
   const listeners: ExecListeners = {
-    stdout: collectOutput,
-    stderr: collectOutput,
+    stdout: collectStdout,
+    stderr: collectStderr,
   };
 
   // Collect default options: Env and listeners
   const PATH = process.env.PATH || '';
   const defaultOptions = { env: { ...process.env, PATH, FOSSA_API_KEY }, listeners };
-  output = '';
-  const exitCode = await exec('fossa', [...getArgs('report attribution')], defaultOptions);
+  const exitCode = await exec('fossa', getArgs(['report', 'attribution']), defaultOptions);
 
   // Check output or exitCode
-  if (exitCode !== 0 || output.match(failedRegex)) {
+  if (exitCode !== 0 || stderr.match(failedRegex)) {
     throw new Error(`FOSSA failed to scan`);
   }
 
-  setOutput('report', output);
+  setOutput('report', stdout);
 }
 
 async function run() {
@@ -147,7 +150,7 @@ async function run() {
 
   try {
     await analyze();
-    if(REPORT_FORMAT?.length) {
+    if (REPORT_FORMAT?.length) {
       await report();
     }
   } catch (e) {
