Add restartTest command

Author: gregberge

README.md

@@ -57,6 +57,7 @@ $ webpagetest --help
 * **locations** _[options]_: list locations and the number of pending tests
 * **testers** _[options]_: list testers status and details
 * **test** _[options] \<url_or_script\>_: run test, _\<url_or_script\>_ can also be a path to a script file
+* **restart** _\<id\>_: restart test
 * **cancel** _\<id\>_: cancel running/pending test
 * **har** _\<id\>_: get the HTTP Archive (HAR) from test
 * **pagespeed** _[options] \<id\>_: get the Google Page Speed results (if available) from test
@@ -147,7 +148,7 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 * **--timeout** _\<seconds\>_: timeout for polling and waiting results [no timeout]
 * **--lighthouse**: perform lighthouse test (Chrome only, Linux agent only)
 
-#### API Key (works for **test** and **cancel** commands)
+#### API Key (works for **test**, **restart** and **cancel** commands)
 * **-k, --key** _\<api_key\>_:API key (if assigned). Contact the WebPageTest server administrator for a key if required or request an API key for limited testing at [webpagetest.org/getkey.php](https://www.webpagetest.org/getkey.php)
 
 #### Request (works for **status**, **results**, **locations**, **testers** and **test** commands)
@@ -351,6 +352,7 @@ Methods and options (including the one letter shorthands) are the same when usin
 * `getLocations(options, callback)`
 * `getTesters(options, callback)`
 * `runTest(url_or_script, options, callback)`
+* `restartTest(id, options, callback)`
 * `cancelTest(id, options, callback)`
 * `getHARData(id, options, callback)`
 * `getPageSpeedData(id, options, callback)`
@@ -475,7 +477,7 @@ wpt.runTest(script, (err, data) => {
 * **timeout**: _String_, timeout for polling and waiting results [no timeout]
 * **lighthouse**: _Boolean_, perform lighthouse test (Chrome only, Linux agent only)
 
-#### API Key (works for `runTest` and `cancelTest` methods)
+#### API Key (works for `runTest`, `restartTest` and `cancelTest` methods)
 * **key**: _String_, API key (if assigned). Contact the WebPageTest server administrator for a key if required
 
 #### Request (works for `getTestStatus` `getResults` `getLocations` `getTesters` and `runTest` methods)

lib/mapping.js

@@ -709,6 +709,12 @@ var commands = {
     info: 'run test',
     nokey: [options.results]
   },
+  'restart': {
+    name: 'restartTest',
+    param: 'id',
+    options: [options.apikey],
+    info: 'restart test'
+  },
   'cancel': {
     name: 'cancelTest',
     param: 'id',

lib/webpagetest.js

@@ -93,7 +93,7 @@ function get(config, pathname, proxy, agent, callback, encoding) {
   if (encoding !== 'binary') {
     options.headers['accept-encoding'] = 'gzip,deflate';
   }
-    
+
   if (agent) {
     options.agent = agent;
   }
@@ -472,6 +472,17 @@ function runTest(what, options, callback) {
   return api.call(this, paths.test, callback, query, options);
 }
 
+function restartTest(id, options, callback) {
+  var query = {resubmit: id};
+
+  callback = callback || options;
+  options = options === callback ? undefined : options;
+
+  helper.setQuery(mapping.commands.restart, options, query);
+
+  return api.call(this, paths.test, callback, query, options);
+}
+
 function cancelTest(id, options, callback) {
   var query = {test: id};
 
@@ -759,6 +770,7 @@ WebPageTest.prototype = {
   getLocations: getLocations,
   getTesters: getTesters,
   runTest: runTest,
+  restartTest: restartTest,
   cancelTest: cancelTest,
   getPageSpeedData: getPageSpeedData,
   getHARData: getHARData,

test/command-line-test.js

@@ -142,6 +142,24 @@ describe('WebPageTest Command Line', function() {
     });
   });
 
+  it('gets a restart test input returns the API url', function(done) {
+    exec(mock('restart 120816_V2_2'), function(err, data) {
+      if (err) return done(err);
+      data = JSON.parse(data);
+      assert.equal(data.url, wptServer + 'runtest.php?resubmit=120816_V2_2');
+      done();
+    });
+  });
+
+  it('gets a restart test with api key input returns the API url', function(done) {
+    exec(mock('restart -k 12345 120816_V2_2'), function(err, data) {
+      if (err) return done(err);
+      data = JSON.parse(data);
+      assert.equal(data.url, wptServer + 'runtest.php?resubmit=120816_V2_2&k=12345');
+      done();
+    });
+  });
+
   it('gets a cancel test input returns the API url', function(done) {
     exec(mock('cancel 120816_V2_2'), function(err, data) {
       if (err) return done(err);
@@ -306,7 +324,7 @@ describe('WebPageTest Command Line', function() {
 
   // loop all commands help
   [
-    '', 'status', 'results', 'locations', 'testers', 'test', 'cancel', 'har',
+    '', 'status', 'results', 'locations', 'testers', 'test', 'restart', 'cancel', 'har',
     'pagespeed', 'utilization', 'request', 'timeline', 'netlog', 'chrometrace',
     'console', 'testinfo', 'history', 'googlecsi', 'response', 'waterfall',
     'screenshot', 'video', 'player', 'listen', 'batch'

test/dryrun-test.js

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

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

@@ -0,0 +1,10 @@
+
+  Usage: restart [options] <id>
+
+  restart test
+
+  Options:
+
+    -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

@@ -9,6 +9,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
+    restart [options] <id>            restart test
     cancel [options] <id>             cancel running/pending test
     har <id>                          get the HTTP Archive (HAR) from test
     pagespeed [options] <id>          get the Google Page Speed results (if available) from test

test/fixtures/objects/restart.json

@@ -0,0 +1 @@
+{"testId":"120817_V2_2"}

test/fixtures/responses/restart.json

@@ -0,0 +1 @@
+{"testId":"120817_V2_2"}

test/helpers/nock-server.js

@@ -32,6 +32,7 @@ var reqResMap = {
   '/getgzip.php?test=120816_V2_2&file=1_screen.jpg': 'screenshot.jpg',
   '/thumbnail.php?test=120816_V2_2&file=1_screen.jpg&run=1&cached=0': 'screenshotThumbnail.jpg',
   '/getgzip.php?test=120816_V2_2&file=1_screen.png': 'screenshotFullResolution.png',
+  '/runtest.php?resubmit=120816_V2_2': 'restart.json',
   '/cancelTest.php?test=120816_V2_2': 'cancel.html',
   '/cancelTest.php?test=120816_V2_3': 'cancelNotCancelled.html',
   '/video/create.php?tests=130416_YS_KD4-r%3A3-c%3A1%2C130416_W6_KEE-r%3A8-c%3A1&f=json&end=visual': 'createVideo.json',