Remove IIFE in test/saucelabs.js.

This commit is contained in:
John-David Dalton
2014-04-28 08:41:24 -07:00
parent 2c4657355f
commit 3efa9d2030

View File

@@ -1,63 +1,61 @@
#!/usr/bin/env node
;(function() {
'use strict';
'use strict';
/** Environment shortcut */
var env = process.env;
/** Environment shortcut */
var env = process.env;
if (isFinite(env.TRAVIS_PULL_REQUEST)) {
if (isFinite(env.TRAVIS_PULL_REQUEST)) {
console.log('Skipping Sauce Labs jobs for pull requests');
process.exit(0);
}
}
/** Load Node.js modules */
var EventEmitter = require('events').EventEmitter,
/** Load Node.js modules */
var EventEmitter = require('events').EventEmitter,
http = require('http'),
path = require('path'),
url = require('url');
/** Load other modules */
var _ = require('../lodash.js'),
/** Load other modules */
var _ = require('../lodash.js'),
chalk = require('chalk'),
ecstatic = require('ecstatic'),
request = require('request'),
SauceTunnel = require('sauce-tunnel-sc3-1');
/** Used for Sauce Labs credentials */
var accessKey = env.SAUCE_ACCESS_KEY,
/** Used for Sauce Labs credentials */
var accessKey = env.SAUCE_ACCESS_KEY,
username = env.SAUCE_USERNAME;
/** Used as the maximum number of times to retry a job */
var maxRetries = 3;
/** Used as the maximum number of times to retry a job */
var maxRetries = 3;
/** Used as the static file server middleware */
var mount = ecstatic({
/** Used as the static file server middleware */
var mount = ecstatic({
'cache': false,
'root': process.cwd()
});
});
/** Used as the list of ports supported by Sauce Connect */
var ports = [
/** Used as the list of ports supported by Sauce Connect */
var ports = [
80, 443, 888, 2000, 2001, 2020, 2109, 2222, 2310, 3000, 3001, 3030, 3210,
3333, 4000, 4001, 4040, 4321, 4502, 4503, 4567, 5000, 5001, 5050, 5555, 5432,
6000, 6001, 6060, 6666, 6543, 7000, 7070, 7774, 7777, 8000, 8001, 8003, 8031,
8080, 8081, 8765, 8777, 8888, 9000, 9001, 9080, 9090, 9876, 9877, 9999, 49221,
55001
];
];
/** Used by `logInline` to clear previously logged messages */
var prevLine = '';
/** Used by `logInline` to clear previously logged messages */
var prevLine = '';
/** Used to detect error messages */
var reError = /\berror\b/i;
/** Used to detect error messages */
var reError = /\berror\b/i;
/** Used to display the wait throbber */
var throbberId,
throbberDelay = 500,
/** Used to display the wait throbber */
var throbberDelay = 500,
waitCount = -1;
/** Used as Sauce Labs config values */
var advisor = getOption('advisor', true),
/** Used as Sauce Labs config values */
var advisor = getOption('advisor', true),
build = getOption('build', env.TRAVIS_COMMIT.slice(0, 10)),
compatMode = getOption('compatMode', null),
customData = Function('return {' + getOption('customData', '').replace(/^\{|}$/g, '') + '}')(),
@@ -78,14 +76,14 @@
tunnelTimeout = getOption('tunnelTimeout', 10000),
videoUploadOnPass = getOption('videoUploadOnPass', false);
/** Used to convert Sauce Labs browser identifiers to their formal names */
var browserNameMap = {
/** Used to convert Sauce Labs browser identifiers to their formal names */
var browserNameMap = {
'googlechrome': 'Chrome',
'iehta': 'Internet Explorer'
};
};
/** List of platforms to load the runner on */
var platforms = [
/** List of platforms to load the runner on */
var platforms = [
['Linux', 'android', '4.3'],
['OS X 10.9', 'iphone', '7.1'],
['OS X 10.9', 'ipad', '7.1'],
@@ -106,25 +104,25 @@
['OS X 10.9', 'safari', '7'],
['OS X 10.8', 'safari', '6'],
['OS X 10.6', 'safari', '5']
];
];
/** Used to tailor the `platforms` array */
var runnerQuery = url.parse(runner, true).query,
/** Used to tailor the `platforms` array */
var runnerQuery = url.parse(runner, true).query,
isBackbone = /\bbackbone\b/i.test(runner),
isMobile = /\bmobile\b/i.test(runnerQuery.build),
isModern = /\bmodern\b/i.test(runnerQuery.build);
// platforms to test IE compat mode
if (compatMode) {
// platforms to test IE compat mode
if (compatMode) {
platforms = [
['Windows 8.1', 'internet explorer', '11'],
['Windows 8', 'internet explorer', '10'],
['Windows 7', 'internet explorer', '9'],
['Windows 7', 'internet explorer', '8']
];
}
// platforms for AMD tests
if (_.contains(tags, 'amd')) {
}
// platforms for AMD tests
if (_.contains(tags, 'amd')) {
platforms = platforms.filter(function(platform) {
var browser = platform[1],
version = +platform[2];
@@ -134,9 +132,9 @@
}
return true;
});
}
// platforms for Backbone tests
if (isBackbone) {
}
// platforms for Backbone tests
if (isBackbone) {
platforms = platforms.filter(function(platform) {
var browser = platform[1],
version = +platform[2];
@@ -147,9 +145,9 @@
}
return true;
});
}
// platforms for mobile and modern builds
if (isMobile || isModern) {
}
// platforms for mobile and modern builds
if (isMobile || isModern) {
platforms = platforms.filter(function(platform) {
var browser = platform[1],
version = +platform[2];
@@ -162,10 +160,10 @@
}
return true;
});
}
}
/** Used as the default `Job` options object */
var defaultOptions = {
/** Used as the default `Job` options object */
var defaultOptions = {
'build': build,
'custom-data': customData,
'framework': framework,
@@ -180,40 +178,40 @@
'tags': tags,
'url': runnerUrl,
'video-upload-on-pass': videoUploadOnPass
};
};
if (publicAccess === true) {
if (publicAccess === true) {
defaultOptions['public'] = 'public';
}
if (tunneled) {
}
if (tunneled) {
defaultOptions['tunnel-identifier'] = tunnelId;
}
}
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/**
/**
* Resolves the formal browser name for a given Sauce Labs browser identifier.
*
* @private
* @param {string} identifier The browser identifier.
* @returns {string} Returns the formal browser name.
*/
function browserName(identifier) {
function browserName(identifier) {
return capitalizeWords(browserNameMap[identifier] || identifier);
}
}
/**
/**
* Capitalizes the first character of each word in `string`.
*
* @private
* @param {string} string The string to augment.
* @returns {string} Returns the augmented string.
*/
function capitalizeWords(string) {
function capitalizeWords(string) {
return _.map(string.split(' '), _.capitalize).join(' ');
}
}
/**
/**
* Gets the value for the given option name. If no value is available the
* `defaultValue` is returned.
*
@@ -222,7 +220,7 @@
* @param {*} defaultValue The default option value.
* @returns {*} Returns the option value.
*/
function getOption(name, defaultValue) {
function getOption(name, defaultValue) {
var isArr = _.isArray(defaultValue);
return _.reduce(process.argv, function(result, value) {
if (isArr) {
@@ -233,30 +231,30 @@
return value == null ? result : value;
}, defaultValue);
}
}
/**
/**
* Writes an inline message to standard output.
*
* @private
* @param {string} text The text to log.
*/
function logInline(text) {
function logInline(text) {
var blankLine = _.repeat(' ', _.size(prevLine));
prevLine = text = _.truncate(text, 40);
process.stdout.write(text + blankLine.slice(text.length) + '\r');
}
}
/**
/**
* Writes the wait throbber to standard output.
*
* @private
*/
function logThrobber() {
function logThrobber() {
logInline('Please wait' + _.repeat('.', (++waitCount % 3) + 1));
}
}
/**
/**
* Converts a comma separated option value into an array.
*
* @private
@@ -264,11 +262,11 @@
* @param {string} string The options string.
* @returns {Array} Returns the new converted array.
*/
function optionToArray(name, string) {
function optionToArray(name, string) {
return _.compact(_.invoke((optionToValue(name, string) || '').split(/, */), 'trim'));
}
}
/**
/**
* Extracts the option value from an option string.
*
* @private
@@ -276,29 +274,29 @@
* @param {string} string The options string.
* @returns {string|undefined} Returns the option value, else `undefined`.
*/
function optionToValue(name, string) {
function optionToValue(name, string) {
var result = (result = string.match(RegExp('^' + name + '(?:=([\\s\\S]+))?$'))) && (result[1] ? result[1].trim() : true);
if (result === 'false') {
return false;
}
return result || undefined;
}
}
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/**
/**
* Used by the `onRun` callback to check the status of a job.
*
* @private
*/
function check() {
function check() {
request.post('https://saucelabs.com/rest/v1/' + this.user + '/js-tests/status', {
'auth': { 'user': this.user, 'pass': this.pass },
'json': { 'js tests': [this.id] }
}, onCheck.bind(this));
}
}
/**
/**
* The `request.post` callback used by `check`.
*
* @private
@@ -306,7 +304,7 @@
* @param {Object} response The response data object.
* @param {Object} body The response body JSON object.
*/
function onCheck(error, response, body) {
function onCheck(error, response, body) {
var data = _.result(body, 'js tests', [{}])[0],
options = this.options,
platform = options.platforms[0],
@@ -341,9 +339,9 @@
console.log(label, description, chalk.green('passed'));
}
this.emit('complete');
}
}
/**
/**
* The `request.post` callback used by `Jobs#run`.
*
* @private
@@ -351,7 +349,7 @@
* @param {Object} response The response data object.
* @param {Object} body The response body JSON object.
*/
function onRun(error, response, body) {
function onRun(error, response, body) {
var id = _.result(body, 'js tests', [])[0],
statusCode = _.result(response, 'statusCode');
@@ -364,46 +362,46 @@
}
this.id = id;
check.call(this);
}
}
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/**
/**
* The Job constructor.
*
* @private
* @param {Object} [properties] The properties to initial a job with.
*/
function Job(properties) {
function Job(properties) {
EventEmitter.call(this);
_.merge(this, { 'attempts': 0, 'options': {} }, properties);
_.defaults(this.options, _.cloneDeep(defaultOptions));
}
}
Job.prototype = _.create(EventEmitter.prototype);
Job.prototype = _.create(EventEmitter.prototype);
/**
/**
* Runs the job on Sauce Labs.
*
* @private
*/
Job.prototype.run = function() {
Job.prototype.run = function() {
request.post('https://saucelabs.com/rest/v1/' + this.user + '/js-tests', {
'auth': { 'user': this.user, 'pass': this.pass },
'json': this.options
}, onRun.bind(this));
};
};
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/**
/**
* Runs jobs for the given platforms.
*
* @private
* @param {Array} platforms The platforms to run jobs for.
* @param {Function} onComplete The function called once all jobs have completed.
*/
function run(platforms, onComplete) {
function run(platforms, onComplete) {
var jobs = _.map(platforms, function(platform) {
return new Job({
'user': username,
@@ -426,29 +424,29 @@
console.log('Starting jobs...');
_.invoke(jobs, 'run');
}
}
// cleanup any inline logs when exited via `ctrl+c`
process.on('SIGINT', function() {
// cleanup any inline logs when exited via `ctrl+c`
process.on('SIGINT', function() {
logInline('');
process.exit();
});
});
// create a web server for the local dir
http.createServer(function(req, res) {
// create a web server for the local dir
http.createServer(function(req, res) {
// see http://msdn.microsoft.com/en-us/library/ff955275(v=vs.85).aspx
if (compatMode && path.extname(url.parse(req.url).pathname) == '.html') {
res.setHeader('X-UA-Compatible', 'IE=' + compatMode);
}
mount(req, res);
}).listen(port);
}).listen(port);
// set up Sauce Connect so we can use this server from Sauce Labs
var tunnel = new SauceTunnel(username, accessKey, tunnelId, tunneled, tunnelTimeout);
// set up Sauce Connect so we can use this server from Sauce Labs
var tunnel = new SauceTunnel(username, accessKey, tunnelId, tunneled, tunnelTimeout);
console.log('Opening Sauce Connect tunnel...');
console.log('Opening Sauce Connect tunnel...');
tunnel.start(function(success) {
tunnel.start(function(success) {
if (!success) {
console.error('Failed to open Sauce Connect tunnel');
process.exit(2);
@@ -457,11 +455,8 @@
run(platforms, function(success) {
console.log('Shutting down Sauce Connect tunnel...');
clearInterval(throbberId);
tunnel.stop(function() { process.exit(success ? 0 : 1); });
});
throbberId = setInterval(logThrobber, throbberDelay);
logThrobber();
});
}());
setInterval(logThrobber, throbberDelay);
});