Refactoring Android project-level and platform scripts to use Q.js

This eliminates the use of shelljs.exec's sync mode, which is the source
of the filehandle leaks that can cause EMFILE on OSX, and are
CPU-intensive everywhere.

Tested locally, needs poking before it gets released.

bin/templates/cordova/build

@@ -27,9 +27,11 @@ var build = require('./lib/build'),
 if(args[2] == '--help' || args[2] == '/?' || args[2] == '-h' ||
                     args[2] == 'help' || args[2] == '-help' || args[2] == '/help') {
     build.help();
-} else if(reqs.run()) {
-    build.run(args[2]);
-    process.exit(0);
 } else {
-    process.exit(2);
-}
+    reqs.run().then(function() {
+        return build.run(args[2]);
+    }).done(null, function(err) {
+        console.error(err);
+        process.exit(2);
+    });
+}

bin/templates/cordova/clean

@@ -26,9 +26,11 @@ var clean = require('./lib/clean'),
 // Usage support for when args are given
 if(args.length > 2) {
     clean.help();
-} else if(reqs.run()) {
-    clean.run();
-    process.exit(0);
 } else {
-    process.exit(2);
-}
+    reqs.run().done(function() {
+        return clean.run();
+    }, function(err) {
+        console.error('ERROR: ' + err);
+        process.exit(2);
+    });
+}

bin/templates/cordova/lib/build.js

@@ -20,6 +20,8 @@
 */
 
 var shell   = require('shelljs'),
+    exec    = require('./exec'),
+    Q       = require('q'),
     clean   = require('./clean'),
     path    = require('path'),
     fs      = require('fs'),
@@ -27,6 +29,7 @@ var shell   = require('shelljs'),
 
 /*
  * Builds the project with ant.
+ * Returns a promise.
  */
 module.exports.run = function(build_type) {
     //default build type
@@ -34,29 +37,24 @@ module.exports.run = function(build_type) {
     var cmd;
     switch(build_type) {
         case '--debug' :
-            clean.run();
             cmd = 'ant debug -f ' + path.join(ROOT, 'build.xml');
             break;
         case '--release' :
-            clean.run();
             cmd = 'ant release -f ' + path.join(ROOT, 'build.xml');
             break;
         case '--nobuild' :
             console.log('Skipping build...');
-            break;
+            return Q();
         default :
-           console.error('Build option \'' + build_type + '\' not recognized.');
-           process.exit(2);
-           break;
+            return Q.reject('Build option \'' + build_type + '\' not recognized.');
     }
     if(cmd) {
-        var result = shell.exec(cmd, {silent:false, async:false});
-        if(result.code > 0) {
-            console.error('ERROR: Failed to build android project.');
-            console.error(result.output);
-            process.exit(2);
-        }
+        return clean.run() // TODO: Can we stop cleaning every time and let ant build incrementally?
+        .then(function() {
+            return exec(cmd);
+        });
     }
+    return Q();
 }
 
 /*
@@ -86,4 +84,4 @@ module.exports.help = function() {
     console.log('    \'--release\': will build project using ant release');
     console.log('    \'--nobuild\': will skip build process (can be used with run command)');
     process.exit(0);
-}
+}

bin/templates/cordova/lib/clean.js

@@ -19,25 +19,20 @@
        under the License.
 */
 
-var shell = require('shelljs'),
+var exec  = require('./exec'),
     path  = require('path'),
     ROOT = path.join(__dirname, '..', '..');
 
 /*
  * Cleans the project using ant
+ * Returns a promise.
  */
 module.exports.run = function() {
-    var cmd = 'ant clean -f ' + path.join(ROOT, 'build.xml');
-    var result = shell.exec(cmd, {silent:false, async:false});
-    if (result.code > 0) {
-        console.error('ERROR: Failed to clean android project.');
-        console.error(result.output);
-        process.exit(2);
-    }
+    return exec('ant clean -f ' + path.join(ROOT, 'build.xml'));
 }
 
 module.exports.help = function() {
     console.log('Usage: ' + path.relative(process.cwd(), process.argv[1]));
     console.log('Cleans the project directory.');
     process.exit(0);
-}
+}

bin/templates/cordova/lib/device.js

@@ -19,24 +19,20 @@
        under the License.
 */
 
-var shell = require('shelljs'),
+var exec  = require('./exec'),
+    Q     = require('q'),
     path  = require('path'),
     build = require('./build'),
     appinfo = require('./appinfo'),
