node-ansible/test/playbook.spec.js

Programmatic interface in Node.js for executing Ansible ad-hoc commands and playbooks

var chai = require('chai');
var expect = chai.expect;
var sinon = require('sinon');
var _ = require('underscore');

var sinonChai = require("sinon-chai");
var chaiAsPromised = require('chai-as-promised');
var process = require('child_process');
var mockSpawn = require('mock-spawn');

chai.use(sinonChai);
chai.use(chaiAsPromised);

describe('Playbook command', function () {

  var mySpawn = mockSpawn();
  var oldSpawn = process.spawn;
  var spawnSpy;
  var default_env = { env: { PYTHONUNBUFFERED: "1" } };


  before(function () {
    process.spawn = mySpawn;
    spawnSpy = sinon.spy(process, 'spawn');
  })

  beforeEach(function() {
    spawnSpy.reset();
  })

  var Playbook = require("../index").Playbook;

  describe('with only playbook', function () {

    it('should execute the playbook', function (done) {
      var command = new Playbook().playbook('test');
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml'] );
        done();
      }).done();
    })

  })

  describe('with variables', function () {
    
    it('should execute the playbook with the given variables', function (done) {
      var command = new Playbook().playbook('test').variables({foo: "bar"});
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-e', '{"foo":"bar"}']);
        done();
      }).done();
    })

    it('should execute the playbook with the given complex variables', function (done) {
      variable = { 
        foo: {
          bar: ["shu"]
        } 
      };
      var command = new Playbook().playbook('test').variables(variable);

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-e', '{"foo":{"bar":["shu"]}}']);
        done();
      }).done();
    })

  })

  describe('with forks', function() {

    it('should execute the playbook with forks param as specified', function (done) {
      var command = new Playbook().playbook('test').forks(10);
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-f', 10]);
        done();
      }).done();
    })

  })

  describe('with verbose', function() {

    it('should execute the playbook with verbosity level', function (done) {
      var command = new Playbook().playbook('test').verbose("vv");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-vv']);
        done();
      }).done();
    })

  })

  describe('with user', function() {

    it('should execute the playbook with specified user', function (done) {
      var command = new Playbook().playbook('test').user("root");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-u', 'root']);
        done();
      }).done();
    })

  })

  describe('with sudo user specified', function() {

    it('should execute the playbook with specified sudo user', function (done) {
      var command = new Playbook().playbook('test').su("root");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-U', 'root']);
        done();
      }).done();
    })

  })

  describe('as sudo user', function() {

    it('should execute the playbook with sudo user flag', function (done) {
      var command = new Playbook().playbook('test').asSudo();
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '-s']);
        done();
      }).done();
    })

  })

  describe('with inventory', function() {

    it('should execute the playbook with specified inventory', function (done) {
      var command = new Playbook().playbook('test').inventory("/etc/my/hosts");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook' ,['test.yml', '-i', '/etc/my/hosts']);
        done();
      }).done();
    })

  })

  describe('with inventory subset', function() {

    it('should execute the playbook with specified inventory subset limit', function (done) {
      var command = new Playbook().playbook('test').limit("localhost");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook' ,['test.yml', '-l', 'localhost']);
        done();
      }).done();
    })

  })

  describe('with private-key', function() {

    it('should execute the playbook with specified private key', function (done) {
      var command = new Playbook().playbook('test').privateKey("/home/user/.ssh/id_rsa");
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook' ,['test.yml', '--private-key', '"/home/user/.ssh/id_rsa"']);
        done();
      }).done();
    })

  })

  describe('with working directory', function () {

    var path = require('path');

    it('should change to working directory during execution', function (done) {
      var command = new Playbook().playbook('test');
      var workingDir = path.resolve(__dirname, './fixtures');
      var options = {cwd: workingDir}
      var promise = command.exec(options);
      expect(promise).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml']);
        expect(spawnSpy.getCall(0).args[2]).to.have.deep.property( "cwd", workingDir );
        expect(spawnSpy.getCall(0).args[2]).to.have.deep.property( "env.PYTHONUNBUFFERED", "1" );
        done();
      }).done();
    })

  })

  describe('unbuffered output', function () {

    it('should default to unbuffered', function (done) {
      var command = new Playbook().playbook('test');
      var promise = command.exec();
      expect(promise).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml']);
        expect(spawnSpy.getCall(0).args[2]).to.have.deep.property( "env.PYTHONUNBUFFERED", "1" );
        done();
      }).done();
    })

    it('should turn on buffering when told to', function (done) {
      var command = new Playbook().playbook('test');
      var promise = command.exec({buffered:true});
      expect(promise).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml'] );
        expect(spawnSpy.getCall(0).args[2]).to.have.deep.property( 'env.PYTHONUNBUFFERED', "" );
        done();
      }).done();
    })

  })

  describe('with --ask-pass flag', function() {

    it('should execute the playbook with --ask-pass flag', function (done) {
      var command = new Playbook().playbook('test').askPass();
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '--ask-pass']);
        done();
      }).done();
    })
  })

  describe('with --ask-sudo-pass flag', function() {

    it('should execute the playbook with --ask-sudo-pass flag', function (done) {
      var command = new Playbook().playbook('test').askSudoPass();

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '--ask-sudo-pass']);
        done();
      }).done();
    })
  })

  describe('with --tags param', function() {

    it('should execute the playbook with --tags', function (done) {
      var command = new Playbook().playbook('test').tags('onetag');

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', "--tags=onetag"]);
        done();
      }).done();
    })
  
    it('should execute the playbook with multiple --tags', function (done) {
      var command = new Playbook().playbook('test').tags('onetag','twotags');
  
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', "--tags=onetag,twotags"]);
        done();
      }).done();
    })
 
    it('should execute the playbook with array of --tags', function (done) {
      var command = new Playbook().playbook('test').tags(['onetag','twotags']);
 
      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', "--tags=onetag,twotags"]);
        done();
      }).done();
    })
  })

  describe('with --skip-tags param', function() {

    it('should execute the playbook with --skip-tags', function (done) {
      var command = new Playbook().playbook('test').skipTags('onetag');

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '--skip-tags=onetag']);
        done();
      }).done();
    })

    it('should execute the playbook with multiple --skip-tags', function (done) {
      var command = new Playbook().playbook('test').skipTags('onetag','twotags');

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '--skip-tags=onetag,twotags']);
        done();
      }).done();
    })

    it('should execute the playbook with array of --skip-tags', function (done) {
      var command = new Playbook().playbook('test').skipTags(['one tag','twotags']);

      expect(command.exec()).to.be.fulfilled.then(function () {
        expect(spawnSpy).to.be.calledWith('ansible-playbook', ['test.yml', '--skip-tags=one tag,twotags']);
        done();
      }).done();
    })
  })

  after(function () {
    process.spawn = oldSpawn;
    spawnSpy.restore();
  })

})