/** * 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 sinon = require("sinon"); var path = require("path"); var NR_TEST_UTILS = require("nr-test-utils"); var localfilesystem = NR_TEST_UTILS.require("@node-red/registry/lib/localfilesystem"); var resourcesDir = path.resolve(path.join(__dirname,"resources","local")); var userDir = path.resolve(path.join(__dirname,"resources","userDir")); var moduleDir = path.resolve(path.join(__dirname,"resources","local","TestNodeModule")); var i18n = NR_TEST_UTILS.require("@node-red/util").i18n; describe("red/nodes/registry/localfilesystem",function() { beforeEach(function() { stubs.push(sinon.stub(i18n,"registerMessageCatalog").callsFake(function() { return Promise.resolve(); })); }) var stubs = []; afterEach(function() { while(stubs.length) { stubs.pop().restore(); } }) function checkNodes(nodes,shouldHaveNodes,shouldNotHaveNodes,module) { for (var i=0;i<shouldHaveNodes.length;i++) { nodes.should.have.a.property(shouldHaveNodes[i]); nodes[shouldHaveNodes[i]].should.have.a.property('file'); nodes[shouldHaveNodes[i]].file.should.equal(path.resolve(nodes[shouldHaveNodes[i]].file)); nodes[shouldHaveNodes[i]].should.have.a.property('module',module||'node-red'); nodes[shouldHaveNodes[i]].should.have.a.property('name',shouldHaveNodes[i]); } for (i=0;i<shouldNotHaveNodes.length;i++) { nodes.should.not.have.a.property(shouldNotHaveNodes[i]); } } describe("#getNodeFiles",function() { it("Finds all the node files in the resources tree",function(done) { localfilesystem.init({coreNodesDir:resourcesDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); var nodes = nm.nodes; checkNodes(nm.nodes,['TestNode1','MultipleNodes1','NestedNode','TestNode2','TestNode3','TestNode4'],['TestNodeModule']); i18n.registerMessageCatalog.called.should.be.true(); i18n.registerMessageCatalog.lastCall.args[0].should.eql('node-red'); i18n.registerMessageCatalog.lastCall.args[1].should.eql(path.resolve(path.join(resourcesDir,"locales"))); i18n.registerMessageCatalog.lastCall.args[2].should.eql('messages.json'); done(); }); it("Includes node files from settings",function(done) { localfilesystem.init({nodesIncludes:['TestNode1.js'],coreNodesDir:resourcesDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNode1'],['MultipleNodes1','NestedNode','TestNode2','TestNode3','TestNode4','TestNodeModule']); done(); }); it("Excludes node files from settings",function(done) { localfilesystem.init({nodesExcludes:['TestNode1.js'],coreNodesDir:resourcesDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['MultipleNodes1','NestedNode','TestNode2','TestNode3','TestNode4'],['TestNode1','TestNodeModule']); done(); }); it("Finds nodes in userDir/nodes",function(done) { localfilesystem.init({userDir:userDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNode5'],['TestNode1']); done(); }); it("Finds nodes in settings.nodesDir (string)",function(done) { localfilesystem.init({nodesDir:userDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNode5'],['TestNode1']); done(); }); it("Finds nodes in settings.nodesDir (string,relative path)",function(done) { var relativeUserDir = path.join("test","unit","@node-red","registry","lib","resources","userDir"); localfilesystem.init({nodesDir:relativeUserDir}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNode5'],['TestNode1']); done(); }); it("Finds nodes in settings.nodesDir (array)",function(done) { localfilesystem.init({nodesDir:[userDir]}); var nodeList = localfilesystem.getNodeFiles(true); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNode5'],['TestNode1']); done(); }); it("Finds nodes module path",function(done) { var _join = path.join; stubs.push(sinon.stub(path,"join").callsFake(function() { if (arguments[0] == resourcesDir) { // This stops the module tree scan from going any higher // up the tree than resourcesDir. return arguments[0]; } return _join.apply(null,arguments); })); localfilesystem.init({coreNodesDir:moduleDir}); var nodeList = localfilesystem.getNodeFiles(); nodeList.should.have.a.property("node-red"); var nm = nodeList['node-red']; // The `node-red` module is loaded differently to those scanned for // It doesn't get the `path` property set. Maybe it should. nm.should.have.a.property('name','node-red'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,[],['TestNode1']); nm = nodeList['TestNodeModule']; nm.should.have.a.property('path') nm.should.have.a.property('name','TestNodeModule'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['TestNodeMod1','TestNodeMod2'],[],'TestNodeModule'); nm = nodeList['VersionMismatchModule']; nm.should.have.a.property('path') nm.should.have.a.property('name','VersionMismatchModule'); nm.should.have.a.property("nodes"); checkNodes(nm.nodes,['VersionMismatchMod1','VersionMismatchMod2'],[],'VersionMismatchModule'); i18n.registerMessageCatalog.called.should.be.true(); i18n.registerMessageCatalog.lastCall.args[0].should.eql('node-red'); i18n.registerMessageCatalog.lastCall.args[1].should.eql(path.resolve(path.join(moduleDir,"locales"))); i18n.registerMessageCatalog.lastCall.args[2].should.eql('messages.json'); done(); }); it.skip("finds locales directory"); it.skip("finds icon path directory"); it("scans icon files in the resources tree",function(done) { var count = 0; localfilesystem.init({ coreNodesDir: resourcesDir }); var list = localfilesystem.getNodeFiles(true); list.should.have.property("node-red"); list["node-red"].should.have.property("icons"); list["node-red"].icons.should.have.length(1); list["node-red"].icons[0].should.have.property("path",path.join(__dirname,"resources/local/NestedDirectoryNode/NestedNode/icons")) list["node-red"].icons[0].should.have.property("icons"); list["node-red"].icons[0].icons.should.have.length(1); list["node-red"].icons[0].icons[0].should.eql("arrow-in.png"); done(); }); it("scans icons dir in library",function(done) { var count = 0; localfilesystem.init({ userDir: userDir }); var list = localfilesystem.getNodeFiles(true); list.should.have.property("node-red"); list["node-red"].should.have.property("icons"); list["node-red"].icons.should.have.length(1); list["node-red"].icons[0].should.have.property("path",path.join(__dirname,"resources/userDir/lib/icons")) list["node-red"].icons[0].should.have.property("icons"); list["node-red"].icons[0].icons.should.have.length(1); list["node-red"].icons[0].icons[0].should.eql("test_icon.png"); done(); }); }); describe("#getModuleFiles",function() { it("gets a nodes module files",function(done) { var _join = path.join; stubs.push(sinon.stub(path,"join").callsFake(function() { if (arguments[0] == resourcesDir) { // This stops the module tree scan from going any higher // up the tree than resourcesDir. return arguments[0]; } return _join.apply(null,arguments); })); localfilesystem.init({coreNodesDir:moduleDir}); var nodeModule = localfilesystem.getModuleFiles('TestNodeModule'); nodeModule.should.have.a.property('TestNodeModule'); nodeModule['TestNodeModule'].should.have.a.property('name','TestNodeModule'); nodeModule['TestNodeModule'].should.have.a.property('version','0.0.1'); nodeModule['TestNodeModule'].should.have.a.property('nodes'); nodeModule['TestNodeModule'].should.have.a.property('path'); checkNodes(nodeModule['TestNodeModule'].nodes,['TestNodeMod1','TestNodeMod2'],[],'TestNodeModule'); nodeModule = localfilesystem.getModuleFiles('VersionMismatchModule'); nodeModule.should.have.a.property('VersionMismatchModule'); nodeModule['VersionMismatchModule'].should.have.a.property('redVersion','100.0.0'); done(); }); it("throws an error if a node isn't found",function(done) { var _join = path.join; stubs.push(sinon.stub(path,"join").callsFake(function() { if (arguments[0] == resourcesDir) { // This stops the module tree scan from going any higher // up the tree than resourcesDir. return arguments[0]; } return _join.apply(null,arguments); })); localfilesystem.init({coreNodesDir:moduleDir}); /*jshint immed: false */ (function(){ localfilesystem.getModuleFiles('WontExistModule'); }).should.throw(); done(); }); it.skip("finds locales directory"); it.skip("finds icon path directory"); it("scans icon files with a module file",function(done) { var _join = path.join; stubs.push(sinon.stub(path,"join").callsFake(function() { if (arguments[0] == resourcesDir) { // This stops the module tree scan from going any higher // up the tree than resourcesDir. return arguments[0]; } return _join.apply(null,arguments); })); localfilesystem.init({ coreNodesDir: moduleDir }); var nodeModule = localfilesystem.getModuleFiles('TestNodeModule'); nodeModule.should.have.property("TestNodeModule"); nodeModule.TestNodeModule.should.have.property('icons'); nodeModule.TestNodeModule.icons.should.have.length(1); nodeModule.TestNodeModule.icons[0].should.have.property("path"); nodeModule.TestNodeModule.icons[0].should.have.property("icons"); nodeModule.TestNodeModule.icons[0].icons[0].should.eql("arrow-in.png"); done(); }); }); });