Add jest and some starter tests (one fails)

Author: lornajane

package.json

@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node_modules/.bin/jest"
   },
   "type": "module",
   "author": "",
@@ -14,5 +14,17 @@
     "jsonpath": "^1.1.1",
     "mergician": "^1.0.3",
     "openapi-format": "^1.13.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.20.2",
+    "babel-jest": "^29.4.1",
+    "jest": "^29.4.1"
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.js$": "babel-jest"
+    },
+    "testEnvironment": "node"
   }
 }

test/expected/output1.yaml

@@ -0,0 +1,111 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: 'http://petstore.swagger.io/v1'
+paths:
+  /pets:
+    get:
+      summary: {}
+      operationId: listPets
+      tags:
+        - pets
+        - wildcard-done
+        - overlayed
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            maximum: 100
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pets'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      info:
+        x-overlay-applied: structured-overlay
+        description: This is an added description
+    post:
+      foo:
+        bar: hello
+  '/pets/{petId}':
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+        - wildcard-done
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+    post:
+      foo:
+        bar: hello
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      maxItems: 100
+      items:
+        $ref: '#/components/schemas/Pet'
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

test/expected/town-building-description.yaml

@@ -0,0 +1,26 @@
+openapi: "3.1.0"
+info:
+  version: 1.0.0
+  title: Imaginary town
+servers:
+  - url: https://example.com
+    description: Example server
+paths:
+  '/buildings':
+    get:
+	  summary: "All of the available buildings"
+      operationId: buildingsAll
+	  description: "This is the summary of getting the buildings"
+
+      responses:
+        '200':
+          description: Return all known buildings
+          content:
+            application/json:
+              schema:
+                type: object
+                properties: 
+                  message:
+                    type: string
+                    example: "house"
+

test/openapi/town.yaml

@@ -0,0 +1,24 @@
+openapi: "3.1.0"
+info:
+  version: 1.0.0
+  title: Imaginary town
+servers:
+  - url: https://example.com
+    description: Example server
+paths:
+  '/buildings':
+    get:
+      summary: All buildings  
+      operationId: buildingsAll
+      responses:
+        '200':
+          description: Return all known buildings
+          content:
+            application/json:
+              schema:
+                type: object
+                properties: 
+                  message:
+                    type: string
+                    example: "house"
+

test/overlay.test.js

@@ -0,0 +1,27 @@
+import {overlayFiles} from '../src/overlay.js'
+import fs from 'fs';
+
+
+test('apply an overlay and check the output', () => {
+	const openapiFile = "test/openapi/petstore.yaml";
+	const overlayFile = "test/overlays/overlay.yaml";
+	const expectedFile = "test/expected/output1.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+test('apply an overlay and check the output', () => {
+	const openapiFile = "test/openapi/town.yaml";
+	const overlayFile = "test/overlays/building-description.yaml";
+	const expectedFile = "test/expected/town-building-description.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+

test/overlays/building-description.yaml

@@ -0,0 +1,10 @@
+overlay: 1.0.0
+info:
+  title: Add a building endpoint description
+  version: 1.0.0
+actions:
+- target: $.paths['/buildings'].get
+  update:
+	description: "This is the summary of getting the buildings"
+	summary: "All of the available buildings"
+