tests: inverse with strip

Author: thim81

test/filtering.test.js

@@ -310,6 +310,16 @@ describe('openapi-format CLI filtering tests', () => {
     });
   });
 
+  describe('yaml-filter-inverse-flags-stripFlags', () => {
+    it('yaml-filter-inverse-flags-stripFlags - should match expected output', async () => {
+      const testName = 'yaml-filter-inverse-flags-stripFlags';
+      const {result, outputBefore, outputAfter} = await testUtils.loadTest(testName);
+      expect(result.code).toBe(0);
+      expect(result.stdout).toContain('formatted successfully');
+      expect(outputAfter).toStrictEqual(outputBefore);
+    });
+  });
+
   describe('isUsedComp', () => {
     it('returns false for non-object input', () => {
       expect(isUsedComp(null, 'schemas')).toBe(false);

test/openapi-core.test.js

@@ -26,6 +26,56 @@ describe('openapi-format core API', () => {
     expect(result.data.tags).toEqual([{name: 'pets'}]);
   });
 
+  it('openapiFilter inverseFlags + stripFlags currently removes previously kept operations after recurse', async () => {
+    const doc = {
+      openapi: '3.0.0',
+      info: {title: 'API', version: '1.0.0'},
+      paths: {
+        '/pets': {
+          get: {'x-public': true, responses: {'200': {description: 'ok'}}},
+          post: {responses: {'200': {description: 'ok'}}}
+        }
+      }
+    };
+
+    const onlyInverse = await openapiFilter(doc, {filterSet: {inverseFlags: ['x-public']}});
+    expect(onlyInverse.data.paths).toHaveProperty('/pets.get');
+
+    const inverseAndStrip = await openapiFilter(doc, {filterSet: {inverseFlags: ['x-public'], stripFlags: ['x-public']}});
+    expect(inverseAndStrip.data.paths).toBeUndefined();
+  });
+
+  it('adding responses to unusedComponents does not change inverseFlags+stripFlags outcome', async () => {
+    const doc = {
+      openapi: '3.0.0',
+      info: {title: 'API', version: '1.0.0'},
+      paths: {
+        '/pets': {
+          get: {'x-public': true, responses: {'200': {description: 'ok'}}},
+          post: {responses: {'200': {description: 'ok'}}}
+        }
+      },
+      components: {
+        schemas: {
+          Pet: {type: 'object'}
+        }
+      }
+    };
+
+    const base = {
+      inverseFlags: ['x-public'],
+      stripFlags: ['x-public'],
+      unusedComponents: ['schemas', 'parameters', 'examples', 'headers', 'requestBodies']
+    };
+    const withResponses = {...base, unusedComponents: [...base.unusedComponents, 'responses']};
+
+    const resultBase = await openapiFilter(doc, {filterSet: base});
+    const resultWithResponses = await openapiFilter(doc, {filterSet: withResponses});
+
+    expect(resultBase.data).toEqual(resultWithResponses.data);
+    expect(resultWithResponses.data.paths).toBeUndefined();
+  });
+
   it('openapiChangeCase should apply summary, description and securitySchemes ref casing', async () => {
     const doc = {
       openapi: '3.0.0',

test/test.js

@@ -8,15 +8,15 @@ const {run} = require('../bin/cli');
 const {parseFile, stringify, writeFile} = require('../openapi-format');
 
 // SELECTIVE TESTING DEBUG
-const localTesting = false;
+const localTesting = true;
 const destroyOutput = false;
 
 // Load tests
 const tests = !localTesting
   ? fs.readdirSync(__dirname).filter(file => {
       return fs.statSync(path.join(__dirname, file)).isDirectory() && !file.startsWith('_');
     })
-  : ['yaml-sort-component-props'];
+  : ['yaml-filter-inverse-flags-stripFlags'];
 
 describe('openapi-format tests', () => {
   let consoleLogSpy, consoleWarnSpy;

test/yaml-filter-inverse-flags-stripFlags/customFilter.yaml

@@ -0,0 +1,11 @@
+inverseFlags:
+  - x-public
+stripFlags:
+  - x-public
+unusedComponents:
+  - schemas
+  - parameters
+  - examples
+  - headers
+  - requestBodies
+  - responses

test/yaml-filter-inverse-flags-stripFlags/input.yaml

@@ -0,0 +1,32 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+paths:
+  /pets:
+    get:
+      operationId: findPets
+      x-public: true
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+    post:
+      operationId: addPet
+      responses:
+        '200':
+          description: pet response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pet'
+components:
+  schemas:
+    Pet:
+      type: object
+      properties:
+        id:
+          type: integer

test/yaml-filter-inverse-flags-stripFlags/options.yaml

@@ -0,0 +1,4 @@
+verbose: true
+no-sort: true
+output: output.yaml
+filterFile: customFilter.yaml

test/yaml-filter-inverse-flags-stripFlags/output.yaml

@@ -0,0 +1,4 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore