mocha.spec.js

'use strict';

var utils = require('../../lib/utils');
var Mocha = require('../../lib/mocha');
var sinon = require('sinon');

describe('Mocha', function() {
  var opts = {reporter: function() {}}; // no output
  var sandbox;

  beforeEach(function() {
    sandbox = sinon.createSandbox();
  });

  afterEach(function() {
    sandbox.restore();
  });

  describe('constructor', function() {
    beforeEach(function() {
      sandbox.stub(Mocha.prototype, 'useColors').returnsThis();
      sandbox.stub(utils, 'deprecate');
    });
    it('should prefer "color" over "useColors"', function() {
      // eslint-disable-next-line no-new
      new Mocha({useColors: true, color: false});
      expect(Mocha.prototype.useColors, 'to have a call satisfying', [false]);
    });

    it('should assign "useColors" to "color"', function() {
      // eslint-disable-next-line no-new
      new Mocha({useColors: true});
      expect(Mocha.prototype.useColors, 'to have a call satisfying', [true]);
    });

    it('should call utils.deprecate()', function() {
      // eslint-disable-next-line no-new
      new Mocha({useColors: true});
      expect(utils.deprecate, 'was called');
    });
  });

  describe('.run(fn)', function() {
    it('should not raise errors if callback was not provided', function() {
      sandbox.stub(Mocha.Runner.prototype, 'run');
      var mocha = new Mocha(opts);
      expect(function() {
        mocha.run();
      }, 'not to throw');
    });

    it('should execute the callback when complete', function(done) {
      var mocha = new Mocha(opts);
      sandbox.stub(Mocha.Runner.prototype, 'run').callsArg(0);
      mocha.run(done);
    });
  });

  describe('.reporter("xunit").run(fn)', function() {
    it('should not raise errors if callback was not provided', function() {
      var mocha = new Mocha();
      expect(function() {
        try {
          mocha.reporter('xunit').run();
        } catch (e) {
          console.log(e);
          expect.fail(e.message);
        }
      }, 'not to throw');
    });
  });

  describe('.addFile()', function() {
    it('should add the given file to the files array', function() {
      var mocha = new Mocha(opts);
      mocha.addFile('myFile.js');
      expect(mocha.files, 'to have length', 1).and('to contain', 'myFile.js');
    });
  });

  describe('.invert()', function() {
    it('should set the invert option to true', function() {
      var mocha = new Mocha(opts);
      mocha.invert();
      expect(mocha.options, 'to have property', 'invert', true);
    });

    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.invert(), 'to be', mocha);
    });
  });

  describe('.ignoreLeaks()', function() {
    it('should set the ignoreLeaks option to true when param equals true', function() {
      var mocha = new Mocha(opts);
      mocha.ignoreLeaks(true);
      expect(mocha.options, 'to have property', 'ignoreLeaks', true);
    });

    it('should set the ignoreLeaks option to false when param equals false', function() {
      var mocha = new Mocha(opts);
      mocha.ignoreLeaks(false);
      expect(mocha.options, 'to have property', 'ignoreLeaks', false);
    });

    it('should set the ignoreLeaks option to false when the param is undefined', function() {
      var mocha = new Mocha(opts);
      mocha.ignoreLeaks();
      expect(mocha.options, 'to have property', 'ignoreLeaks', false);
    });

    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.ignoreLeaks(), 'to be', mocha);
    });
  });

  describe('.checkLeaks()', function() {
    it('should set the ignoreLeaks option to false', function() {
      var mocha = new Mocha(opts);
      mocha.checkLeaks();
      expect(mocha.options, 'to have property', 'ignoreLeaks', false);
    });

    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.checkLeaks(), 'to be', mocha);
    });
  });

  describe('.fullTrace()', function() {
    it('should set the fullStackTrace option to true', function() {
      var mocha = new Mocha(opts);
      mocha.fullTrace();
      expect(mocha.options, 'to have property', 'fullStackTrace', true);
    });

    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.fullTrace(), 'to be', mocha);
    });
  });

  describe('.growl()', function() {
    describe('if capable of notifications', function() {
      it('should set the growl option to true', function() {
        var mocha = new Mocha(opts);
        mocha.isGrowlCapable = function forceEnable() {
          return true;
        };
        mocha.growl();
        expect(mocha.options, 'to have property', 'growl', true);
      });
    });
    describe('if not capable of notifications', function() {
      it('should set the growl option to false', function() {
        var mocha = new Mocha(opts);
        mocha.isGrowlCapable = function forceDisable() {
          return false;
        };
        mocha.growl();
        expect(mocha.options, 'to have property', 'growl', false);
      });
    });
    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.growl(), 'to be', mocha);
    });
  });

  describe('.useInlineDiffs()', function() {
    it('should set the useInlineDiffs option to true when param equals true', function() {
      var mocha = new Mocha(opts);
      mocha.useInlineDiffs(true);
      expect(mocha.options, 'to have property', 'useInlineDiffs', true);
    });

    it('should set the useInlineDiffs option to false when param equals false', function() {
      var mocha = new Mocha(opts);
      mocha.useInlineDiffs(false);
      expect(mocha.options, 'to have property', 'useInlineDiffs', false);
    });

    it('should set the useInlineDiffs option to false when the param is undefined', function() {
      var mocha = new Mocha(opts);
      mocha.useInlineDiffs();
      expect(mocha.options, 'to have property', 'useInlineDiffs', false);
    });

    it('should be chainable', function() {
      var mocha = new Mocha(opts);
      expect(mocha.useInlineDiffs(), 'to be', mocha);
    });
  });

  describe('.noHighlighting()', function() {
    it('should set the noHighlighting option to true', function() {
      var mocha = new Mocha(opts);
      mocha.noHighlighting();
      expect(mocha.options, 'to have property', 'noHighlighting', true);
    });
  });

  describe('.allowUncaught()', function() {
    it('should set the allowUncaught option to true', function() {
      var mocha = new Mocha(opts);
      mocha.allowUncaught();
      expect(mocha.options, 'to have property', 'allowUncaught', true);
    });
  });

  describe('.delay()', function() {
    it('should set the delay option to true', function() {
      var mocha = new Mocha(opts);
      mocha.delay();
      expect(mocha.options, 'to have property', 'delay', true);
    });
  });

  describe('.bail()', function() {
    it('should set the suite._bail to true if there is no arguments', function() {
      var mocha = new Mocha(opts);
      mocha.bail();
      expect(mocha.suite._bail, 'to be', true);
    });
  });

  describe('.unloadFile()', function() {
    before(function() {
      if (process.browser) {
        this.skip();
      }
    });

    it('should unload a specific file from cache', function() {
      var mocha = new Mocha(opts);
      var resolvedFilePath;
      var filePath = __filename;

      mocha.addFile(filePath);
      mocha.loadFiles();
      resolvedFilePath = require.resolve(filePath);
      expect(require.cache, 'to have key', resolvedFilePath);

      mocha.unloadFile(filePath);
      expect(require.cache, 'not to have key', resolvedFilePath);
    });
  });

  describe('.unloadFiles()', function() {
    var path;

    before(function() {
      if (process.browser) {
        this.skip();
      } else {
        path = require('path');
      }
    });

    it('should unload all test files from cache', function() {
      var mocha = new Mocha(opts);
      var resolvedTestFiles;
      var testFiles = [
        __filename,
        path.join(__dirname, 'throw.spec.js'),
        path.join(__dirname, 'context.spec.js')
      ];

      testFiles.forEach(mocha.addFile, mocha);
      mocha.loadFiles();
      resolvedTestFiles = testFiles.map(require.resolve);
      expect(require.cache, 'to have keys', resolvedTestFiles);

      mocha.unloadFiles();
      expect(require.cache, 'not to have keys', resolvedTestFiles);
    });
  });

  describe('error handling', function() {
    it('should throw reporter error if an invalid reporter is given', function() {
      var updatedOpts = {reporter: 'invalidReporter', reporterOptions: {}};
      var throwError = function() {
        // eslint-disable-next-line no-new
        new Mocha(updatedOpts);
      };
      expect(throwError, 'to throw', {
        message: "invalid reporter 'invalidReporter'",
        code: 'ERR_MOCHA_INVALID_REPORTER',
        reporter: 'invalidReporter'
      });
    });
  });
});