Custom Sauce Labs WebDriver Extensions for Network and Log Commands

To enable networking capabilities for tests and generate custom log files, use these Sauce Labs options for the Selenium JavaScript Executor and our extended debugging features. You can find more examples of this feature written in Node.js, Python, and Java on GitHub.

You must have Extended Debugging enabled to use these commands.

See the following sections for more information:

Test Environment Tools

Test Environment Tools simulate network conditions and manipulate network requests to analyze and improve test performance. 

Intercept Network Requests

Allows modification of requests made by the browser. You can alter these as your tests require:

• Blacklist requests to 3rd party vendors
• Modify requests to REST API (Mock REST API response)
• Redirect certain parts of the app 
• Insert or change headers

driver.execute_script('sauce:intercept', {
    "url": "https://saucelabs.com",
    "redirect": "https://google.com"
})

driver.execute_script("sauce:intercept", {
	"url": "http://sampleapp.appspot.com/api/todos",
        "response": {
            "headers": {
                "x-custom-header": "foobar"
            },
            "body": [{
                "title": "Hello",
                "order": 1,
                "completed": false,
                "url": "http://todo-backend-express.herokuapp.com/15727"
            }]
        }
    })

driver.execute_script("sauce:intercept", {
	"url": "https://saucecon.com/wp-content/uploads/2017/07/SauceCon-hero-img-100-2.jpg",
    error: "Failed"}

Network Intercept Example

driver.execute_script('sauce:intercept', {
    "url": "https://saucelabs.com",
    "redirect": "https://google.com"
})
# or
driver.execute_script('sauce:intercept', {
    "url": "https://saucelabs.com/res7/v1/build/32hmv4j32v4j2j3v4j24v232vj4j",
    "response": {
        "statusCode": 200,
        "headers": {
            "etag": 3244224432,
            "Cookie: "foo=bar",
            ...
        },
        "rawResponse": "{\"username\":\"..."
    }
})

Throttle CPU Capabilities

Mobile devices have less CPU power than most desktops and laptops (or a VM's default configuration). You can use CPU Throttling to simulate how your app will run on slower systems, helping you identify possible performance issues.

driver.execute_script('sauce:throttleCPU', {
	"rate": 4
})

Throttle Network Capabilities

With network conditioning you can test your site on a variety of network connections, including Edge, 3G, and even offline. You can throttle the data throughput, including the maximum download and upload throughput, and use latency manipulation to enforce a minimum delay in connection round-trip time (RTT).

driver.execute_script('sauce:throttleNetwork', {
	"condition": "GPRS"
})
# or
driver.execute_script('sauce:throttleNetwork', {
	"condition": {
		"download": 1000,
		"upload": 500,
		"latency": 40
    }
})

Strings

online

No Restrictions

No Restrictions

No Restrictions

Custom objects

You can create custom network conditions with objects. You must define the download speed (in bytes/second), upload speed (in bytes/second), and latency (in milliseconds) for the custom condition, as shown in the example.

Extended Debugging Tools

Extended Debugging Tools provide additional logs to analyze test performance. 

Network Log

The Sauce Labs network log records all network requests being made by the page currently open in the browser.

[{
    "url": "http://saucelabs.com/beta/dashboard",
    "statusCode": 200,
    "method": "GET",
    "requestHeaders": {
        ...
    },
    "responseHeaders": {
        ...
    },
    "timing": {
        "blocked": -1,
        "connect": -1,
        "dns": -1,
        "receive": 0,
        "send": 0,
        "ssl": -1,
        "wait": 0
    }
}, {
    ...
}]

Performance Log

The Sauce Labs performance log contains performance-related metrics.

{
  "load": 1083,
  "speedIndex": 905,
  "firstInteractive": 1073,
  "firstVisualChange": 576,
  "lastVisualChange": 1243,
  "firstMeaningfulPaint": 1239,
  "firstCPUIdle": 1239,
  "timeToFirstByte": 69,
  "firstPaint": 559,
  "estimatedInputLatency": 16,
  "firstContentfulPaint": 630,
  "score": 0.9947067807295903,
  "domContentLoaded": 1073
}