Refactored all the unit tests to use Mocha's Promises support (I didn't know it existed until today)

Author: JamesMessinger

package.json

@@ -24,7 +24,7 @@
     "build": "npm run lint && npm run browserify",
     "browserify": "simplifyify lib/index.js --outfile dist/ref-parser.js --standalone \\$RefParser --debug --minify",
     "watch": "npm run browserify -- --watch",
-    "mocha": "mocha --bail --recursive tests/fixtures tests/specs",
+    "mocha": "mocha --bail --async-only tests/fixtures tests/specs",
     "istanbul": "istanbul cover _mocha --dir coverage/node -- --bail --recursive tests/fixtures tests/specs",
     "karma": "karma start --single-run",
     "test": "npm run browserify -- --test && npm run istanbul && npm run karma",

tests/fixtures/config.js

@@ -5,6 +5,7 @@
     // Configure Mocha
     mocha.setup('bdd');
     mocha.fullTrace();
+    mocha.asyncOnly();
     mocha.checkLeaks();
     mocha.globals(['$0', '$1', '$2', '$3', '$4', '$5']);
   }

tests/fixtures/helper.js

@@ -19,17 +19,10 @@
   helper.bundled = {};
 
   /**
-   * Returns a function that throws an error if called.
-   *
-   * @param {function} done
+   * Throws an error if called.
    */
-  helper.shouldNotGetCalled = function shouldNotGetCalled(done) {
-    return function shouldNotGetCalledFN(err) {
-      if (!(err instanceof Error)) {
-        err = new Error('This function should not have gotten called.');
-      }
-      done(err);
-    };
+  helper.shouldNotGetCalled = function shouldNotGetCalled() {
+    throw new Error('This function should not have gotten called.');
   };
 
   /**
@@ -80,7 +73,7 @@
 
           done();
         })
-        .catch(helper.shouldNotGetCalled(done));
+        .catch(helper.shouldNotGetCalled);
     }
   };
 

tests/specs/__({[ ! % & $ # @ ` ~ ,)}]__/special-characters.spec.js

@@ -1,49 +1,42 @@
 'use strict';
 
 describe('File names with special characters', function() {
-  it('should parse successfully', function(done) {
+  it('should parse successfully', function() {
     var parser = new $RefParser();
-    parser
+    return parser
       .parse(path.rel('specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.yaml'))
       .then(function(schema) {
         expect(schema).to.equal(parser.schema);
         expect(schema).to.deep.equal(helper.parsed.specialCharacters.schema);
         expect(parser.$refs.paths()).to.deep.equal([path.abs('specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.yaml')]);
-        done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 
   it('should resolve successfully', helper.testResolve(
     'specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.yaml', helper.parsed.specialCharacters.schema,
     'specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.json', helper.parsed.specialCharacters.file
   ));
 
-  it('should dereference successfully', function(done) {
+  it('should dereference successfully', function() {
     var parser = new $RefParser();
-    parser
+    return parser
       .dereference(path.rel('specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.yaml'))
       .then(function(schema) {
         expect(schema).to.equal(parser.schema);
         expect(schema).to.deep.equal(helper.dereferenced.specialCharacters);
 
         // The "circular" flag should NOT be set
         expect(parser.$refs.circular).to.equal(false);
-
-        done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 
-  it('should bundle successfully', function(done) {
+  it('should bundle successfully', function() {
     var parser = new $RefParser();
-    parser
+    return parser
       .bundle(path.rel('specs/__({[ ! % & $ # @ ` ~ ,)}]__/__({[ ! % & $ # @ ` ~ ,)}]__.yaml'))
       .then(function(schema) {
         expect(schema).to.equal(parser.schema);
         expect(schema).to.deep.equal(helper.dereferenced.specialCharacters);
-        done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 });

tests/specs/blank/blank.spec.js

@@ -18,36 +18,34 @@ describe('Blank files', function() {
 
   it('should throw an error if parsed as YAML', function(done) {
     testDone = done;
-    $RefParser
+    return $RefParser
       .parse(path.rel('specs/blank/blank.yaml'))
-      .then(helper.shouldNotGetCalled(done))
+      .then(helper.shouldNotGetCalled)
       .catch(function(err) {
         expect(err).to.be.an.instanceOf(SyntaxError);
         expect(err.message).to.contain('blank/blank.yaml" is not a valid JSON Schema');
         done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 
   it('should throw an error if parsed as JSON', function(done) {
     testDone = done;
-    $RefParser
+    return $RefParser
       .parse(path.rel('specs/blank/blank.yaml'), {allow: {yaml: false}})
-      .then(helper.shouldNotGetCalled(done))
+      .then(helper.shouldNotGetCalled)
       .catch(function(err) {
         expect(err).to.be.an.instanceOf(SyntaxError);
         expect(err.message).to.contain('Error parsing "');
         expect(err.message).to.contain('blank/blank.yaml"');
         done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 
   it('should throw an error if "options.allow.empty" is disabled', function(done) {
     testDone = done;
-    $RefParser
+    return $RefParser
       .parse(path.rel('specs/blank/blank.yaml'), {allow: {empty: false}})
-      .then(helper.shouldNotGetCalled(done))
+      .then(helper.shouldNotGetCalled)
       .catch(function(err) {
         if (userAgent.isNode) {
           expect(err).to.be.an.instanceOf(SyntaxError);
@@ -60,7 +58,6 @@ describe('Blank files', function() {
           expect(err.message).to.contain('HTTP 204: No Content');
         }
         done();
-      })
-      .catch(helper.shouldNotGetCalled(done));
+      });
   });
 });

tests/specs/callbacks.spec.js

@@ -27,7 +27,7 @@ describe('Callback & Promise syntax', function() {
           done();
         }
         catch (e) {
-          done(e)
+          done(e);
         }
       });
     }
@@ -66,12 +66,11 @@ describe('Callback & Promise syntax', function() {
   }
 
   function testPromiseError(method) {
-    return function(done) {
-      $RefParser[method](path.rel('specs/invalid/invalid.yaml'))
-        .then(helper.shouldNotGetCalled(done))
+    return function() {
+      return $RefParser[method](path.rel('specs/invalid/invalid.yaml'))
+        .then(helper.shouldNotGetCalled)
         .catch(function(err) {
           expect(err).to.be.an.instanceOf(SyntaxError);
-          done();
         });
     }
   }