Fix K6 summary handling

Author: elsand

.github/workflows/action-run-k6-tests.yml

@@ -21,6 +21,9 @@ on:
 jobs:
   k6-test:
     runs-on: ubuntu-latest
+    permissions:
+      checks: write
+      pull-requests: write
 
     steps:
     - name: Checkout code
@@ -30,7 +33,7 @@ jobs:
       uses: grafana/k6-action@v0.3.1
       with:
         filename: ${{ inputs.testSuitePath }}
-        #flags: --quiet --log-output=stdout --include-system-env-vars
+        flags: --quiet --log-output=stdout --include-system-env-vars
       env:
         API_ENVIRONMENT: ${{ inputs.environment }}
         API_VERSION: ${{ inputs.apiVersion }}
@@ -41,9 +44,11 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: k6-summary-report
-        path: summary.json
+        path: junit.xml
 
     - name: 'Publish test results'
       uses: EnricoMi/publish-unit-test-result-action@v2
+      if: always()
       with:
-        junit_files: 'junit.xml'
+        files: |
+          junit.xml

tests/k6/common/report.js

@@ -1,64 +1,33 @@
-export { textSummary } from 'https://jslib.k6.io/k6-summary/0.0.1/index.js';
+export { textSummary } from 'https://jslib.k6.io/k6-summary/0.1.0/index.js';
 
-let replacements = {
-    '&': '&',
-    '<': '&lt;',
-    '>': '&gt;',
-    "'": '&#39;',
-    '"': '&quot;',
-};
+export function generateJUnitXML(k6Json) {
+    const xmlDoc = [];
+    xmlDoc.push('<?xml version="1.0" encoding="UTF-8" ?>');
+    xmlDoc.push('<testsuites>');
 
-function escapeHTML(str) {
-    return str.replace(/[&<>'"]/g, function (char) {
-        return replacements[char];
-    });
-}
+    function processGroup(group) {
+        if (group.name) { // skip root group
+            xmlDoc.push(`<testsuite name="${group.name}" tests="${group.checks.length}">`);
 
-/**
- * Generate a junit xml string from the summary of a k6 run considering each checks as a test case
- * @param {*} data
- * @param {String} suiteName Name of the test ex., filename
- * @returns junit xml string
- */
-export function generateJUnitXML(data, suiteName) {
+            group.checks.forEach(check => {
+                let failed = check.fails > 0 ;
+                xmlDoc.push(`<testcase classname="${group.name}" name="${check.name}">`);
+                if (failed) {
+                    xmlDoc.push(`<failure message="Check failed. See output K6 task for more details.">${check.name}</failure>`);
+                }
+                xmlDoc.push('</testcase>');
+            });
+        }
 
-    let failures = 0;
-    let cases = [];
-    let time = (data.state.testRunDurationMs) / 1000;
-    let checks = [];
-    if (data.root_group.checks.length > 0) {
-        checks = data.root_group.checks;
-    } else if (data.root_group.hasOwnProperty('groups') && data.root_group.groups.length > 0) {
-        let groups = data.root_group.groups;
-        groups.forEach((group) => {
-            if (group.groups.length > 0) {
-                let subGroups = group.groups;
-                subGroups.forEach((subGroup) => {
-                    subGroup.checks.forEach((check) => {
-                        checks.push(check);
-                    });
-                });
-            } else {
-                group.checks.forEach((check) => {
-                    checks.push(check);
-                });
-            }
+        group.groups.forEach(subGroup => {
+            processGroup(subGroup);
         });
+
+        xmlDoc.push('</testsuite>');
     }
-    checks.forEach((check) => {
-        if (check.passes >= 1 && check.fails === 0) {
-            cases.push(`<testcase classname="${escapeHTML(check.name)}" name="${escapeHTML(check.name)}" time="0"/>`);
-        } else {
-            failures++;
-            let errmsg = "See the output of the &quot;Run K6&quot; step to see more details";
-            cases.push(`<testcase classname="${escapeHTML(check.name)}" name="${escapeHTML(check.name)}" time="0"><failure message="${errmsg}"/></testcase>`);
-        }
-    });
 
-    return (
-        `<?xml version="1.0" encoding="UTF-8" ?>\n` +
-        `<testsuites>\n` +
-        `<testsuite package="${escapeHTML(suiteName)}" name="${escapeHTML(suiteName)}" id="0" tests="${cases.length}" failures="${failures}" time="${time}">\n` +
-        `${cases.join('\n')}\n</testsuite>\n</testsuites>`
-    );
+    processGroup(k6Json.root_group);
+
+    xmlDoc.push('</testsuites>');
+    return xmlDoc.join('\n');
 }

tests/k6/common/summary.js

@@ -3,7 +3,8 @@ import { generateJUnitXML, textSummary } from "./report.js";
 export default function (data) {
     return {
         'stdout': textSummary(data, { indent: ' ', enableColors: true }) + "\n",
-        'summary.json': JSON.stringify(data),
-        'junit.xml': generateJUnitXML(data, 'dialogporten')
+        //'summary.txt': textSummary(data, { indent: ' ', enableColors: false }) + "\n",
+        //'summary.json': JSON.stringify(data),
+        'junit.xml': generateJUnitXML(data)
     };
 }

tests/k6/suites/createremove-perf-10-vus-1-min.js

@@ -1,4 +1,5 @@
 import { default as run, setup as testSetup } from "../tests/serviceowner/performance/createremove-no-delay.js";
+import { default as summary } from "../common/summary.js";
 export let options = {
     vus: 10,  // Number of virtual users
     duration: '1m',  // Test duration
@@ -9,3 +10,7 @@ export function setup() {
 }
 
 export default function (data) { run(data); }
+
+export function handleSummary(data) {
+    return summary(data);
+}