@cuppet/core 1.2.0 → 1.2.2

package/features/app/mqttManager.js

@@ -249,6 +249,35 @@ class MqttManager {
         });
     }
 
+    /** Wait for specific message on a topic with timeout. IMPORTANT: Message is position,case and whitespace sensitive.
+     * @param {string} topic - Topic to wait for message on
+     * @param {string} message - Message to wait for
+     * @param {number} timeoutSeconds - Timeout in seconds
+     * @returns {Promise<Object>} - Resolves with message when received
+     */
+    async waitForSpecificMessage(topic, message, timeoutSeconds = 10) {
+        const timeoutMs = timeoutSeconds * 1000;
+        const startTime = Date.now();
+
+        while (Date.now() - startTime < timeoutMs) {
+            const latestMessage = this.getLatestMessage(topic);
+            if (latestMessage) {
+                const latestMessageString = JSON.stringify(latestMessage.message);
+                const expectedMessageString = JSON.stringify(message);
+                if (latestMessageString === expectedMessageString) {
+                    return latestMessage;
+                } else {
+                    throw new Error(
+                        `Message: ${latestMessageString} on topic ${topic} does not match expected: ${expectedMessageString}`
+                    );
+                }
+            }
+            await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+
+        throw new Error(`Timeout waiting for message on topic: ${topic} after ${timeoutSeconds} seconds`);
+    }
+
     /**
      * Check if client is connected
      * @returns {boolean}

package/features/app/stepDefinitions/helperSteps.js

@@ -77,3 +77,8 @@ Given('I switch back to original window', async function () {
 Given('I switch to {string} tab', async function (tabNumber) {
     this.page = await helper.switchToTab(this.browser, tabNumber);
 });
+
+Then('I generate UUID and store it in {string} variable', async function (variable) {
+    const uuid = helper.generateRandomUuid();
+    await dataStorage.iStoreVariableWithValueToTheJsonFile(uuid, variable);
+});

package/features/app/stepDefinitions/mqttSteps.js

@@ -69,6 +69,20 @@ Then('I should receive a message on MQTT topic {string}', async function (topic)
     await mqttFunctions.validateMessageReceived(this.mqttManager, topic, 10);
 });
 
+/**
+ * Wait for a specific message on a topic with timeout
+ * @example Then I should receive the message "Hello World" on MQTT topic "test/response" within 5 seconds
+ */
+Then(
+    'I should receive the message {string} on MQTT topic {string} within {int} seconds',
+    async function (message, topic, timeout) {
+        await mqttFunctions.waitForSpecificMessage(this.mqttManager, topic, message, timeout);
+    }
+);
+
+Then('I should receive the message {string} on MQTT topic {string}', async function (message, topic) {
+    await mqttFunctions.waitForSpecificMessage(this.mqttManager, topic, message, 10);
+});
 /**
  * Validate the content of the latest message on a topic
  * @example Then the MQTT message on topic "test/echo" should equal "Hello World"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cuppet/core",
-    "version": "1.2.0",
+    "version": "1.2.2",
     "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
     "main": "index.js",
     "files": [
@@ -44,6 +44,7 @@
         "pa11y": "^9.0.0",
         "pa11y-reporter-html": "^2.0.0",
         "puppeteer": "^24.0.1",
+        "uuid": "^13.0.0",
         "webdriverio": "9.12.7",
         "xml2js": "^0.6.2"
     },

package/src/helperFunctions.js

@@ -4,6 +4,8 @@
  * @typedef {import('puppeteer').Browser} Browser
  */
 const config = require('config');
+const { v4: uuidv4 } = require('uuid');
+
 module.exports = {
     /**
      * Waits for a keypress event to continue the test execution.
@@ -32,6 +34,15 @@ module.exports = {
             .substring(2, length + 2);
     },
 
+    /**
+     * Generate random v4 UUID
+     * @example 123e4567-e89b-12d3-a456-426614174000
+     * @returns {string}
+     */
+    generateRandomUuid: function () {
+        return uuidv4();
+    },
+
     /**
      * Iterate through  json object and return the value of specific property
      * @param object - the json object to iterate through

package/src/mqttFunctions.js

@@ -98,6 +98,20 @@ module.exports = {
         return await mqttManager.waitForMessage(resolvedTopic, timeoutSeconds);
     },
 
+    /**
+     * Wait for a specific message on a topic with timeout
+     * @param {object} mqttManager - MQTT manager instance
+     * @param {string} topic - Topic to wait for message on
+     * @param {string} message - Message to wait for
+     * @param {number} timeoutSeconds - Timeout in seconds
+     * @returns {Promise<Object>} - Message object
+     */
+    waitForSpecificMessage: async function (mqttManager, topic, message, timeoutSeconds = 10) {
+        const resolvedTopic = await this.prepareTopic(topic);
+        const resolvedMessage = await this.prepareMessage(message);
+        return await mqttManager.waitForSpecificMessage(resolvedTopic, resolvedMessage, timeoutSeconds);
+    },
+
     /**
      * Get the latest message from a topic
      * @param {object} mqttManager - MQTT manager instance