k6-tools

Tools for k6 scripts.

Install

npm i @gwinkamp/k6-tools

Usage

Request headrs builder

designed for easy assembly of HTTP request headers.

import { Headers } from "@gwinkamp/k6-tools";
import http from "k6/http";

export default function() {
  const headers = new Headers();

  // add custom header
  headers.add("X-CustomHeader", "Value");

  // set Authorization header
  headers.setAuth("my-secret-token");

  // set Content-Type header
  headers.setContentType("plain/text");

  // set Content-Type header with "application/json" value
  headers.setJsonContentType();

  // set multipart/form-data Content-Type header with boundary
  headers.setFormDataContentType("test-boundary");

  const response = http.get("http://localhost:8080/get", {
    headers: headers.build()  // build headers
  });
}

Multipart form-data builder

designed for assembling multipart form-data payload of request body.

import { FormData, Headers } from "@gwinkamp/k6-tools";
import http from "k6/http";

const file = open("test.txt", "b");

export default function() {
  const headers = new Headers();
  const form = new FormData();

  // add string field to form
  form.append("param", "value");

  // add file field to form
  form.append("file", http.file(file, "test.txt"));

  // set multipart/form-data Content-Type header with boundary
  headers.setFormDataContentType(form.boundary);

  const response = http.post(
    "http://localhost:8080/post",
    form.body(),
    {
      headers: headers.build(),
    }
  );
}

URL

designed for assembling URL with query params.

import { URL } from "@gwinkamp/k6-tools";
import http from "k6/http";

export default function() {
  const url = new URL("http://localhost:8080");

  url.addParam("key1", "value1");
  url.addParam("key2", 123);
  url.addParam("key3", ["value2", "value3"]);

  // URL to be http://localhost:8080?key1=value1&key2=123&key3[]=value2&key3[]=value3
  const response = http.get(url.toString());
}

k6 utils

All methods from the k6-util library are also available. For example:

• randomIntBetween(min, max) - Random integer in a given range
• randomItem(array) - Random item from a given array
• randomString(length, [charset]) - Random string of a given length, optionally selected from a custom character set
• uuidv4() - Random UUID v4 in a string representation
• findBetween(content, left, right, [repeat]) - Extract a string between two surrounding strings

import { randomString } from "@gwinkamp/k6-tools"

export default function() {
  console.log(randomString(10));
}

Contribution

Freely. I am always glad to have suggestions