refactored the cli runner to better accomodate external build runners…

… such as grunt
xuaniyo · Oct 24, 2014 · 2ca4605 · 2ca4605
1 parent e578137
commit 2ca4605
Show file tree

Hide file tree

Showing 59 changed files with 460 additions and 358 deletions.
diff --git a/bin/_cli.js b/bin/_cli.js
diff --git a/bin/nightwatch b/bin/nightwatch
@@ -1,3 +1,3 @@
 #!/usr/bin/env node
-require('./runner.js');            
+require('./runner.js');
 
diff --git a/bin/runner.js b/bin/runner.js
@@ -2,94 +2,12 @@
  * Module dependencies
  */
 var Logger = require('../lib/util/logger.js');
-var cli = require('./_cli.js');
-var CliRunner = require('./_clirunner.js');
-
-// CLI definitions
-
-// $ nightwatch -c
-// $ nightwatch --config
-cli.command('config')
-  .demand(true)
-  .description('Path to configuration file')
-  .alias('c')
-  .defaults('./nightwatch.json');
-
-// $ nightwatch -o
-// $ nightwatch --output
-cli.command('output')
-  .description('Where to save the JUnit XML test reports.')
-  .alias('o')
-  .defaults('tests_output');
-
-// $ nightwatch -e
-// $ nightwatch --env saucelabs
-cli.command('env')
-  .description('Testing environment to use.')
-  .alias('e')
-  .defaults('default');
-
-// $ nightwatch --verbose
-cli.command('verbose')
-  .description('Turns on selenium command logging during the session.');
-
-// $ nightwatch -t
-// $ nightwatch --test
-cli.command('test')
-  .description('Runs a single test.')
-  .alias('t');
-
-// $ nightwatch -g
-// $ nightwatch --group
-cli.command('group')
-  .description('Runs a group of tests (i.e. a folder)')
-  .alias('g');
-
-// $ nightwatch -s
-// $ nightwatch --skipgroup
-cli.command('skipgroup')
-  .description('Skips one or several (comma separated) group of tests.')
-  .alias('s');
-
-// $ nightwatch -f
-// $ nightwatch --filter
-cli.command('filter')
-  .description('Specify a filter (glob expression) as the file name format to use when loading the files.')
-  .defaults('')
-  .alias('f');
-
-// $ nightwatch -a
-// $ nightwatch --tag
-cli.command('tag')
-  .description('Only run tests with the given tag.')
-  .defaults('')
-  .alias('a');
-
-// $ nightwatch -h
-// $ nightwatch --help
-cli.command('help')
-  .description('Shows this help.')
-  .alias('h');
-
-// $ nightwatch -v
-// $ nightwatch --version
-cli.command('version')
-  .alias('v')
-  .description('Shows version information.');
+var Nightwatch = require('../lib/index.js');
 
 try {
-  var argv = cli.init();
-  if (argv.help) {
-    cli.showHelp();
-  } else if (argv.version) {
-    var packageConfig = require(__dirname + '/../package.json');
-    console.log(packageConfig.name + ' v' + packageConfig.version);
-  } else {
-    process.chdir(process.cwd());
-
-    var runner = module.exports = new CliRunner(argv);
-    runner.init().runTests();
-  }
+  Nightwatch.cli(function(argv) {
+    Nightwatch.runner(argv);
+  });
 } catch (ex) {
   Logger.error('There was an error while starting the test runner:\n\n');
   process.stderr.write(ex.stack + '\n');

diff --git a/lib/selenium/assertions/attributeContains.js → lib/api/assertions/attributeContains.js b/lib/selenium/assertions/attributeContains.js → lib/api/assertions/attributeContains.js
diff --git a/lib/selenium/assertions/attributeEquals.js → lib/api/assertions/attributeEquals.js b/lib/selenium/assertions/attributeEquals.js → lib/api/assertions/attributeEquals.js
diff --git a/lib/selenium/assertions/containsText.js → lib/api/assertions/containsText.js b/lib/selenium/assertions/containsText.js → lib/api/assertions/containsText.js
diff --git a/...selenium/assertions/cssClassNotPresent.js → lib/api/assertions/cssClassNotPresent.js b/...selenium/assertions/cssClassNotPresent.js → lib/api/assertions/cssClassNotPresent.js
diff --git a/lib/selenium/assertions/cssClassPresent.js → lib/api/assertions/cssClassPresent.js b/lib/selenium/assertions/cssClassPresent.js → lib/api/assertions/cssClassPresent.js
diff --git a/lib/selenium/assertions/cssProperty.js → lib/api/assertions/cssProperty.js b/lib/selenium/assertions/cssProperty.js → lib/api/assertions/cssProperty.js
diff --git a/lib/selenium/assertions/elementNotPresent.js → lib/api/assertions/elementNotPresent.js b/lib/selenium/assertions/elementNotPresent.js → lib/api/assertions/elementNotPresent.js
diff --git a/lib/selenium/assertions/elementPresent.js → lib/api/assertions/elementPresent.js b/lib/selenium/assertions/elementPresent.js → lib/api/assertions/elementPresent.js
diff --git a/lib/selenium/assertions/hidden.js → lib/api/assertions/hidden.js b/lib/selenium/assertions/hidden.js → lib/api/assertions/hidden.js
diff --git a/lib/selenium/assertions/title.js → lib/api/assertions/title.js b/lib/selenium/assertions/title.js → lib/api/assertions/title.js
diff --git a/lib/selenium/assertions/urlContains.js → lib/api/assertions/urlContains.js b/lib/selenium/assertions/urlContains.js → lib/api/assertions/urlContains.js
diff --git a/lib/selenium/assertions/urlEquals.js → lib/api/assertions/urlEquals.js b/lib/selenium/assertions/urlEquals.js → lib/api/assertions/urlEquals.js
diff --git a/lib/selenium/assertions/value.js → lib/api/assertions/value.js b/lib/selenium/assertions/value.js → lib/api/assertions/value.js
diff --git a/lib/selenium/assertions/valueContains.js → lib/api/assertions/valueContains.js b/lib/selenium/assertions/valueContains.js → lib/api/assertions/valueContains.js
diff --git a/lib/selenium/assertions/visible.js → lib/api/assertions/visible.js b/lib/selenium/assertions/visible.js → lib/api/assertions/visible.js
diff --git a/lib/selenium/client-commands.js → lib/api/client-commands.js b/lib/selenium/client-commands.js → lib/api/client-commands.js
diff --git a/lib/selenium/commands/_locateStrategy.js → lib/api/commands/_locateStrategy.js b/lib/selenium/commands/_locateStrategy.js → lib/api/commands/_locateStrategy.js
diff --git a/lib/selenium/commands/_waitForElement.js → lib/api/commands/_waitForElement.js b/lib/selenium/commands/_waitForElement.js → lib/api/commands/_waitForElement.js
diff --git a/lib/selenium/commands/pause.js → lib/api/commands/pause.js b/lib/selenium/commands/pause.js → lib/api/commands/pause.js
diff --git a/lib/selenium/commands/perform.js → lib/api/commands/perform.js b/lib/selenium/commands/perform.js → lib/api/commands/perform.js
diff --git a/lib/selenium/commands/useCss.js → lib/api/commands/useCss.js b/lib/selenium/commands/useCss.js → lib/api/commands/useCss.js
diff --git a/lib/selenium/commands/useXpath.js → lib/api/commands/useXpath.js b/lib/selenium/commands/useXpath.js → lib/api/commands/useXpath.js
diff --git a/...nium/commands/waitForElementNotPresent.js → lib/api/commands/waitForElementNotPresent.js b/...nium/commands/waitForElementNotPresent.js → lib/api/commands/waitForElementNotPresent.js
diff --git a/...nium/commands/waitForElementNotVisible.js → lib/api/commands/waitForElementNotVisible.js b/...nium/commands/waitForElementNotVisible.js → lib/api/commands/waitForElementNotVisible.js
diff --git a/...elenium/commands/waitForElementPresent.js → lib/api/commands/waitForElementPresent.js b/...elenium/commands/waitForElementPresent.js → lib/api/commands/waitForElementPresent.js
diff --git a/...elenium/commands/waitForElementVisible.js → lib/api/commands/waitForElementVisible.js b/...elenium/commands/waitForElementVisible.js → lib/api/commands/waitForElementVisible.js
diff --git a/lib/selenium/element-commands.js → lib/api/element-commands.js b/lib/selenium/element-commands.js → lib/api/element-commands.js
diff --git a/lib/selenium/errors.json → lib/api/errors.json b/lib/selenium/errors.json → lib/api/errors.json
diff --git a/lib/selenium/protocol.js → lib/api/protocol.js b/lib/selenium/protocol.js → lib/api/protocol.js
diff --git a/lib/core/api.js b/lib/core/api.js
@@ -72,7 +72,7 @@ module.exports = new (function() {
       }
     }
 
-    var dirPath = path.join(__dirname, './../selenium/assertions/');
+    var dirPath = path.join(__dirname, './../api/assertions/');
 
     loadAssertionFiles(dirPath, client.api.assert, true);
     loadAssertionFiles(dirPath, client.api.verify, false);
@@ -130,7 +130,7 @@ module.exports = new (function() {
    * Loads selenium protocol actions
    */
   function loadProtocolActions() {
-    var protocol = require('./../selenium/protocol.js')(client);
+    var protocol = require('./../api/protocol.js')(client);
     var actions  = Object.keys(protocol);
     actions.forEach(function(command) {
       addCommand(command, protocol[command], client.api, client.api);
@@ -142,14 +142,14 @@ module.exports = new (function() {
    */
   function loadClientCommands() {
     // adding element specific commands
-    var elementCommands = require('./../selenium/element-commands.js')(client);
+    var elementCommands = require('./../api/element-commands.js')(client);
     var entries  = Object.keys(elementCommands);
     entries.forEach(function(command) {
       addCommand(command, elementCommands[command], client.api, client.api);
     });
 
     // adding client specific commands
-    var clientCommands = require('./../selenium/client-commands.js')(client);
+    var clientCommands = require('./../api/client-commands.js')(client);
     entries  = Object.keys(clientCommands);
     entries.forEach(function(command) {
       addCommand(command, clientCommands[command], client.api, client.api, true);
@@ -162,7 +162,7 @@ module.exports = new (function() {
    * Loads the external commands
    */
   function loadCommandFiles(context) {
-    var relativePath = './../selenium/commands/';
+    var relativePath = './../api/commands/';
     var commandFiles = fs.readdirSync(path.join(__dirname, relativePath));
     var commandName;
     var commandModule;

diff --git a/lib/index.js b/lib/index.js
@@ -368,7 +368,7 @@ Nightwatch.prototype.saveScreenshotToFile = function(fileName, content, cb) {
 Nightwatch.prototype.handleTestError = function(result) {
   var errorMessage = '';
   if (result && result.status) {
-    var errorCodes = require('./selenium/errors.json');
+    var errorCodes = require('./api/errors.json');
     errorMessage = errorCodes[result.status] && errorCodes[result.status].message || '';
   }
 
@@ -429,7 +429,34 @@ Nightwatch.prototype.followRedirect = function (request, response) {
   return this;
 };
 
-exports.client = function(options) {
-  return new Nightwatch(options);
+module.exports = {
+  client : function(options) {
+    return new Nightwatch(options);
+  },
+
+  cli : function(runTests) {
+    var cli = require('./runner/cli/cli.js');
+    cli.setup();
+    var argv = cli.init();
+
+    if (argv.help) {
+      cli.showHelp();
+    } else if (argv.version) {
+      var packageConfig = require(__dirname + '/../package.json');
+      console.log(packageConfig.name + ' v' + packageConfig.version);
+    } else {
+      if (typeof runTests != 'function') {
+        throw new Error('Supplied argument needs to be a function!');
+      }
+      runTests(argv);
+    }
+  },
+
+  runner : function(argv, done, settings) {
+    var CliRunner = require('./runner/cli/clirunner.js');
+
+    var runner = new CliRunner(argv);
+    return runner.init(done).runTests(done, settings);
+  }
 };