runTest: Run test

In johndharrison/webpagetestr: `WebPageTest` API wrapper for R

Description

Run test

Usage

runTest(server, urlOrScript, key = Sys.getenv("WPTKEY"), location,
  connectivity = NULL, runs = NULL, firstViewOnly = FALSE,
  video = FALSE, private = FALSE, label = NULL,
  stopAtDocumentComplete = FALSE, disableJavaScript = FALSE,
  clearCerts = FALSE, ignoreSSL = FALSE, disableCompatibilityView = FALSE,
  tcpDump = FALSE, saveResponseBodies = FALSE,
  keepOriginalUserAgent = FALSE, domElement = NULL,
  minimumDuration = NULL, tester = NULL, emulateMobile = FALSE,
  timeline = FALSE, timelineCallStack = NULL, chromeTrace = FALSE,
  netLog = FALSE, dataReduction = FALSE, userAgent = NULL,
  commandLine = NULL, login = NULL, password = NULL, sensitive = FALSE,
  disableHTTPHeaders = FALSE, block = NULL, spof = NULL,
  customMetrics = NULL, authenticationType = NULL, notifyEmail = NULL,
  pingback = NULL, bandwidthDown = NULL, bandwidthUp = NULL,
  latency = NULL, packetLossRate = NULL, disableOptimization = FALSE,
  disableScreenshot = FALSE, fullResolutionScreenshot = FALSE,
  jpegQuality = NULL, medianVideo = FALSE, htmlBody = FALSE,
  tsView = NULL, tsViewConfigs = NULL, affinity = NULL, priority = NULL,
  blockAds = FALSE, continuousVideoCapture = FALSE, forceSpdy3 = FALSE,
  forceSoftwareRendering = FALSE, requestId = NULL, breakDown = FALSE,
  domains = FALSE, pageSpeed = FALSE, requests = FALSE,
  medianMetric = NULL, medianRun = NULL, dryRun = FALSE, ...)

Arguments

server	A WebPagetest server
urlOrScript	URL or script string
key	API key (if assigned). Contact the WebPageTest server administrator for a key if required
location	location to test from
connectivity	connectivity profile. One of (Cable|DSL|FIOS|Dial|3G|3GFast|Native|custom). Defaults to cable.
runs	number of test runs. Defaults to NULL = 1L run
firstViewOnly	skip the Repeat View test. Defaults to FALSE.
video	capture video. Defaults to FALSE.
private	keep the test hidden from the test log. Defaults to FALSE
label	label for the test
stopAtDocumentComplete	stop test at document complete. typically, tests run until all activity stops
disableJavaScript	disable javascript (IE, Chrome, Firefox)
clearCerts	clear SSL certificate caches
ignoreSSL	ignore SSL certificate errors, e.g. name mismatch, self-signed certificates, etc
disableCompatibilityView	forces all pages to load in standards mode (IE only)
tcpDump	capture network packet trace (tcpdump)
saveResponseBodies	save response bodies for text resources
keepOriginalUserAgent	do not add PTST to the original browser User Agent string
domElement	DOM element to record for sub-measurement
minimumDuration	minimum test duration in seconds
tester	run the test on a specific PC (name must match exactly or the test will not run)
emulateMobile	(experimental) emulate mobile browser: Chrome mobile user agent, 640x960 screen, 2x scaling and fixed viewport (Chrome only)
timeline	capture Developer Tools Timeline (Chrome only)
timelineCallStack	set between 1-5 to include the JS call stack. must be used in conjunction with timeline (increases overhead) (Chrome only)
chromeTrace	capture chrome trace (about://tracing) (Chrome only)
netLog	capture Network Log (Chrome only)
dataReduction	enable data reduction on Chrome 34+ Android (Chrome only)
userAgent	custom user agent string (Chrome only)
commandLine	use a list of custom command line switches (Chrome only)
login	username for authenticating tests (http authentication)
password	password for authenticating tests (http authentication)
sensitive	discard script and http headers in the result
disableHTTPHeaders	disable saving of the http headers (as well as browser status messages and CPU utilization)
block	chracter vector of urls to block (substring match)
spof	chracter vector of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
customMetrics	execute arbitrary javascript at the end of a test to collect custom metrics
authenticationType	type of authentication: 0 = Basic, 1 = SNS [0]
notifyEmail	e-mail address to notify with the test results
pingback	URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
bandwidthDown	download bandwidth in Kbps (used when specifying a custom connectivity profile)
bandwidthUp	upload bandwidth in Kbps (used when specifying a custom connectivity profile)
latency	first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
packetLossRate	packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
disableOptimization	disable optimization checks (for faster testing)
disableScreenshot	disable screen shot capturing
fullResolutionScreenshot	save a full-resolution version of the fully loaded screen shot as a PNG
jpegQuality	jpeg compression level (30-100) for the screen shots and video capture
medianVideo	store the video from the median run when capturing video is enabled
htmlBody	save the content of only the base HTML response
tsView	test name to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)
tsViewConfigs	configs to use when submitting results to tsviewdb (for private instances that have integrated with tsviewdb)
affinity	string to hash test to a specific test agent. tester will be picked by index among available testers
priority	change test priority (0-9) [enforced by API key, otherwise 5]
blockAds	block ads defined by adblockrules.org
continuousVideoCapture	capture video continuously (unstable/experimental, may cause tests to fail)
forceSpdy3	force SPDY version 3 (Chrome only)
forceSoftwareRendering	force software rendering, disable GPU acceleration (Chrome only)
requestId	request ID, useful to track asynchronous requests
breakDown	include the breakdown of requests and bytes by mime type. Defaults to NULL = FALSE
domains	include the breakdown of requests and bytes by domain. Defaults to NULL = FALSE
pageSpeed	logical value include the PageSpeed score in the response (may be slower). Defaults to NULL = FALSE
requests	include the request data in the response (slower and results in much larger responses). Defaults to NULL = FALSE
medianMetric	A string. Set the metric used to calculate median for multiple runs tests. Defaults to "loadTime" = NULL. Other options include "visualComplete", "SpeedIndex", "titleTime", "domTime", "docTime", "fullyLoaded", "render", "TTFB"
medianRun	set the run used for median for multiple runs tests. Defaults to "median = NULL. Other acceptable values include "fastest".
dryRun	If TRUE just return the RESTful API URL. Defaults to FALSE
...	Additonal function arguments

Value

a list of results

Examples

## Not run: 
  WPT <- server()
  har <- runTest(WPT, location = "someLoc")

## End(Not run)

johndharrison/webpagetestr documentation built on May 19, 2019, 5:14 p.m.