Completed Joi conversion, turned into node module, added mocha tests

Author: jharmn

README.md

@@ -8,4 +8,7 @@ Some areas of concern in governing standards:
 * Restrict the use of verb, status
 * Enforce the use of schema and formats in parameters and fields
 
-`swagger-api-checkstyle` is a specification meant to designate these governance criteria. This should provide a specification for implementing the validation of API spec files against a checkstyle definition. 
+`swagger-api-checkstyle` is a specification meant to designate these governance criteria. This should provide a specification for implementing the validation of API spec files against a checkstyle definition.
+
+Node library in development
+

examples/uber/swagger-errors.yaml

@@ -15,13 +15,13 @@ basePath: /v1
 produces:
   - application/json
 paths:
-  /Pr_oducts:
+  /Prod_ucts:
     get:
-      operationId: getProducts
+      operationId: G_etProducts
       summary: Product Types
       description: The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.
       parameters:
-        - name: latitude
+        - name: Latitude
           in: query
           description: Latitude component of location.
           required: true

lib/conventions.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var exports = module.exports = {};
+
+exports.path = {
+  "spine-case": /^[\/a-z0-9\-]*$/g,
+  "CAP-SPINE-CASE": /^[\/A-Z0-9\-]*$/g,
+  "snake_case": /^[\/a-z0-9\_]*$/g,
+  "camelCase": /^[\/a-z]+[\/A-Z0-9][\/a-z0-9]+[\/A-Za-z0-9]*$/g,
+  "ProperCase": /^(\/[A-Z][a-z]*)+$/g
+};
+
+exports.naming = {
+  "spine-case": /^[a-z0-9\-]*$/g,
+  "CAP-SPINE-CASE": /^[A-Z0-9\-]*$/g,
+  "snake_case": /^[a-z0-9\_]*$/g,
+  "camelCase": /^[a-z]+[\/A-Z0-9][\/a-z0-9]+[\/A-Za-z0-9]*$/g,
+  "ProperCase": /^([A-Z][a-z]*)+$/g
+  //"Train-Case": "[a-z0-9\-]*
+};

lib/index.js

@@ -0,0 +1,4 @@
+'use strict';
+
+module.exports.conventions = require('./conventions');
+module.exports.validate = require('./validate');

joi_regex.js renamed to lib/joi_regex.js

@@ -1,5 +1,6 @@
 var _       = require("lodash");
 var Joi     = require("joi");
