2015-11-14 00:16:47 +01:00
|
|
|
/**
|
2017-01-11 16:24:33 +01:00
|
|
|
* Copyright JS Foundation and other contributors, http://js.foundation
|
2015-11-14 00:16:47 +01:00
|
|
|
*
|
|
|
|
* 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 when = require("when");
|
|
|
|
var sinon = require("sinon");
|
|
|
|
var path = require("path");
|
|
|
|
|
2018-08-20 17:17:24 +02:00
|
|
|
var NR_TEST_UTILS = require("nr-test-utils");
|
|
|
|
|
|
|
|
var localfilesystem = NR_TEST_UTILS.require("@node-red/registry/lib/localfilesystem");
|
2015-11-14 00:16:47 +01:00
|
|
|
|
2018-04-26 13:32:05 +02:00
|
|
|
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"));
|
|
|
|
|
2018-08-20 17:17:24 +02:00
|
|
|
var i18n = NR_TEST_UTILS.require("@node-red/util").i18n;
|
2015-11-14 00:16:47 +01:00
|
|
|
|
|
|
|
describe("red/nodes/registry/localfilesystem",function() {
|
2018-04-26 13:32:05 +02:00
|
|
|
beforeEach(function() {
|
|
|
|
stubs.push(sinon.stub(i18n,"registerMessageCatalog", function() { return Promise.resolve(); }));
|
|
|
|
})
|
|
|
|
|
2015-11-14 00:16:47 +01:00
|
|
|
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');
|
2017-04-10 16:41:20 +02:00
|
|
|
nodes[shouldHaveNodes[i]].file.should.equal(path.resolve(nodes[shouldHaveNodes[i]].file));
|
2015-11-14 00:16:47 +01:00
|
|
|
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) {
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{coreNodesDir:resourcesDir}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles(true);
|
2015-11-14 00:16:47 +01:00
|
|
|
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']);
|
2018-04-26 13:32:05 +02:00
|
|
|
i18n.registerMessageCatalog.called.should.be.true();
|
|
|
|
i18n.registerMessageCatalog.lastCall.args[0].should.eql('node-red');
|
2018-08-20 22:22:47 +02:00
|
|
|
i18n.registerMessageCatalog.lastCall.args[1].should.eql(path.resolve(path.join(resourcesDir,"locales")));
|
2018-04-26 13:32:05 +02:00
|
|
|
i18n.registerMessageCatalog.lastCall.args[2].should.eql('messages.json');
|
2015-11-14 00:16:47 +01:00
|
|
|
done();
|
|
|
|
});
|
2017-03-08 11:00:00 +01:00
|
|
|
it("Includes node files from settings",function(done) {
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{nodesIncludes:['TestNode1.js'],coreNodesDir:resourcesDir}});
|
2017-03-08 11:00:00 +01:00
|
|
|
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();
|
|
|
|
});
|
2015-11-14 00:16:47 +01:00
|
|
|
it("Excludes node files from settings",function(done) {
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{nodesExcludes:['TestNode1.js'],coreNodesDir:resourcesDir}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles(true);
|
2015-11-14 00:16:47 +01:00
|
|
|
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) {
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{userDir:userDir}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles(true);
|
2015-11-14 00:16:47 +01:00
|
|
|
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) {
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{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) {
|
2018-08-20 17:17:24 +02:00
|
|
|
var relativeUserDir = path.join("test","unit","@node-red","registry","lib","resources","userDir");
|
|
|
|
console.log(relativeUserDir)
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{nodesDir:relativeUserDir}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles(true);
|
2015-11-14 00:16:47 +01:00
|
|
|
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();
|
|
|
|
});
|
2018-04-26 13:32:05 +02:00
|
|
|
it("Finds nodes in settings.nodesDir (array)",function(done) {
|
|
|
|
localfilesystem.init({settings:{nodesDir:[userDir]}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles(true);
|
2015-11-14 00:16:47 +01:00
|
|
|
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",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);
|
|
|
|
}));
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{coreNodesDir:moduleDir}});
|
2015-12-07 00:13:52 +01:00
|
|
|
var nodeList = localfilesystem.getNodeFiles();
|
2015-11-14 00:16:47 +01:00
|
|
|
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']);
|
|
|
|
|
|
|
|
nm = nodeList['TestNodeModule'];
|
|
|
|
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('name','VersionMismatchModule');
|
|
|
|
nm.should.have.a.property("nodes");
|
|
|
|
checkNodes(nm.nodes,['VersionMismatchMod1','VersionMismatchMod2'],[],'VersionMismatchModule');
|
|
|
|
|
2018-04-26 13:32:05 +02:00
|
|
|
i18n.registerMessageCatalog.called.should.be.true();
|
|
|
|
i18n.registerMessageCatalog.lastCall.args[0].should.eql('node-red');
|
2018-08-20 22:22:47 +02:00
|
|
|
i18n.registerMessageCatalog.lastCall.args[1].should.eql(path.resolve(path.join(moduleDir,"locales")));
|
2018-04-26 13:32:05 +02:00
|
|
|
i18n.registerMessageCatalog.lastCall.args[2].should.eql('messages.json');
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-11-14 00:16:47 +01:00
|
|
|
done();
|
|
|
|
});
|
2015-11-17 22:12:43 +01:00
|
|
|
it.skip("finds locales directory");
|
|
|
|
it.skip("finds icon path directory");
|
2017-11-30 14:13:35 +01:00
|
|
|
it("scans icon files in the resources tree",function(done) {
|
|
|
|
var count = 0;
|
|
|
|
localfilesystem.init({
|
2018-04-26 13:32:05 +02:00
|
|
|
|
|
|
|
// events:{emit:function(eventName,dir){
|
|
|
|
// if (count === 0) {
|
|
|
|
// eventName.should.equal("node-icon-dir");
|
|
|
|
// dir.name.should.equal("node-red");
|
|
|
|
// dir.icons.should.be.an.Array();
|
|
|
|
// count = 1;
|
|
|
|
// } else if (count === 1) {
|
|
|
|
// done();
|
|
|
|
// }
|
|
|
|
// }},
|
2017-11-30 14:13:35 +01:00
|
|
|
settings:{coreNodesDir:resourcesDir}
|
|
|
|
});
|
2018-04-26 13:32:05 +02:00
|
|
|
var list = localfilesystem.getNodeFiles(true);
|
|
|
|
list.should.have.property("node-red");
|
|
|
|
list["node-red"].should.have.property("icons");
|
2018-08-20 17:17:24 +02:00
|
|
|
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");
|
2018-04-26 13:32:05 +02:00
|
|
|
done();
|
2017-11-30 14:13:35 +01:00
|
|
|
});
|
2018-01-05 15:23:47 +01:00
|
|
|
it("scans icons dir in library",function(done) {
|
|
|
|
var count = 0;
|
|
|
|
localfilesystem.init({
|
2018-04-26 13:32:05 +02:00
|
|
|
//
|
|
|
|
// events:{emit:function(eventName,dir){
|
|
|
|
// eventName.should.equal("node-icon-dir");
|
|
|
|
// if (count === 0) {
|
|
|
|
// dir.name.should.equal("node-red");
|
|
|
|
// dir.icons.should.be.an.Array();
|
|
|
|
// count = 1;
|
|
|
|
// } else if (count === 1) {
|
|
|
|
// dir.name.should.equal("Library");
|
|
|
|
// dir.icons.should.be.an.Array();
|
|
|
|
// dir.icons.length.should.equal(1);
|
|
|
|
// dir.icons[0].should.be.equal("test_icon.png");
|
|
|
|
// done();
|
|
|
|
// }
|
|
|
|
// }},
|
2018-01-05 15:23:47 +01:00
|
|
|
settings:{userDir:userDir}
|
|
|
|
});
|
2018-04-26 13:32:05 +02:00
|
|
|
var list = localfilesystem.getNodeFiles(true);
|
|
|
|
list.should.have.property("node-red");
|
|
|
|
list["node-red"].should.have.property("icons");
|
2018-08-20 17:17:24 +02:00
|
|
|
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");
|
2018-04-26 13:32:05 +02:00
|
|
|
done();
|
2018-01-05 15:23:47 +01:00
|
|
|
});
|
2015-11-14 00:16:47 +01:00
|
|
|
});
|
|
|
|
describe("#getModuleFiles",function() {
|
|
|
|
it("gets a nodes module files",function(done) {
|
|
|
|
var _join = path.join;
|
|
|
|
stubs.push(sinon.stub(path,"join",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);
|
|
|
|
}));
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{coreNodesDir:moduleDir}});
|
2015-11-14 00:16:47 +01:00
|
|
|
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');
|
|
|
|
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",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);
|
|
|
|
}));
|
2018-04-26 13:32:05 +02:00
|
|
|
localfilesystem.init({settings:{coreNodesDir:moduleDir}});
|
2015-11-14 00:16:47 +01:00
|
|
|
/*jshint immed: false */
|
|
|
|
(function(){
|
|
|
|
localfilesystem.getModuleFiles('WontExistModule');
|
|
|
|
}).should.throw();
|
|
|
|
done();
|
|
|
|
});
|
2015-11-17 22:12:43 +01:00
|
|
|
it.skip("finds locales directory");
|
|
|
|
it.skip("finds icon path directory");
|
2017-11-30 14:13:35 +01:00
|
|
|
it("scans icon files with a module file",function(done) {
|
|
|
|
var _join = path.join;
|
|
|
|
stubs.push(sinon.stub(path,"join",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({
|
2018-04-26 13:32:05 +02:00
|
|
|
|
|
|
|
// events:{emit:function(eventName,dir){
|
|
|
|
// eventName.should.equal("node-icon-dir");
|
|
|
|
// dir.name.should.equal("TestNodeModule");
|
|
|
|
// dir.icons.should.be.an.Array();
|
|
|
|
// done();
|
|
|
|
// }},
|
2017-11-30 14:13:35 +01:00
|
|
|
settings:{coreNodesDir:moduleDir}
|
|
|
|
});
|
|
|
|
var nodeModule = localfilesystem.getModuleFiles('TestNodeModule');
|
2018-04-26 13:32:05 +02:00
|
|
|
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();
|
2017-11-30 14:13:35 +01:00
|
|
|
});
|
2015-11-14 00:16:47 +01:00
|
|
|
});
|
|
|
|
});
|