Merge pull request #5 from MikeRalphson/mr/tests

lornajane · web-flow · commit 888bac564442 · 2023-03-19T20:55:51.000Z
New tests and hardening of actions updating
diff --git a/src/overlay.js b/src/overlay.js
@@ -5,7 +5,7 @@ import mergician from 'mergician';
 
 function applyOverlayToOpenAPI(spec, overlay) {
 	// Use jsonpath.apply to do the changes
-	overlay.actions.forEach((a)=>{
+	if (overlay.actions && overlay.actions.length >= 1) overlay.actions.forEach((a)=>{
 		// Is it a remove?
 		if (a.hasOwnProperty('remove')) {
 			while(true) {
@@ -19,34 +19,38 @@ function applyOverlayToOpenAPI(spec, overlay) {
 			}
 
 		} else {
-			// It must be an update
-			jsonpath.apply(spec, a.target, (chunk) => {
-				
-				// Deep merge using a module (built-in spread operator is only shallow)
-				const merger = mergician({appendArrays: true});
-				const merged = merger(chunk, a.update);
-				return merged;
+			try {
+				// It must be an update
+				jsonpath.apply(spec, a.target, (chunk) => {
+					// Deep merge using a module (built-in spread operator is only shallow)
+					const merger = mergician({appendArrays: true})
+					return merger(chunk, a.update)
+				});
+			}
+			catch (ex) {
+				process.stderr.write(`Error applying overlay: ${ex.message}\n`)
+				//return chunk
+			}
 
-			});
 		}
 	})
 
 	return spec;
 }
 
 function sortOpenAPIFields(field1, field2) {
-    const orderedKeys = ["info", "servers", "paths", "components", "summary", "objectId", "description", "tags", "parameters", "responses"];
+	const orderedKeys = ["info", "servers", "summary", "operationId", "tags", "paths", "components", "description", "parameters", "responses"];
 
-    const index1 = orderedKeys.indexOf(field1);
-    const index2 = orderedKeys.indexOf(field2);
+	const index1 = orderedKeys.indexOf(field1);
+	const index2 = orderedKeys.indexOf(field2);
 
-    if (index1 === -1 || index2 === -1) {
-        return 0;
-    } else if (index1 > index2) {
-        return 1;
-    } else {
-        return -1;
-    }
+	if (index1 === -1 || index2 === -1) {
+		return 0;
+	} else if (index1 > index2) {
+		return 1;
+	} else {
+		return -1;
+	}
 }
 
 export function overlayFiles(openapiFile, overlayFile) {
diff --git a/test/expected/empty.yaml b/test/expected/empty.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/expected/immutable.yaml b/test/expected/immutable.yaml
@@ -0,0 +1,5 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+paths: {}
diff --git a/test/expected/not-jsonpath.yaml b/test/expected/not-jsonpath.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/expected/not-overlay.yaml b/test/expected/not-overlay.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/expected/output1.yaml b/test/expected/output1.yaml
@@ -10,9 +10,6 @@ paths:
   /pets:
     get:
       operationId: listPets
-      info:
-        x-overlay-applied: structured-overlay
-        description: This is an added description
       tags:
         - pets
         - wildcard-done
@@ -44,6 +41,9 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+      x-info:
+        x-overlay-applied: structured-overlay
+        description: This is an added description
     post:
       foo:
         bar: hello
diff --git a/test/expected/town-building-description.yaml b/test/expected/town-building-description.yaml
@@ -53,7 +53,7 @@ paths:
                   type: object
                   properties:
                     location_id:
-                      type: int
+                      type: integer
                       example: 44
                     name:
                       type: string
@@ -67,5 +67,5 @@ components:
           type: string
           example: house
         location_id:
-          type: int
+          type: integer
           example: 44
diff --git a/test/expected/town-remove-descriptions.yaml b/test/expected/town-remove-descriptions.yaml
@@ -47,7 +47,7 @@ paths:
                   type: object
                   properties:
                     location_id:
-                      type: int
+                      type: integer
                       example: 44
                     name:
                       type: string
@@ -61,5 +61,5 @@ components:
           type: string
           example: house
         location_id:
-          type: int
+          type: integer
           example: 44
diff --git a/test/expected/town-remove-example.yaml b/test/expected/town-remove-example.yaml
@@ -52,7 +52,7 @@ paths:
                   type: object
                   properties:
                     location_id:
-                      type: int
+                      type: integer
                       example: 44
                     name:
                       type: string
@@ -65,5 +65,5 @@ components:
         building:
           type: string
         location_id:
-          type: int
+          type: integer
           example: 44
diff --git a/test/expected/town-remove-properties.yaml b/test/expected/town-remove-properties.yaml
@@ -52,7 +52,7 @@ paths:
                   type: object
                   properties:
                     location_id:
-                      type: int
+                      type: integer
                       example: 44
 components:
   schemas:
@@ -63,5 +63,5 @@ components:
           type: string
           example: house
         location_id:
-          type: int
+          type: integer
           example: 44
diff --git a/test/openapi/empty.yaml b/test/openapi/empty.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/openapi/immutable.yaml b/test/openapi/immutable.yaml
@@ -0,0 +1,5 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+paths: {}
diff --git a/test/openapi/not-jsonpath.yaml b/test/openapi/not-jsonpath.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/openapi/not-overlay.yaml b/test/openapi/not-overlay.yaml
@@ -0,0 +1,7 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: API
+tags:
+  - name: Things
+paths: {}
diff --git a/test/openapi/town.yaml b/test/openapi/town.yaml
@@ -54,7 +54,7 @@ paths:
                   type: object
                   properties:
                     location_id:
-                      type: int
+                      type: integer
                       example: 44
                     name:
                       type: string
@@ -69,5 +69,5 @@ components:
           type: string
           example: "house"
         location_id:
-          type: int
+          type: integer
           example: 44
diff --git a/test/overlay.test.js b/test/overlay.test.js
@@ -59,4 +59,47 @@ test('remove all description fields', () => {
 	expect(result).toEqual(expectedOutput);
 });
 
+test('fail to update a primitive string type', () => {
+	const openapiFile = "test/openapi/immutable.yaml";
+	const overlayFile = "test/overlays/immutable.yaml";
+	const expectedFile = "test/expected/immutable.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+test('fail to parse invalid jsonpath expression', () => {
+	const openapiFile = "test/openapi/not-jsonpath.yaml";
+	const overlayFile = "test/overlays/not-jsonpath.yaml";
+	const expectedFile = "test/expected/not-jsonpath.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+test('fail to parse invalid overlay document', () => {
+	const openapiFile = "test/openapi/not-overlay.yaml";
+	const overlayFile = "test/overlays/not-overlay.yaml";
+	const expectedFile = "test/expected/not-overlay.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+test('overlay document with empty actions is a nop', () => {
+	const openapiFile = "test/openapi/not-overlay.yaml";
+	const overlayFile = "test/overlays/not-overlay.yaml";
+	const expectedFile = "test/expected/not-overlay.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
 
diff --git a/test/overlays/empty.yaml b/test/overlays/empty.yaml
@@ -0,0 +1,5 @@
+overlay: 1.0.0
+info:
+  title: Expected to fail as actions omitted or empty
+  version: 1.0.0
+actions: []
diff --git a/test/overlays/immutable.yaml b/test/overlays/immutable.yaml
@@ -0,0 +1,4 @@
+overlay: 1.0.0
+actions:
+- target: info.version
+  update: 1.1.0
diff --git a/test/overlays/not-jsonpath.yaml b/test/overlays/not-jsonpath.yaml
@@ -0,0 +1,8 @@
+overlay: 1.0.0
+info:
+  title: Expected to fail on unparseable target expression
+  version: 1.0.0
+actions:
+  - target: £
+    add:
+      name: foo
diff --git a/test/overlays/not-overlay.yaml b/test/overlays/not-overlay.yaml
@@ -0,0 +1,5 @@
+openapi: 1.0.0
+info:
+  title: Expected to fail as not an overlay document
+  version: 1.0.0
+paths: {}
diff --git a/test/overlays/overlay.yaml b/test/overlays/overlay.yaml
@@ -11,7 +11,7 @@ actions:
       - wildcard-done
 - target: $.paths['/pets'].get
   update:
-    info:
+    x-info:
       x-overlay-applied: structured-overlay
       description: This is an added description
     tags:
