Spectral rules fix for changed | addedOrChanged (#2541)

opticdev · Nov 15, 2023 · edbf288 · edbf288
1 parent 71dbc91
commit edbf288
Show file tree

Hide file tree

Showing 11 changed files with 129 additions and 10 deletions.
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "openapi-workspaces",
   "license": "MIT",
   "private": true,
-  "version": "0.52.2",
+  "version": "0.52.3",
   "workspaces": [
     "projects/json-pointer-helpers",
     "projects/openapi-io",

diff --git a/projects/fastify-capture/package.json b/projects/fastify-capture/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/fastify-capture",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/json-pointer-helpers/package.json b/projects/json-pointer-helpers/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/json-pointer-helpers",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/openapi-io/package.json b/projects/openapi-io/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-io",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/openapi-utilities/package.json b/projects/openapi-utilities/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/openapi-utilities",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/optic/package.json b/projects/optic/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/optic",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/rulesets-base/package.json b/projects/rulesets-base/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/rulesets-base",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

diff --git a/projects/rulesets-base/src/__tests__/__snapshots__/spectral-rule.test.ts.snap b/projects/rulesets-base/src/__tests__/__snapshots__/spectral-rule.test.ts.snap
@@ -121,3 +121,22 @@ exports[`spectral rule test runs spectral rules on added 1`] = `
   },
 ]
 `;
+
+exports[`spectral rule test runs spectral rules on addedOrChanged 1`] = `
+[
+  {
+    "docsLink": undefined,
+    "error": "Error code: this-rule: readOnly is not supported by API Gateway",
+    "exempted": false,
+    "location": {
+      "jsonPath": "/paths/~1api/get/responses/200/content/application~1json/schema/properties/example",
+      "spec": "after",
+    },
+    "name": "Spectral addedOrChanged rule",
+    "passed": false,
+    "severity": 2,
+    "type": "addedOrChanged",
+    "where": "addedOrChanged ",
+  },
+]
+`;
diff --git a/projects/rulesets-base/src/__tests__/spectral-rule.test.ts b/projects/rulesets-base/src/__tests__/spectral-rule.test.ts
@@ -1,6 +1,7 @@
 import { test, expect, describe } from '@jest/globals';
 import { RuleRunner } from '../rule-runner';
 import { SpectralRule } from '../extended-rules/spectral-rule';
+import { undefined as SpectralUndefinedFunc } from '@stoplight/spectral-functions';
 import {
   Spectral,
   RulesetDefinition as SpectralRulesetDefinition,
@@ -57,6 +58,95 @@ describe('spectral rule test', () => {
     expect(resultsAgainstSelf.length === 0).toBe(true);
   });
 
+  test('runs spectral rules on addedOrChanged', async () => {
+    const spectral = new Spectral();
+    spectral.setRuleset({
+      extends: [],
+      rules: {
+        'this-rule': {
+          description: 'readOnly is not supported by API Gateway',
+          severity: 'error',
+          given: '$..readOnly',
+          then: [
+            {
+              function: SpectralUndefinedFunc,
+            },
+          ],
+        },
+      },
+    });
+
+    const ruleRunner = new RuleRunner([
+      new SpectralRule({
+        name: 'spectral-rules',
+        spectral,
+        applies: 'addedOrChanged',
+      }),
+    ]);
+    const before: OpenAPIV3.Document = {
+      ...defaultEmptySpec,
+      paths: {
+        '/api': {
+          get: {
+            responses: {
+              '200': {
+                description: '200',
+                content: {
+                  'application/json': {
+                    schema: {
+                      type: 'object',
+                      properties: {
+                        example: {
+                          type: 'string',
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+    const after: OpenAPIV3.Document = {
+      ...defaultEmptySpec,
+      paths: {
+        '/api': {
+          get: {
+            responses: {
+              '200': {
+                description: '200',
+                content: {
+                  'application/json': {
+                    schema: {
+                      type: 'object',
+                      properties: {
+                        example: {
+                          type: 'string',
+                          readOnly: true,
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+    const diffs = diff(before, after);
+    const resultsWithChanges = await ruleRunner.runRules({
+      diffs,
+      fromSpec: before,
+      toSpec: after,
+      context: {},
+    });
+
+    expect(resultsWithChanges).toMatchSnapshot();
+  });
+
   test('can use matches', async () => {
     const ruleRunner = new RuleRunner([
       new SpectralRule({

diff --git a/projects/rulesets-base/src/extended-rules/spectral-rule.ts b/projects/rulesets-base/src/extended-rules/spectral-rule.ts
@@ -302,7 +302,12 @@ export class SpectralRule extends ExternalRuleBase {
       } else {
         // find if there is an appropriate change
         let maybeChange: ObjectDiff | undefined =
-          changesByJsonPath[fact.location.jsonPath];
+          changesByJsonPath[fact.location.jsonPath] ||
+          changesByJsonPath[
+            jsonPointerHelpers.compile(
+              spectralResult.path.map((i) => i.toString())
+            )
+          ];
 
         if (
           !maybeChange &&
@@ -465,7 +470,12 @@ export class SpectralRule extends ExternalRuleBase {
       } else {
         // find if there is an appropriate change
         const maybeChange: IChange | undefined =
-          changesByJsonPath[fact.location.jsonPath];
+          changesByJsonPath[fact.location.jsonPath] ||
+          changesByJsonPath[
+            jsonPointerHelpers.compile(
+              spectralResult.path.map((i) => i.toString())
+            )
+          ];
         if (maybeChange) {
           if (this.lifecycle === 'added' && maybeChange.added) {
             results.push(

diff --git a/projects/standard-rulesets/package.json b/projects/standard-rulesets/package.json
@@ -2,7 +2,7 @@
   "name": "@useoptic/standard-rulesets",
   "license": "MIT",
   "packageManager": "[email protected]",
-  "version": "0.52.2",
+  "version": "0.52.3",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [