@gregoriusrippenstein/erlang-red-unittest 0.15.2 → 0.20.0

package/nodes/ut-assert-debug.js

@@ -4,42 +4,64 @@ module.exports = function(RED) {
 
     var node = this;
     var cfg = config;
+    
+    var testFailed = (msgstr) => {
+      node.status({ fill: "red", shape: "ring", text: RED._("ut-assert-debug.status.failed") });
+      RED.comms.publish("unittesting:testresults", { flowid: node.z, status: "failed" })
+      // sending a message to the debug panel will faile because the node isn't part 
+      // of the workspace, hence use `log` instead of `error`.
+      node.log(`FAILED [${node.z}] Assert Debug '${msgstr}'`)
+    }
 
-    node.on('close', function (removed, done) {
-      if (removed) {
-        node.status({});
+    var testSucceed = () => {
+      node.status({ fill: "green", shape: "dot", text: RED._("ut-assert-debug.status.succeed") })
+      setTimeout(() => { node.status({}); }, 1000)      
+    }
+
+    var handler = (msg) => {
+      // msg has to be debug and also originating from the node we've been configured to check
+      if (msg.topic != "debug" || cfg.scope.indexOf(msg.data.id) < 0) { return }
+
+      node.context().set("receivedmsg", true)
+
+      // set status according to .... settings
+      if (cfg.inverse) {
+        testFailed("recevied debug message where none was expected")
       } else {
-        // use node.log(..) here because node.error(..) sends a message to the debug
-        // panel but that errors out because the frontend can't find the workspace:
-        //    Uncaught TypeError: can't access property "label", RED.nodes.workspace(...) is undefined
-        // that has follow-on effects.
-        node.log(`UNSUPPORTED [${node.z}] debug is not supported`)
+        if ( (cfg.msgtype == "warning" && msg.data.level == 30) 
+          || (cfg.msgtype == "error" && msg.data.level == 20)
+          || (cfg.msgtype == "normal" && !msg.data.level) ) {
+          testSucceed()
+        } else {
+          testFailed(`debug message type did not match ${cfg.msgtype} != ${msg.data.level}`)
+        }
       }
-      done()
-    });
 
-    /* msg handler, in this case pass the message on unchanged */
-    node.on("input", function(msg, send, done) {
-      // How to send a status update
-      node.status({ fill: "green", shape: "ring", text: RED._("ut-assert-debug.label.statusset") });
-      setTimeout(() => { node.status({}); }, 1000)
-      
-      // Send a message and how to handle errors.
-      try {
-        try {
-          send(msg);
-          done();
-        } catch ( err ) {
-          // use node.error if the node might send subsequent messages
-          node.error("error occurred", { ...msg, error: err })
-          done();
+      node.send(msg)
+    }
+
+    node.context().set("receivedmsg", false)
+    require("@node-red/util").events.on('comms', handler)
+
+    node.on('close', function (removed, done) {
+      if (removed) {
+        // This node has been disabled/deleted
+        let receivedmsg = (node.context().get("receivedmsg") ?? false)
+        if (!receivedmsg) {
+          if (!cfg.inverse) {
+            testFailed("expected debug message but none received")
+          } else {
+            testSucceed()
+          }
         }
-      } catch (err) {
-        // use done if the node won't send anymore messages for the
-        // message it received.
-        msg.error = err
-        done(err.message, msg)
+      } else {
+        // This node is being restarted
+        node.status({})
+        node.context().set("receivedmsg", false)
       }
+      
+      require("@node-red/util").events.off("comms", handler)
+      done();
     });
   }
 
@@ -55,7 +77,7 @@ RED.httpAdmin.get("/UnitTesting/:flowid/runtest",
     // API defined here --> https://github.com/node-red/node-red/blob/master/packages/node_modules/%40node-red/runtime/lib/index.js
     const runtime = require("@node-red/runtime");
 
-    let testDir = path.resolve(path.dirname(__filename), "..", "testflows")
+    let testDir = path.resolve(path.dirname(__filename), "..", "examples")
 
     // if a test generates an uncaught exception, then captcha that and generate
 // a failure - tests are considered failed if they generate uncaught exceptions/errors.
@@ -376,7 +398,7 @@ RED.httpAdmin.get("/UnitTesting/:flowid/retrieve",
     const path = require('path');
     const fs = require('fs')
 
-    let fileName = path.resolve(path.dirname(__filename), "..", "testflows", req.params.flowid, "flows.json")
+    let fileName = path.resolve(path.dirname(__filename), "..", "examples", req.params.flowid, "flows.json")
     const data = fs.readFileSync(fileName);
 
     try {
@@ -399,7 +421,7 @@ RED.httpAdmin.get("/UnitTesting/tests.json",
     const path = require('path');
     const fs = require('fs')
 
-    let testDir = path.resolve(path.dirname(__filename), "..", "testflows")
+    let testDir = path.resolve(path.dirname(__filename), "..", "examples")
 
     fs.globSync(`${testDir}/**/*.json`).forEach(filename => {
       let details = path.parse(filename)

package/nodes/ut-assert-status.html

@@ -1,14 +1,6 @@
 <script type="text/javascript">
   (function(){
   
-
-  function frontendSupportFunction() {
-  }
-
-  var functTwo = (arg) => {
-
-  };
-  
   RED.nodes.registerType('ut-assert-status',{
     color: '#C0DEED',
     icon: "font-awesome/fa-window-minimize",
@@ -18,9 +10,19 @@
       name: {
         value:"",
       },
+      
+      scope: {
+        value: null,
+        type: "*[]",
+        required: true,
+        validate: function (v) {
+          if (!v) { return false }
+          return Array.isArray(v) && v.length > 0
+        }
+      },
+
       nodeid: {
         value: "",
-        required: true
       },
       content: {
         value: "",
@@ -41,26 +43,34 @@
 
     inputs: 0,
 
-    outputs: 0,
+    outputs: 1,
 
     label: function() {
-      if ( this.nodeid && !this.name) {
-        let nodeLabel = `[${this.nodeid}]`;
-        let node = RED.nodes.node(this.nodeid)
+      if (this.nodeid && (!this.scope || !this.scope[0])) {
+        this.scope = [this.nodeid]
+      }
+
+      if (this.scope && this.scope[0] && !this.name) {
+        let nodeLabel = `[${this.scope[0]}]`;
+        let node = RED.nodes.node(this.scope[0])
         if (node) {
           nodeLabel = RED.utils.getNodeLabel(node)
         }
-        
-        if ( this.inverse )  {
-          return `Assert No Status for ${nodeLabel}`
+
+        if (this.inverse) {
+          return `Assert No Status from ${nodeLabel}`
         } else {
-          return `Assert Status for ${nodeLabel}: ${this.colour} ${this.shape}`
+          return `Assert Status of ${this.msgtype} for ${nodeLabel}`
         }
       } else { return (this.name || this._def.paletteLabel) }
     },
 
     labelStyle: function() {
-      return (this.name || this.nodeid) ? "node_label_italic" : "";
+      if (this.nodeid && (!this.scope || !this.scope[0])) {
+        this.scope = [this.nodeid]
+      }
+
+      return (this.name || (this.scope && this.scope[0])) ? "node_label_italic" : "";      
     },
 
     onpaletteadd: function() {
@@ -125,7 +135,7 @@
           nodeid: nde.id,
           node: nde,
           sublabel: nde.type,
-          selected: nde.id == this.nodeid,
+          selected: this.scope && this.scope.indexOf(nde.id) > -1,
           checkbox: false,
           radio: true,
           children: undefined
@@ -139,7 +149,11 @@
     },
 
     oneditsave: function() {
-      this.nodeid = $("#node-input-assert-status-target-container-div").treeList('selected').nodeid;
+      if ($("#node-input-assert-status-target-container-div").treeList('selected').nodeid) {
+        this.scope = [$("#node-input-assert-status-target-container-div").treeList('selected').nodeid]
+      } else {
+        this.scope = []
+      }
     },
 
     oneditresize: function(size) {

package/nodes/ut-assert-status.js

@@ -5,42 +5,73 @@ module.exports = function(RED) {
     var node = this;
     var cfg = config;
 
-    node.on('close', function(removed, done) {
-      if ( removed) {
-        node.status({});
+    var testFailed = (msgstr) => {
+      node.status({ fill: "red", shape: "ring", text: RED._("ut-assert-status.status.failed") });
+      RED.comms.publish("unittesting:testresults", { flowid: node.z, status: "failed" })
+      // sending a message to the debug panel will faile because the node isn't part 
+      // of the workspace, hence use `log` instead of `error`.
+      node.log(`FAILED [${node.z}] Assert Status '${msgstr}'`)
+    }
+
+    var testSucceed = () => {
+      node.status({ fill: "green", shape: "dot", text: RED._("ut-assert-status.status.succeed") })
+      setTimeout(() => { node.status({}); }, 1000)
+    }
+
+    var handler = (msg) => {
+      if ((cfg.scope || [cfg.nodeid]).indexOf(msg.id) < 0) { return }
+
+      // ignore status resets - these are when status is undefined or is empty `{}`
+      if (!msg.status || (typeof msg.status == "object" && Object.keys(msg.status).length == 0)) { return }
+
+      node.context().set("receivedmsg", true)
+
+      if (cfg.inverse) {
+        testFailed("received status where none was expected")
       } else {
-        // use node.log(..) here because node.error(..) sends a message to the debug
-        // panel but that errors out because the frontend can't find the workspace:
-        //    Uncaught TypeError: can't access property "label", RED.nodes.workspace(...) is undefined
-        // that has follow-on effects.
-        node.log(`UNSUPPORTED [${node.z}] status is not supported`)
+        if ((cfg.colour == msg.status.fill) && (cfg.shape == msg.status.shape) ) {
+          if (cfg.content) {
+            if (cfg.content == msg.status.text) {
+              testSucceed()
+            } else {
+              testFailed(`content mismatch: '${cfg.content}' != '${msg.status.text}'`)
+            }
+          } else {
+            testSucceed()
+          }
+        } else {
+          testFailed(`shape/colour mismatch: expected ${cfg.colour},${cfg.shape} got ${msg.status.fill},${msg.status.shape}`)
+        }
       }
-      done()
-    });
 
-    /* msg handler, in this case pass the message on unchanged */
-    node.on("input", function(msg, send, done) {
-      // How to send a status update
-      node.status({ fill: "green", shape: "ring", text: RED._("ut-assert-status.label.statusset") });
-      setTimeout(() => { node.status({}); }, 1000)
+      node.send(msg)
+    }
+
+    node.context().set("receivedmsg", false)
+    require("@node-red/util").events.on('node-status', handler)
 
-      // Send a message and how to handle errors.
-      try {
-        try {
-          send(msg);
-          done();
-        } catch ( err ) {
-          // use node.error if the node might send subsequent messages
-          node.error("error occurred", { ...msg, error: err })
-          done();
+    node.on('close', function (removed, done) {
+      if (removed) {
+        // This node has been disabled/deleted
+        let receivedmsg = (node.context().get("receivedmsg") ?? false)
+        
+        if (!receivedmsg) {
+          if (!cfg.inverse) {
+            testFailed("expected status message but none received")
+          } else {
+            testSucceed()
+          }
         }
-      } catch (err) {
-        // use done if the node won't send anymore messages for the
-        // message it received.
-        msg.error = err
-        done(err.message, msg)
+      } else {
+        // This node is being restarted
+        node.status({})
+        node.context().set("receivedmsg", false)
       }
+
+      require("@node-red/util").events.off("node-status", handler)
+      done();
     });
+
   }
 
   RED.nodes.registerType("ut-assert-status", Coreut_assert_statusFunctionality);

package/nodes/ut-assert-success.js

@@ -33,6 +33,7 @@ module.exports = function (RED) {
           node.log(`FAILED [${node.z}] assert success node failed: ${cfg.count} ${cfg.msglimit} ${node.context().get("msgcnt") || 0}`)
         }
       } else {
+        // node was restarted
         node.status({});
       }
 

package/nodes/ut-assert-values.js

@@ -12,19 +12,6 @@ module.exports = function(RED) {
     //
     //
 
-
-    /*
-    * Note to self: getMessageProperty(..) and getObjectProperty(...) only differ in that
-    * getMessageProperty will remove any 'msg.' prefix from the property name. This is not
-    * the case here since we're using the Node-RED inbuilt helpers for setting values.
-    * --> here: https://github.com/node-red/node-red/blob/0f653ed7b2640feba8885e48b9448df7d42acaf0/packages/node_modules/%40node-red/util/lib/util.js#L397-L402
-    *
-    *
-    * from --> https://github.com/node-red/node-red/blob/0f653ed7b2640feba8885e48b9448df7d42acaf0/packages/node_modules/%40node-red/util/lib/util.js#L407-L418
-    *
-    *  getObjectProperty will return undefined if a property isn't set.
-    */
-
     var sendToDebug = (nde,rule,msgc,lvl) => {
      try {
       let msg = {
@@ -102,6 +89,7 @@ module.exports = function(RED) {
           }
         } 
       } else {
+        // node was restarted
         node.status({});
         node.context().set("succeed", false)
         node.context().set("received_message", false)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/erlang-red-unittest",
-  "version": "0.15.2",
+  "version": "0.20.0",
   "dependencies": {
   },