Merge pull request #228 from postmanlabs/feature/missing-endpoints

Added support for missing endpoints in collection.

Author: abhijitkane

lib/schemaUtils.js

@@ -2980,5 +2980,35 @@ module.exports = {
       score: null,
       pathVars: []
     };
+  },
+
+  /**
+   * @param {Object} schemaPaths - OpenAPI Paths object
+   * @param {Array} matchedEndpoints - All matched endpoints
+   * @returns {Array} - Array of all MISSING_ENDPOINT objects
+   */
+  getMissingSchemaEndpoints: function (schemaPaths, matchedEndpoints) {
+    let endpoints = [],
+      schemaJsonPath;
+
+    _.forEach(schemaPaths, (schemaPathObj, schemaPath) => {
+      _.forEach(_.keys(schemaPathObj), (pathKey) => {
+        schemaJsonPath = `$.paths[${schemaPath}].${_.toLower(pathKey)}`;
+        if (METHODS.includes(pathKey) && !matchedEndpoints.includes(schemaJsonPath)) {
+          endpoints.push({
+            property: 'ENDPOINT',
+            transactionJsonPath: null,
+            schemaJsonPath,
+            reasonCode: 'MISSING_ENDPOINT',
+            reason: `The endpoint "${_.toUpper(pathKey)} ${schemaPath}" is missing in collection`,
+            endpoint: {
+              method: _.toUpper(pathKey),
+              path: schemaPath
+            }
+          });
+        }
+      });
+    });
+    return endpoints;
   }
 };

lib/schemapack.js

@@ -309,7 +309,8 @@ class SchemaPack {
     let schema = this.openapi,
       componentsAndPaths,
       options = this.computedOptions,
-      schemaResolutionCache = this.schemaResolutionCache;
+      schemaResolutionCache = this.schemaResolutionCache,
+      matchedEndpoints = [];
 
 
     if (!this.validated) {
@@ -377,6 +378,7 @@ class SchemaPack {
         return setTimeout(() => {
           // 2. perform validation for each identified matchedPath (schema endpoint)
           return async.map(matchedPaths, (matchedPath, pathsCallback) => {
+            matchedEndpoints.push(matchedPath.jsonPath);
             // 3. validation involves checking these individual properties
             async.parallel({
               path: function(cb) {
@@ -462,7 +464,8 @@ class SchemaPack {
         });
 
         retVal = {
-          requests: _.keyBy(result, 'requestId')
+          requests: _.keyBy(result, 'requestId'),
+          missingEndpoints: schemaUtils.getMissingSchemaEndpoints(schema.paths, matchedEndpoints)
         };
 
         callback(null, retVal);