Merge f61846a into a39dbce

apiaryio · May 22, 2019 · 4417530 · 4417530
2 parents a39dbce + f61846a
commit 4417530
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 4 deletions.
diff --git a/lib/next/test/integration/validateMessage.test.js b/lib/next/test/integration/validateMessage.test.js
@@ -17,7 +17,11 @@ describe('validateMessage', () => {
     });
 
     it('contains all validatable keys', () => {
-      assert.hasAllKeys(result, ['headers', 'body']);
+      assert.hasAllKeys(result, ['isValid', 'headers', 'body']);
+    });
+
+    it('has "isValid" set to true', () => {
+      assert.propertyVal(result, 'isValid', true);
     });
 
     describe('headers', () => {
@@ -86,7 +90,11 @@ describe('validateMessage', () => {
     });
 
     it('contains all validatable keys', () => {
-      assert.hasAllKeys(result, ['headers', 'body']);
+      assert.hasAllKeys(result, ['isValid', 'headers', 'body']);
+    });
+
+    it('has "isValid" set to false', () => {
+      assert.propertyVal(result, 'isValid', false);
     });
 
     describe('method', () => {
@@ -168,7 +176,11 @@ describe('validateMessage', () => {
     });
 
     it('contains all validatable keys', () => {
-      assert.hasAllKeys(result, ['statusCode', 'headers', 'body']);
+      assert.hasAllKeys(result, ['isValid', 'statusCode', 'headers', 'body']);
+    });
+
+    it('sets "isValid" to true', () => {
+      assert.propertyVal(result, 'isValid', true);
     });
 
     describe('statusCode', () => {
@@ -262,7 +274,11 @@ describe('validateMessage', () => {
     });
 
     it('contains all validatable keys', () => {
-      assert.hasAllKeys(result, ['statusCode', 'headers']);
+      assert.hasAllKeys(result, ['isValid', 'statusCode', 'headers']);
+    });
+
+    it('has "isValid" as false', () => {
+      assert.propertyVal(result, 'isValid', false);
     });
 
     describe('statusCode', () => {

diff --git a/lib/next/validateMessage.js b/lib/next/validateMessage.js
@@ -24,6 +24,10 @@ function validateMessage(realMessage, expectedMessage) {
     results.body = validateBody(real, expected);
   }
 
+  results.isValid = !Object.values(results).some((resultGroup) => {
+    return resultGroup.results.some((result) => result.severity === 'error');
+  });
+
   return results;
 }
 

diff --git a/lib/validate.js b/lib/validate.js
@@ -39,6 +39,16 @@ function getValidatableObject(real, expected, type) {
 }
 
 function isValid(real, expected, type, cb) {
+  console.warn(`\
+Usage of "isValid" is deprecated and will be removed in the future releases of Gavel.
+Use "isValid" property of the validation result instead:
+
+const { validate } = require('gavel');
+
+const result = validate(real, expected, 'request');
+const { isValid } = result;\
+`);
+
   return proxy(getValidatableObject(real, expected, type), 'isValid', cb);
 }