CLOUD-439 - Return error objects, rather than error messages

pingidentity · Oct 17, 2024 · f2c9b57 · f2c9b57
1 parent 50a71ec
commit f2c9b57
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 13 deletions.
diff --git a/lib/LintRulePack.js b/lib/LintRulePack.js
@@ -412,7 +412,7 @@ class LintRulePack {
               ruleResponse.errorCount += response.errorCount;
 
               response.errors.forEach((err) => {
-                ruleResponse.errors.push(err.message);
+                ruleResponse.errors.push(err);
               });
             }
 

diff --git a/test/rules/example-rule/ExampleRule.js b/test/rules/example-rule/ExampleRule.js
@@ -20,7 +20,7 @@ class ExampleRule extends LintRule {
   runRule() {
     try {
       const dvFlow = this.mainFlow;
-      const someErrorCondition = false;
+      const someErrorCondition = true;
 
       // Variation where this rule is ignored in any subflows
       // const { allFlows } = this;
@@ -29,7 +29,10 @@ class ExampleRule extends LintRule {
       // }
 
       if (someErrorCondition) {
-        this.addError("example-error", { messageArgs: [dvFlow.flowId] });
+        this.addError("example-error", {
+          messageArgs: [dvFlow.flowId],
+          nodeId: "n1234",
+        });
       }
     } catch (err) {
       this.addError("generic-error", { messageArgs: [`${err}`] });

diff --git a/test/rules/example-rule/tests/Example.expect.json b/test/rules/example-rule/tests/Example.expect.json
@@ -1,29 +1,45 @@
 {
   "name": "PingOne DaVinci Linter",
-  "pass": true,
-  "errorCount": 0,
+  "pass": false,
+  "errorCount": 1,
   "rulePackResults": [
     {
       "name": "@ping-identity/dvlint",
-      "pass": true,
-      "errorCount": 0,
+      "pass": false,
+      "errorCount": 1,
       "lintResults": [
         {
           "flowId": "2291498df43a63457abad5d2d1fa4df9",
           "flowName": "dv-rule-general-001",
-          "pass": true,
-          "errorCount": 0,
-          "errors": [],
+          "pass": false,
+          "errorCount": 1,
+          "errors": [
+            {
+              "code": "example-error",
+              "message": "Example Rule of flow '2291498df43a63457abad5d2d1fa4df9'",
+              "nodeId": "n1234",
+              "recommendation": "We recommend this example.",
+              "type": "best-practice"
+            }
+          ],
           "rulesApplied": [
             "example-rule"
           ],
           "ruleResults": [
             {
               "ruleId": "example-rule",
               "ruleDescription": "Example Rule",
-              "pass": true,
-              "errorCount": 0,
-              "errors": []
+              "pass": false,
+              "errorCount": 1,
+              "errors": [
+                {
+                  "code": "example-error",
+                  "message": "Example Rule of flow '2291498df43a63457abad5d2d1fa4df9'",
+                  "nodeId": "n1234",
+                  "recommendation": "We recommend this example.",
+                  "type": "best-practice"
+                }
+              ]
             }
           ],
           "rulesIgnored": []