protractor_runner.js

/*
 * grunt-protractor-runner
 * https://github.com/teerapap/grunt-protractor-runner
 *
 * Copyright (c) 2013 Teerapap Changwichukarn
 * Licensed under the MIT license.
 */

'use strict';

var util = require('util');
var path = require('path');
var fs = require('fs');
var split = require('split');
var through2 = require('through2');

module.exports = function(grunt) {

  grunt.registerMultiTask('protractor', 'A grunt task to run protractor.', function() {

    // '.../node_modules/protractor/lib/protractor.js'
    var protractorMainPath = require.resolve('protractor');
    // '.../node_modules/protractor/bin/protractor'
    var protractorBinPath = path.resolve(protractorMainPath, '../../bin/protractor');
    // '.../node_modules/protractor/referenceConf.js'
    var protractorRefConfPath = path.resolve(protractorMainPath, '../../referenceConf.js');
    // '.../node_modules/protractor/bin/webdriver-manager'
    var webdriverManagerPath = path.resolve(protractorMainPath, '../../bin/webdriver-manager');

    // Merge task-specific and/or target-specific options with these defaults.
    var opts = this.options({
      configFile: protractorRefConfPath,
      keepAlive: false,
      noColor: false,
      debug: false,
      nodeBin: 'node',
      args: {},
      output: false,
      webdriverManagerUpdate: false
    });

    // configFile is a special property which need not to be in options{} object.
    if (!grunt.util._.isUndefined(this.data.configFile)) {
      opts.configFile = this.data.configFile;
    }

    grunt.verbose.writeln("Options: " + util.inspect(opts));

    var keepAlive = opts['keepAlive'];
    var strArgs = ["seleniumAddress", "seleniumServerJar", "seleniumPort", "baseUrl", "rootElement", "browser", "chromeDriver", "chromeOnly", "directConnect", "sauceUser", "sauceKey", "sauceSeleniumAddress", "framework", "suite", "beforeLaunch", "onPrepare"];
    var listArgs = ["specs", "exclude"];
    var boolArgs = ["includeStackTrace", "verbose"];
    var objectArgs = ["params", "capabilities", "multiCapabilities", "cucumberOpts", "mochaOpts"];

    var args = process.execArgv.concat([protractorBinPath, opts.configFile]);
    if (opts.noColor){
      args.push('--no-jasmineNodeOpts.showColors');
    }
    if (!grunt.util._.isUndefined(opts.debug) && opts.debug === true){
      args.splice(1,0,'debug');
    }

    // Iterate over all supported arguments.
    strArgs.forEach(function(a) {
      if (a in opts.args || grunt.option(a)) {
        args.push('--'+a, grunt.option(a) || opts.args[a]);
      }
    });
    listArgs.forEach(function(a) {
      if (a in opts.args || grunt.option(a)) {
        args.push('--'+a,  grunt.option(a) || opts.args[a].join(","));
      }
    });
    boolArgs.forEach(function(a) {
      if (a in opts.args || grunt.option(a)) {
        args.push('--'+a);
      }
    });

    // Convert [object] to --[object].key1 val1 --[object].key2 val2 ....
    objectArgs.forEach(function(a) {
      (function convert(prefix, obj, args) {
        if (typeof obj === 'string'){
          obj = JSON.parse(obj);
        }
        for (var key in obj) {
          var val = obj[key];
          var type = typeof obj[key];
          if (type === "object") {
            if (Array.isArray(val)) {
              // Add duplicates --[object].key val1 --[object].key val2 ...
              for (var i=0;i<val.length;i++) {
                args.push(prefix+"."+key, val[i]);
              }
            } else {
              // Dig deeper
              convert(prefix+"."+key, val, args);
            }
          } else if (type === "undefined" || type === "function") {
            // Skip these types
          } else if (type === "boolean") {
            // Add --[object].key
            args.push(prefix+"."+key);
          } else {
            // Add --[object].key value
            args.push(prefix+"."+key, val);
          }
        }
      })("--" + a, grunt.option(a) || opts.args[a], args);
    });


    // Spawn protractor command
    var done = this.async();
    var startProtractor = function(){
      grunt.verbose.writeln("Spawn node with arguments: " + args.join(" "));
      var child = grunt.util.spawn({
          cmd: opts.nodeBin,
          args: args,
          opts: {
            stdio:'pipe'
          }
        },
        function(error, result, code) {
          if (error) {
            grunt.log.error(String(result));
            if(code === 1 && keepAlive) {
              // Test fails but do not want to stop the grunt process.
              grunt.log.oklns("Test failed but keep the grunt process alive.");
            } else {
              // Test fails and want to stop the grunt process,
              // or protractor exited with other reason.
              grunt.warn('Tests failed, protractor exited with code: '+code, code);
            }
          }
          done();
          done = null;
        }
      );
      process.stdin.pipe(child.stdin);
      child.stdout.pipe(process.stdout);
      child.stderr.pipe(process.stderr);

      // Write the result in the output file
      if (!grunt.util._.isUndefined(opts.output) && opts.output !== false) {

        grunt.log.writeln("Output test result to: " + opts.output);

        grunt.file.mkdir(path.dirname(opts.output));

        child.stdout
          .pipe(split())
          .pipe(through2(function (chunk, encoding, callback) {
            if ((/^Using the selenium server at/).test(chunk.toString())) {
              // skip
            }
            else {
              this.push(chunk + '\n');
            }
            callback();
          }))
          .pipe(fs.createWriteStream(opts.output));
      }
    };

    if (opts.webdriverManagerUpdate) {
      grunt.log.writeln('webdriver-manager path: ' + webdriverManagerPath);
      grunt.util.spawn({
        cmd: opts.nodeBin,
        args: [webdriverManagerPath, 'update'],
        opts: {
          stdio: 'inherit'
        }
      }, startProtractor);
    } else {
      startProtractor();
    }
  });

};