added key option to cancel method

Author: marcelduran

lib/mapping.js

@@ -21,13 +21,6 @@ var options = {
     }
   },
   test: {
-    'key': {
-      name: 'key',
-      key: 'k',
-      api: 'k',
-      param: 'api_key',
-      info: 'API key (if assigned). Contact the WebPageTest server administrator for a key if required'
-    },
     'location': {
       name: 'location',
       key: 'l',
@@ -536,6 +529,15 @@ var options = {
       invert: true,
       info: 'hide labels for requests (URL) [false]'
     }
+  },
+  'apikey': {
+    'key': {
+      name: 'key',
+      key: 'k',
+      api: 'k',
+      param: 'api_key',
+      info: 'API key (if assigned). Contact the WebPageTest server administrator for a key if required'
+    }
   }
 };
 
@@ -565,13 +567,14 @@ var commands = {
   'test': {
     name: 'runTest',
     param: 'url_or_script',
-    options: [options.test, options.request, options.results],
+    options: [options.apikey, options.test, options.request, options.results],
     info: 'run test',
     nokey: [options.results]
   },
   'cancel': {
     name: 'cancelTest',
     param: 'id',
+    options: [options.apikey],
     info: 'cancel running/pending test'
   },
   'har': {

lib/webpagetest.js

@@ -399,10 +399,14 @@ function runTest(what, options, callback) {
 }
 
 function cancelTest(id, options, callback) {
+  var query = {test: id};
+
   callback = callback || options;
   options = options === callback ? undefined : options;
 
-  return api.call(this, paths.cancel, callback, {test: id}, options);
+  helper.setQuery(mapping.commands.cancel, options, query);
+
+  return api.call(this, paths.cancel, callback, query, options);
 }
 
 function getPageSpeedData(id, options, callback) {

test/command-line-test.js

@@ -149,6 +149,15 @@ describe('WebPageTest Command Line', function() {
     });
   });
 
+  it('gets a cancel test with api key input returns the API url', function(done) {
+    exec(mock('cancel -k 12345 120816_V2_2'), function(err, data) {
+      if (err) return done(err);
+      data = JSON.parse(data);
+      assert.equal(data.url, wptServer + 'cancelTest.php?test=120816_V2_2&k=12345');
+      done();
+    });
+  });
+
   it('gets a page speed data input returns the API url', function(done) {
     exec(mock('pagespeed 120816_V2_2'), function(err, data) {
       if (err) return done(err);

test/dryrun-test.js

@@ -162,6 +162,14 @@ describe('Dry Run', function() {
       });
     });
 
+    it('gets a cancel test with api key request', function(done) {
+      wpt.cancelTest('120816_V2_2', {key: '12345', dryRun: true}, function (err, data) {
+        if (err) return done(err);
+        assert.equal(data.url, wptServer + 'cancelTest.php?test=120816_V2_2&k=12345');
+        done();
+      });
+    });
+
     it('gets page speed data request', function(done) {
       wpt.getPageSpeedData('120816_V2_2', {dryRun: true}, function (err, data) {
         if (err) return done(err);

test/fixtures/command-line/help-cancel.txt

@@ -3,5 +3,6 @@
 
   Options:
 
-    -h, --help  output usage information
+    -h, --help           output usage information
+    -k, --key <api_key>  API key (if assigned). Contact the WebPageTest server administrator for a key if required
 

test/fixtures/command-line/help.txt

@@ -8,7 +8,7 @@
     locations [options]    list locations and the number of pending tests
     testers [options]      list testers status and details
     test [options] <url_or_script> run test
-    cancel <id>            cancel running/pending test
+    cancel [options] <id>  cancel running/pending test
     har <id>               get the HTTPS Archive (HAR) from test
     pagespeed [options] <id> get the Google Page Speed results (if available) from test
     utilization [options] <id> get the CPU, bandwidth and memory utilization data from test