[feat] Parse K6 command output from stdout

- Ignore progress updates from stdout
- Extract cloud test run urls from k6 command output

Author: DefCon-007

dist/index.js

@@ -29899,7 +29899,8 @@ const core = __importStar(__nccwpck_require__(2186));
 const glob = __importStar(__nccwpck_require__(8090));
 const child_process_1 = __nccwpck_require__(2081);
 const fs = __importStar(__nccwpck_require__(5630));
-var TEST_PIDS = [];
+const k6OutputParser_1 = __nccwpck_require__(5035);
+const TEST_PIDS = [], TEST_RESULT_URLS_MAP = {};
 run();
 /**
  * The main function for the action.
@@ -29913,7 +29914,7 @@ async function run() {
         const flags = core.getInput('flags', { required: false });
         const cloudRunLocally = core.getInput('cloud-run-locally', { required: false }) === 'true';
         const isCloud = await isCloudIntegrationEnabled();
-        const commands = testPaths.map(testPath => generateCommand(testPath));
+        const commands = testPaths.map(testPath => generateCommand(testPath)), TOTAL_TEST_RUNS = commands.length;
         if (commands.length === 0) {
             throw new Error('No test files found');
         }
@@ -30010,6 +30011,9 @@ async function run() {
                 detached: true,
                 env: process.env,
             });
+            // Parse k6 command output and extract test run URLs if running in cloud mode. 
+            // Also, print the output to the console, excluding the progress lines.
+            child.stdout?.on('data', (data) => (0, k6OutputParser_1.parseK6Output)(data, isCloud ? TEST_RESULT_URLS_MAP : null, TOTAL_TEST_RUNS));
             return child;
         }
     }
@@ -30056,6 +30060,75 @@ function isDirectory(filepath) {
 }
 
 
+/***/ }),
+
+/***/ 5035:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.parseK6Output = void 0;
+const REGEX_EXPRESSIONS = {
+    scriptPath: /^\s*script:\s*(.+)$/m,
+    output: /^\s*output:\s*(.+)$/m,
+    runningIteration: /running \(\d+m\d+\.\d+s\), \d+\/\d+ VUs, \d+ complete and \d+ interrupted iterations/g,
+    runProgress: /\[ *(\d+)% *\] *\d+ VUs *\d+(\.\d+)?s\/\d+(\.\d+)?s/g
+};
+function extractTestRunUrl(data, testResultUrlsMap) {
+    /**
+     * This function extracts the script path and output URL from the k6 output.
+     * It then adds the script path and output URL to the testResultUrlsMap which is a reference to
+     * an object passed from the main function to store test run urls mapped to corresponding test script.
+     *
+     * @param {string} data - The k6 command output data as string
+     * @param {TestResultUrlsMap} testResultUrlsMap - The map containing the script path and output URL
+     *
+     * @returns {void}
+     *
+     */
+    // Extracting the script path
+    const scriptMatch = data.match(REGEX_EXPRESSIONS.scriptPath);
+    const scriptPath = scriptMatch ? scriptMatch[1] : null;
+    // Extracting the output URL
+    const outputMatch = data.match(REGEX_EXPRESSIONS.output);
+    const output = outputMatch ? outputMatch[1] : null;
+    if (scriptPath && output) {
+        testResultUrlsMap[scriptPath] = output;
+    }
+}
+function parseK6Output(data, testResultUrlsMap, totalTestRuns) {
+    /*
+    * This function is responsible for parsing the output of the k6 command.
+    * It filters out the progress lines and logs the rest of the output.
+    * It also extracts the test run URLs from the output.
+    *
+    * @param {Buffer} data - The k6 command output data
+    * @param {TestResultUrlsMap | null} testResultUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
+    * @param {number} totalTestRuns - The total number of test runs. This is used to determine when all test run URLs have been extracted.
+    *
+    * @returns {void}
+    */
+    const dataString = data.toString(), lines = dataString.split('\n');
+    // Extract test run URLs
+    if (testResultUrlsMap && Object.keys(testResultUrlsMap).length < totalTestRuns) {
+        extractTestRunUrl(dataString, testResultUrlsMap);
+    }
+    const filteredLines = lines.filter((line) => {
+        const isRegexMatch = REGEX_EXPRESSIONS.runningIteration.test(line) || REGEX_EXPRESSIONS.runProgress.test(line);
+        return !isRegexMatch;
+    });
+    if (filteredLines.length < lines.length) {
+        // ignore empty lines only when progress lines output was ignored.
+        if (filteredLines.join("") === "") {
+            return;
+        }
+    }
+    console.log(filteredLines.join('\n'));
+}
+exports.parseK6Output = parseK6Output;
+
+
 /***/ }),
 
 /***/ 9491:

