Warn for missing targets (#659)

* Warn for missing openApiOperationId

Author: thim81

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## [Unreleased]
 
+- Warn for missing targets (#632 #391)
+
 ## v1.30.4 - (2024-10-07)
 
 - Handle Postman API non-200 responses better (#660)

README.md

@@ -137,9 +137,10 @@ Options:
  --filterFile               Path/URL to openapi-format config file (oas-format-filter.json)                  [string]
  --envFile                  Path to the .env file to inject environment variables                            [string]
  --collectionName           Overwrite OpenAPI title to set the Postman collection name                       [string]
- --cliOptionsFile           Path/URL to Portman CLI options file                                            [string]
+ --cliOptionsFile           Path/URL to Portman CLI options file                                             [string]
  --ignoreCircularRefs       Ignore circular references in OpenAPI spec (default: false)                      [boolean]
  --logAssignVariables       Toggle logging of assigned variables (default: true)                             [boolean]
+ --warn/--no-warn           Toggle warnings for missing openApiOperationIds (default: true)                  [boolean]
  --init                     Configure Portman CLI options in an interactive manner                           [string]
  --extraUnknownFormats      Add extra unknown formats to json schema tests                                   [array]
 ```

package-lock.json

@@ -70,7 +70,7 @@
     "@apidevtools/swagger-parser": "^10.1.0",
     "@faker-js/faker": "5.5.3",
     "ajv": "^8.12.0",
-    "axios": "^1.6.5",
+    "axios": "^1.7.7",
     "chalk": "^4.1.2",
     "dot-object": "^2.1.5",
     "dotenv": "^10.0.0",

package.json

@@ -20,7 +20,7 @@ import { clearTmpDirectory, getConfig } from './lib'
 import { OpenApiFormatter, OpenApiParser } from './oas'
 import { PostmanParser } from './postman'
 import { IOpenApiToPostmanConfig, OpenApiToPostmanService, PostmanSyncService } from './services'
-import { PortmanConfig, PortmanTestTypes } from './types'
+import { PortmanConfig, PortmanTestTypes, Track } from './types'
 import { PortmanOptions } from './types/PortmanOptions'
 import { validate } from './utils/PortmanConfig.validator'
 import { PortmanError } from './utils/PortmanError'
@@ -189,6 +189,7 @@ export class Portman {
 
   async after(): Promise<void> {
     const { consoleLine, collectionFile } = this
+
     await clearTmpDirectory()
     console.log(chalk.green(consoleLine))
 
@@ -199,6 +200,9 @@ export class Portman {
     )
 
     console.log(chalk.green(consoleLine))
+
+    // Display warning
+    this.displayMissingTargets(this.testSuite.track)
   }
 
   async parseOpenApiSpec(): Promise<void> {
@@ -666,4 +670,34 @@ export class Portman {
       process.exit(1)
     }
   }
+
+  displayMissingTargets = (track: Track): void => {
+    const {
+      consoleLine,
+      options: { warn }
+    } = this
+
+    if (warn === false) {
+      return
+    }
+
+    // Deduplicate missing targets
+    const uniqueOperationIds = Array.from(new Set(track.openApiOperationIds))
+    const uniqueOperations = Array.from(new Set(track.openApiOperations))
+
+    if (uniqueOperationIds.length > 0 || uniqueOperations.length === 0) {
+      console.log(
+        chalk.yellow(`WARNING: The following targets are missing from the OpenAPI specification.`)
+      )
+      if (uniqueOperationIds.length > 0) {
+        const idsList = uniqueOperationIds.join(', ')
+        console.log(chalk.yellow(`operationId:\t\t${idsList}`))
+      }
+      if (uniqueOperations.length > 0) {
+        const opsList = uniqueOperations.join(', ')
+        console.log(chalk.yellow(`openApiOperation:\t${opsList}`))
+      }
+      console.log(chalk.yellow(consoleLine))
+    }
+  }
 }

src/Portman.ts

@@ -39,7 +39,10 @@ export class IntegrationTestWriter {
 
       const pmOperation = testSuite.postmanParser.getOperationById(openApiOperationId)
 
-      if (!pmOperation) return
+      if (!pmOperation) {
+        this.testSuite.track.openApiOperationIds.push(openApiOperationId)
+        return
+      }
 
       const folderId = variationWriter.variationFolder.id
       // const folderName = pmOperation.getParentFolderName()

src/application/IntegrationTestWriter.ts

@@ -36,6 +36,7 @@ import {
   ResponseTime,
   StatusCode,
   TestSuiteOptions,
+  Track,
   VariationTestConfig
 } from '../types'
 import { inRange } from '../utils'
@@ -61,6 +62,9 @@ export class TestSuite {
 
   requestTestTypes: PortmanReqTestType[]
 
+  // Tracker
+  public track = { openApiOperationIds: [], openApiOperations: [] } as Track
+
   constructor(testSuiteOptions: TestSuiteOptions) {
     const { oasParser, postmanParser, config, options } = testSuiteOptions
 
@@ -168,10 +172,24 @@ export class TestSuite {
 
     if (openApiOperation) {
       pmOperations = this.postmanParser.getOperationsByPath(openApiOperation)
+      // Track missing operations
+      if (pmOperations.length === 0) {
+        this.track.openApiOperations.push(openApiOperation)
+      }
     } else if (openApiOperationId) {
       pmOperations = this.postmanParser.getOperationsByIds([openApiOperationId])
+
+      // Track missing operations
+      if (pmOperations.length === 0) {
+        this.track.openApiOperationIds.push(openApiOperationId)
+      }
     } else if (openApiOperationIds) {
       pmOperations = this.postmanParser.getOperationsByIds(openApiOperationIds)
+
+      // Track missing operations
+      if (pmOperations.length === 0) {
+        this.track.openApiOperationIds.push(...openApiOperationIds)
+      }
     }
 
     if (settings?.excludeForOperations) {

src/application/TestSuite.ts

@@ -129,6 +129,10 @@ require('dotenv').config()
       describe: 'Toggle logging of assigned variables',
       type: 'boolean'
     })
+    .option('warn', {
+      describe: 'Toggle warnings for missing openApiOperationIds',
+      type: 'boolean'
+    })
     .option('init', {
       describe: 'Initialize Portman and generate a Portman CLI configuration file',
       type: 'boolean'
@@ -232,6 +236,7 @@ require('dotenv').config()
   const oaOutput = options.oaOutput || ''
   const collectionName = options.collectionName || ''
   const logAssignVariables = options?.logAssignVariables
+  const warn = options?.warn || true
   const extraUnknownFormats = options?.extraUnknownFormats || []
   const syncPostmanCollectionIds = options?.syncPostmanCollectionIds || false
 
@@ -254,6 +259,7 @@ require('dotenv').config()
     oaOutput,
     collectionName,
     logAssignVariables,
+    warn,
     extraUnknownFormats,
     syncPostmanCollectionIds
   })

src/index.ts

@@ -32,6 +32,7 @@ export interface PortmanOptions {
   oaUrl?: string
   init?: boolean
   logAssignVariables?: boolean
+  warn?: boolean
   extraUnknownFormats?: string[]
   syncPostmanCollectionIds?: boolean
 }

src/types/PortmanOptions.ts

@@ -9,3 +9,7 @@ export type PortmanReqTestType = {
 export interface PortmanTestSuite {
   pmReqTestType?: PortmanReqTestType
 }
+export interface Track {
+  openApiOperationIds: string[]
+  openApiOperations: string[]
+}