Add suppression propagation for circular references.

Author: tjprescott

src/definitions.ts

@@ -144,6 +144,10 @@ export class DefinitionRegistry {
           for (const [key, value] of toSorted(Object.entries(itemCopy))) {
             matchCopy[key] = value;
           }
+          this.client?.suppressions?.propagateSuppression(
+            refResult,
+            this.currentPath
+          );
           return this.#expand(matchCopy, refResult.name);
         }
       } else {

test/files/suppressions3.yaml

@@ -0,0 +1,2 @@
+- path: definitions/Foo/properties/value/format
+  reason: Because a really good reason.

test/files/suppressions3a.json

@@ -0,0 +1,57 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "(title)",
+    "version": "0000-00-00",
+    "x-typespec-generated": [
+      {
+        "emitter": "@azure-tools/typespec-autorest"
+      }
+    ]
+  },
+  "schemes": ["https"],
+  "produces": ["application/json"],
+  "consumes": ["application/json"],
+  "tags": [],
+  "paths": {
+    "/": {
+      "put": {
+        "operationId": "Create",
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/Foo"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "schema": {
+              "$ref": "#/definitions/Foo"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "Foo": {
+      "type": "object",
+      "properties": {
+        "inner": {
+          "$ref": "#/definitions/Foo"
+        },
+        "value": {
+          "type": "integer",
+          "format": "int16"
+        }
+      },
+      "required": ["value"]
+    }
+  },
+  "parameters": {}
+}

test/files/suppressions3b.json

@@ -0,0 +1,57 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "(title)",
+    "version": "0000-00-00",
+    "x-typespec-generated": [
+      {
+        "emitter": "@azure-tools/typespec-autorest"
+      }
+    ]
+  },
+  "schemes": ["https"],
+  "produces": ["application/json"],
+  "consumes": ["application/json"],
+  "tags": [],
+  "paths": {
+    "/": {
+      "put": {
+        "operationId": "Create",
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/Foo"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "schema": {
+              "$ref": "#/definitions/Foo"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "Foo": {
+      "type": "object",
+      "properties": {
+        "inner": {
+          "$ref": "#/definitions/Foo"
+        },
+        "value": {
+          "type": "integer",
+          "format": "int32"
+        }
+      },
+      "required": ["value"]
+    }
+  },
+  "parameters": {}
+}

test/rest-api-diff.test.ts

@@ -334,3 +334,27 @@ it("should sort arrays of strings for stable comparison", async () => {
   expect(client.diffResults?.noViolations.length).toBe(2);
   expect(client.diffResults?.assumedViolations.length).toBe(0);
 });
+
+it("should propagate suppressions for circular references", async () => {
+  const config: DiffClientConfig = {
+    lhs: ["test/files/suppressions3a.json"],
+    rhs: ["test/files/suppressions3b.json"],
+    args: {
+      suppressions: "test/files/suppressions3.yaml",
+    },
+    rules: getApplicableRules({}),
+  };
+  const client = await TestableDiffClient.create(config);
+  client.parse();
+  client.processDiff();
+  client.buildOutput();
+  const [lhsParser, rhsParser] = client.getParsers();
+  expect(lhsParser.getUnresolvedReferences().length).toBe(0);
+  expect(lhsParser.getUnreferencedTotal()).toBe(0);
+  expect(rhsParser.getUnresolvedReferences().length).toBe(0);
+  expect(rhsParser.getUnreferencedTotal()).toBe(0);
+  expect(client.diffResults?.assumedViolations.length).toBe(0);
+  expect(client.diffResults?.flaggedViolations.length).toBe(0);
+  expect(client.diffResults?.suppressedViolations.length).toBe(2);
+  expect(client.diffResults?.noViolations.length).toBe(1);
+});