Skip to content

Commit e25b687

Browse files
marcelduranmarcelduran
committed
renamed poll and wait (results) options
1 parent f33fde9 commit e25b687

3 files changed

Lines changed: 60 additions & 60 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
109109
* **-C, --spdy3**: force SPDY version 3 (Chrome only)
110110
* **-J, --swrender**: force software rendering, disable GPU acceleration (Chrome only)
111111
* **-Q, --noparser**: disable threaded HTML parser (Chrome only)
112-
* **--pollresults** _[interval]_: poll for results after test is scheduled at every <interval> seconds [5]
113-
* **--waitresults** _[hostname:port]_: wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
114-
* **--timeout** _\<seconds\>_: timeout for pollresults and waitresults [no timeout]
112+
* **--poll** _[interval]_: poll for results after test is scheduled at every <interval> seconds [5]
113+
* **--wait** _[hostname:port]_: wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
114+
* **--timeout** _\<seconds\>_: timeout for polling and waiting results [no timeout]
115115

116116
#### Results (works for **results** only)
117117
* **-m, --median** _\<metric\>_: set the metric used to calculate median for multiple runs tests [loadTime]
@@ -255,11 +255,11 @@ $ webpagetest waterfall 121025_PT_N8K --thumbnail --cached --uri
255255

