/** * 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 fs = require('fs-extra'); var path = require('path'); var sinon = require('sinon'); var inherits = require("util").inherits; var NR_TEST_UTILS = require("nr-test-utils"); var index = NR_TEST_UTILS.require("@node-red/runtime/lib/nodes/index"); var flows = NR_TEST_UTILS.require("@node-red/runtime/lib/flows"); var registry = NR_TEST_UTILS.require("@node-red/registry") var Node = NR_TEST_UTILS.require("@node-red/runtime/lib/nodes/Node"); describe("red/nodes/index", function() { before(function() { sinon.stub(index,"startFlows"); process.env.NODE_RED_HOME = NR_TEST_UTILS.resolve("node-red"); process.env.foo="bar"; }); after(function() { index.startFlows.restore(); delete process.env.NODE_RED_HOME; delete process.env.foo; }); afterEach(function() { index.clearRegistry(); }); var testFlows = [{"type":"test","id":"tab1","label":"Sheet 1"}]; var testCredentials = {"tab1":{"b":1, "c":"2", "d":"$(foo)"}}; var storage = { getFlows: function() { return Promise.resolve({red:123,flows:testFlows,credentials:testCredentials}); }, saveFlows: function(conf) { should.deepEqual(testFlows, conf.flows); return Promise.resolve(123); } }; var settings = { available: function() { return false }, get: function() { return false } }; var EventEmitter = require('events').EventEmitter; var runtime = { settings: settings, storage: storage, log: {debug:function() {}, warn:function() {}, _: function() {}}, events: new EventEmitter() }; function TestNode(n) { this._flow = {getSetting: p => process.env[p]}; index.createNode(this, n); this.on("log", function() { // do nothing }); } it('nodes are initialised with credentials',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { var testnode = new TestNode({id:'tab1',type:'test',name:'barney'}); testnode.credentials.should.have.property('b',1); testnode.credentials.should.have.property('c',"2"); testnode.credentials.should.have.property('d',"bar"); done(); }).catch(function(err) { done(err); }); }); it('flows should be initialised',function(done) { index.init(runtime); index.loadFlows().then(function() { // console.log(testFlows); // console.log(index.getFlows()); should.deepEqual(testFlows, index.getFlows().flows); done(); }).catch(function(err) { done(err); }); }); describe("registerType", function() { describe("logs deprecated usage", function() { before(function() { sinon.stub(registry,"registerType"); }); after(function() { registry.registerType.restore(); }); it("called without node-set name", function() { var runtime = { settings: settings, storage: storage, log: {debug:function() {}, warn:sinon.spy()}, events: new EventEmitter() } index.init(runtime); index.registerType(/*'test-node-set',*/'test', TestNode, {}); runtime.log.warn.called.should.be.true(); registry.registerType.called.should.be.true(); registry.registerType.firstCall.args[0].should.eql(''); registry.registerType.firstCall.args[1].should.eql('test'); registry.registerType.firstCall.args[2].should.eql(TestNode); }); }); describe("extends constructor with Node constructor", function() { var TestNodeConstructor; before(function() { sinon.stub(registry,"registerType"); }); after(function() { registry.registerType.restore(); }); beforeEach(function() { TestNodeConstructor = function TestNodeConstructor() {}; var runtime = { settings: settings, storage: storage, log: {debug:function() {}, warn:sinon.spy()}, events: new EventEmitter() } index.init(runtime); }) it('extends a constructor with the Node constructor', function() { TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node); index.registerType('node-set','node-type',TestNodeConstructor); TestNodeConstructor.prototype.should.be.an.instanceOf(Node); }); it('does not override a constructor prototype', function() { function Foo(){}; inherits(TestNodeConstructor,Foo); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); TestNodeConstructor.prototype.should.not.be.an.instanceOf(Node); index.registerType('node-set','node-type',TestNodeConstructor); TestNodeConstructor.prototype.should.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); index.registerType('node-set','node-type2',TestNodeConstructor); TestNodeConstructor.prototype.should.be.an.instanceOf(Node); TestNodeConstructor.prototype.should.be.an.instanceOf(Foo); }); }); describe("register credentials definition", function() { var http = require('http'); var express = require('express'); var app = express(); var runtime = NR_TEST_UTILS.require("@node-red/runtime"); var credentials = NR_TEST_UTILS.require("@node-red/runtime/lib/nodes/credentials"); var localfilesystem = NR_TEST_UTILS.require("@node-red/runtime/lib/storage/localfilesystem"); var log = NR_TEST_UTILS.require("@node-red/util").log; var RED = NR_TEST_UTILS.require("node-red/lib/red.js"); var userDir = path.join(__dirname,".testUserHome"); before(function(done) { sinon.stub(log,"log").callsFake(function(){}); fs.remove(userDir,function(err) { fs.mkdir(userDir,function() { sinon.stub(index, 'load').callsFake(function() { return new Promise(function(resolve,reject){ resolve([]); }); }); sinon.stub(localfilesystem, 'getCredentials').callsFake(function() { return new Promise(function(resolve,reject) { resolve({"tab1":{"b":1,"c":2}}); }); }) ; RED.init(http.createServer(function(req,res){app(req,res)}), {userDir: userDir}); runtime.start().then(function () { done(); }); }); }); }); after(function(done) { fs.remove(userDir,function() { runtime.stop().then(function() { index.load.restore(); localfilesystem.getCredentials.restore(); log.log.restore(); done(); }); }); }); it('definition defined',function() { index.registerType('test-node-set','test', TestNode, { credentials: { foo: {type:"test"} } }); var testnode = new TestNode({id:'tab1',type:'test',name:'barney', '_alias':'tab1'}); index.getCredentialDefinition("test").should.have.property('foo'); }); }); describe("register settings definition", function() { beforeEach(function() { sinon.stub(registry,"registerType"); }) afterEach(function() { registry.registerType.restore(); }) it('registers valid settings',function() { var runtime = { settings: settings, storage: storage, log: {debug:function() {}, warn:function() {}}, events: new EventEmitter() } runtime.settings.registerNodeSettings = sinon.spy(); index.init(runtime); index.registerType('test-node-set','test', TestNode, { settings: { testOne: {} } }); runtime.settings.registerNodeSettings.called.should.be.true(); runtime.settings.registerNodeSettings.firstCall.args[0].should.eql('test'); runtime.settings.registerNodeSettings.firstCall.args[1].should.eql({testOne: {}}); }); it('logs invalid settings',function() { var runtime = { settings: settings, storage: storage, log: {debug:function() {}, warn:sinon.spy()}, events: new EventEmitter() } runtime.settings.registerNodeSettings = function() { throw new Error("pass");} index.init(runtime); index.registerType('test-node-set','test', TestNode, { settings: { testOne: {} } }); runtime.log.warn.called.should.be.true(); }); }); }); describe('allows nodes to be added/removed/enabled/disabled from the registry', function() { var randomNodeInfo = {id:"5678",types:["random"]}; beforeEach(function() { sinon.stub(registry,"getNodeInfo").callsFake(function(id) { if (id == "test") { return {id:"1234",types:["test"]}; } else if (id == "doesnotexist") { return null; } else { return randomNodeInfo; } }); sinon.stub(registry,"disableNode").callsFake(function(id) { return Promise.resolve(randomNodeInfo); }); }); afterEach(function() { registry.getNodeInfo.restore(); registry.disableNode.restore(); }); it('allows an unused node type to be disabled',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { return index.disableNode("5678").then(function(info) { registry.disableNode.calledOnce.should.be.true(); registry.disableNode.calledWith("5678").should.be.true(); info.should.eql(randomNodeInfo); done(); }); }).catch(function(err) { done(err); }); }); it('prevents disabling a node type that is in use',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { /*jshint immed: false */ (function() { index.disabledNode("test"); }).should.throw(); done(); }).catch(function(err) { done(err); }); }); it('prevents disabling a node type that is unknown',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { /*jshint immed: false */ (function() { index.disableNode("doesnotexist"); }).should.throw(); done(); }).catch(function(err) { done(err); }); }); }); describe('allows modules to be removed from the registry', function() { var randomNodeInfo = {id:"5678",types:["random"]}; var randomModuleInfo = { name:"random", nodes: [randomNodeInfo] }; before(function() { sinon.stub(registry,"getNodeInfo").callsFake(function(id) { if (id == "node-red/foo") { return {id:"1234",types:["test"]}; } else if (id == "doesnotexist") { return null; } else { return randomNodeInfo; } }); sinon.stub(registry,"getModuleInfo").callsFake(function(module) { if (module == "node-red") { return {nodes:[{name:"foo"}]}; } else if (module == "doesnotexist") { return null; } else { return randomModuleInfo; } }); sinon.stub(registry,"removeModule").callsFake(function(id) { return randomModuleInfo; }); }); after(function() { registry.getNodeInfo.restore(); registry.getModuleInfo.restore(); registry.removeModule.restore(); }); it('prevents removing a module that is in use',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { /*jshint immed: false */ (function() { index.removeModule("node-red"); }).should.throw(); done(); }).catch(function(err) { done(err); }); }); it('prevents removing a module that is unknown',function(done) { index.init(runtime); index.registerType('test-node-set','test', TestNode); index.loadFlows().then(function() { /*jshint immed: false */ (function() { index.removeModule("doesnotexist"); }).should.throw(); done(); }).catch(function(err) { done(err); }); }); }); });