Fixes to k6 scripts (#568)

- Update threshold to use checks metrics instead of errors
- Simplified the stopInterationOnFail method and updated call points.

test/k6/readme.md

@@ -1,21 +1,17 @@
-## k6 test project for automated tests
+# Automated tests using k6
 
-# Getting started
-
-
-Install pre-requisites
-## Install k6
+## Install prerequisites
 
 *We recommend running the tests through a docker container.*
 
 From the command line:
 
-> docker pull grafana/k6
-
+```
+docker pull grafana/k6
+```
 
 Further information on [installing k6 for running in docker is available here.](https://k6.io/docs/get-started/installation/#docker)
 
-
 Alternatively, it is possible to run the tests directly on your machine as well.
 
 [General installation instructions are available here.](https://k6.io/docs/get-started/installation/)
@@ -25,32 +21,38 @@ Alternatively, it is possible to run the tests directly on your machine as well.
 
 All tests are defined in `src/tests` and in the top of each test file an example of the cmd to run the test is available.
 
-The command should be run from the root of the k6 folder.
+The command should be run from the k6 folder.
 
->$> cd /altinn-notifications/test/k6
+```
+$> cd /altinn-notifications/test/k6
+```
 
 Run test suite by specifying filename.
 
 For example:
 
- >$> podman compose run k6 run /src/tests/orders_email.js `
-    -e tokenGeneratorUserName=autotest `
+ ```
+ $> podman compose run k6 run /src/tests/orders_email.js `
+    -e tokenGeneratorUserName=*** `
     -e tokenGeneratorUserPwd=*** `
     -e env=*** `
-    -e toAddress=*** `
+    -e emailRecipient=*** `
+    -e ninRecipient=*** `
     -e runFullTestSet=true
+```
 
-The comand consists of three sections
+The command consists of three parts
 
 `podman compose run` to run the test in a docker container
 
-`k6 run {path to test file}` pointing to the test file you want to run e.g. `/src/tests/orders_email.js.js`
+`k6 run {path to test file}` pointing to the test file you want to run e.g. `/src/tests/orders_email.js`
 
+The last part is all script parameters provided as environment variables for the container.
 ```
- -e tokenGeneratorUserName=autotest
+ -e tokenGeneratorUserName=***
  -e tokenGeneratorUserPwd=***
  -e env=***
- -e toAddress=***
+ -e emailRecipient=***
+ -e ninRecipient=***
  -e runFullTestSet=true
 ````
- all environment variables that should be included in the request.

test/k6/src/api/authentication.js

@@ -5,7 +5,7 @@ import {
   buildHeaderWithBearer
 } from "../apiHelpers.js";
 import { platformAuthentication } from "../config.js";
-import { stopIterationOnFail, addErrorCount } from "../errorhandler.js";
+import { stopIterationOnFail } from "../errorhandler.js";
 
 
 export function exchangeToAltinnToken(token, test) {
@@ -17,12 +17,8 @@ export function exchangeToAltinnToken(token, test) {
     "// Setup // Authentication towards Altinn 3 Success": (r) =>
       r.status === 200,
   });
-  addErrorCount(success);
-  stopIterationOnFail(
-    "// Setup // Authentication towards Altinn 3  Failed",
-    success,
-    res
-  );
+
+  stopIterationOnFail("// Setup // Authentication towards Altinn 3  Failed", success);
 
   return res.body;
 }

test/k6/src/api/maskinporten.js

@@ -7,7 +7,7 @@ import KJUR from "https://unpkg.com/[email protected]/lib/jsrsasign.js";
 
 import { buildHeaderWithContentType}  from "../apiHelpers.js";
 import * as config from "../config.js";
-import { stopIterationOnFail, addErrorCount } from "../errorhandler.js";
+import { stopIterationOnFail } from "../errorhandler.js";
 
 const encodedJwk = __ENV.encodedJwk;
 const mpClientId = __ENV.mpClientId;
@@ -40,12 +40,8 @@ export function generateAccessToken(scopes) {
     "// Setup // Authentication towards Maskinporten Success": (r) =>
       r.status === 200,
   });
-  addErrorCount(success);
-  stopIterationOnFail(
-    "// Setup // Authentication towards Maskinporten Failed",
-    success,
-    res
-  );
+
+  stopIterationOnFail("// Setup // Authentication towards Maskinporten Failed", success);
 
   let accessToken = JSON.parse(res.body)['access_token'];
   return accessToken;

test/k6/src/api/token-generator.js

@@ -37,7 +37,7 @@ function generateToken(endpoint) {
   var response = http.get(endpoint, params);
 
   if (response.status != 200) {
-    stopIterationOnFail("Token generation failed", false, response);
+    stopIterationOnFail("Token generation failed", false);
   }
 
   var token = response.body;

test/k6/src/errorhandler.js

@@ -1,25 +1,12 @@
-import { Counter } from "k6/metrics";
 import { fail } from "k6";
 
-let ErrorCount = new Counter("errors");
-
-//Adds a count to the error counter when value of success is false
-export function addErrorCount(success) {
-  if (!success) {
-    ErrorCount.add(1);
-  }
-}
-
 /**
  * Stops k6 iteration when success is false and prints test name with response code
- * @param {String} testName
- * @param {boolean} success
- * @param {JSON} res
+ * @param {String} failReason The reason for stopping the tests
+ * @param {boolean} success The result of a check
  */
-export function stopIterationOnFail(testName, success, res) {
-  if (!success && res != null) {
-    fail(testName + ": Response code: " + res.status + ". Response message: " + res.body);
-  } else if (!success) {
-    fail(testName);
+export function stopIterationOnFail(failReason, success) {
+  if (!success) {
+    fail(failReason);
   }
 }