src/index.ts

@@ -2,8 +2,10 @@ import * as core from '@actions/core';
 import * as glob from '@actions/glob';
 import { spawn } from 'child_process';
 import * as fs from 'fs-extra';
+import { parseK6Output } from './k6OutputParser';
 
-var TEST_PIDS: number[] = [];
+const TEST_PIDS: number[] = [],
+    TEST_RESULT_URLS_MAP: { [key: string]: string } = {};
 
 run()
 
@@ -21,7 +23,8 @@ export async function run(): Promise<void> {
 
         const isCloud = await isCloudIntegrationEnabled()
 
-        const commands = testPaths.map(testPath => generateCommand(testPath))
+        const commands = testPaths.map(testPath => generateCommand(testPath)),
+            TOTAL_TEST_RUNS = commands.length;
         if (commands.length === 0) {
             throw new Error('No test files found')
         }
@@ -119,7 +122,10 @@ export async function run(): Promise<void> {
                 detached: true,
                 env: process.env,
             });
-
+            // Parse k6 command output and extract test run URLs if running in cloud mode. 
+            // Also, print the output to the console, excluding the progress lines.
+            child.stdout?.on('data', (data) => parseK6Output(data, isCloud ? TEST_RESULT_URLS_MAP : null, TOTAL_TEST_RUNS));  
+            
             return child;
         }
     } catch (error) {

src/k6OutputParser.ts

@@ -0,0 +1,71 @@
+import { TestResultUrlsMap } from './types';
+
+const REGEX_EXPRESSIONS = {
+    scriptPath: /^\s*script:\s*(.+)$/m,
+    output: /^\s*output:\s*(.+)$/m,
+    runningIteration: /running \(\d+m\d+\.\d+s\), \d+\/\d+ VUs, \d+ complete and \d+ interrupted iterations/g,
+    runProgress: /\[ *(\d+)% *\] *\d+ VUs *\d+(\.\d+)?s\/\d+(\.\d+)?s/g
+};
+
+
+function extractTestRunUrl(data: string, testResultUrlsMap: TestResultUrlsMap): void {
+    /**
+     * This function extracts the script path and output URL from the k6 output.
+     * It then adds the script path and output URL to the testResultUrlsMap which is a reference to 
+     * an object passed from the main function to store test run urls mapped to corresponding test script.
+     * 
+     * @param {string} data - The k6 command output data as string
+     * @param {TestResultUrlsMap} testResultUrlsMap - The map containing the script path and output URL
+     * 
+     * @returns {void}
+     * 
+     */
+
+    // Extracting the script path
+    const scriptMatch = data.match(REGEX_EXPRESSIONS.scriptPath);
+    const scriptPath = scriptMatch ? scriptMatch[1] : null;
+
+    // Extracting the output URL
+    const outputMatch = data.match(REGEX_EXPRESSIONS.output);
+    const output = outputMatch ? outputMatch[1] : null;
+
+    if (scriptPath && output) {
+        testResultUrlsMap[scriptPath] = output;
+    }
+}
+
+
+export function parseK6Output(data: Buffer, testResultUrlsMap: TestResultUrlsMap | null, totalTestRuns: number): void {
+    /*
+    * This function is responsible for parsing the output of the k6 command. 
+    * It filters out the progress lines and logs the rest of the output.
+    * It also extracts the test run URLs from the output.
+    * 
+    * @param {Buffer} data - The k6 command output data
+    * @param {TestResultUrlsMap | null} testResultUrlsMap - The map containing the script path and output URL. If null, the function will not extract test run URLs.
+    * @param {number} totalTestRuns - The total number of test runs. This is used to determine when all test run URLs have been extracted.
+    * 
+    * @returns {void}
+    */ 
+
+    const dataString = data.toString(),
+        lines = dataString.split('\n');
+    
+    // Extract test run URLs
+    if (testResultUrlsMap && Object.keys(testResultUrlsMap).length < totalTestRuns) {
+        extractTestRunUrl(dataString, testResultUrlsMap);
+    }
+
+    const filteredLines = lines.filter((line) => {
+        const isRegexMatch = REGEX_EXPRESSIONS.runningIteration.test(line) || REGEX_EXPRESSIONS.runProgress.test(line);
+        return !isRegexMatch;
+    });
+
+    if (filteredLines.length < lines.length) {
+        // ignore empty lines only when progress lines output was ignored.
+        if (filteredLines.join("") === "") {
+            return;
+        }
+    }
+    console.log(filteredLines.join('\n'))
+}

src/types.ts

@@ -0,0 +1,3 @@
+export type TestResultUrlsMap = {
+    [key: string]: string;
+};