@cuppet/core 1.3.0 → 1.3.2

package/README.md

@@ -132,8 +132,8 @@ For a detailed configuration and step definitions guide, see [GUIDE.MD](./GUIDE.
 
 This package requires the following peer dependencies:
 
-- `@cucumber/cucumber` ^11.0.0
-- `config` ^3.3.9
+- `@cucumber/cucumber` ^12.0.0
+- `config` ^4.1.0
 
 Make sure to install these in your project:
 

package/features/app/stepDefinitions/mqttSteps.js

@@ -27,6 +27,11 @@ When('I unsubscribe from MQTT topic {string}', async function (topic) {
     await mqttFunctions.unsubscribeFromTopic(this.mqttManager, topic);
 });
 
+When('I prepare MQTT message as JSON', async function (docString) {
+    const message = JSON.stringify(docString);
+    await mqttFunctions.prepareMessage(message, true);
+});
+
 /**
  * Publish a message to an MQTT topic
  * @example When I publish "Hello World" to MQTT topic "test/message"
@@ -53,7 +58,15 @@ When(
  * @example When I publish JSON '{"temperature": 25, "humidity": 60}' to MQTT topic "sensors/room1"
  */
 When('I publish JSON {string} to MQTT topic {string}', async function (jsonMessage, topic) {
-    await mqttFunctions.publishJsonMessage(this.mqttManager, jsonMessage, topic, 0, false);
+    await mqttFunctions.publishJsonMessage(this.mqttManager, topic, jsonMessage);
+});
+
+/**
+ * Publish an already prepared JSON message to an MQTT topic
+ * @example When I publish the prepared JSON message to MQTT topic "sensors/room1"
+ */
+When('I publish the prepared JSON message to MQTT topic {string}', async function (topic) {
+    await mqttFunctions.publishJsonMessage(this.mqttManager, topic);
 });
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cuppet/core",
-    "version": "1.3.0",
+    "version": "1.3.2",
     "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
     "main": "index.js",
     "files": [

package/src/dataStorage.js

@@ -126,6 +126,9 @@ module.exports = {
         const regex = /%([^%]+)%/g;
         const allVariables = this.getJsonFile();
         // The convention dictates if function argument is not used, it can be replaced by "_".
+        if (typeof text !== 'string') {
+            throw new Error(`The value passed to checkForMultipleVariables is not a string: ${text}`);
+        }
         const result = text.replace(regex, (_, group) => {
             return allVariables[group];
         });

package/src/mqttFunctions.js

@@ -7,6 +7,9 @@ const helper = require('./helperFunctions');
  * Provides core MQTT testing operations following the same pattern as Puppeteer and Appium functions
  */
 module.exports = {
+    /** @type {Object} */
+    messageObject: null,
+
     /**
      * Prepare topic by replacing variables
      * @param {string} topic - Topic with potential variables
@@ -21,8 +24,17 @@ module.exports = {
      * @param {string} message - Message with potential variables
      * @returns {Promise<string>} - Resolved message
      */
-    prepareMessage: async function (message) {
-        return await storage.checkForMultipleVariables(message);
+    prepareMessage: async function (message, json = false) {
+        const resolvedMessage = await storage.checkForMultipleVariables(message);
+        if (json) {
+            try {
+                this.messageObject = JSON.parse(resolvedMessage);
+                return this.messageObject;
+            } catch (error) {
+                throw new Error(`Invalid JSON message: ${error.message}`);
+            }
+        }
+        return resolvedMessage;
     },
 
     /**
@@ -66,23 +78,17 @@ module.exports = {
     /**
      * Publish a JSON message to a topic
      * @param {object} mqttManager - MQTT manager instance
-     * @param {string} jsonString - JSON string to publish
      * @param {string} topic - Topic to publish to
+     * @param {string} jsonString - JSON string to publish
      * @param {number} qos - Quality of Service level
      * @param {boolean} retain - Whether to retain the message
      * @returns {Promise<void>}
      */
-    publishJsonMessage: async function (mqttManager, jsonString, topic, qos = 0, retain = false) {
+    publishJsonMessage: async function (mqttManager, topic, jsonString = null, qos = 0, retain = false) {
         const resolvedTopic = await this.prepareTopic(topic);
-        const resolvedJson = await this.prepareMessage(jsonString);
-
-        // Validate JSON
-        try {
-            JSON.parse(resolvedJson);
-        } catch (error) {
-            throw new Error(`Invalid JSON message: ${error.message}`);
-        }
-
+        const resolvedJson = jsonString ? await this.prepareMessage(jsonString, true) : this.messageObject;
+        // Delete the message object before the message is published to avoid conflicts if the request fails.
+        delete this.messageObject;
         await mqttManager.publish(resolvedTopic, resolvedJson, { qos, retain });
     },