+
 var exports = module.exports = {};
 
 module.exports = function(any) {

index.js renamed to lib/validate.js

@@ -1,40 +1,17 @@
+'use strict';
+
+module.exports = validate;
+
+var joiRegex = require('./joi_regex');
+var conventions = require('./conventions');
+
+var Joi     = require("joi");
 var Promise = require("bluebird");
 var fs      = Promise.promisifyAll(require("fs"));
 var parser  = Promise.promisifyAll(require("swagger-parser"));
 var yaml    = Promise.promisifyAll(require("js-yaml"));
 var _       = Promise.promisifyAll(require("lodash"));
-var mask    = require("json-mask");
-
-var joiRegex = require("./joi_regex.js");
-var Joi     = require("joi");
-
-'use strict';
 
-pathNamingConventions = {
-  "spine-case": /^[\/a-z0-9\-]*$/g,
-  "CAP-SPINE-CASE": /^[\/A-Z0-9\-]*$/g,
-  "snake_case": /^[\/a-z0-9\_]*$/g,
-  "camelCase": /^[\/a-z]+[\/A-Z0-9][\/a-z0-9]+[\/A-Za-z0-9]*$/g,
-  "ProperCase": /^(\/[A-Z][a-z]*)+$/g
-}
-
-namingConventions = {
-  "spine-case": /^[a-z0-9\-]*$/g,
-  "CAP-SPINE-CASE": /^[A-Z0-9\-]*$/g,
-  "snake_case": /^[a-z0-9\_]*$/g,
-  "camelCase": /^[a-z]+[\/A-Z0-9][\/a-z0-9]+[\/A-Za-z0-9]*$/g,
-  "ProperCase": /^([A-Z][a-z]*)+$/g
-  //"Train-Case": "[a-z0-9\-]*
-}
-
-function ValidationError(type, field) {
-  this.type = type;
-  this.field = field;
-}
-
-//Promise.onPossiblyUnhandledRejection(function(error){
-//  throw error;
-//});
 
 function getSpecPromise(file) {
   return parser.parseAsync(file)
@@ -56,16 +33,16 @@ function getCheckStylePromise(file) {
 }
 
 function getSchema(checkStyle) {
-  pathConvention = pathNamingConventions[checkStyle.paths.namingConvention];
-  opIdConvention = namingConventions[checkStyle.paths.operationId.namingConvention];
-  tagConvention= namingConventions[checkStyle.paths.tags.namingConvention];
-  queryParamConvention = namingConventions[checkStyle.paths.parameters.query.namingConvention];
-  headerParamConvention = namingConventions[checkStyle.paths.parameters.header.namingConvention];
-  pathParamConvention = namingConventions[checkStyle.paths.parameters.path.namingConvention];
-  statuses = new RegExp("^".concat(Object.keys(checkStyle.paths.status).join("$|^")).concat("$"));
-  verbs = new RegExp("^".concat(checkStyle.paths.verbs.join("$|^")).concat("$"));
+  var pathConvention = conventions.path[checkStyle.paths.namingConvention];
+  var opIdConvention = conventions.naming[checkStyle.paths.operationId.namingConvention];
+  var tagConvention= conventions.naming[checkStyle.paths.tags.namingConvention];
+  var queryParamConvention = conventions.naming[checkStyle.paths.parameters.query.namingConvention];
+  var headerParamConvention = conventions.naming[checkStyle.paths.parameters.header.namingConvention];
+  var pathParamConvention = conventions.naming[checkStyle.paths.parameters.path.namingConvention];
+  var statuses = new RegExp("^".concat(Object.keys(checkStyle.paths.status).join("$|^")).concat("$"));
+  var verbs = new RegExp("^".concat(checkStyle.paths.verbs.join("$|^")).concat("$"));
 
-  parameterKeys = {
+  var parameterKeys = {
     'in': Joi.string().valid('query', 'header'),
     format: Joi.string(),
     type: Joi.string(),
@@ -76,7 +53,7 @@ function getSchema(checkStyle) {
       .when('in', {is: 'header', then: Joi.string().regex(headerParamConvention)})
   }
 
-  schema = Joi.object().keys({
+  var schema = Joi.object().keys({
     swagger: Joi.any().valid(checkStyle.swagger),
     info: Joi.object().keys({
       title: Joi.string(),
@@ -110,19 +87,15 @@ function getSchema(checkStyle) {
   return schema;
 }
 
-function validate(checkStyleFile, specFile) {
-  Promise.join(getSpecPromise(specFile), getCheckStylePromise(checkStyleFile), 
-      function(spec, checkStyle) {
-    return [spec, getSchema(checkStyle)];
-  }).spread(function(spec, schema) {
-    var result = Joi.validate(spec, schema);
-    if (result.error) {
-      console.log(result.error) 
-    }
+function validate(checkStyleFile, specFile, callback) {
+  Promise.join(getSpecPromise(specFile), getCheckStylePromise(checkStyleFile), callback,
+      function(spec, checkStyle, callback) {
+    return [spec, getSchema(checkStyle), callback];
+  }).spread(function(spec, schema, callback) {
+    return Joi.validate(spec, schema);
+  }).then(function(result) {
+    callback(result, null);
+  }).catch(function(e) {
+    callback(null, e);
   });
 }
-
-checkStyle = './examples/uber/swagger-checkstyle.yaml';
-spec = './examples/uber/swagger.yaml';
-
-validate(checkStyle, spec);

package.json

@@ -10,6 +10,7 @@
   "license": "ISC",
   "dependencies": {
     "bluebird": "^2.9.30",
+    "commander": "^2.8.1",
     "joi": "^6.5.0",
     "js-yaml": "^3.3.1",
     "json-mask": "^0.3.4",
@@ -19,5 +20,22 @@
   "devDependencies": {
     "mocha": "^2.2.5",
     "should": "^7.0.1"
-  }
+  },
+  "directories": {
+    "example": "examples",
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jasonh-n-austin/swagger-api-checkstyle.git"
+  },
+  "keywords": [
+    "swagger",
+    "api",
+    "checkstyle"
+  ],
+  "bugs": {
+    "url": "https://github.com/jasonh-n-austin/swagger-api-checkstyle/issues"
+  },
+  "homepage": "https://github.com/jasonh-n-austin/swagger-api-checkstyle#readme"
 }

test/convention_validation.js

@@ -1,8 +1,27 @@
-var should    = require("should");
+var should = require("should");
+var assert = require("assert");
+var swaggerCheckStyle = require("../lib")
 
-describe('validateConventions', function() {
-  it('should validate paths', function() {
-    //validateConventions(spec, pathNamingConvention, opNamingConvention)
+describe('validate', function(done) {
+  it('should validate swagger', function(done) {
+    checkStyle = './examples/uber/swagger-checkstyle.yaml';
+    spec = './examples/uber/swagger.yaml';
+    result = null;
 
+    swaggerCheckStyle.validate(checkStyle, spec, function(result, err) {
+      if (err) throw err;
+      should.not.exist(result.error)
+      done();
+    });
+  });
+  it('should not validate bad swagger', function(done) {
+    checkStyle = './examples/uber/swagger-checkstyle.yaml';
+    spec = './examples/uber/swagger-errors.yaml';
+
+    swaggerCheckStyle.validate(checkStyle, spec, function(result, err) {
+      if (err) throw err;
+      result.error.name.should.eql("ValidationError");
+      done();
+    });
   });
 });

test/joi_regex_spec.js

@@ -1,4 +1,4 @@
-var joiRegex  = require("../joi_regex.js");
+var joiRegex  = require("../lib/joi_regex");
 var Joi       = require("joi");
 var _         = require("lodash");
 var should    = require('should');

test/mocha.opts

@@ -0,0 +1,3 @@
+--require should
+--reporter spec
+--ui bdd