README
¶
xk6-proxy
k6 extension to define a separate (independent) proxy from the HTTP_PROXY variables for HTTP requests. Additionally, the extension allows to display and re-set a new proxy in tests. Implemented using the xk6 system.
Build
xk6 build --with github.com/gpiechnik2/xk6-proxy@latest
Example
On a single request
To use the proxy on http.Request objects from the k6 repository you would have to rebuild the entire class. Since this would take too much time, we use requests from the library, which under the k6 implementation is also used. We do not return the same Response object, but instead a string with the typical response for the http format.
import proxy from 'k6/x/proxy';
export default function () {
const proxyRes = proxy.request('GET', 'https://k6.io', "http://0.0.0.0:8080", {
headers: [
{
'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:50.0) Gecko/20100101 Firefox/50.0',
'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'
}
]
});
check(proxyRes, {
'response code was 200': (proxyRes) => proxyRes.includes("200 OK") == true
});
}
On global variables
[WARNING] Remember that using global variables affects ALL runs. The example at the bottom should not be used in performing actual tests. Use only for debugging or on a single thread.
import proxy from 'k6/x/proxy';
export default function () {
let currentEnvHTTP = proxy.getCurrentEnvHTTP() // 0.0.0.0:9000
let currentEnvHTTPS = proxy.getCurrentEnvHTTPS() // 0.0.0.0:6000
proxy.setEnvHTTP('0.0.0.0:14000') // set a new HTTP_PROXY environment variable
proxy.setEnvHTTPS('0.0.0.0:10000') // set a new HTTPS_PROXY environment variable
currentEnvHTTP = proxy.getCurrentEnvHTTP() // 0.0.0.0:14000
currentEnvHTTPS = proxy.getCurrentEnvHTTPS() // 0.0.0.0:10000
}
Run sample script
./k6 run ./script.js
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Proxy ¶
type Proxy struct{}
Proxy is the k6 extension
func (*Proxy) GetCurrentEnvHTTP ¶
Get the current https proxy in use
func (*Proxy) GetCurrentEnvHTTPS ¶
Get the current http proxy in use
Source Files