feat: validates "uri" field of HTTP message

Author: artem-zakharchenko

lib/next/test/unit/units/validateURI.test.js

@@ -0,0 +1,76 @@
+const { assert } = require('chai');
+const { validateURI } = require('../../../units/validateURI');
+
+describe('validateURI', () => {
+  describe('given matching URI', () => {
+    const result = validateURI(
+      {
+        uri: 'https://apiary.io/dashboard'
+      },
+      {
+        uri: 'https://apiary.io/dashboard'
+      }
+    );
+
+    it('marks field as valid', () => {
+      assert.propertyVal(result, 'isValid', true);
+    });
+
+    it('has "null" validator', () => {
+      assert.propertyVal(result, 'validator', null);
+    });
+
+    it('has "text/vnd.apiary.uri" real type', () => {
+      assert.propertyVal(result, 'realType', 'text/vnd.apiary.uri');
+    });
+
+    it('has "text/vnd.apiary.uri" expected type', () => {
+      assert.propertyVal(result, 'expectedType', 'text/vnd.apiary.uri');
+    });
+
+    it('has no errors', () => {
+      assert.lengthOf(result.errors, 0);
+    });
+  });
+
+  describe('given non-matching URI', () => {
+    const result = validateURI(
+      {
+        uri: 'https://apiary.io/dashboard'
+      },
+      {
+        uri: 'http://domain.com/dashboard'
+      }
+    );
+
+    it('marks field as invalid', () => {
+      assert.propertyVal(result, 'isValid', false);
+    });
+
+    it('has "null" validator', () => {
+      assert.propertyVal(result, 'validator', null);
+    });
+
+    it('has "text/vnd.apiary.uri" real type', () => {
+      assert.propertyVal(result, 'realType', 'text/vnd.apiary.uri');
+    });
+
+    it('has "text/vnd.apiary.uri" expected type', () => {
+      assert.propertyVal(result, 'expectedType', 'text/vnd.apiary.uri');
+    });
+
+    describe('produces an error', () => {
+      it('exactly one error', () => {
+        assert.lengthOf(result.errors, 1);
+      });
+
+      it('has explanatory message', () => {
+        assert.propertyVal(
+          result.errors[0],
+          'message',
+          'Expected "uri" field to equal "https://apiary.io/dashboard", but got "http://domain.com/dashboard".'
+        );
+      });
+    });
+  });
+});

lib/next/units/coerce/index.js

@@ -3,6 +3,7 @@ const otherwise = require('../../utils/otherwise');
 
 const coercionMap = {
   method: otherwise(''),
+  uri: otherwise(''),
   headers: otherwise({})
 };
 

lib/next/units/validateStatusCode.js

@@ -22,7 +22,6 @@ function validateStatusCode(expected, real) {
     validator: 'TextDiff',
     realType: APIARY_STATUS_CODE_TYPE,
     expectedType: APIARY_STATUS_CODE_TYPE,
-    rawData: '',
     errors
   };
 }

lib/next/units/validateURI.js

@@ -0,0 +1,24 @@
+const APIARY_URI_TYPE = 'text/vnd.apiary.uri';
+
+const validateURI = (expected, real) => {
+  const { uri: expectedURI } = expected;
+  const { uri: realURI } = real;
+  const errors = [];
+  const isValid = expectedURI === realURI;
+
+  if (!isValid) {
+    errors.push({
+      message: `Expected "uri" field to equal "${expectedURI}", but got "${realURI}".`
+    });
+  }
+
+  return {
+    isValid,
+    validator: null,
+    expectedType: APIARY_URI_TYPE,
+    realType: APIARY_URI_TYPE,
+    errors
+  };
+};
+
+module.exports = { validateURI };

lib/next/validate.js

@@ -3,6 +3,7 @@ const { coerce, coerceWeak } = require('./units/coerce');
 const { normalize } = require('./units/normalize');
 const { isValid } = require('./units/isValid');
 const { validateMethod } = require('./units/validateMethod');
+const { validateURI } = require('./units/validateURI');
 const { validateStatusCode } = require('./units/validateStatusCode');
 const { validateHeaders } = require('./units/validateHeaders');
 const { validateBody } = require('./units/validateBody');
@@ -27,6 +28,10 @@ function validate(expectedMessage, realMessage) {
     result.fields.method = validateMethod(expected, real);
   }
 
+  if (expected.uri) {
+    result.fields.uri = validateURI(expected, real);
+  }
+
   if (expected.statusCode) {
     result.fields.statusCode = validateStatusCode(expected, real);
   }

test/cucumber/step_definitions/uri_steps.js

@@ -0,0 +1,11 @@
+module.exports = function() {
+  this.Given(/^you expect HTTP message URI "([^"]*)"$/, (uri, callback) => {
+    this.expected.uri = uri;
+    return callback();
+  });
+
+  return this.When(/^real HTTP message URI is "([^"]*)"$/, (uri, callback) => {
+    this.real.uri = uri;
+    return callback();
+  });
+};