256256
#### Run test on http://twitter.com/marcelduran and poll results every 5 seconds timing out in 60 seconds
257257
```bash
258-
$ webpagetest test http://twitter.com/marcelduran --pollresults 5 --timeout 60
258+
$ webpagetest test http://twitter.com/marcelduran --poll 5 --timeout 60
259259
```
260260
#### Or run test on http://twitter.com/marcelduran and wait for results listening on localhost\* port 8000\**
261261
```bash
262-
$ webpagetest test http://twitter.com/marcelduran --waitresults 8000
262+
$ webpagetest test http://twitter.com/marcelduran --wait 8000
263263
```
264264
```javascript
265265
{
@@ -532,7 +532,7 @@ $ npm test
532532

533533
## Changelog
534534

535-
* 0.0.4: Sync test with results via `--pollresults` or `--waitresults`
535+
* 0.0.4: Sync test with results via `--poll` or `--wait`
536536
* 0.0.3: Custom test results median metric; Custom waterfall; new Chrome test options
537537
* 0.0.2: Minor bugs; 2 new commands: testers and testinfo
538538
* 0.0.1: Initial release

‎lib/mapping.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,13 +331,13 @@ var options = {
331331
bool: true,
332332
info: 'disable threaded HTML parser (Chrome only)'
333333
},
334-
'pollresults': {
334+
'poll': {
335335
name: 'pollResults',
336336
param: 'interval',
337337
optional: true,
338338
info: 'poll for results after test is scheduled at every <interval> seconds [5]'
339339
},
340-
'waitresults': {
340+
'wait': {
341341
name: 'waitResults',
342342
param: 'hostname:port',
343343
optional: true,
@@ -346,7 +346,7 @@ var options = {
346346
'timeout': {
347347
name: 'timeout',
348348
param: 'seconds',
349-
info: 'timeout for pollresults and waitresults [no timeout]'
349+
info: 'timeout for polling and waiting results [no timeout]'
350350
}
351351
},
352352
run: {

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

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3,55 +3,55 @@
33

44
Options:
55

6-
-h, --help output usage information
7-
-k, --key <api_key> API key (if assigned). Contact the WebPageTest server administrator for a key if required
8-
-l, --location <location> location to test from
9-
-r, --runs <number> number of test runs [1]
10-
-f, --first skip the Repeat View test
11-
-L, --label <label> label for the test
12-
-p, --private keep the test hidden from the test log
13-
-v, --video capture video
14-
-y, --connectivity <profile> connectivity profile (DSL|FIOS|Dial|custom) [DSL]
15-
-m, --dom <element> DOM element to record for sub-measurement
16-
-c, --connections <number> override the number of concurrent connections
17-
-i, --onload force the test to stop at window.onload
18-
-t, --sensitive discard script and http headers in the result
19-
-b, --block <urls> space-delimited list of urls to block (substring match)
20-
-g, --login <username> username for authenticating tests (http authentication)
21-
-w, --password <password> password for authenticating tests (http authentication)
22-
-a, --authtype <type> type of authentication: 0 = Basic, 1 = SNS [0]
23-
-e, --request <id> echo request ID, useful to track asynchronous requests
24-
-n, --notify <e-mail> e-mail address to notify with the test results
25-
-B, --pingback <url> URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
26-
-D, --bwdown <bandwidth> download bandwidth in Kbps (used when specifying a custom connectivity profile)
27-
-U, --bwup <bandwidth> upload bandwidth in Kbps (used when specifying a custom connectivity profile)
28-
-Y, --latency <time> first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
29-
-P, --plr <percentage> packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
30-
-u, --tcpdump enable tcpdump capture
31-
-z, --noopt disable optimization checks (for faster testing)
32-
-I, --noimages disable screen shot capturing
33-
-H, --noheaders disable saving of the http headers (as well as browser status messages and CPU utilization)
34-
-F, --full save a full-resolution version of the fully loaded screen shot as a PNG
35-
-j, --jpeg <level> jpeg compression level (30-100) for the screen shots and video capture
36-
-S, --noscript disable javascript (IE, Chrome, Firefox)
37-
-R, --ignoressl ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
38-
-T, --standards forces all pages to load in standards mode (IE only)
39-
-O, --bodies save response bodies for text resources
40-
-K, --keepua do not add PTST to the original browser User Agent string
41-
-N, --duration <seconds> minimum test duration in seconds
42-
-A, --noads block ads defined by adblockrules.org
43-
-E, --aft (experimental) measure above-the-fold rendering time
44-
-Z, --spof <domains> space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
45-
-W, --mobile (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
46-
-M, --timeline capture Developer Tools Timeline (Chrome only)
47-
-G, --netlog capture Network Log (Chrome only)
48-
-C, --spdy3 force SPDY version 3 (Chrome only)
49-
-J, --swrender force software rendering, disable GPU acceleration (Chrome only)
50-
-Q, --noparser disable threaded HTML parser (Chrome only)
51-
--pollresults [interval] poll for results after test is scheduled at every <interval> seconds [5]
52-
--waitresults [hostname:port] wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
53-
--timeout <seconds> timeout for pollresults and waitresults [no timeout]
54-
--median <metric> set the metric used to calculate median for multiple runs tests [loadtTime]
55-
--specs <json_or_file> set the specs for performance test suite
56-
--reporter <name> set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
6+
-h, --help output usage information
7+
-k, --key <api_key> API key (if assigned). Contact the WebPageTest server administrator for a key if required
8+
-l, --location <location> location to test from
9+
-r, --runs <number> number of test runs [1]
10+
-f, --first skip the Repeat View test
11+
-L, --label <label> label for the test
12+
-p, --private keep the test hidden from the test log
13+
-v, --video capture video
14+
-y, --connectivity <profile> connectivity profile (DSL|FIOS|Dial|custom) [DSL]
15+
-m, --dom <element> DOM element to record for sub-measurement
16+
-c, --connections <number> override the number of concurrent connections
17+
-i, --onload force the test to stop at window.onload
18+
-t, --sensitive discard script and http headers in the result
19+
-b, --block <urls> space-delimited list of urls to block (substring match)
20+
-g, --login <username> username for authenticating tests (http authentication)
21+
-w, --password <password> password for authenticating tests (http authentication)
22+
-a, --authtype <type> type of authentication: 0 = Basic, 1 = SNS [0]
23+
-e, --request <id> echo request ID, useful to track asynchronous requests
24+
-n, --notify <e-mail> e-mail address to notify with the test results
25+
-B, --pingback <url> URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
26+
-D, --bwdown <bandwidth> download bandwidth in Kbps (used when specifying a custom connectivity profile)
27+
-U, --bwup <bandwidth> upload bandwidth in Kbps (used when specifying a custom connectivity profile)
28+
-Y, --latency <time> first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
29+
-P, --plr <percentage> packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
30+
-u, --tcpdump enable tcpdump capture
31+
-z, --noopt disable optimization checks (for faster testing)
32+
-I, --noimages disable screen shot capturing
33+
-H, --noheaders disable saving of the http headers (as well as browser status messages and CPU utilization)
34+
-F, --full save a full-resolution version of the fully loaded screen shot as a PNG
35+
-j, --jpeg <level> jpeg compression level (30-100) for the screen shots and video capture
36+
-S, --noscript disable javascript (IE, Chrome, Firefox)
37+
-R, --ignoressl ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
38+
-T, --standards forces all pages to load in standards mode (IE only)
39+
-O, --bodies save response bodies for text resources
40+
-K, --keepua do not add PTST to the original browser User Agent string
41+
-N, --duration <seconds> minimum test duration in seconds
42+
-A, --noads block ads defined by adblockrules.org
43+
-E, --aft (experimental) measure above-the-fold rendering time
44+
-Z, --spof <domains> space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
45+
-W, --mobile (experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
46+
-M, --timeline capture Developer Tools Timeline (Chrome only)
47+
-G, --netlog capture Network Log (Chrome only)
48+
-C, --spdy3 force SPDY version 3 (Chrome only)
49+
-J, --swrender force software rendering, disable GPU acceleration (Chrome only)
50+
-Q, --noparser disable threaded HTML parser (Chrome only)
51+
--poll [interval] poll for results after test is scheduled at every <interval> seconds [5]
52+
--wait [hostname:port] wait for test results informed by agent once complete listening on <hostname>:<port> [hostname:first port available above 8000]
53+
--timeout <seconds> timeout for polling and waiting results [no timeout]
54+
--median <metric> set the metric used to calculate median for multiple runs tests [loadtTime]
55+
--specs <json_or_file> set the specs for performance test suite
56+
--reporter <name> set performance test suite reporter output: [dot]|spec|tap|xunit|list|progress|min|nyan|landing|json|doc|markdown|teamcity
5757

0 commit comments

Comments
 (0)