gulp-current-msbuild/test/msbuild-runner.js

msbuild plugin for gulp. Inspired by grunt-msbuild. Written by Stefan Hoffman. Updated to run with VS 2019

/*global describe, it, beforeEach*/

'use strict';

var chai          = require('chai'),
    childProcess  = require('child_process'),
    constants     = require('../lib/constants'),
    gutil         = require('gulp-util'),
    expect        = chai.expect,
    sinon         = require('sinon'),
    path          = require('path'),
    fs            = require('fs'),
    proxyquire    = require('proxyquire');

chai.use(require('sinon-chai'));
require('mocha-sinon');

var commandBuilder = require('../lib/msbuild-command-builder');
var msbuildRunner = require('../lib/msbuild-runner');

var defaults;

var events;

function simulateEvent(name) {
  events.push({ name: name, data: Array.prototype.slice.call(arguments, 1) });
}

describe('msbuild-runner', function () {

  beforeEach(function () {
    defaults = JSON.parse(JSON.stringify(constants.DEFAULTS));
    events = [];

    function spawn(command, args, options) {
      var listeners = {};

      process.nextTick(function() {
        events.forEach(function(e) {
          listeners[e.name].apply(this, e.data);
        });
      });

      return {
        on: function(name, handler) {
          listeners[name] = handler;
        }
      };
    }

    this.sinon.stub(childProcess, 'spawn', spawn);
    this.sinon.stub(commandBuilder, 'construct').returns({ executable: 'msbuild', args: ['/nologo'] });
    this.sinon.stub(gutil, 'log');
    this.sinon.stub(gutil, 'File').returnsArg(0);
    this.sinon.stub(path, 'join');
  });

  it('should execute the msbuild command', function (done) {
    defaults.stdout = true;

    simulateEvent('exit', 0);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function () {
      expect(gutil.log).to.have.been.calledWith(gutil.colors.cyan('MSBuild complete!'));
    });

    expect(childProcess.spawn).to.have.been.calledWith('msbuild', ['/nologo']);
    done();
  });

  it('should log the command when the logCommand option is set', function(done) {
    defaults.logCommand = true;

    simulateEvent('exit', 0);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function () {
      expect(gutil.log).to.have.been.calledWith(gutil.colors.cyan('Using MSBuild command:'), 'msbuild', '/nologo');
    });
    done();
  });

  it('should log an error message when the msbuild command exits with a non-zero code', function (done) {
    simulateEvent('exit', 1);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function () {
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed with code 1!'));
    });
    done();
  });

  it('should log an error message when the msbuild command is killed by a signal', function (done) {
    simulateEvent('exit', null, 'SIGUSR1');

    msbuildRunner.startMsBuildTask(defaults, {}, null, function () {
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild killed with signal SIGUSR1!'));
    });
    done();
  });

  it('should log an error message and return an Error in the callback when the msbuild command failed', function (done) {
    defaults.errorOnFail = true;

    simulateEvent('exit', 1);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function (err) {
      expect(err).to.be.an.instanceof(Error);
      expect(err.message).to.be.equal('MSBuild failed with code 1!');
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed with code 1!'));
    });
    done();
  });

  it('should log an error message when the spawned process experienced an error', function (done) {
    var error = new Error('broken');

    simulateEvent('error', error);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function () {
      expect(gutil.log).to.have.been.calledWith(error);
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed!'));
    });
    done();
  });

  it('should log an error message and return an Error in the callback when the spawned process experienced an error', function (done) {
    defaults.errorOnFail = true;
    var error = new Error('broken');

    simulateEvent('error', error);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function (err) {
      expect(err).to.be.equal(error);
      expect(gutil.log).to.have.been.calledWith(error);
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed!'));
      done();
    });
  });

  it('should be able to handle error and exit events', function (done) {
    defaults.errorOnFail = true;
    var error = new Error('broken');

    simulateEvent('error', error);
    simulateEvent('exit', 1);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function (err) {
      expect(err).to.be.equal(error);
      expect(gutil.log).to.have.been.calledWith(error);
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed!'));
      expect(gutil.log).to.have.been.calledTwice;
      done();
    });
  });

  it('should be able to handle exit and error events', function (done) {
    defaults.errorOnFail = true;
    var error = new Error('broken');
    var failedError = new Error('MSBuild failed with code 1!');

    simulateEvent('exit', 1);
    simulateEvent('error', error);

    msbuildRunner.startMsBuildTask(defaults, {}, null, function (err) {
      expect(err.message).to.be.equal('MSBuild failed with code 1!');
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('MSBuild failed with code 1!'));
      expect(gutil.log).to.have.been.calledOnce;
      done();
    });
  });

  it('should return an Error if we cannot glob the publish location', function(done) {
    defaults.emitPublishedFiles = true;
    defaults.publishDirectory = 'foobar';

    var error = new Error('Error globbing published files at foobar');
    var mockGlob = this.sinon.stub().callsArgWith(2, error, []);

    simulateEvent('exit', 0);

    var msbuildRunner = proxyquire('../lib/msbuild-runner', { 'glob': mockGlob });

    msbuildRunner.startMsBuildTask(defaults, {}, null, function(err) {
      expect(err).to.be.equal(error);
      expect(gutil.log).to.have.been.calledWith(gutil.colors.cyan('MSBuild complete!'));
      expect(gutil.log).to.have.been.calledWith(gutil.colors.red('Error globbing published files at foobar'));
      done();
    });
  });

  it('should should push gutil files for each file with the correct attributes', function(done) {
    defaults.emitPublishedFiles = true;

    var publishDirectory = 'foobar';
    defaults.publishDirectory = publishDirectory;

    var fileArray = [
      'foo.js',
      'bar.js'
    ];

    var pathArray = [
      'foo.js',
      'bar.js'
    ];

    var contentArray = [
      new Buffer('foo content'),
      new Buffer('bar content')
    ];

    var mockGlob = this.sinon.stub().callsArgWith(2, null, fileArray);
    var msbuildRunner = proxyquire('../lib/msbuild-runner',
      {
        'glob': mockGlob
      });

    var stubStatsObj = {
      isFile: function() { return true; }
    };
    this.sinon.stub(fs, 'statSync').returns(stubStatsObj);

    path.join.withArgs(defaults.publishDirectory, fileArray[0]).returns(pathArray[0]);
    path.join.withArgs(defaults.publishDirectory, fileArray[1]).returns(pathArray[1]);

    this.sinon.stub(fs, 'readFileSync').withArgs(fileArray[0]).returns(contentArray[0]);
    fs.readFileSync.withArgs(fileArray[1]).returns(contentArray[1]);


    var mockStream = {
      push: this.sinon.stub()
    };

    simulateEvent('exit', 0);

    msbuildRunner.startMsBuildTask(defaults, {}, mockStream, function(err) {
      expect(gutil.File).to.have.been.calledWithNew;
      expect(mockStream.push).to.have.been.calledTwice;
      expect(mockStream.push).to.have.been.calledWithMatch({
        cwd: publishDirectory,
        base: publishDirectory,
        path: pathArray[0],
        contents: contentArray[0]
      });
      expect(mockStream.push).to.have.been.calledWithMatch({
        cwd: publishDirectory,
        base: publishDirectory,
        path: pathArray[1],
        contents: contentArray[1]
      });
      done();
    });
  });
});