https://github.com/gpiechnik2/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.
https://github.com/gpiechnik2/xk6-proxy

extension k6 performance proxy tests xk6 xk6-extension

Last synced: about 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/gpiechnik2/xk6-proxy
• Owner: gpiechnik2
• License: apache-2.0
• Created: 2022-06-08T22:31:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-18T22:43:12.000Z (over 1 year ago)
• Last Synced: 2024-07-30T21:05:38.294Z (5 months ago)
• Topics: extension, k6, performance, proxy, tests, xk6, xk6-extension
• Language: Go
• Homepage:
• Size: 39.1 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xk6-proxy

[k6](https://github.com/grafana/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](https://github.com/grafana/xk6) system.

## Build

```shell

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.

```javascript

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.

```javascript

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

```shell

./k6 run ./script.js

```