node-red/test/nodes/core/parsers/70-XML_spec.js

/**
 * Copyright JS Foundation and other contributors, http://js.foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

var should = require("should");
var xmlNode = require("nr-test-utils").require("@node-red/nodes/core/parsers/70-XML.js");
var helper = require("node-red-node-test-helper");

describe('XML node', function() {

    before(function(done) {
        helper.startServer(done);
    });

    after(function(done) {
        helper.stopServer(done);
    });

    afterEach(function() {
        helper.unload();
    });

    it('should be loaded', function(done) {
        var flow = [{id:"xmlNode1", type:"xml", name: "xmlNode" }];
        helper.load(xmlNode, flow, function() {
            var xmlNode1 = helper.getNode("xmlNode1");
            xmlNode1.should.have.property('name', 'xmlNode');
            done();
        });
    });

    it('should convert a valid xml string to a javascript object', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                msg.payload.should.have.property('employees');
                msg.payload.employees.should.have.property('firstName');
                should.equal(msg.payload.employees.firstName[0], 'John');
                msg.payload.employees.should.have.property('lastName');
                should.equal(msg.payload.employees.lastName[0], 'Smith');
                done();
            });
            var string = '  <employees><firstName>John</firstName><lastName>Smith</lastName></employees>\r\n  ';
            n1.receive({payload:string,topic: "bar"});
        });
    });

    it('should convert a valid xml string to a javascript object - alternative property', function(done) {
        var flow = [{id:"n1",type:"xml",property:"foo",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                msg.foo.should.have.property('employees');
                msg.foo.employees.should.have.property('firstName');
                should.equal(msg.foo.employees.firstName[0], 'John');
                msg.foo.employees.should.have.property('lastName');
                should.equal(msg.foo.employees.lastName[0], 'Smith');
                done();
            });
            var string = '  <employees><firstName>John</firstName><lastName>Smith</lastName></employees>\r\n ';
            n1.receive({foo:string,topic: "bar"});
        });
    });

    it('should convert a valid xml string to a javascript object with options', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                msg.payload.should.have.property('employees');
                msg.payload.employees.should.have.property('firstName');
                should.equal(msg.payload.employees.firstName[0], 'John');
                msg.payload.employees.should.have.property('lastName');
                should.equal(msg.payload.employees.lastName[0], 'Smith');
                done();
            });
            var string = '  <employees><firstName>John</firstName><lastName>Smith</lastName></employees>\r\n  ';
            n1.receive({payload:string, topic:"bar", options:{trim:true}});
        });
    });

    it('should convert a javascript object to an xml string', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                var index = msg.payload.indexOf('<employees><firstName>John</firstName><lastName>Smith</lastName></employees>');
                index.should.be.above(-1);
                done();
            });
            var obj = {"employees":{"firstName":["John"],"lastName":["Smith"] }};
            n1.receive({payload:obj,topic: "bar"});
        });
    });

    it('should convert a javascript object to an xml string with options - alternative property', function(done) {
        var flow = [{id:"n1",type:"xml",property:"foo",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                var index = msg.foo.indexOf('<employees>\n  <firstName>John</firstName>\n  <lastName>Smith</lastName>\n</employees>');
                index.should.be.above(-1);
                done();
            });
            var obj = {"employees":{"firstName":["John"],"lastName":["Smith"] }};
            n1.receive({foo:obj, topic:"bar", options:{headless:true}});
        });
    });

    it('should log an error if asked to parse an invalid xml string', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n1.receive({payload:'<not valid>',topic: "bar"});
            setTimeout(function() {
                try {
                    var logEvents = helper.log().args.filter(function(evt) {
                        return evt[0].type == "xml";
                    });
                    logEvents.should.have.length(1);
                    logEvents[0][0].should.have.a.property('msg');
                    logEvents[0][0].msg.toString().should.startWith("Error: Attribute without value");
                    done();
                } catch(err) {
                    done(err);
                }
            },200);
        });
    });

    it('should log an error if asked to parse something thats not xml or js', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n1.receive({payload:1,topic: "bar"});
            setTimeout(function() {
                try {
                    var logEvents = helper.log().args.filter(function(evt) {
                        return evt[0].type == "xml";
                    });
                    logEvents.should.have.length(1);
                    logEvents[0][0].should.have.a.property('msg',"xml.errors.xml_js");
                    done();
                } catch(err) {
                    done(err);
                }
            },200);
        });
    });

    it('should just pass through if payload is missing', function(done) {
        var flow = [{id:"n1",type:"xml",wires:[["n2"]],func:"return msg;"},
                    {id:"n2", type:"helper"}];
        helper.load(xmlNode, flow, function() {
            var n1 = helper.getNode("n1");
            var n2 = helper.getNode("n2");
            n2.on("input", function(msg) {
                msg.should.have.property('topic', 'bar');
                msg.should.not.have.property('payload');
                done();
            });
            n1.receive({topic: "bar"});
        });
    });

});