/**
|
* 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 fs = require('fs-extra');
|
var EventEmitter = require('events');
|
|
var NR_TEST_UTILS = require("nr-test-utils");
|
|
var installer = NR_TEST_UTILS.require("@node-red/registry/lib/installer");
|
var registry = NR_TEST_UTILS.require("@node-red/registry/lib/index");
|
var typeRegistry = NR_TEST_UTILS.require("@node-red/registry/lib/registry");
|
const { events, exec, log, hooks } = NR_TEST_UTILS.require("@node-red/util");
|
|
describe('nodes/registry/installer', function() {
|
|
var mockLog = {
|
log: sinon.stub(),
|
debug: sinon.stub(),
|
trace: sinon.stub(),
|
warn: sinon.stub(),
|
info: sinon.stub(),
|
metric: sinon.stub(),
|
_: function(msg) { return msg }
|
}
|
|
var execResponse;
|
|
beforeEach(function() {
|
sinon.stub(exec,"run").callsFake(() => execResponse || Promise.resolve(""))
|
installer.init({})
|
});
|
|
afterEach(function() {
|
execResponse = null;
|
if (registry.addModule.restore) {
|
registry.addModule.restore();
|
}
|
if (registry.removeModule.restore) {
|
registry.removeModule.restore();
|
}
|
if (typeRegistry.removeModule.restore) {
|
typeRegistry.removeModule.restore();
|
}
|
if (registry.getModuleInfo.restore) {
|
registry.getModuleInfo.restore();
|
}
|
if (typeRegistry.getModuleInfo.restore) {
|
typeRegistry.getModuleInfo.restore();
|
}
|
if (typeRegistry.setModulePendingUpdated.restore) {
|
typeRegistry.setModulePendingUpdated.restore();
|
}
|
if (fs.statSync.restore) {
|
fs.statSync.restore();
|
}
|
exec.run.restore();
|
hooks.clear();
|
});
|
|
describe("installs module", function() {
|
it("rejects module name that includes version", function(done) {
|
installer.installModule("module@version",null,null).catch(function(err) {
|
err.code.should.be.eql('invalid_module_name');
|
done();
|
}).catch(done);
|
});
|
it("rejects missing module name", function(done) {
|
installer.installModule("",null,null).catch(function(err) {
|
err.code.should.be.eql('invalid_module_name');
|
done();
|
}).catch(done);
|
});
|
it("rejects null module name", function(done) {
|
installer.installModule(null,null,null).catch(function(err) {
|
err.code.should.be.eql('invalid_module_name');
|
done();
|
}).catch(done);
|
});
|
it("rejects invalid url", function(done) {
|
installer.installModule("module",null,"abc").catch(function(err) {
|
err.code.should.be.eql('invalid_module_url');
|
done();
|
});
|
});
|
it("rejects when npm returns a 404", function(done) {
|
var res = {
|
code: 1,
|
stdout:"",
|
stderr:" 404 this_wont_exist"
|
}
|
var p = Promise.reject(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
installer.installModule("this_wont_exist").catch(function(err) {
|
err.should.have.property("code",404);
|
done();
|
}).catch(done);
|
});
|
it("rejects when npm does not find specified version", function(done) {
|
var res = {
|
code: 1,
|
stdout:"",
|
stderr:" version not found: this_wont_exist@0.1.2"
|
}
|
var p = Promise.reject(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
version: "0.1.1"
|
}
|
});
|
installer.installModule("this_wont_exist","0.1.2").catch(function(err) {
|
err.code.should.be.eql(404);
|
done();
|
}).catch(done);
|
});
|
it("rejects when update requested to existing version", function(done) {
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
installer.installModule("this_wont_exist","0.1.1").catch(function(err) {
|
err.code.should.be.eql('module_already_loaded');
|
done();
|
}).catch(done);
|
});
|
it("rejects when update requested to existing version and url", function(done) {
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
installer.installModule("this_wont_exist","0.1.1","https://example/foo-0.1.1.tgz").catch(function(err) {
|
err.code.should.be.eql('module_already_loaded');
|
done();
|
}).catch(done);
|
});
|
it("rejects with generic error", function(done) {
|
var res = {
|
code: 1,
|
stdout:"",
|
stderr:" kaboom!"
|
}
|
var p = Promise.reject(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
installer.installModule("this_wont_exist").then(function() {
|
done(new Error("Unexpected success"));
|
}).catch(err => {
|
// Expected result
|
done()
|
});
|
});
|
it("succeeds when module is found", function(done) {
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist").then(function(info) {
|
info.should.eql(nodeInfo);
|
// commsMessages.should.have.length(1);
|
// commsMessages[0].topic.should.equal("node/added");
|
// commsMessages[0].msg.should.eql(nodeInfo.nodes);
|
done();
|
}).catch(done);
|
});
|
it("rejects when non-existant path is provided", function(done) {
|
this.timeout(20000);
|
var resourcesDir = path.resolve(path.join(__dirname,"resources","local","TestNodeModule","node_modules","NonExistant"));
|
installer.installModule(resourcesDir).then(function() {
|
done(new Error("Unexpected success"));
|
}).catch(function(err) {
|
if (err.hasOwnProperty("code")) {
|
err.code.should.eql(404);
|
done();
|
}
|
else {
|
console.log("ERRROR::"+err.toString()+"::");
|
err.toString().should.eql("Error: Install failed");
|
done();
|
}
|
});
|
});
|
it("succeeds when path is valid node-red module", function(done) {
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
var resourcesDir = path.resolve(path.join(__dirname,"resources","local","TestNodeModule","node_modules","TestNodeModule"));
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
installer.installModule(resourcesDir).then(function(info) {
|
info.should.eql(nodeInfo);
|
done();
|
}).catch(done);
|
});
|
it("succeeds when url is valid node-red module", function(done) {
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist",null,"https://example/foo-0.1.1.tgz").then(function(info) {
|
info.should.eql(nodeInfo);
|
done();
|
}).catch(done);
|
});
|
|
it("triggers preInstall and postInstall hooks", function(done) {
|
let receivedPreEvent,receivedPostEvent;
|
hooks.add("preInstall", function(event) { event.args = ["a"]; receivedPreEvent = event; })
|
hooks.add("postInstall", function(event) { receivedPostEvent = event; })
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
var res = {code: 0,stdout:"",stderr:""}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist","1.2.3").then(function(info) {
|
exec.run.called.should.be.true();
|
exec.run.lastCall.args[1].should.eql([ 'install', 'a', 'this_wont_exist@1.2.3' ]);
|
info.should.eql(nodeInfo);
|
should.exist(receivedPreEvent)
|
receivedPreEvent.should.have.property("module","this_wont_exist")
|
receivedPreEvent.should.have.property("version","1.2.3")
|
receivedPreEvent.should.have.property("dir")
|
receivedPreEvent.should.have.property("url")
|
receivedPreEvent.should.have.property("isExisting")
|
receivedPreEvent.should.have.property("isUpgrade")
|
receivedPreEvent.should.eql(receivedPostEvent)
|
done();
|
}).catch(done);
|
});
|
|
it("fails install if preInstall hook fails", function(done) {
|
let receivedEvent;
|
hooks.add("preInstall", function(event) { throw new Error("preInstall-error"); })
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
|
installer.installModule("this_wont_exist","1.2.3").catch(function(err) {
|
exec.run.called.should.be.false();
|
done();
|
}).catch(done);
|
});
|
|
it("skips invoking npm if preInstall returns false", function(done) {
|
let receivedEvent;
|
hooks.add("preInstall", function(event) { return false })
|
hooks.add("postInstall", function(event) { receivedEvent = event; })
|
var nodeInfo = {nodes:{module:"foo",types:["a"]}};
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist","1.2.3").then(function() {
|
exec.run.called.should.be.false();
|
should.exist(receivedEvent);
|
done();
|
}).catch(done);
|
});
|
|
it("rollsback install if postInstall hook fails", function(done) {
|
hooks.add("postInstall", function(event) { throw new Error("fail"); })
|
installer.installModule("this_wont_exist","1.2.3").catch(function(err) {
|
exec.run.calledTwice.should.be.true();
|
exec.run.firstCall.args[1].includes("install").should.be.true();
|
exec.run.secondCall.args[1].includes("remove").should.be.true();
|
done();
|
}).catch(done);
|
});
|
|
describe("allowUpdate lists", function() {
|
it("rejects when update requested with allowUpdate set to false", function(done) {
|
installer.init({ externalModules: { palette: { allowUpdate: false } } })
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
installer.installModule("this_wont_exist","0.1.2").catch(function(err) {
|
err.code.should.be.eql('update_not_allowed');
|
done();
|
}).catch(done);
|
})
|
it("succeeds when update requested with module not on denyUpdateList", function(done) {
|
installer.init({ externalModules: { palette: { denyUpdateList: ['this_wont_exist'] } } })
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var nodeInfo = {nodes:{module:"this_is_allowed",types:["a"]}};
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
sinon.stub(typeRegistry,"setModulePendingUpdated").callsFake(function() {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_is_allowed","0.1.2").then(function() {
|
done();
|
}).catch(done);
|
})
|
it("rejects when update requested with module on denyUpdateList", function(done) {
|
installer.init({ externalModules: { palette: { denyUpdateList: ['this_wont_exist'] } } })
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var nodeInfo = {nodes:{module:"this_is_allowed",types:["a"]}};
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
sinon.stub(typeRegistry,"setModulePendingUpdated").callsFake(function() {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist","0.1.2").catch(function(err) {
|
err.code.should.be.eql('update_not_allowed');
|
done();
|
}).catch(done);
|
})
|
it("succeeds when update requested with module on allowUpdateList", function(done) {
|
installer.init({ externalModules: { palette: { allowUpdateList: ['this_is_allowed'] } } })
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var nodeInfo = {nodes:{module:"this_is_allowed",types:["a"]}};
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
sinon.stub(typeRegistry,"setModulePendingUpdated").callsFake(function() {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_is_allowed","0.1.2").then(function() {
|
done();
|
}).catch(done);
|
})
|
it("rejects when update requested with module not on allowUpdateList", function(done) {
|
installer.init({ externalModules: { palette: { allowUpdateList: ['this_is_allowed'] } } })
|
sinon.stub(typeRegistry,"getModuleInfo").callsFake(function() {
|
return {
|
user: true,
|
version: "0.1.1"
|
}
|
});
|
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
var nodeInfo = {nodes:{module:"this_wont_exist",types:["a"]}};
|
|
var addModule = sinon.stub(registry,"addModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
sinon.stub(typeRegistry,"setModulePendingUpdated").callsFake(function() {
|
return Promise.resolve(nodeInfo);
|
});
|
|
installer.installModule("this_wont_exist","0.1.2").catch(function(err) {
|
err.code.should.be.eql('update_not_allowed');
|
done();
|
}).catch(done);
|
})
|
});
|
});
|
describe("uninstalls module", function() {
|
it("rejects invalid module names", function(done) {
|
var promises = [];
|
var rejectedCount = 0;
|
|
promises.push(installer.uninstallModule("this_wont_exist ").catch(() => {rejectedCount++}));
|
promises.push(installer.uninstallModule("this_wont_exist;no_it_really_wont").catch(() => {rejectedCount++}));
|
Promise.all(promises).then(function() {
|
rejectedCount.should.eql(2);
|
done();
|
}).catch(done);
|
});
|
|
it("rejects with generic error", function(done) {
|
var nodeInfo = [{module:"foo",types:["a"]}];
|
var removeModule = sinon.stub(registry,"removeModule").callsFake(function(md) {
|
return Promise.resolve(nodeInfo);
|
});
|
var res = {
|
code: 1,
|
stdout:"",
|
stderr:"error"
|
}
|
var p = Promise.reject(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
installer.uninstallModule("this_wont_exist").then(function() {
|
done(new Error("Unexpected success"));
|
}).catch(err => {
|
// Expected result
|
done()
|
});
|
});
|
it("succeeds when module is found", function(done) {
|
var nodeInfo = [{module:"foo",types:["a"]}];
|
var removeModule = sinon.stub(typeRegistry,"removeModule").callsFake(function(md) {
|
return nodeInfo;
|
});
|
var getModuleInfo = sinon.stub(registry,"getModuleInfo").callsFake(function(md) {
|
return {nodes:[]};
|
});
|
var res = {
|
code: 0,
|
stdout:"",
|
stderr:""
|
}
|
var p = Promise.resolve(res);
|
p.catch((err)=>{});
|
execResponse = p;
|
|
sinon.stub(fs,"statSync").callsFake(function(fn) { return {}; });
|
|
installer.uninstallModule("this_wont_exist").then(function(info) {
|
info.should.eql(nodeInfo);
|
// commsMessages.should.have.length(1);
|
// commsMessages[0].topic.should.equal("node/removed");
|
// commsMessages[0].msg.should.eql(nodeInfo);
|
done();
|
}).catch(done);
|
});
|
});
|
});
|
