affiance/test/unit/lib/hook/pre-commit/MochaOnly.test.js

A configurable and extendable Git hook manager for node projects

'use strict';
const testHelper = require('../../../../test_helper');
const fse = require('fs-extra');
const path = require('path');
const expect = testHelper.expect;
const sinon = testHelper.sinon;
const MochaOnly = testHelper.requireSourceModule(module);
const Config = testHelper.requireSourceModule(module, 'lib/config');
const HookContextPreCommit = testHelper.requireSourceModule(module, 'lib/hook-context/pre-commit');
const utils = testHelper.requireSourceModule(module, 'lib/utils');

describe('MochaOnly', function () {
  beforeEach('setup hook context', function() {
    this.oldCwd = process.cwd();
    this.repoPath = testHelper.tempRepo();
    process.chdir(this.repoPath);

    this.sandbox = sinon.sandbox.create();
    this.config = new Config({});
    this.context = new HookContextPreCommit(this.config, [], {});
    this.hook = new MochaOnly(this.config, this.context);
    this.stagedFile = 'filename.txt';

    this.sandbox.stub(this.hook, 'command').returns('grep');
    this.sandbox.stub(this.hook, 'flags').returns(['-EIHn', '(it|describe)\.only']);
    this.sandbox.stub(this.hook, 'applicableFiles');
  });

  afterEach('reset cwd on process', function() {
    if(!this.oldCwd) { return; }

    process.chdir(this.oldCwd);
    testHelper.cleanupDirectory(this.repoPath);
    this.sandbox.restore();
  });

  it('fails when the file contains a specific test with a .only', function() {
    let filePath = path.join(this.repoPath, this.stagedFile);
    fse.writeFileSync(filePath, [
      "let helper = require('helper');",
      "describe('some test', function() {",
      "  it.only('does some stuff', function(done) {",
      '    expect(helper).to.have.been.called;',
      '  });',
      '});'
    ].join('\n'));

    utils.execSync('git add ' + this.stagedFile);
    this.hook.applicableFiles.returns([filePath]);

    return this.hook.run().then((hookResult) => {
      expect(hookResult).to.have.length(2);
      expect(hookResult[0]).to.equal('fail');
    });
  });

  it('fails when the file contains a specific describe with a .only', function() {
    let filePath = path.join(this.repoPath, this.stagedFile);
    fse.writeFileSync(filePath, [
      "let helper = require('helper');",
      "describe.only('some test', function() {",
      "  it('does some stuff', function(done) {",
      '    expect(helper).to.have.been.called;',
      '  });',
      '});'
    ].join('\n'));

    utils.execSync('git add ' + this.stagedFile);
    this.hook.applicableFiles.returns([filePath]);

    return this.hook.run().then((hookResult) => {
      expect(hookResult).to.have.length(2);
      expect(hookResult[0]).to.equal('fail');
    });
  });

  it('passes when the file contains an only in a test description', function() {
    let filePath = path.join(this.repoPath, this.stagedFile);
    fse.writeFileSync(filePath, [
      "let helper = require('helper');",
      "describe('some test', function() {",
      "  it('does only this thing', function(done) {",
      '    expect(helper).to.have.been.called;',
      '  });',
      '});'
    ].join('\n'));

    utils.execSync('git add ' + this.stagedFile);
    this.hook.applicableFiles.returns([filePath]);

    return this.hook.run().then((hookResult) => {
      expect(hookResult).to.equal('pass');
    });
  });
});