-    exec  = require('child_process').exec,
     ROOT = path.join(__dirname, '..', '..');
 
 /**
- * Returns a list of the device ID's found
+ * Returns a promise for the list of the device ID's found
  */
 module.exports.list = function() {
-    var cmd = 'adb devices';
-    var result = shell.exec(cmd, {silent:true, async:false});
-    if (result.code > 0) {
-        console.error('Failed to execute android command \'' + cmd + '\'.');
-        process.exit(2);
-    } else {
-        var response = result.output.split('\n');
+    return exec('adb devices')
+    .then(function(output) {
+        var response = output.split('\n');
         var device_list = [];
         for (var i = 1; i < response.length; i++) {
             if (response[i].match(/\w+\tdevice/) && !response[i].match(/emulator/)) {
@@ -44,52 +40,47 @@ module.exports.list = function() {
             }
         }
         return device_list;
-    }
+    });
 }
 
 /*
  * Installs a previously built application on the device
  * and launches it.
+ * Returns a promise.
  */
 module.exports.install = function(target) {
-    var device_list = this.list();
-    if (device_list.length > 0) {
+    var launchName;
+    return this.list()
+    .then(function(device_list) {
+        if (!device_list || !device_list.length)
+            return Q.reject('ERROR: Failed to deploy to device, no devices found.');
+
         // default device
         target = typeof target !== 'undefined' ? target : device_list[0];
-        if (device_list.indexOf(target) > -1) {
-            var apk_path = build.get_apk();
-            var launchName = appinfo.getActivityName();
-            console.log('Installing app on device...');
-            cmd = 'adb -s ' + target + ' install -r ' + apk_path;
-            var install = shell.exec(cmd, {silent:false, async:false});
-            if (install.error || install.output.match(/Failure/)) {
-                console.error('ERROR : Failed to install apk to device : ');
-                console.error(install.output);
-                process.exit(2);
-            }
 
-            //unlock screen
-            cmd = 'adb -s ' + target + ' shell input keyevent 82';
-            shell.exec(cmd, {silent:true, async:false});
+        if (device_list.indexOf(target) < 0)
+            return Q.reject('ERROR: Unable to find target \'' + target + '\'.');
 
-            // launch the application
-            console.log('Launching application...');
-            cmd = 'adb -s ' + target + ' shell am start -W -a android.intent.action.MAIN -n ' + launchName;
-            var launch = shell.exec(cmd, {silent:true, async:false});
-            if(launch.code > 0) {
-                console.error('ERROR : Failed to launch application on emulator : ' + launch.error);
-                console.error(launch.output);
-                process.exit(2);
-            } else {
-                console.log('LANCH SUCCESS');
-            }
-        } else {
-            console.error('ERROR : Unable to find target \'' + target + '\'.');
-            console.error('Failed to deploy to device.');
-            process.exit(2);
-        }
-    } else {
-        console.error('ERROR : Failed to deploy to device, no devices found.');
-        process.exit(2);
-    }
+        var apk_path = build.get_apk();
+        launchName = appinfo.getActivityName();
+        console.log('Installing app on device...');
+        var cmd = 'adb -s ' + target + ' install -r ' + apk_path;
+        return exec(cmd);
+    }).then(function(output) {
+        if (output.match(/Failure/)) return Q.reject('ERROR: Failed to install apk to device: ' + output);
+
+        //unlock screen
+        var cmd = 'adb -s ' + target + ' shell input keyevent 82';
+        return exec(cmd);
+    }, function(err) { return Q.reject('ERROR: Failed to install apk to device: ' + err); })
+    .then(function() {
+        // launch the application
+        console.log('Launching application...');
+        var cmd = 'adb -s ' + target + ' shell am start -W -a android.intent.action.MAIN -n ' + launchName;
+        return exec(cmd);
+    }).then(function() {
+        console.log('LANCH SUCCESS');
+    }, function(err) {
+        return Q.reject('ERROR: Failed to launch application on device: ' + err);
+    });
 }

bin/templates/cordova/lib/emulator.js

@@ -20,14 +20,17 @@
 */
 
 var shell = require('shelljs'),
+    exec  = require('./exec'),
+    Q     = require('q'),
     path  = require('path'),
     appinfo = require('./appinfo'),
     build = require('./build'),
     ROOT  = path.join(__dirname, '..', '..'),
+    child_process = require('child_process'),
     new_emulator = 'cordova_emulator';
 
 /**
- * Returns a list of emulator images in the form of objects
+ * Returns a Promise for a list of emulator images in the form of objects
  * {
        name   : <emulator_name>,
        path   : <path_to_emulator_image>,
@@ -37,13 +40,9 @@ var shell = require('shelljs'),
    }
  */
 module.exports.list_images = function() {
-    var cmd = 'android list avds';
-    var result = shell.exec(cmd, {silent:true, async:false});
-    if (result.code > 0) {
-        console.error('Failed to execute android command \'' + cmd + '\'.');
-        process.exit(2);
-    } else {
-        var response = result.output.split('\n');
+    return exec('android list avds')
+    .then(function(output) {
+        var response = output.split('\n');
         var emulator_list = [];
         for (var i = 1; i < response.length; i++) {
             // To return more detailed information use img_obj
@@ -76,41 +75,41 @@ module.exports.list_images = function() {
 
         }
         return emulator_list;
-    }
+    });
 }
 
 /**
  * Will return the closest avd to the projects target
  * or undefined if no avds exist.
+ * Returns a promise.
  */
 module.exports.best_image = function() {
     var project_target = this.get_target().replace('android-', '');
-    var images = this.list_images();
-    var closest = 9999;
-    var best = images[0];
-    for (i in images) {
-        var target = images[i].target;
-        if(target) {
-            var num = target.split('(API level ')[1].replace(')', '');
-            if (num == project_target) {
-                return images[i];
-            } else if (project_target - num < closest && project_target > num) {
-                var closest = project_target - num;
-                best = images[i];
+    return this.list_images()
+    .then(function(images) {
+        var closest = 9999;
+        var best = images[0];
+        for (i in images) {
+            var target = images[i].target;
+            if(target) {
+                var num = target.split('(API level ')[1].replace(')', '');
+                if (num == project_target) {
+                    return images[i];
+                } else if (project_target - num < closest && project_target > num) {
+                    var closest = project_target - num;
+                    best = images[i];
+                }
             }
         }
-    }
-    return best;
+        return best;
+    });
 }
 
+// Returns a promise.
 module.exports.list_started = function() {
-    var cmd = 'adb devices';
-    var result = shell.exec(cmd, {silent:true, async:false});
-    if (result.code > 0) {
-        console.error('Failed to execute android command \'' + cmd + '\'.');
-        process.exit(2);
-    } else {
-        var response = result.output.split('\n');
+    return exec('adb devices')
+    .then(function(output) {
+        var response = output.split('\n');
         var started_emulator_list = [];
         for (var i = 1; i < response.length; i++) {
             if (response[i].match(/device/) && response[i].match(/emulator/)) {
@@ -118,7 +117,7 @@ module.exports.list_started = function() {
             }
         }
         return started_emulator_list;
-    }
+    });
 }
 
 module.exports.get_target = function() {
@@ -126,15 +125,19 @@ module.exports.get_target = function() {
     return target.split('=')[1].replace('\n', '').replace('\r', '').replace(' ', '');
 }
 
+// Returns a promise.
 module.exports.list_targets = function() {
-    var target_out = shell.exec('android list targets', {silent:true, async:false}).output.split('\n');
-    var targets = [];
-    for (var i = target_out.length; i >= 0; i--) {
-        if(target_out[i].match(/id:/)) {
-            targets.push(targets[i].split(' ')[1]);
+    return exec('android list targets')
+    .then(function(output) {
+        var target_out = output.split('\n');
+        var targets = [];
+        for (var i = target_out.length; i >= 0; i--) {
+            if(target_out[i].match(/id:/)) {
+                targets.push(targets[i].split(' ')[1]);
+            }
         }
-    }
-    return targets;
+        return targets;
+    });
 }
 
 /*
@@ -142,147 +145,141 @@ module.exports.list_targets = function() {
  * and returns the started ID of that emulator.
  * If no ID is given it will used the first image availible,
  * if no image is availible it will error out (maybe create one?).
+ *
+ * Returns a promise.
  */
 module.exports.start = function(emulator_ID) {
-    var started_emulators = this.list_started();
-    var num_started = started_emulators.length;
-    if (typeof emulator_ID === 'undefined') {
-        var emulator_list = this.list_images();
-        if (emulator_list.length > 0) {
-            emulator_ID = this.best_image().name;
-            console.log('WARNING : no emulator specified, defaulting to ' + emulator_ID);
+    var self = this;
+    var emulator_id, num_started, started_emulators;
+
+    return self.list_started()
+    .then(function(list) {
+        started_emulators = list;
+        num_started = started_emulators.length;
+        if (typeof emulator_ID === 'undefined') {
+            return self.list_images()
+            .then(function(emulator_list) {
+                if (emulator_list.length > 0) {
+                    return self.best_image()
+                    .then(function(best) {
+                        emulator_ID = best.name;
+                        console.log('WARNING : no emulator specified, defaulting to ' + emulator_ID);
+                        return emulator_ID;
+                    });
+                } else {
+                    return Q.reject('ERROR : No emulator images (avds) found, if you would like to create an\n' +
+                        ' avd follow the instructions provided here:\n' +
+                        ' http://developer.android.com/tools/devices/index.html\n' +
+                        ' Or run \'android create avd --name <name> --target <targetID>\'\n' +
+                        ' in on the command line.');
+                }
+            });
         } else {
-            console.error('ERROR : No emulator images (avds) found, if you would like to create an');
-            console.error(' avd follow the instructions provided here : ');
-            console.error(' http://developer.android.com/tools/devices/index.html')
-            console.error(' Or run \'android create avd --name <name> --target <targetID>\' ');
-            console.error(' in on the command line.');
-            process.exit(2);
-            /*console.log('WARNING : no emulators availible, creating \'' + new_emulator + '\'.');
-            this.create_image(new_emulator, this.get_target());
-            emulator_ID = new_emulator;*/
+            return Q(emulator_ID);
         }
-    }
-
-    var pipe_null = (process.platform == 'win32' || process.platform == 'win64'? '> NUL' : '> /dev/null');
-    var cmd = 'emulator -avd ' + emulator_ID + ' ' + pipe_null + ' &';
-    if(process.platform == 'win32' || process.platform == 'win64') {
-        cmd = '%comspec% /c start cmd /c ' + cmd;
-    }
-    var result = shell.exec(cmd, {silent:true, async:false}, function(code, output) {
-        if (code > 0) {
-            console.error('Failed to execute android command \'' + cmd + '\'.');
-            console.error(output);
-            process.exit(2);
+    }).then(function() {
+        var cmd, args;
+        if(process.platform == 'win32' || process.platform == 'win64') {
+            cmd = '%comspec%';
+            args = ['/c', 'start', 'cmd', '/c', 'emulator', '-avd', emulator_ID];
+        } else {
+            cmd = 'emulator';
+            args = ['-avd', emulator_ID];
         }
-    });
-
-    // wait for emulator to start
-    console.log('Waiting for emulator...');
-    var new_started = this.wait_for_emulator(num_started);
-    var emulator_id;
-    if (new_started.length > 1) {
-        for (i in new_started) {
-            console.log(new_started[i]);
-            console.log(started_emulators.indexOf(new_started[i]));
-            if (started_emulators.indexOf(new_started[i]) < 0) {
-                emulator_id = new_started[i];
+        var proc = child_process.spawn(cmd, args, { stdio: 'inherit', detached: true });
+        proc.unref(); // Don't wait for it to finish, since the emulator will probably keep running for a long time.
+    }).then(function() {
+        // wait for emulator to start
+        console.log('Waiting for emulator...');
+        return self.wait_for_emulator(num_started);
+    }).then(function(new_started) {
+        if (new_started.length > 1) {
+            for (i in new_started) {
+                if (started_emulators.indexOf(new_started[i]) < 0) {
+                    emulator_id = new_started[i];
+                }
             }
+        } else {
+            emulator_id = new_started[0];
         }
-    } else {
-        emulator_id = new_started[0];
-    }
-    if (!emulator_id) {
-        console.error('ERROR :  Failed to start emulator, could not find new emulator');
-        process.exit(2);
-    }
+        if (!emulator_id) return Q.reject('ERROR :  Failed to start emulator, could not find new emulator');
 
-    //wait for emulator to boot up
-    process.stdout.write('Booting up emulator (this may take a while)...');
-    this.wait_for_boot(emulator_id);
-    console.log('BOOT COMPLETE');
+        //wait for emulator to boot up
+        process.stdout.write('Booting up emulator (this may take a while)...');
+        return self.wait_for_boot(emulator_id);
+    }).then(function() {
+        console.log('BOOT COMPLETE');
 
-    //unlock screen
-    cmd = 'adb -s ' + emulator_id + ' shell input keyevent 82';
-    shell.exec(cmd, {silent:false, async:false});
-
-    //return the new emulator id for the started emulators
-    return emulator_id;
+        //unlock screen
+        return exec('adb -s ' + emulator_id + ' shell input keyevent 82');
+    }).then(function() {
+        //return the new emulator id for the started emulators
+        return emulator_id;
+    });
 }
 
 /*
  * Waits for the new emulator to apear on the started-emulator list.
+ * Returns a promise with a list of newly started emulators' IDs.
  */
 module.exports.wait_for_emulator = function(num_running) {
-    var new_started = this.list_started();
-    if (new_started.length > num_running) {
-        return new_started;
-    } else {
-        this.sleep(1);
-        return this.wait_for_emulator(num_running);
-    }
+    var self = this;
+    return self.list_started()
+    .then(function(new_started) {
+        if (new_started.length > num_running) {
+            return new_started;
+        } else {
+            return Q.delay(1000).then(function() {
+                return self.wait_for_emulator(num_running);
+            });
+        }
+    });
 }
 
 /*
  * Waits for the boot animation property of the emulator to switch to 'stopped'
  */
 module.exports.wait_for_boot = function(emulator_id) {
-    var cmd;
-    // ShellJS opens a lot of file handles, and the default on OS X is too small.
-    // TODO : This is not working, need to find a better way to increese the ulimit.
-    if(process.platform == 'win32' || process.platform == 'win64') {
-        cmd = 'adb -s ' + emulator_id + ' shell getprop init.svc.bootanim';
-    } else {
-        cmd = 'ulimit -S -n 4096; adb -s ' + emulator_id + ' shell getprop init.svc.bootanim';
-    }
-    var boot_anim = shell.exec(cmd, {silent:true, async:false});
-    if (boot_anim.output.match(/stopped/)) {
-        return;
-    } else {
-        process.stdout.write('.');
-        this.sleep(3);
-        return this.wait_for_boot(emulator_id);
-    }
-}
-
-/*
- * TODO : find a better way to wait for the emulator (maybe using async methods?)
- */
-module.exports.sleep = function(time_sec) {
-    if (process.platform == 'win32' || process.platform == 'win64') {
-        shell.exec('ping 127.0.0.1 -n ' + time_sec, {silent:true, async:false});
-    } else {
-        shell.exec('sleep ' + time_sec, {silent:true, async:false});
-    }
+    var self = this;
+    return exec('adb -s ' + emulator_id + ' shell getprop init.svc.bootanim')
+    .then(function(output) {
+        if (output.match(/stopped/)) {
+            return;
+        } else {
+            process.stdout.write('.');
+            return Q.delay(3000).then(function() {
+                return self.wait_for_boot(emulator_id);
+            });
+        }
+    });
 }
 
 /*
  * Create avd
  * TODO : Enter the stdin input required to complete the creation of an avd.
+ * Returns a promise.
  */
 module.exports.create_image = function(name, target) {
     console.log('Creating avd named ' + name);
     if (target) {
-        var cmd = 'android create avd --name ' + name + ' --target ' + target;
-        var create = shell.exec(cmd, {sient:false, async:false});
-        if (create.error) {
+        return exec('android create avd --name ' + name + ' --target ' + target)
+        .then(null, function(error) {
             console.error('ERROR : Failed to create emulator image : ');
             console.error(' Do you have the latest android targets including ' + target + '?');
             console.error(create.output);
-            process.exit(2);
-        }
+        });
     } else {
         console.log('WARNING : Project target not found, creating avd with a different target but the project may fail to install.');
-        var cmd = 'android create avd --name ' + name + ' --target ' + this.list_targets()[0];
-        var create = shell.exec(cmd, {sient:false, async:false});
-        if (create.error) {
+        return exec('android create avd --name ' + name + ' --target ' + this.list_targets()[0])
+        .then(function() {
+            // TODO: This seems like another error case, even though it always happens.
+            console.error('ERROR : Unable to create an avd emulator, no targets found.');
+            console.error('Please insure you have targets availible by runing the "android" command');
+            return Q.reject();
+        }, function(error) {
             console.error('ERROR : Failed to create emulator image : ');
-            console.error(create.output);
-            process.exit(2);
-        }
-        console.error('ERROR : Unable to create an avd emulator, no targets found.');
-        console.error('Please insure you have targets availible by runing the "android" command').
-        process.exit(2);
+            console.error(error);
+        });
     }
 }
 
@@ -290,48 +287,44 @@ module.exports.create_image = function(name, target) {
  * Installs a previously built application on the emulator and launches it.
  * If no target is specified, then it picks one.
  * If no started emulators are found, error out.
+ * Returns a promise.
  */
 module.exports.install = function(target) {
-    var emulator_list = this.list_started();
-    if (emulator_list.length < 1) {
-        console.error('ERROR : No started emulators found, please start an emultor before deploying your project.');
-        process.exit(2);
-        /*console.log('WARNING : No started emulators found, attemting to start an avd...');
-        this.start(this.best_image().name);*/
-    }
-    // default emulator
-    target = typeof target !== 'undefined' ? target : emulator_list[0];
-    if (emulator_list.indexOf(target) > -1) {
-        console.log('Installing app on emulator...');
-        var apk_path = build.get_apk();
-        var cmd = 'adb -s ' + target + ' install -r ' + apk_path;
-        var install = shell.exec(cmd, {sient:false, async:false});
-        if (install.error || install.output.match(/Failure/)) {
-            console.error('ERROR : Failed to install apk to emulator : ');
-            console.error(install.output);
-            process.exit(2);
+    var self = this;
+    return this.list_started()
+    .then(function(emulator_list) {
+        if (emulator_list.length < 1) {
+            return Q.reject('No started emulators found, please start an emultor before deploying your project.');
         }
 
-        //unlock screen
-        cmd = 'adb -s ' + target + ' shell input keyevent 82';
-        shell.exec(cmd, {silent:true, async:false});
+        // default emulator
+        target = typeof target !== 'undefined' ? target : emulator_list[0];
+        if (emulator_list.indexOf(target) < 0) {
+            return Q.reject('Unable to find target \'' + target + '\'. Failed to deploy to emulator.');
+        }
 
+        console.log('Installing app on emulator...');
+        var apk_path = build.get_apk();
+        return exec('adb -s ' + target + ' install -r ' + apk_path);
+    }).then(function(output) {
+        if (output.match(/Failure/)) {
+            return Q.reject('Failed to install apk to emulator: ' + output);
+        }
+        return Q();
+    }, function(err) {
+        return Q.reject('Failed to install apk to emulator: ' + err);
+    }).then(function() {
+        //unlock screen
+        return exec('adb -s ' + target + ' shell input keyevent 82');
+    }).then(function() {
         // launch the application
         console.log('Launching application...');
         var launchName = appinfo.getActivityName();
         cmd = 'adb -s ' + target + ' shell am start -W -a android.intent.action.MAIN -n ' + launchName;
-        console.log(cmd);
-        var launch = shell.exec(cmd, {silent:false, async:false});
-        if(launch.code > 0) {
-            console.error('ERROR : Failed to launch application on emulator : ' + launch.error);
-            console.error(launch.output);
-            process.exit(2);
-        } else {
-            console.log('LANCH SUCCESS');
-        }
-    } else {
-        console.error('ERROR : Unable to find target \'' + target + '\'.');
-        console.error('Failed to deploy to emulator.');
-        process.exit(2);
-    }
+        return exec(cmd);
+    }).then(function(output) {
+        console.log('LAUNCH SUCCESS');
+    }, function(err) {
+        return Q.reject('Failed to launch app on emulator: ' + err);
+    });
 }

bin/templates/cordova/lib/exec.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+/*
+       Licensed to the Apache Software Foundation (ASF) under one
+       or more contributor license agreements.  See the NOTICE file
+       distributed with this work for additional information
+       regarding copyright ownership.  The ASF licenses this file
+       to you under the Apache License, Version 2.0 (the
+       "License"); you may not use this file except in compliance
+       with the License.  You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing,
+       software distributed under the License is distributed on an
+       "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+       KIND, either express or implied.  See the License for the
+       specific language governing permissions and limitations
+       under the License.
+*/
+
+var child_process = require('child_process'),
+    Q       = require('q');
+
+// Takes a command and optional current working directory.
+// Returns a promise that either resolves with the stdout, or
+// rejects with an error message and the stderr.
+module.exports = function(cmd, opt_cwd) {
+    var d = Q.defer();
+    console.log('exec: ' + cmd);
+    try {
+        child_process.exec(cmd, {cwd: opt_cwd}, function(err, stdout, stderr) {
+            console.log([cmd, err, stdout, stderr]);
+            if (err) d.reject('Error executing "' + cmd + '": ' + stderr);
+            else d.resolve(stdout);
+        });
+    } catch(e) {
+        console.error('error caught: ' + e);
+        d.reject(e);
+    }
+    return d.promise;
+}
+

bin/templates/cordova/lib/install-device

@@ -26,13 +26,17 @@ if(args.length > 2) {
     var install_target;
     if (args[2].substring(0, 9) == '--target=') {
         install_target = args[2].substring(9, args[2].length);
-        device.install(install_target);
-        process.exit(0);
+        device.install(install_target).done(null, function(err) {
+            console.error('ERROR: ' + err);
+            process.exit(2);
+        });
      } else {
         console.error('ERROR : argument \'' + args[2] + '\' not recognized.');
         process.exit(2);
      }
 } else {
-    device.install();
-    process.exit(0);
-}
+    device.install().done(null, function(err) {
+        console.error('ERROR: ' + err);
+        process.exit(2);
+    });
+}

bin/templates/cordova/lib/install-emulator

@@ -22,17 +22,17 @@
 var emulator = require('./emulator'),
     args     = process.argv;
 
+var install_target;
 if(args.length > 2) {
-    var install_target;
     if (args[2].substring(0, 9) == '--target=') {
         install_target = args[2].substring(9, args[2].length);
-        emulator.install(install_target);
-        process.exit(0);
      } else {
         console.error('ERROR : argument \'' + args[2] + '\' not recognized.');
         process.exit(2);
      }
-} else {
-    emulator.install();
-    process.exit(0);
-}
+}
+
+emulator.install(install_target).done(null, function(err) {
+    console.error('ERROR: ' + err);
+    process.exit(2);
+});

bin/templates/cordova/lib/list-devices

@@ -22,7 +22,12 @@
 var devices = require('./device');
 
 // Usage support for when args are given
-var device_list = devices.list();
-for(device in device_list) {
-    console.log(device_list[device]);
-}
+devices.list().done(function(device_list) {
+    device_list && device_list.forEach(function(dev) {
+        console.log(dev);
+    });
+}, function(err) {
+    console.error('ERROR: ' + err);
+    process.exit(2);
+});
+

bin/templates/cordova/lib/list-emulator-images

@@ -22,8 +22,11 @@
 var emulators = require('./emulator');
 
 // Usage support for when args are given
-var emulator_list = emulators.list_images();
-for(emulator in emulator_list) {
-    console.log(emulator_list[emulator].name);
-    process.exit(0);
-}
+emulators.list_images().done(function(emulator_list) {
+    emulator_list && emulator_list.forEach(function(emu) {
+        console.log(emu.name);
+    });
+}, function(err) {
+    console.error('ERROR: ' + err);
+    process.exit(2);
+});

bin/templates/cordova/lib/list-started-emulators

@@ -22,8 +22,11 @@
 var emulators = require('./emulator');
 
 // Usage support for when args are given
-var emulator_list = emulators.list_started();
-for(emulator in emulator_list) {
-    console.log(emulator_list[emulator]);
-    process.exit(0);
-}
+emulators.list_started().done(function(emulator_list) {
+    emulator_list && emulator_list.forEach(function(emu) {
+        console.log(emu);
+    });
+}, function(err) {
+    console.error('ERROR: ' + err);
+    process.exit(2);
+});

bin/templates/cordova/lib/log.js

@@ -21,23 +21,37 @@
 
 var shell = require('shelljs'),
     path  = require('path'),
-    ROOT = path.join(__dirname, '..', '..');
+    Q     = require('q'),
+    child_process = require('child_process'),
+    ROOT  = path.join(__dirname, '..', '..');
 
 /*
  * Starts running logcat in the shell.
+ * Returns a promise.
  */
 module.exports.run = function() {
     var cmd = 'adb logcat | grep -v nativeGetEnabledTags';
-    var result = shell.exec(cmd, {silent:false, async:false});
-    if (result.code > 0) {
-        console.error('ERROR: Failed to run logcat command.');
-        console.error(result.output);
-        process.exit(2);
-    }
+    var d = Q.defer();
+    var adb = child_process.spawn('adb', ['logcat']);
+
+    adb.stdout.on('data', function(data) {
+        var lines = data ? data.toString().split('\n') : [];
+        var out = lines.filter(function(x) { return x.indexOf('nativeGetEnabledTags') < 0; });
+        console.log(out.join('\n'));
+    });
+
+    adb.stderr.on('data', console.error);
+    adb.on('close', function(code) {
+        if (code > 0) {
+            d.reject('Failed to run logcat command.');
+        } else d.resolve();
+    });
+
+    return d.promise;
 }
 
 module.exports.help = function() {
     console.log('Usage: ' + path.relative(process.cwd(), path.join(ROOT, 'corodva', 'log')));
     console.log('Gives the logcat output on the command line.');
     process.exit(0);
-}
+}

bin/templates/cordova/lib/run.js

@@ -22,13 +22,15 @@
 var path  = require('path'),
     build = require('./build'),
     emulator = require('./emulator'),
-    device   = require('./device');
+    device   = require('./device'),
+    Q = require('q');
 
 /*
  * Runs the application on a device if availible.
  * If not device is found, it will use a started emulator.
  * If no started emulators are found it will attempt to start an avd.
  * If no avds are found it will error out.
+ * Returns a promise.
  */
  module.exports.run = function(args) {
     var build_type;
@@ -52,61 +54,75 @@ var path  = require('path'),
             process.exit(2);
         }
     }
-    build.run(build_type);
-    if (install_target == '--device') {
-        device.install();
-    } else if (install_target == '--emulator') {
-        if (emulator.list_started() == 0) {
-            emulator.start();
-        }
-        emulator.install();
-    } else if (install_target) {
-        var devices = device.list();
-        var started_emulators = emulator.list_started();
-        var avds = emulator.list_images();
-        if (devices.indexOf(install_target) > -1) {
-            device.install(install_target);
-        } else if (started_emulators.indexOf(install_target) > -1) {
-            emulator.install(install_target);
-        } else {
-            // if target emulator isn't started, then start it.
-            var emulator_ID;
-            for(avd in avds) {
-                if(avds[avd].name == install_target) {
-                    emulator_ID = emulator.start(install_target);
-                    emulator.install(emulator_ID);
-                    break;
-                }
-            }
-            if(!emulator_ID) {
-                console.error('ERROR : Target \'' + install_target + '\' not found, unalbe to run project');
-                process.exit(2);
-            }
-        }
-    } else {
-        // no target given, deploy to device if availible, otherwise use the emulator.
-        var device_list = device.list();
-        if (device_list.length > 0) {
-            console.log('WARNING : No target specified, deploying to device \'' + device_list[0] + '\'.');
-            device.install(device_list[0])
-        } else {
-            var emulator_list = emulator.list_started();
-            if (emulator_list.length > 0) {
-                console.log('WARNING : No target specified, deploying to emulator \'' + emulator_list[0] + '\'.');
-                emulator.install(emulator_list[0]);
-            } else {
-                console.log('WARNING : No started emulators found, starting an emulator.');
-                var best_avd = emulator.best_image();
-                if(best_avd) {
-                    var emulator_ID = emulator.start(best_avd.name);
-                    console.log('WARNING : No target specified, deploying to emulator \'' + emulator_ID + '\'.');
-                    emulator.install(emulator_ID);
+
+    return build.run(build_type).then(function() {
+        if (install_target == '--device') {
+            return device.install();
+        } else if (install_target == '--emulator') {
+            return emulator.list_started().then(function(started) {
+                var p = started && started.length > 0 ? Q() : emulator.start();
+                return p.then(function() { emulator.install(); });
+            });
+        } else if (install_target) {
+            var devices, started_emulators, avds;
+            return device.list()
+            .then(function(res) {
+                devices = res;
+                return emulator.list_started();
+            }).then(function(res) {
+                started_emulators = res;
+                return emulator.list_images();
+            }).then(function(res) {
+                avds = res;
+                if (devices.indexOf(install_target) > -1) {
+                    return device.install(install_target);
+                } else if (started_emulators.indexOf(install_target) > -1) {
+                    return emulator.install(install_target);
                 } else {
-                    emulator.start();
+                    // if target emulator isn't started, then start it.
+                    var emulator_ID;
+                    for(avd in avds) {
+                        if(avds[avd].name == install_target) {
+                            return emulator.start(install_target)
+                            .then(function() { emulator.install(emulator_ID); });
+                        }
+                    }
+                    return Q.reject('Target \'' + install_target + '\' not found, unable to run project');
                 }
-            }
+            });
+        } else {
+            // no target given, deploy to device if availible, otherwise use the emulator.
+            return device.list()
+            .then(function(device_list) {
+                if (device_list.length > 0) {
+                    console.log('WARNING : No target specified, deploying to device \'' + device_list[0] + '\'.');
+                    return device.install(device_list[0]);
+                } else {
+                    return emulator.list_started()
+                    .then(function(emulator_list) {
+                        if (emulator_list.length > 0) {
+                            console.log('WARNING : No target specified, deploying to emulator \'' + emulator_list[0] + '\'.');
+                            return emulator.install(emulator_list[0]);
+                        } else {
+                            console.log('WARNING : No started emulators found, starting an emulator.');
+                            return emulator.best_image()
+                            .then(function(best_avd) {
+                                if(best_avd) {
+                                    return emulator.start(best_avd.name)
+                                    .then(function(emulator_ID) {
+                                        console.log('WARNING : No target specified, deploying to emulator \'' + emulator_ID + '\'.');
+                                        return emulator.install(emulator_ID);
+                                    });
+                                } else {
+                                    return emulator.start();
+                                }
+                            });
+                        }
+                    });
+                }
+            });
         }
-    }
+    });
 }
 
 module.exports.help = function() {
@@ -120,4 +136,4 @@ module.exports.help = function() {
     console.log('    --emulator : Will deploy the built project to an emulator if one exists');
     console.log('    --target=<target_id> : Installs to the target with the specified id.');
     process.exit(0);
-}
+}

bin/templates/cordova/lib/start-emulator

@@ -22,17 +22,18 @@
 var emulator = require('./emulator'),
       args   = process.argv;
 
+var install_target;
 if(args.length > 2) {
-    var install_target;
     if (args[2].substring(0, 9) == '--target=') {
         install_target = args[2].substring(9, args[2].length);
-        emulator.start(install_target);
-        process.exit(0);
      } else {
         console.error('ERROR : argument \'' + args[2] + '\' not recognized.');
         process.exit(2);
      }
-} else {
-    emulator.start();
-    process.exit(0);
-}
+}
+
+emulator.start(install_target).done(null, function(err) {
+    console.error('ERROR: ' + err);
+    process.exit(2);
+});
+

bin/templates/cordova/log

@@ -26,8 +26,11 @@ var log  = require('./lib/log'),
 // Usage support for when args are given
 if(args.length > 2) {
     log.help();
-} else if(reqs.run()) {
-    log.run();
 } else {
-    process.exit(2);
-}
+    reqs.run().done(function() {
+        return log.run();
+    }, function(err) {
+        console.error('ERROR: ' + err);
+        process.exit(2);
+    });
+}

bin/templates/cordova/run

@@ -27,9 +27,11 @@ var run  = require('./lib/run'),
 if (args[2] == '--help' || args[2] == '/?' || args[2] == '-h' ||
                     args[2] == 'help' || args[2] == '-help' || args[2] == '/help') {
     run.help();
-} else if(reqs.run()) {
-    run.run(args);
-    process.exit(0);
 } else {
-    process.exit(2);
-}
+    reqs.run().done(function() {
+        return run.run(args);
+    }, function(err) {
+        console.error('ERROR: ' + err);
+        process.exit(2);
+    });
+}