Create a k6 load test

Author: nodeexx

.eslintrc.cjs

@@ -62,7 +62,7 @@ module.exports = {
       rules: {},
     },
     {
-      files: ['**/*.cjs'],
+      files: ['**/*.cjs', '**/*.js'],
       rules: {
         '@typescript-eslint/no-var-requires': 'off',
       },

scripts/testing/load/commands/run-sh.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -eu
+
+docker container run \
+    --name "graphana-k6" \
+    --interactive \
+    --tty \
+    --rm \
+    --user "k6" \
+    --workdir "/home/k6" \
+    --volume "${PWD}:/home/k6" \
+    --entrypoint "/bin/sh" \
+    "grafana/k6:0.49.0"

scripts/testing/load/commands/run.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -eu
+
+docker container run \
+    --name "graphana-k6" \
+    --interactive \
+    --tty \
+    --rm \
+    --user "root" \
+    --workdir "/home/k6" \
+    --volume "${PWD}:/home/k6" \
+    "grafana/k6:0.49.0" \
+    $@

scripts/testing/load/tests/_template.test.js

@@ -0,0 +1,63 @@
+// @ts-expect-error
+import http from 'k6/http';
+// @ts-expect-error
+import { sleep } from 'k6';
+
+export const options = {
+  // A number specifying the number of VUs to run concurrently.
+  vus: 10,
+  // A string specifying the total duration of the test run.
+  duration: '30s',
+
+  // The following section contains configuration options for execution of this
+  // test script in Grafana Cloud.
+  //
+  // See https://grafana.com/docs/grafana-cloud/k6/get-started/run-cloud-tests-from-the-cli/
+  // to learn about authoring and running k6 test scripts in Grafana k6 Cloud.
+  //
+  // ext: {
+  //   loadimpact: {
+  //     // The ID of the project to which the test is assigned in the k6 Cloud UI.
+  //     // By default tests are executed in default project.
+  //     projectID: "",
+  //     // The name of the test in the k6 Cloud UI.
+  //     // Test runs with the same name will be grouped.
+  //     name: "script.js"
+  //   }
+  // },
+
+  // Uncomment this section to enable the use of Browser API in your tests.
+  //
+  // See https://grafana.com/docs/k6/latest/using-k6-browser/running-browser-tests/ to learn more
+  // about using Browser API in your test scripts.
+  //
+  // scenarios: {
+  //   // The scenario name appears in the result summary, tags, and so on.
+  //   // You can give the scenario any name, as long as each name in the script is unique.
+  //   ui: {
+  //     // Executor is a mandatory parameter for browser-based tests.
+  //     // Shared iterations in this case tells k6 to reuse VUs to execute iterations.
+  //     //
+  //     // See https://grafana.com/docs/k6/latest/using-k6/scenarios/executors/ for other executor types.
+  //     executor: 'shared-iterations',
+  //     options: {
+  //       browser: {
+  //         // This is a mandatory parameter that instructs k6 to launch and
+  //         // connect to a chromium-based browser, and use it to run UI-based
+  //         // tests.
+  //         type: 'chromium',
+  //       },
+  //     },
+  //   },
+  // }
+};
+
+// The function that defines VU logic.
+//
+// See https://grafana.com/docs/k6/latest/examples/get-started-with-k6/ to learn more
+// about authoring k6 scripts.
+//
+export default function () {
+  http.get('https://test.k6.io');
+  sleep(1);
+}

scripts/testing/load/tests/load-1.test.js

@@ -0,0 +1,47 @@
+// @ts-expect-error
+import http from 'k6/http';
+// @ts-expect-error
+import { check, sleep } from 'k6';
+// @ts-expect-error
+import { Rate } from 'k6/metrics';
+// @ts-expect-error
+import { htmlReport } from 'https://raw.githubusercontent.com/benc-uk/k6-reporter/main/dist/bundle.js';
+
+// Define the failure rate
+let failureRate = new Rate('failed_requests');
+
+export let options = {
+  stages: [
+    { duration: '10s', target: 10 }, // ramp up to 5 requests per second over 10 seconds
+    { duration: '10s', target: 10 }, // stay at 5 requests per second for 10 seconds
+    { duration: '10s', target: 1 }, // ramp down to 1 request per second over 10 seconds
+  ],
+  thresholds: {
+    'http_req_duration{scenario:default}': ['p(95)<5000'], // Test fails if 95th percentile of request durations is higher than 5 seconds
+    failed_requests: ['rate<0.01'], // Fail if more than 1% of requests fail
+  },
+};
+
+export default function () {
+  let response = http.get('http://staging-code-snippet-sharing.nodeexx.com');
+
+  // Check each response for a 200 status code
+  const checkRes = check(response, {
+    // @ts-expect-error
+    'status is 200': (r) => r.status === 200,
+  });
+
+  // Track the failed requests
+  failureRate.add(!checkRes);
+
+  // Since the test doesn't precisely control the request rate to exactly match the target,
+  // sleeping for a short duration helps to regulate the execution pace.
+  sleep(1);
+}
+
+// @ts-expect-error
+export function handleSummary(data) {
+  return {
+    'summary.html': htmlReport(data),
+  };
+}

tsconfig.json

@@ -26,7 +26,7 @@
     "./.*.ts",
     "./scripts/app/**/*.js",
     "./scripts/stack/**/*.js",
-    "./scripts/ci/**/*.js"
+    "./scripts/testing/**/*.js"
   ],
   "compilerOptions": {
     "useDefineForClassFields": true,