Merge pull request #35 from SecureCodeWarrior/reorder-operations

Reorder operations

Author: cwong-scw

dist/index.js

@@ -31,7 +31,7 @@
       },
       "results": [
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "error",
           "message": {
             "text": "Result text. This result does not have a rule associated."
@@ -55,7 +55,7 @@
           }
         },
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "note",
           "message": {
             "text": "more different text."

dist/index.js.map

@@ -39,7 +39,7 @@
       },
       "results": [
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "error",
           "message": {
             "text": "Result text. This result does not have a rule associated."
@@ -63,7 +63,7 @@
           }
         },
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "note",
           "message": {
             "text": "more different text."

fixtures/test003.sarif

@@ -39,7 +39,7 @@
       },
       "results": [
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "error",
           "message": {
             "text": "Result text. This result does not have a rule associated."
@@ -63,7 +63,7 @@
           }
         },
         {
-          "ruleId": "TEST01",
+          "ruleId": "TEST01 CWE-22",
           "level": "note",
           "message": {
             "text": "more different text."

fixtures/test004.sarif

@@ -8,7 +8,6 @@ const languageResolver = require('./languageResolver');
 const sarifLoader = require('./sarifLoader');
 const resultProcessor = require('./sarifProcessors/resultProcessor');
 const ruleProcessor = require('./sarifProcessors/ruleProcessor');
-const taxonomyProcessor = require('./sarifProcessors/taxonomyProcessor');
 
 const OUTPUT_DIR = 'processed-sarifs';
 
@@ -48,14 +47,11 @@ async function run() {
             // process each run
             if (sarif && sarif.runs) {
                 for (const run of sarif.runs) {
-                    // process run for rules
-                    await ruleProcessor.process(run, languageKey);
-
-                    // process run for taxonomies
-                    await taxonomyProcessor.process(run, languageKey);
-
                     // process run for results
-                    await resultProcessor.process(run, languageKey);
+                    const triggeredRules = await resultProcessor.process(run, languageKey);
+                    
+                    // process run for rules
+                    await ruleProcessor.process(run, languageKey, triggeredRules);
                 }
             }
 

fixtures/test005.sarif

@@ -1,6 +1,6 @@
 {
   "name": "github-action-add-sarif-contextual-training",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "GitHub Action for adding contextual training material to SARIF files",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,7 @@
   },
   "devDependencies": {
     "@vercel/ncc": "^0.25.1",
-    "eslint": "^7.13.0",
+    "eslint": "^7.15.0",
     "jest": "^26.6.3"
   }
 }

index.js

@@ -1,7 +1,19 @@
 "use strict";
 
 async function process(run) {
-    return run;
+    const ruleMap = new Map();
+
+    if (run && run.results) {
+        for (const result of run.results) {
+            const ruleId = result.ruleId;
+            const seen = ruleMap.get(ruleId);
+            if (seen === undefined) {
+                ruleMap.set(ruleId, true);
+            }
+        }
+    }
+
+    return ruleMap;
 }
 
 module.exports = {

package-lock.json

@@ -6,7 +6,9 @@ const sarifLoader = require('../sarifLoader');
 test('resultProcessor should load test001 and add contextual micro-learning material', async () => {
   const sarifs = await sarifLoader.load('./fixtures/test001.sarif');
   for (const sarif of sarifs) {
-    const processed = await resultProcessor.process(sarif.runs[0]);
-    expect(processed.tool.driver.name).toEqual('Tool Name 3');
+    const ruleMap = await resultProcessor.process(sarif.runs[0]);
+    expect(ruleMap.has('TEST01')).toEqual(true);
+    expect(ruleMap.get('TEST01')).toEqual(true);
+    expect(ruleMap.get('TEST02')).toEqual(undefined);
   }
 });