Improve casing errors

.jshintrc

@@ -1,29 +1,28 @@
 {
-"esversion": 6,
-"bitwise": true,
-"camelcase": true,
-"curly": false,
-"eqeqeq": false,
-"forin": true,
-"immed": true,
-"indent": 2,
-"latedef": true,
-"maxparams": false,
-"maxdepth": false,
-"maxstatements": false,
-"maxcomplexity": false,
-"newcap": true,
-"noarg": true,
-"node": true,
-"noempty": true,
-"nonew": true,
-"plusplus": false,
-"quotmark": "single",
-"regexp": true,
-"sub": true,
-"strict": false,
-"trailing": true,
-"undef": true,
-"unused": false,
-"shadow": true
+  "esversion": 6,
+  "bitwise": true,
+  "camelcase": true,
+  "curly": false,
+  "eqeqeq": false,
+  "forin": true,
+  "immed": true,
+  "indent": 2,
+  "latedef": false,
+  "maxparams": false,
+  "maxdepth": false,
+  "maxstatements": false,
+  "maxcomplexity": false,
+  "newcap": true,
+  "noarg": true,
+  "node": true,
+  "noempty": true,
+  "nonew": true,
+  "plusplus": false,
+  "regexp": true,
+  "sub": true,
+  "strict": false,
+  "trailing": true,
+  "undef": true,
+  "unused": false,
+  "shadow": true
 }

ChangeLog.md

