adds openapi-format dep to filter operations (#28)

* adds openapi-format dep to filter operations

* update changelog

CHANEGLOG.md

@@ -1,3 +1,9 @@
+## v0.1.0 - (2021-05-31)
+
+### OpenApi-Format / CLI options
+
+- Added CLI Option filterFile to pass path to filter options for ignoring requests in spec before passing to Postman conversion
+
 ## v0.0.9 - (2021-05-28)
 
 ### CLI options

package.json

@@ -63,6 +63,7 @@
     "newman": "^5.2.3",
     "node-emoji": "^1.10.0",
     "node-fetch": "^2.6.1",
+    "openapi-format": "^1.2.3",
     "openapi-to-postmanv2": "git://github.com/thim81/openapi-to-postman.git#latest.2.7.0",
     "ora": "^5.4.0",
     "pluralize": "^8.0.0",

src/index.ts

@@ -15,6 +15,7 @@ import { PostmanService } from './application/PostmanService'
 import {
   cleanupTestSchemaDefs,
   clearTmpDirectory,
+  execShellCommand,
   getConfig,
   injectEnvVariables,
   injectPreRequest,
@@ -91,6 +92,10 @@ require('dotenv').config()
       describe: 'Path to postman-testsuite.json',
       type: 'string'
     })
+    .option('filterFile', {
+      describe: 'Path to openapi-format-filter.json',
+      type: 'string'
+    })
     .option('envFile', {
       describe: 'Path to .env file to use for variable injection',
       type: 'string'
@@ -134,6 +139,7 @@ require('dotenv').config()
     ? undefined
     : options.testSuiteConfigFile || 'postman-testsuite.json'
   const envFile = options.envFile || '.env'
+  const filterFile = options.filterFile
 
   const { variableOverwrites, preRequestScripts, globalReplacements, orderOfOperations } =
     await getConfig(portmanConfigFile)
@@ -185,12 +191,20 @@ require('dotenv').config()
     }
   }
 
-  const openApiSpec = oaLocal ? './tmp/converted/spec.yml' : await new DownloadService().get(oaUrl)
+  let openApiSpec = oaLocal ? './tmp/converted/spec.yml' : await new DownloadService().get(oaUrl)
   const specExists = await fs.pathExists(openApiSpec)
   if (!specExists) {
     throw new Error(`Download failed. ${openApiSpec} doesn't exist. `)
   }
 
+  if (filterFile && (await fs.pathExists(filterFile))) {
+    const openApiSpecPath = './tmp/converted/filtered.yml'
+
+    await execShellCommand(
+      `npx openapi-format ${openApiSpec} -o ${openApiSpecPath} --yaml --filterFile ${filterFile}`
+    )
+    openApiSpec = openApiSpecPath
+  }
   // --- openapi-to-postman - Transform OpenApi to Postman collection, with optional test suite generation
   const tmpCollectionFile = `${process.cwd()}/tmp/working/tmpCollection.json`
 

src/lib/execShellCommand.ts

@@ -0,0 +1,13 @@
+import { exec } from 'child_process'
+export const execShellCommand = (cmd: string): Promise<boolean> => {
+  return new Promise((resolve, _reject) => {
+    exec(cmd, { maxBuffer: 1024 * 500 }, (error, stdout, stderr) => {
+      if (error) {
+        console.warn(error)
+      } else if (stderr) {
+        console.log(stderr)
+      }
+      resolve(stdout ? true : false)
+    })
+  })
+}

src/lib/index.ts

@@ -1,4 +1,5 @@
 export * from './clearTmpDirectory'
+export * from './execShellCommand'
 export * from './getConfig'
 export * from './runNewmanWith'
 export * from './transforms/cleanupTestSchemaDefs'

src/types/PortmanOptions.ts

@@ -11,6 +11,7 @@ export interface PortmanOptions {
   portmanConfigFile?: string
   postmanConfigFile?: string
   testSuiteConfigFile?: string
+  filterFile?: string
   envFile?: string
   cliOptionsFile?: string
 }