cgreening/grunt-liquibase

/*
* grunt-liquibase
* https://github.com/chrisgreening/grunt-liquibase
*
* Copyright (c) 2014 Chris Greening
* Licensed under the MIT license.
*/

'use strict';

var path = require('path');
var chalk = require('chalk');
var fs = require('fs');
// We should really explore the use of .spawn for streams, exec can run into buffer exceeded errors for
// larger outputs
var exec = require('child_process').exec;

module.exports = function(grunt) {

// Please see the Grunt documentation for more information regarding task
// creation: http://gruntjs.com/creating-tasks

  grunt.registerMultiTask('liquibase', 'Simple integration of liquibase with grunt', function() {
    var cb = this.async();
    // merge defaults with the passed in options
    var options = this.options({
      changeLogFile : 'changelog.xml',
      defaultSchemaName : null,
      logLevel: 'info',
      defaultsFile: null,
      execOptions : {
         maxBuffer : Infinity
      },
      liquibaseJarPath: null
    });
    var cmd = this.data.command;
    var cmdAttr = this.data.commandAttr || '';

    var supportedCommands = [
      "update",
      "updateCount",
      "updateSQL",
      "updateCountSQL",
      "rollback",
      "rollbackToDate",
      "rollbackCount",
      "rollbackSQL",
      "rollbackToDateSQL",
      "rollbackCountSQL",
      "futureRollbackSQL",
      "updateTestingRollback",
      "generateChangeLog",
      "diff",
      "diffChangeLog",
      "dbDoc",
      "tag",
      "tagExists",
      "status",
      "validate",
      "changelogSync",
      "changelogSyncSQL",
      "markNextChangeSetRan",
      "listLocks",
      "releaseLocks",
      "dropAll",
      "clearCheckSums"
    ];

    var liquibaseJarLocation = path.join(__dirname, '..', 'lib', 'liquibase.jar');

    if (fs.existsSync(options.liquibaseJarPath)) {
      liquibaseJarLocation = options.liquibaseJarPath;
    }

    var snakeyamlJarLocation = path.join(__dirname, '..', 'lib', 'snakeyaml-1.13.jar');
    var liquibaseCommand = 'java -cp ' + snakeyamlJarLocation + ' -jar ' + liquibaseJarLocation;
    var optionName;

    grunt.verbose.writeln("Will excecute:" + cmd);

    if (supportedCommands.indexOf(cmd) >= 0) {
      if(options.username === undefined) {
        throw new Error('`username` must be specified');
      }
      if(options.password === undefined) {
        throw new Error('`password` must be specified');
      }
      if(options.url === undefined) {
        throw new Error('`url` must be specified');
      }
      var excludes = ['changeLogFile', 'execOptions', 'liquibaseJarPath'];
      // this is the command we need to run
      for(optionName in options) {
        //if the option is not a falsy (except zero), add to command options
        if (excludes.indexOf(optionName) === -1 && (options[optionName] || options[optionName] === 0)) {
          liquibaseCommand += ' --' + optionName + ' ' + options[optionName];
        }
      }
      //dropAll does not need a changeLogFile
      if(cmd !== 'dropAll') {
        liquibaseCommand += ' --changeLogFile ' + options.changeLogFile;
      }
      liquibaseCommand += ' ' + cmd + ' ' + cmdAttr;
    } else if(cmd === 'version') {
      // this is the command we need to run
      liquibaseCommand += ' --version';
    } else {
      throw new Error('`command` must be one of the following: ' + supportedCommands.join(', '));
    }

    grunt.verbose.writeln('Command:', chalk.yellow(liquibaseCommand));

    // Do not execute command if no-write is set
    if (grunt.option('no-write')) {
        grunt.log.ok('no-write specified, not running command');
        return;
    }
    console.log("grunt-liquibase: cmd:", liquibaseCommand, "opt:", options.execOptions);
    // spawn the process
    var cp = exec(liquibaseCommand, options.execOptions, function (err, stdout, stderr) {
      if (err) {
        grunt.warn(err);
      }
      cb();
    }.bind(this));

    var captureOutput = function (child, output) {
      if (grunt.option('color') === false) {
        child.on('data', function (data) {
          output.write(chalk.stripColor(data));
        });
      } else {
        child.pipe(output);
      }
    };

    // capture the output from liquibase and pipe it out
    captureOutput(cp.stdout, process.stdout);
    captureOutput(cp.stderr, process.stderr);
  });
};