Add more tests for removing various things by expression

lornajane · lornajane · commit 7b0506fa3629 · 2023-02-17T15:25:19.000Z
diff --git a/test/expected/town-building-description.yaml b/test/expected/town-building-description.yaml
@@ -9,17 +9,63 @@ paths:
   /buildings:
     get:
       summary: All of the available buildings
-      operationId: buildingsAll
-	  description: This is the summary of getting the buildings
+      operationId: buildingsList
+      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
-
+                type: array
+                items:
+                  $ref: '#/components/schemas/Building'
+  '/buildings/{buildingId}':
+    get:
+      summary: Specific building
+      operationId: buildingById
+      parameters:
+        - name: buildingId
+          in: path
+          required: true
+          description: Which building to return
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Return a building
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Building'
+  /locations:
+    get:
+      summary: All locations
+      operationId: locationList
+      responses:
+        '200':
+          description: Returns all locations
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    location_id:
+                      type: int
+                      example: 44
+                    name:
+                      type: string
+                      example: North Village
+components:
+  schemas:
+    Building:
+      type: object
+      properties:
+        building:
+          type: string
+          example: house
+        location_id:
+          type: int
+          example: 44
diff --git a/test/expected/town-remove-descriptions.yaml b/test/expected/town-remove-descriptions.yaml
@@ -0,0 +1,65 @@
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: Imaginary town
+servers:
+  - url: 'https://example.com'
+paths:
+  /buildings:
+    get:
+      summary: All buildings
+      operationId: buildingsList
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Building'
+  '/buildings/{buildingId}':
+    get:
+      summary: Specific building
+      operationId: buildingById
+      parameters:
+        - name: buildingId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Building'
+  /locations:
+    get:
+      summary: All locations
+      operationId: locationList
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    location_id:
+                      type: int
+                      example: 44
+                    name:
+                      type: string
+                      example: North Village
+components:
+  schemas:
+    Building:
+      type: object
+      properties:
+        building:
+          type: string
+          example: house
+        location_id:
+          type: int
+          example: 44
diff --git a/test/expected/town-remove-example.yaml b/test/expected/town-remove-example.yaml
@@ -4,17 +4,66 @@ info:
   title: Imaginary town
 servers:
   - url: 'https://example.com'
+    description: Example server
 paths:
   /buildings:
     get:
       summary: All buildings
-      operationId: buildingsAll
+      operationId: buildingsList
       responses:
         '200':
+          description: Return all known buildings
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  message:
-                    type: string
+                type: array
+                items:
+                  $ref: '#/components/schemas/Building'
+  '/buildings/{buildingId}':
+    get:
+      summary: Specific building
+      operationId: buildingById
+      parameters:
+        - name: buildingId
+          in: path
+          required: true
+          description: Which building to return
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Return a building
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Building'
+  /locations:
+    get:
+      summary: All locations
+      operationId: locationList
+      responses:
+        '200':
+          description: Returns all locations
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    location_id:
+                      type: int
+                      example: 44
+                    name:
+                      type: string
+                      example: North Village
+components:
+  schemas:
+    Building:
+      type: object
+      properties:
+        building:
+          type: string
+        location_id:
+          type: int
+          example: 44
diff --git a/test/expected/town-remove-properties.yaml b/test/expected/town-remove-properties.yaml
@@ -0,0 +1,67 @@
+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: buildingsList
+      responses:
+        '200':
+          description: Return all known buildings
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Building'
+  '/buildings/{buildingId}':
+    get:
+      summary: Specific building
+      operationId: buildingById
+      parameters:
+        - name: buildingId
+          in: path
+          required: true
+          description: Which building to return
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Return a building
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Building'
+  /locations:
+    get:
+      summary: All locations
+      operationId: locationList
+      responses:
+        '200':
+          description: Returns all locations
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    location_id:
+                      type: int
+                      example: 44
+components:
+  schemas:
+    Building:
+      type: object
+      properties:
+        building:
+          type: string
+          example: house
+        location_id:
+          type: int
+          example: 44
diff --git a/test/openapi/town.yaml b/test/openapi/town.yaml
@@ -8,17 +8,66 @@ servers:
 paths:
   '/buildings':
     get:
-      summary: All buildings  
-      operationId: buildingsAll
+      summary: All buildings
+      operationId: buildingsList
       responses:
         '200':
           description: Return all known buildings
           content:
             application/json:
               schema:
-                type: object
-                properties: 
-                  message:
-                    type: string
-                    example: "house"
+                type: array
+                items:
+                  $ref: "#/components/schemas/Building"
 
+  '/buildings/{buildingId}':
+    get:
+      summary: Specific building
+      operationId: buildingById
+      parameters:
+        - name: buildingId
+          in: path
+          required: true
+          description: Which building to return
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Return a building
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Building"
+
+  '/locations':
+    get:
+      summary: All locations
+      operationId: locationList
+      responses:
+        '200':
+          description: Returns all locations
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    location_id:
+                      type: int
+                      example: 44
+                    name:
+                      type: string
+                      example: "North Village"
+
+components:
+  schemas:
+    Building:
+      type: object
+      properties:
+        building:
+          type: string
+          example: "house"
+        location_id:
+          type: int
+          example: 44
diff --git a/test/overlay.test.js b/test/overlay.test.js
@@ -37,3 +37,26 @@ test('remove an example', () => {
 });
 
 
+test('remove a property', () => {
+	const openapiFile = "test/openapi/town.yaml";
+	const overlayFile = "test/overlays/remove-properties.yaml";
+	const expectedFile = "test/expected/town-remove-properties.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+test('remove all description fields', () => {
+	const openapiFile = "test/openapi/town.yaml";
+	const overlayFile = "test/overlays/remove-descriptions.yaml";
+	const expectedFile = "test/expected/town-remove-descriptions.yaml";
+	const expectedOutput = fs.readFileSync(expectedFile, 'utf8');
+
+	const result = overlayFiles(openapiFile, overlayFile);
+
+	expect(result).toEqual(expectedOutput);
+});
+
+
diff --git a/test/overlays/building-description.yaml b/test/overlays/building-description.yaml
@@ -5,6 +5,6 @@ info:
 actions:
 - target: $.paths['/buildings'].get
   update:
-    description: "This is the summary of getting the buildings"
-    summary: "All of the available buildings"
+    description: This is the summary of getting the buildings
+    summary: All of the available buildings
 
diff --git a/test/overlays/remove-descriptions.yaml b/test/overlays/remove-descriptions.yaml
@@ -0,0 +1,7 @@
+overlay: 1.0.0
+info:
+  title: Remove an example
+  version: 1.0.0
+actions:
+- target: $..description
+  remove: true
diff --git a/test/overlays/remove-example.yaml b/test/overlays/remove-example.yaml
diff --git a/test/overlays/remove-properties.yaml b/test/overlays/remove-properties.yaml
