test(reference): add location tests for OpenAPI 2.0 dereference

Refs #3102

packages/apidom-reference/test/dereference/strategies/openapi-2/parameter-object/fixtures/operation-object/dereferenced.json

@@ -0,0 +1,25 @@
+[
+  {
+    "swagger": "2.0",
+    "paths": {
+      "/path": {
+        "get": {
+          "parameters": [
+            {
+              "name": "offset",
+              "in": "query",
+              "required": true
+            }
+          ]
+        }
+      }
+    },
+    "parameters": {
+      "param1": {
+        "name": "offset",
+        "in": "query",
+        "required": true
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/parameter-object/fixtures/operation-object/root.json

@@ -0,0 +1,21 @@
+{
+  "swagger": "2.0",
+  "paths": {
+    "/path": {
+      "get": {
+        "parameters": [
+          {
+            "$ref": "#/parameters/param1"
+          }
+        ]
+      }
+    }
+  },
+  "parameters": {
+    "param1": {
+      "name": "offset",
+      "in": "query",
+      "required": true
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/parameter-object/fixtures/path-item-object/dereferenced.json

@@ -0,0 +1,23 @@
+[
+  {
+    "swagger": "2.0",
+    "paths": {
+      "/path": {
+        "parameters": [
+          {
+            "name": "offset",
+            "in": "query",
+            "required": true
+          }
+        ]
+      }
+    },
+    "parameters": {
+      "param1": {
+        "name": "offset",
+        "in": "query",
+        "required": true
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/parameter-object/fixtures/path-item-object/root.json

@@ -0,0 +1,19 @@
+{
+  "swagger": "2.0",
+  "paths": {
+    "/path": {
+      "parameters": [
+        {
+          "$ref": "#/parameters/param1"
+        }
+      ]
+    }
+  },
+  "parameters": {
+    "param1": {
+      "name": "offset",
+      "in": "query",
+      "required": true
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/parameter-object/index.ts

@@ -0,0 +1,45 @@
+import path from 'node:path';
+import { assert } from 'chai';
+import { toValue } from '@swagger-api/apidom-core';
+import { mediaTypes } from '@swagger-api/apidom-ns-openapi-2';
+
+import { loadJsonFile } from '../../../../helpers';
+import { dereference } from '../../../../../src';
+
+const rootFixturePath = path.join(__dirname, 'fixtures');
+
+describe('dereference', function () {
+  context('strategies', function () {
+    context('openapi-2', function () {
+      context('Parameter Object', function () {
+        context('given in Path Item Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'path-item-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+
+        context('given in Operation Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'operation-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+      });
+    });
+  });
+});

packages/apidom-reference/test/dereference/strategies/openapi-2/response-object/fixtures/responses-object/dereferenced.json

@@ -0,0 +1,27 @@
+[
+  {
+    "swagger": "2.0",
+    "paths": {
+      "/path": {
+        "get": {
+          "responses": {
+            "default": {
+              "description": "first response object"
+            },
+            "200": {
+              "description": "second response object"
+            }
+          }
+        }
+      }
+    },
+    "responses": {
+      "default": {
+        "description": "first response object"
+      },
+      "200": {
+        "description": "second response object"
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/response-object/fixtures/responses-object/root.json

@@ -0,0 +1,25 @@
+{
+  "swagger": "2.0",
+  "paths": {
+    "/path": {
+      "get": {
+        "responses": {
+          "default": {
+            "$ref": "#/responses/default"
+          },
+          "200": {
+            "$ref": "#/responses/200"
+          }
+        }
+      }
+    }
+  },
+  "responses": {
+    "default": {
+      "description": "first response object"
+    },
+    "200": {
+      "description": "second response object"
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/response-object/index.ts

@@ -0,0 +1,31 @@
+import path from 'node:path';
+import { assert } from 'chai';
+import { toValue } from '@swagger-api/apidom-core';
+import { mediaTypes } from '@swagger-api/apidom-ns-openapi-2';
+
+import { loadJsonFile } from '../../../../helpers';
+import { dereference } from '../../../../../src';
+
+const rootFixturePath = path.join(__dirname, 'fixtures');
+
+describe('dereference', function () {
+  context('strategies', function () {
+    context('openapi-2', function () {
+      context('Response Object', function () {
+        context('given in Responses Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'responses-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+      });
+    });
+  });
+});

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/definitions/dereferenced.json

@@ -0,0 +1,13 @@
+[
+  {
+    "swagger": "2.0",
+    "definitions": {
+      "schema1": {
+        "title": "title of schema 1"
+      },
+      "schema2": {
+        "title": "title of schema 1"
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/definitions/root.json

@@ -0,0 +1,11 @@
+{
+  "swagger": "2.0",
+  "definitions": {
+    "schema1": {
+      "title": "title of schema 1"
+    },
+    "schema2": {
+      "$ref": "#/definitions/schema1"
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/parameter-object/dereferenced.json

@@ -0,0 +1,17 @@
+[
+  {
+    "swagger": "2.0",
+    "parameters": {
+      "parameter1": {
+        "schema": {
+          "title": "parameter1 schema title"
+        }
+      },
+      "parameter2": {
+        "schema": {
+          "title": "parameter1 schema title"
+        }
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/parameter-object/root.json

@@ -0,0 +1,15 @@
+{
+  "swagger": "2.0",
+  "parameters": {
+    "parameter1": {
+      "schema": {
+        "title": "parameter1 schema title"
+      }
+    },
+    "parameter2": {
+      "schema": {
+        "$ref": "#/parameters/parameter1/schema"
+      }
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/response-object/dereferenced.json

@@ -0,0 +1,19 @@
+[
+  {
+    "swagger": "2.0",
+    "responses": {
+      "response1": {
+        "description": "response1 description",
+        "schema": {
+          "type": "string"
+        }
+      },
+      "response2": {
+        "description": "response2 description",
+        "schema": {
+          "type": "string"
+        }
+      }
+    }
+  }
+]

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/fixtures/response-object/root.json

@@ -0,0 +1,17 @@
+{
+  "swagger": "2.0",
+  "responses": {
+    "response1": {
+      "description": "response1 description",
+      "schema": {
+        "type": "string"
+      }
+    },
+    "response2": {
+      "description": "response2 description",
+      "schema": {
+        "$ref": "#/responses/response1/schema"
+      }
+    }
+  }
+}

packages/apidom-reference/test/dereference/strategies/openapi-2/schema-object/index.ts

@@ -0,0 +1,59 @@
+import path from 'node:path';
+import { assert } from 'chai';
+import { toValue } from '@swagger-api/apidom-core';
+import { mediaTypes } from '@swagger-api/apidom-ns-openapi-2';
+
+import { loadJsonFile } from '../../../../helpers';
+import { dereference } from '../../../../../src';
+
+const rootFixturePath = path.join(__dirname, 'fixtures');
+
+describe('dereference', function () {
+  context('strategies', function () {
+    context('openapi-2', function () {
+      context('Schema Object', function () {
+        context('given in definitions field', function () {
+          const fixturePath = path.join(rootFixturePath, 'definitions');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+
+        context('given in Parameter Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'parameter-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+
+        context('given in Response Object', function () {
+          const fixturePath = path.join(rootFixturePath, 'response-object');
+
+          specify('should dereference', async function () {
+            const rootFilePath = path.join(fixturePath, 'root.json');
+            const actual = await dereference(rootFilePath, {
+              parse: { mediaType: mediaTypes.latest('json') },
+            });
+            const expected = loadJsonFile(path.join(fixturePath, 'dereferenced.json'));
+
+            assert.deepEqual(toValue(actual), expected);
+          });
+        });
+      });
+    });
+  });
+});