PiratProxies

Automation and testing

Sending WebdriverIO traffic through a proxy

WebdriverIO runs browser tests through WebDriver. The browser takes a proxy host and port in its capabilities, but there is no place for a username and password.

The right proxy type for WebdriverIO

Residential proxies suit automation that acts like a visitor, with a sticky session for anything that logs in. For testing your own site from other countries, any plan with the right country works; Residential Lite is the cheapest.

The values to enter in WebdriverIO

Every PiratProxies plan comes down to four values: host, port, username and password. Here they are for Residential; your own username and password are on your plan page.

Hostresi.piratproxies.com
HTTP port8080
SOCKS5 port1080
UsernameUSERNAME
Passwordshown on your plan page

There is no separate country or session field: both are part of the username. Your plan page has a generator that writes it, and Targeting and sessions describes each piece.

Setting it up in WebdriverIO

  1. Start a local forwarder that adds the login: gost -L=:8899 -F=http://USERNAME:PASSWORD@resi.piratproxies.com:8080.
  2. Point the browser at the forwarder in the capabilities.

Code: WebdriverIO through a proxy

wdio.conf.js

capabilities: [{
  browserName: 'chrome',
  proxy: { proxyType: 'manual', httpProxy: '127.0.0.1:8899', sslProxy: '127.0.0.1:8899' },
}],

Put your own login from the plan page in place of USERNAME and PASSWORD. The example calls an IP-check service, so what it prints is the address your request came from.

Should WebdriverIO rotate IPs or keep one?

When WebdriverIO plays one visitor across several steps, a sticky session keeps the IP address unchanged from start to finish. When every run stands alone, drop the session and each run begins from a new address.

Here is what a sticky username looks like:

USERNAME-country-us-time-600-session-a1b2c3d4

When WebdriverIO will not connect

  • A local forwarder that adds the login solves this. See proxies with a login in tools that only take IP and port.
  • Error 407 means the login was refused. Copy the username and password from your plan page once more, and make sure no space crept in and the username was not cut short.
  • An IP in the wrong country nearly always comes from the username, since the country code lives there. Other fixes.

WebdriverIO and proxies: questions

Can WebdriverIO use a SOCKS5 proxy?

Only without a login: WebdriverIO cannot send a SOCKS5 username and password. Use the HTTP port, 8080, instead; it handles http and https sites alike.

Which PiratProxies plan suits WebdriverIO best?

Residential proxies suit automation that acts like a visitor, with a sticky session for anything that logs in. For testing your own site from other countries, any plan with the right country works; Residential Lite is the cheapest.

Words used in this guide: headless browser, rotating proxy, sticky session, proxy authentication.

WebdriverIO belongs to its own developers, and PiratProxies has no connection with them; we name it only to say what this guide covers. Follow the rules of the sites you visit and our acceptable use policy.