@@ -1,3 +1,7 @@
+### 01/31/2018 0.4.26
+- Fix all linter issues. [#201](https://github.com/Azure/oav/issues/201)
+- Add option to do case insensitive regex matches on swagger paths to the SpecValidator and LiveValidator. [#203](https://github.com/Azure/oav/issues/203)
+
 ### 01/30/2018 0.4.25
 - Fixed a typo in the variable name while resolving nullable types.
 
@@ -52,13 +56,13 @@
 ### 08/03/2017 0.4.9
  - [Live Validator] Shallow clone the azure-rest-api-spec repo.
  - [Model Validator] Improve pluggability of oav into vs-code. #143
- 
+
 ### 08/03/2017 0.4.8
  - [Live Validator] Before cloning the rest api specs repo if directory named 'repo' exists we delete it and then create an empty directory to clone repo inside it.
- 
+
 ### 07/11/2017 0.4.7
  - Fixed Live validator for reorg branch of azure-rest-api-specs #137
- 
+
 ### 07/03/2017 0.4.6
 - Fixed issue #134
 

lib/autorestPlugin/pluginHost.js

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+const vscodeJsonRpc = require("vscode-jsonrpc");
 const linq = require('linq');
 const jsonPath = require('jsonpath');
 const yaml = require("js-yaml");
@@ -18,7 +18,7 @@ exports = module.exports;
 
 const extension = new extensionBase.AutoRestExtension();
 const modelValidatorPluginName = "model-validator";
-const modelValidationCategory = "ExampleModelViolation"
+const modelValidationCategory = "ExampleModelViolation";
 
 function FormattedOutput(channel, details, code, text, source) {
   this.channel = channel;
@@ -28,24 +28,31 @@ function FormattedOutput(channel, details, code, text, source) {
   this.source = source;
 }
 
+/**
+ * Returns a promise with the examples validation of the swagger.
+ */
+function analyzeSwagger(swaggerFileName, autoRestApi) {
+  autoRestApi.ReadFile(swaggerFileName).then((swaggerFile) => {
+    const swagger = yaml.safeLoad(swaggerFile);
+    return exports.openApiValidationExample(swagger, swaggerFileName).then(function (exampleValidationResults) {
+      for (const result of exampleValidationResults) {
+        autoRestApi.Message({ Channel: result.channel, Text: result.text, Details: result.details, Key: result.code, Source: result.source });
+      }
+      // console.error(JSON.stringify(exampleValidationResults, null, 2));
+    });
+  });
+}
+
 extension.Add(modelValidatorPluginName, autoRestApi => {
-  return autoRestApi.ListInputs().then(function (swaggerFileNames) {
+  return autoRestApi.ListInputs().then((swaggerFileNames) => {
     const promises = [];
     for (const swaggerFileName of swaggerFileNames) {
       promises.push(
-        autoRestApi.ReadFile(swaggerFileName).then(function (swaggerFile) {
-          const swagger = yaml.safeLoad(swaggerFile);
-          return exports.openApiValidationExample(swagger, swaggerFileName).then(function (exampleValidationResults) {
-            for (const result of exampleValidationResults) {
-              autoRestApi.Message({ Channel: result.channel, Text: result.text, Details: result.details, Key: result.code, Source: result.source });
-            }
-            // console.error(JSON.stringify(exampleValidationResults, null, 2));
-          })
-        })
+        analyzeSwagger(swaggerFileName)
       );
     }
-    return Promise.all(promises).then(_ => true)
-  })
+    return Promise.all(promises).then(_ => true);
+  });
 });
 
 exports.openApiValidationExample = function openApiValidationExample(swagger, swaggerFileName, options) {
@@ -57,10 +64,10 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
   //console.error(JSON.stringify(swagger, null, 2));
   return specVal.initialize().then(function () {
     specVal.validateOperations();
-    Promise.resolve(specVal.specValidationResult).then(function (specValidationResult) {
-      for (var op in specValidationResult.operations) {
+    Promise.resolve(specVal.specValidationResult).then((specValidationResult) => {
+      for (let op of utils.getKeys(specValidationResult.operations)) {
         const xmsExamplesNode = specValidationResult.operations[op]["x-ms-examples"];
-        for (var scenario in xmsExamplesNode.scenarios) {
+        for (let scenario of utils.getKeys(xmsExamplesNode.scenarios)) {
           // invalid? meaning that there's an issue found in the validation
           var scenarioItem = xmsExamplesNode.scenarios[scenario];
           if (scenarioItem.isValid === false) {
@@ -72,7 +79,7 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
               throw new Error("Model Validator: Path to x-ms-examples not found.");
             }
             //console.error(JSON.stringify(scenarioItem, null, 2));
-            var result = new FormattedOutput("verbose", scenarioItem, scenario, [modelValidationCategory], "Model validator found issue (see details).", [{ document: swaggerFileName, Position: { path: xmsexPath } }])
+            var result = new FormattedOutput("verbose", scenarioItem, scenario, [modelValidationCategory], "Model validator found issue (see details).", [{ document: swaggerFileName, Position: { path: xmsexPath } }]);
             formattedResult.push(result);
 
             // request
@@ -84,9 +91,9 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
                 throw new Error("Model Validator: Unexpected format.");
               }
               for (const innerError of innerErrors) {
-                const path = ConvertIndicesFromStringToNumbers(innerError.path);
+                const path = convertIndicesFromStringToNumbers(innerError.path);
                 //console.error(JSON.stringify(error, null, 2));
-                resultDetails = { type: "Error", code: error.code, message: error.message, id: error.id, validationCategory: modelValidationCategory, innerErrors: innerError };
+                let resultDetails = { type: "Error", code: error.code, message: error.message, id: error.id, validationCategory: modelValidationCategory, innerErrors: innerError };
                 result = new FormattedOutput("error", resultDetails, [error.code, error.id, modelValidationCategory],
                   innerError.message + ". \nScenario: " + scenario + ". \nDetails: " + JSON.stringify(innerError.errors, null, 2) + "\nMore info: " + openAPIDocUrl + "#" + error.id.toLowerCase() + "-" + error.code.toLowerCase() + "\n",
                   [{ document: swaggerFileName, Position: { path: path } }]);
@@ -95,7 +102,7 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
             }
 
             // responses
-            for (var responseCode in scenarioItem.responses) {
+            for (let responseCode of utils.getKeys(scenarioItem.responses)) {
               const response = scenarioItem.responses[responseCode];
               if (response.isValid === false) {
                 const error = response.error;
@@ -105,19 +112,19 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
                 }
                 for (const innerError of innerErrors) {
                   //console.error(JSON.stringify(error, null, 2));
-                  resultDetails = { type: "Error", code: error.code, message: error.message, id: error.id, validationCategory: modelValidationCategory, innerErrors: innerError };
+                  let resultDetails = { type: "Error", code: error.code, message: error.message, id: error.id, validationCategory: modelValidationCategory, innerErrors: innerError };
                   result = new FormattedOutput("error", resultDetails, [error.code, error.id, modelValidationCategory],
                     innerError.message + ". \nScenario: " + scenario + ". \nDetails: " + JSON.stringify(innerError.errors, null, 2) + "\nMore info: " + openAPIDocUrl + "#" + error.id.toLowerCase() + "-" + error.code.toLowerCase() + "\n",
                     [{ document: swaggerFileName, Position: { path: xmsexPath.slice(0, xmsexPath.length - 1).concat(["responses", responseCode]) } }
-                    ])
+                    ]);
                   formattedResult.push(result);
                 }
               }
             }
           }
         }
       }
-    })
+    });
     return formattedResult;
   }).catch(function (err) {
     console.error(err);
@@ -127,7 +134,7 @@ exports.openApiValidationExample = function openApiValidationExample(swagger, sw
 /**
  * Path comes with indices as strings in "inner errors", so converting those to actual numbers for path to work.
  */
-function ConvertIndicesFromStringToNumbers(path) {
+function convertIndicesFromStringToNumbers(path) {
   const result = path.slice();
   for (let i = 1; i < result.length; ++i) {
     const num = parseInt(result[i]);

lib/commands/extract-xmsexamples.js

@@ -36,6 +36,6 @@ exports.handler = function (argv) {
   vOptions.matchApiVersion = argv.matchApiVersion;
 
   return validate.extractXMsExamples(specPath, recordings, vOptions);
-}
+};
 
 exports = module.exports;

lib/commands/generate-wireformat.js

@@ -51,6 +51,6 @@ exports.handler = function (argv) {
     }
   }
   return execWireFormat().catch((err) => { process.exitCode = 1; });
-}
+};
 
 exports = module.exports;

lib/commands/validate-example.js

@@ -13,9 +13,9 @@ exports.describe = 'Performs validation of x-ms-examples and examples present in
 exports.builder = {
   o: {
     alias: 'operationIds',
-    describe: 'A comma separated string of operationIds for which the examples ' + 
-    'need to be validated. If operationIds are not provided then the entire spec will be validated. ' + 
-    'Example: "StorageAccounts_Create, StorageAccounts_List, Usages_List".',
+    describe: 'A comma separated string of operationIds for which the examples ' +
+      'need to be validated. If operationIds are not provided then the entire spec will be validated. ' +
+      'Example: "StorageAccounts_Create, StorageAccounts_List, Usages_List".',
     string: true
   }
 };
@@ -32,6 +32,6 @@ exports.handler = function (argv) {
   } else {
     return validate.validateExamples(specPath, operationIds, vOptions);
   }
-}
+};
 
 exports = module.exports;

lib/templates/httpTemplate.js

@@ -3,7 +3,8 @@
 
 'use strict';
 const url = require('url'),
-  uuid = require('uuid');
+  uuid = require('uuid'),
+  utils = require('../util/utils');
 
 class HttpTemplate {
 
@@ -27,7 +28,7 @@ class HttpTemplate {
       result += `\n${padding}-H 'Content-Length: ${JSON.stringify(this.request.body).length}' \\`;
     }
     if (this.request.headers) {
-      let headers = Object.keys(this.request.headers);
+      let headers = utils.getKeys(this.request.headers);
 
       for (let i = 0; i < headers.length; i++) {
         let headerName = headers[i];

lib/templates/markdownHttpTemplate.js

@@ -4,7 +4,8 @@
 'use strict';
 const url = require('url'),
   HttpTemplate = require('./httpTemplate'),
-  uuid = require('uuid');
+  uuid = require('uuid'),
+  utils = require('../util/utils');
 
 class MarkdownHttpTemplate extends HttpTemplate {
 
@@ -18,7 +19,7 @@ class MarkdownHttpTemplate extends HttpTemplate {
       result += `Content-Length: ${JSON.stringify(this.request.body).length}\n`;
     }
     if (this.request.headers) {
-      let headers = Object.keys(this.request.headers);
+      let headers = utils.getKeys(this.request.headers);
 
       for (let i = 0; i < headers.length; i++) {
         let headerName = headers[i];
@@ -38,7 +39,7 @@ class MarkdownHttpTemplate extends HttpTemplate {
     }
     let gotContentType = false;
     if (response.headers) {
-      let headers = Object.keys(response.headers);
+      let headers = utils.getKeys(response.headers);
       for (let i = 0; i < headers.length; i++) {
         let headerName = headers[i];
         if (headerName.match(/^Content-Type$/ig) !== null) gotContentType = true;
@@ -49,7 +50,7 @@ class MarkdownHttpTemplate extends HttpTemplate {
       }
     }
     if (!gotContentType) {
-      result += `Content-Type: application/json; charset=utf-8`
+      result += `Content-Type: application/json; charset=utf-8`;
     }
     return result;
   }
@@ -121,7 +122,7 @@ curl -X ${this.request.method} '${this.request.url}' \\\n-H 'authorization: bear
           template += this.populateResponse(this.responses.longrunning.initialResponse, 'Initial Response');
         }
         if (this.responses.longrunning.finalResponse) {
-          template += this.populateResponse(this.responses.longrunning.finalResponse, 'Final Response after polling is complete and successful')
+          template += this.populateResponse(this.responses.longrunning.finalResponse, 'Final Response after polling is complete and successful');
         }
       } else {
         template += this.populateResponse(this.responses.standard.finalResponse, 'Response');

lib/templates/yamlHttpTemplate.js

@@ -3,13 +3,14 @@
 
 'use strict';
 const url = require('url'),
+  utils = require('../util/utils'),
   HttpTemplate = require('./httpTemplate'),
   uuid = require('uuid');
 
 class YamlHttpTemplate extends HttpTemplate {
 
   constructor(request, responses) {
-    super(request, responses)
+    super(request, responses);
   }
 
   getRequestHeaders() {
@@ -18,7 +19,7 @@ class YamlHttpTemplate extends HttpTemplate {
       result += `  Content-Length: ${JSON.stringify(this.request.body).length}\n`;
     }
     if (this.request.headers) {
-      let headers = Object.keys(this.request.headers);
+      let headers = utils.getKeys(this.request.headers);
 
       for (let i = 0; i < headers.length; i++) {
         let headerName = headers[i];
@@ -38,7 +39,7 @@ class YamlHttpTemplate extends HttpTemplate {
     }
     let gotContentType = false;
     if (response.headers) {
-      let headers = Object.keys(response.headers);
+      let headers = utils.getKeys(response.headers);
       for (let i = 0; i < headers.length; i++) {
         let headerName = headers[i];
         if (headerName.match(/^Content-Type$/ig) !== null) gotContentType = true;
@@ -49,7 +50,7 @@ class YamlHttpTemplate extends HttpTemplate {
       }
     }
     if (!gotContentType) {
-      result += `    Content-Type: application/json; charset=utf-8`
+      result += `    Content-Type: application/json; charset=utf-8`;
     }
     return result;
   }
@@ -115,7 +116,7 @@ curl: |
           template += this.populateResponse(this.responses.longrunning.initialResponse, 'Initial Response');
         }
         if (this.responses.longrunning.finalResponse) {
-          template += this.populateResponse(this.responses.longrunning.finalResponse, 'Final Response after polling is complete and successful')
+          template += this.populateResponse(this.responses.longrunning.finalResponse, 'Final Response after polling is complete and successful');
         }
       } else {
         template += this.populateResponse(this.responses.standard.finalResponse, 'Response');