wptagentCross-platform WebPageTest agent
There are separate lines of development under different licenses (pull requests accepted to either):
master branch where most active development occurs has the Polyform Shield 1.0.0 licenseapache branch has the more permissive Apache 2.0 license-v, -vv, -vvvā¦: Increase verbosity (specify multiple times for more). -vvvv for full debug output.
--name: Agent name (defaults to the machineās hostname).
--exit: Exit after the specified number of minutes. Useful for running in a shell script that does maintenance or periodic updates (like hourly).
--dockerized: The agent is running inside a docker container.
--ec2: Load config settings from EC2 user data.
--gce: Load config settings from GCE user data.
--log: Log critical errors to the given file.
--noidle: Doesn't wait for system idle at any point.
--healthcheckport: HTTP Health check port (defaults to 8889). Set to 0 to disable. Returns 200 if the agent is running and communicating with the server, 503 otherwise.
--har : Generate a per-run HAR file as part of the test result (defaults to False).
--xvfb: Use an Xvfb virtual display for headless testing.--fps: Video capture frame rate (defaults to 10). Valid range is 1ā60.--server (required): URL for WebPageTest work. Example: https://www.webpagetest.org/work/.--location (required): Location ID (as configured in the serverās locations.ini).--validcertificate: Validate server certificates (HTTPS server, defaults to False).--key : Location key (if configured in locations.ini).--shaper: Override default traffic shaper. Supported values:
none: Disable traffic-shaping (i.e. when you canāt run as root).netem,<interface>: Use NetEm to bridge reverse-tethered traffic (specify outbound interface). Example: --shaper netem,eth0remote,<server>,<down pipe>,<up pipe>: Connect to the remote server over ssh and use preconfigured dummynet pipes. SSH keys for root user should be pre-authorized.chrome: Use Chrome DevToolsās traffic-shaping. Only for Chromium-based browsers, and as a last resort because of inaccuracy.--android: Run tests on an attached Android device.--device: Device ID, if more than one Android is attached.--gnirehtet: Use the gnirehtet tool for reverse-tethering. You will need to manually approve the vpn once per mobile device. Valid options are:
<external interface>,<dns>: e.g. --gnirehtet eth0,8.8.8.8--vpntether: (Android 7+) Use vpn-reverse-tether for reverse-tethering. You will need to manually approve the vpn once per mobile device. Valid options are:
<external interface>,<dns>: e.g. --vpntether eth0,8.8.8.8--vpntether2 (recommended): Use vpn-reverse-tether v2 for reverse-tethering. You will need to manually approve the VPN once per mobile device. Valid options:
<external interface>,<dns>: e.g. --vpntether2 eth0,8.8.8.8--simplert: Use SimpleRT for reverse-tethering. The APK should be installed manually (adb install simple-rt/simple-rt-1.1.apk) and tested once manually (./simple-rt -i eth0, then disconnect and re-connect phone) to dismiss any system dialogs. The ethernet interface and DNS server should be passed as options:
<interface>,<dns1>: i.e. --simplert eth0,8.8.8.8--rndis (deprecated): Enable reverse-tethering over rndis (Android 6+). Valid options:
--rndis <ip>/<network>,<gateway>,<dns1>,<dns2>: Static Address. e.g. --rndis 192.168.0.8/24,192.168.0.1,8.8.8.8,8.8.4.4--rndis dhcp--username: Username if using HTTP Basic Auth with WebPageTest server.--password: Password if using HTTP Basic Auth with WebPageTest server.--cert: Client certificate if using certificates to authenticate the WebPageTest server connection.--certkey: Client-side private key (if not embedded in the client certificate).The test result is written as JSON to stdout. If a server, location, and key are provided, then the test will be uploaded to the given WebPageTest server and the test ID returned in the output JSON.
--testurl: Test the given URL via the command line (required unless --testspec is provided)--testspec: Path to a full JSON file with test parameters--browser: What browser to test in (can also be specified in the JSON file)--testout: Output format fot the test result. Valid options:
id: Test ID (if tests are uploaded to a server/location)url: URL to test result (if tests are uploaded to a server/location)json: JSON-formatted raw test result--testoutdir (optional): Output directory for the raw JSON test results--testruns: Number of runs to test. Defaults to 1.--testrv: Include repeat view (defaults to only testing first view)The following Script Commands are supported on Windows, Linux, Mac, and Android:
navigateexec and execAndWaitblocksleeplogDatacombineStepssetEventNamesetUserAgentsetBrowserSize, setViewportSize, and setDeviceScaleFactorsetActivityTimeout and setTimeoutblockDomains and blockDomainsExceptsetDns and `setDnsNamesetHeader and addHeader (addHeader add multiple values for the same header, effectively the same as setHeader)resetHeaderssetCookiesetABMclick, clickAndWait, and sendClickselectValue and setValuesetInnerHTML and setInnerTextsubmitFormoverrideHostThere are no plans to implement the following Script Commands:
sendKeyDownsetDOMElementwaitForCompleteoverrideHostUrlignoreErrorslogErrors (TODO: canāt find any mention of this in this GitHub organization?)loadFileloadVariablesminIntervalendIntervalexpireCacherequiredRequestsetDOMRequestwaitForJSDone (change semantics to console.log message)if, else, and endif