mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
Update runtime apis to support multiple libraries
This commit is contained in:
Nick O'Leary
@@ -38,7 +38,7 @@ describe("runtime-api/library", function() {
|
||||
library.init({
|
||||
log: mockLog,
|
||||
library: {
|
||||
getEntry: function(type,path) {
|
||||
getEntry: function(library, type,path) {
|
||||
if (type === "known") {
|
||||
return Promise.resolve("known");
|
||||
} else if (type === "forbidden") {
|
||||
@@ -67,13 +67,13 @@ describe("runtime-api/library", function() {
|
||||
})
|
||||
})
|
||||
it("returns a known entry", function(done) {
|
||||
library.getEntry({type: "known", path: "/abc"}).then(function(result) {
|
||||
library.getEntry({library: "local",type: "known", path: "/abc"}).then(function(result) {
|
||||
result.should.eql("known")
|
||||
done();
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects a forbidden entry", function(done) {
|
||||
library.getEntry({type: "forbidden", path: "/abc"}).then(function(result) {
|
||||
library.getEntry({library: "local",type: "forbidden", path: "/abc"}).then(function(result) {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","forbidden");
|
||||
@@ -82,7 +82,7 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects an unknown entry", function(done) {
|
||||
library.getEntry({type: "not_found", path: "/abc"}).then(function(result) {
|
||||
library.getEntry({library: "local",type: "not_found", path: "/abc"}).then(function(result) {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","not_found");
|
||||
@@ -91,7 +91,7 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects a blank (unknown) entry", function(done) {
|
||||
library.getEntry({type: "blank", path: "/abc"}).then(function(result) {
|
||||
library.getEntry({library: "local",type: "blank", path: "/abc"}).then(function(result) {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","not_found");
|
||||
@@ -100,7 +100,7 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects unexpected error", function(done) {
|
||||
library.getEntry({type: "error", path: "/abc"}).then(function(result) {
|
||||
library.getEntry({library: "local",type: "error", path: "/abc"}).then(function(result) {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("status",400);
|
||||
@@ -114,7 +114,7 @@ describe("runtime-api/library", function() {
|
||||
library.init({
|
||||
log: mockLog,
|
||||
library: {
|
||||
saveEntry: function(type,path,meta,body) {
|
||||
saveEntry: function(library,type,path,meta,body) {
|
||||
opts = {type,path,meta,body};
|
||||
if (type === "known") {
|
||||
return Promise.resolve();
|
||||
@@ -137,7 +137,7 @@ describe("runtime-api/library", function() {
|
||||
})
|
||||
|
||||
it("saves an entry", function(done) {
|
||||
library.saveEntry({type: "known", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
library.saveEntry({library: "local",type: "known", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
opts.should.have.property("type","known");
|
||||
opts.should.have.property("path","/abc");
|
||||
opts.should.have.property("meta",{a:1});
|
||||
@@ -146,7 +146,7 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects a forbidden entry", function(done) {
|
||||
library.saveEntry({type: "forbidden", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
library.saveEntry({library: "local",type: "forbidden", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","forbidden");
|
||||
@@ -155,7 +155,7 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
it("rejects an unknown entry", function(done) {
|
||||
library.saveEntry({type: "not_found", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
library.saveEntry({library: "local",type: "not_found", path: "/abc", meta: {a:1}, body:"123"}).then(function() {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("status",400);
|
||||
@@ -163,377 +163,5 @@ describe("runtime-api/library", function() {
|
||||
}).catch(done)
|
||||
})
|
||||
})
|
||||
describe("getEntries", function() {
|
||||
var opts;
|
||||
before(function() {
|
||||
library.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
getAllFlows: function() {
|
||||
return Promise.resolve({a:1});
|
||||
}
|
||||
},
|
||||
nodes: {
|
||||
getNodeExampleFlows: function() {
|
||||
return {b:2};
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
it("returns all flows", function(done) {
|
||||
library.getEntries({type:"flows"}).then(function(result) {
|
||||
result.should.eql({a:1,d:{_examples_:{b:2}}});
|
||||
done();
|
||||
}).catch(done)
|
||||
});
|
||||
it("fails for non-flows (currently)", function(done) {
|
||||
library.getEntries({type:"functions"}).then(function(result) {
|
||||
done(new Error("did not reject"));
|
||||
}).catch(function(err) {
|
||||
done();
|
||||
}).catch(done)
|
||||
})
|
||||
})
|
||||
|
||||
|
||||
});
|
||||
|
||||
|
||||
/*
|
||||
|
||||
var should = require("should");
|
||||
var sinon = require("sinon");
|
||||
var fs = require("fs");
|
||||
var fspath = require('path');
|
||||
var request = require('supertest');
|
||||
var express = require('express');
|
||||
var bodyParser = require('body-parser');
|
||||
|
||||
var when = require('when');
|
||||
|
||||
var app;
|
||||
var library = require("../../../../red/api/editor/library");
|
||||
var auth = require("../../../../red/api/auth");
|
||||
|
||||
describe("api/editor/library", function() {
|
||||
|
||||
function initLibrary(_flows,_libraryEntries,_examples,_exampleFlowPathFunction) {
|
||||
var flows = _flows;
|
||||
var libraryEntries = _libraryEntries;
|
||||
library.init(app,{
|
||||
log:{audit:function(){},_:function(){},warn:function(){}},
|
||||
storage: {
|
||||
init: function() {
|
||||
return when.resolve();
|
||||
},
|
||||
getAllFlows: function() {
|
||||
return when.resolve(flows);
|
||||
},
|
||||
getFlow: function(fn) {
|
||||
if (flows[fn]) {
|
||||
return when.resolve(flows[fn]);
|
||||
} else if (fn.indexOf("..")!==-1) {
|
||||
var err = new Error();
|
||||
err.code = 'forbidden';
|
||||
return when.reject(err);
|
||||
} else {
|
||||
return when.reject();
|
||||
}
|
||||
},
|
||||
saveFlow: function(fn,data) {
|
||||
if (fn.indexOf("..")!==-1) {
|
||||
var err = new Error();
|
||||
err.code = 'forbidden';
|
||||
return when.reject(err);
|
||||
}
|
||||
flows[fn] = data;
|
||||
return when.resolve();
|
||||
},
|
||||
getLibraryEntry: function(type,path) {
|
||||
if (path.indexOf("..")!==-1) {
|
||||
var err = new Error();
|
||||
err.code = 'forbidden';
|
||||
return when.reject(err);
|
||||
}
|
||||
if (libraryEntries[type] && libraryEntries[type][path]) {
|
||||
return when.resolve(libraryEntries[type][path]);
|
||||
} else {
|
||||
return when.reject();
|
||||
}
|
||||
},
|
||||
saveLibraryEntry: function(type,path,meta,body) {
|
||||
if (path.indexOf("..")!==-1) {
|
||||
var err = new Error();
|
||||
err.code = 'forbidden';
|
||||
return when.reject(err);
|
||||
}
|
||||
libraryEntries[type][path] = body;
|
||||
return when.resolve();
|
||||
}
|
||||
},
|
||||
events: {
|
||||
on: function(){},
|
||||
removeListener: function(){}
|
||||
},
|
||||
nodes: {
|
||||
getNodeExampleFlows: function() {
|
||||
return _examples;
|
||||
},
|
||||
getNodeExampleFlowPath: _exampleFlowPathFunction
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
describe("flows", function() {
|
||||
before(function() {
|
||||
app = express();
|
||||
app.use(bodyParser.json());
|
||||
app.get("/library/flows",library.getAll);
|
||||
app.post(new RegExp("/library/flows\/(.*)"),library.post);
|
||||
app.get(new RegExp("/library/flows\/(.*)"),library.get);
|
||||
app.response.sendFile = function (path) {
|
||||
app.response.json.call(this, {sendFile: path});
|
||||
};
|
||||
sinon.stub(fs,"statSync",function() { return true; });
|
||||
});
|
||||
after(function() {
|
||||
fs.statSync.restore();
|
||||
});
|
||||
it('returns empty result', function(done) {
|
||||
initLibrary({},{flows:{}});
|
||||
request(app)
|
||||
.get('/library/flows')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.not.have.property('f');
|
||||
res.body.should.not.have.property('d');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('returns 404 for non-existent entry', function(done) {
|
||||
initLibrary({},{flows:{}});
|
||||
request(app)
|
||||
.get('/library/flows/foo')
|
||||
.expect(404)
|
||||
.end(done);
|
||||
});
|
||||
|
||||
|
||||
it('can store and retrieve item', function(done) {
|
||||
initLibrary({},{flows:{}});
|
||||
var flow = '[]';
|
||||
request(app)
|
||||
.post('/library/flows/foo')
|
||||
.set('Content-Type', 'application/json')
|
||||
.send(flow)
|
||||
.expect(204).end(function (err, res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
request(app)
|
||||
.get('/library/flows/foo')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.text.should.equal(flow);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('lists a stored item', function(done) {
|
||||
initLibrary({f:["bar"]});
|
||||
request(app)
|
||||
.get('/library/flows')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.have.property('f');
|
||||
should.deepEqual(res.body.f,['bar']);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('returns 403 for malicious get attempt', function(done) {
|
||||
initLibrary({});
|
||||
// without the userDir override the malicious url would be
|
||||
// http://127.0.0.1:1880/library/flows/../../package to
|
||||
// obtain package.json from the node-red root.
|
||||
request(app)
|
||||
.get('/library/flows/../../../../../package')
|
||||
.expect(403)
|
||||
.end(done);
|
||||
});
|
||||
it('returns 403 for malicious post attempt', function(done) {
|
||||
initLibrary({});
|
||||
// without the userDir override the malicious url would be
|
||||
// http://127.0.0.1:1880/library/flows/../../package to
|
||||
// obtain package.json from the node-red root.
|
||||
request(app)
|
||||
.post('/library/flows/../../../../../package')
|
||||
.expect(403)
|
||||
.end(done);
|
||||
});
|
||||
it('includes examples flows if set', function(done) {
|
||||
var examples = {"d":{"node-module":{"f":["example-one"]}}};
|
||||
initLibrary({},{},examples);
|
||||
request(app)
|
||||
.get('/library/flows')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.have.property('d');
|
||||
res.body.d.should.have.property('_examples_');
|
||||
should.deepEqual(res.body.d._examples_,examples);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('can retrieve an example flow', function(done) {
|
||||
var examples = {"d":{"node-module":{"f":["example-one"]}}};
|
||||
initLibrary({},{},examples,function(module,path) {
|
||||
return module + ':' + path
|
||||
});
|
||||
request(app)
|
||||
.get('/library/flows/_examples_/node-module/example-one')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.have.property('sendFile',
|
||||
fspath.resolve('node-module') + ':example-one');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('can retrieve an example flow in an org scoped package', function(done) {
|
||||
var examples = {"d":{"@org_scope/node_package":{"f":["example-one"]}}};
|
||||
initLibrary({},{},examples,function(module,path) {
|
||||
return module + ':' + path
|
||||
});
|
||||
request(app)
|
||||
.get('/library/flows/_examples_/@org_scope/node_package/example-one')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.have.property('sendFile',
|
||||
fspath.resolve('@org_scope/node_package') +
|
||||
':example-one');
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("type", function() {
|
||||
before(function() {
|
||||
|
||||
app = express();
|
||||
app.use(bodyParser.json());
|
||||
initLibrary({},{});
|
||||
auth.init({settings:{}});
|
||||
library.register("test");
|
||||
});
|
||||
|
||||
it('returns empty result', function(done) {
|
||||
initLibrary({},{'test':{"":[]}});
|
||||
request(app)
|
||||
.get('/library/test')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.body.should.not.have.property('f');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('returns 404 for non-existent entry', function(done) {
|
||||
initLibrary({},{});
|
||||
request(app)
|
||||
.get('/library/test/foo')
|
||||
.expect(404)
|
||||
.end(done);
|
||||
});
|
||||
|
||||
it('can store and retrieve item', function(done) {
|
||||
initLibrary({},{'test':{}});
|
||||
var flow = {text:"test content"};
|
||||
request(app)
|
||||
.post('/library/test/foo')
|
||||
.set('Content-Type', 'application/json')
|
||||
.send(flow)
|
||||
.expect(204).end(function (err, res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
request(app)
|
||||
.get('/library/test/foo')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
res.text.should.equal(flow.text);
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('lists a stored item', function(done) {
|
||||
initLibrary({},{'test':{'a':['abc','def']}});
|
||||
request(app)
|
||||
.get('/library/test/a')
|
||||
.expect(200)
|
||||
.end(function(err,res) {
|
||||
if (err) {
|
||||
throw err;
|
||||
}
|
||||
// This response isn't strictly accurate - but it
|
||||
// verifies the api returns what storage gave it
|
||||
should.deepEqual(res.body,['abc','def']);
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
it('returns 403 for malicious access attempt', function(done) {
|
||||
request(app)
|
||||
.get('/library/test/../../../../../../../../../../etc/passwd')
|
||||
.expect(403)
|
||||
.end(done);
|
||||
});
|
||||
|
||||
it('returns 403 for malicious access attempt', function(done) {
|
||||
request(app)
|
||||
.get('/library/test/..\\..\\..\\..\\..\\..\\..\\..\\..\\..\\etc\\passwd')
|
||||
.expect(403)
|
||||
.end(done);
|
||||
});
|
||||
|
||||
it('returns 403 for malicious access attempt', function(done) {
|
||||
request(app)
|
||||
.post('/library/test/../../../../../../../../../../etc/passwd')
|
||||
.set('Content-Type', 'text/plain')
|
||||
.send('root:x:0:0:root:/root:/usr/bin/tclsh')
|
||||
.expect(403)
|
||||
.end(done);
|
||||
});
|
||||
|
||||
});
|
||||
});
|
||||
|
||||
*/
|
||||
|
||||
138
test/unit/@node-red/runtime/lib/library/examples_spec.js
Normal file
138
test/unit/@node-red/runtime/lib/library/examples_spec.js
Normal file
@@ -0,0 +1,138 @@
|
||||
/**
|
||||
* 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 fs = require("fs");
|
||||
|
||||
var NR_TEST_UTILS = require("nr-test-utils");
|
||||
var examplesLibrary = NR_TEST_UTILS.require("@node-red/runtime/lib/library/examples")
|
||||
|
||||
var mockLog = {
|
||||
log: sinon.stub(),
|
||||
debug: sinon.stub(),
|
||||
trace: sinon.stub(),
|
||||
warn: sinon.stub(),
|
||||
info: sinon.stub(),
|
||||
metric: sinon.stub(),
|
||||
audit: sinon.stub(),
|
||||
_: function() { return "abc"}
|
||||
}
|
||||
|
||||
describe("runtime/library/examples", function() {
|
||||
describe("getEntry", function() {
|
||||
before(function() {
|
||||
examplesLibrary.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
getLibraryEntry: function(type,path) {
|
||||
return Promise.resolve({type,path});
|
||||
},
|
||||
getFlow: function(path) {
|
||||
return Promise.resolve({path});
|
||||
}
|
||||
},
|
||||
nodes: {
|
||||
getNodeExampleFlows: function() {
|
||||
return {
|
||||
"test-module": {
|
||||
f: ["abc"]
|
||||
},
|
||||
"@scope/test-module": {
|
||||
f: ["abc","throw"]
|
||||
}
|
||||
|
||||
}
|
||||
},
|
||||
getNodeExampleFlowPath: function(module,entryPath) {
|
||||
if (module === "unknown") {
|
||||
return null;
|
||||
}
|
||||
return "/tmp/"+module+"/"+entryPath;
|
||||
}
|
||||
}
|
||||
});
|
||||
sinon.stub(fs,"readFile", function(path,opts,callback) {
|
||||
if (path === "/tmp/test-module/abc") {
|
||||
callback(null,"Example flow result");
|
||||
} else if (path === "/tmp/@scope/test-module/abc") {
|
||||
callback(null,"Example scope flow result");
|
||||
} else if (path === "/tmp/test-module/throw") {
|
||||
throw new Error("Instant error")
|
||||
} else {
|
||||
callback(new Error("Unexpected path:"+path))
|
||||
}
|
||||
})
|
||||
});
|
||||
after(function() {
|
||||
fs.readFile.restore();
|
||||
})
|
||||
|
||||
it ('returns a flow example entry', function(done) {
|
||||
examplesLibrary.getEntry("flows","test-module/abc").then(function(result) {
|
||||
result.should.eql("Example flow result");
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
|
||||
it ('returns a flow example listing - top level', function(done) {
|
||||
examplesLibrary.getEntry("flows","").then(function(result) {
|
||||
result.should.eql([ 'test-module', '@scope/test-module' ])
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
it ('returns a flow example listing - in module', function(done) {
|
||||
examplesLibrary.getEntry("flows","test-module").then(function(result) {
|
||||
result.should.eql([{ fn: 'abc' }])
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
it ('returns a flow example listing - in scoped module', function(done) {
|
||||
examplesLibrary.getEntry("flows","@scope/test-module").then(function(result) {
|
||||
result.should.eql([{ fn: 'abc' }, {fn: 'throw'}])
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
it ('returns a flow example entry from scoped module', function(done) {
|
||||
examplesLibrary.getEntry("flows","@scope/test-module/abc").then(function(result) {
|
||||
result.should.eql("Example scope flow result");
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
it ('returns an error for unknown flow example entry', function(done) {
|
||||
examplesLibrary.getEntry("flows","unknown/abc").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","not_found");
|
||||
done();
|
||||
});
|
||||
});
|
||||
it ('returns an error for file load error - async', function(done) {
|
||||
examplesLibrary.getEntry("flows","test-module/unknown").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
done();
|
||||
});
|
||||
});
|
||||
it ('returns an error for file load error - sync', function(done) {
|
||||
examplesLibrary.getEntry("flows","test-module/throw").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -16,10 +16,11 @@
|
||||
|
||||
var should = require("should");
|
||||
var sinon = require("sinon");
|
||||
var fs = require("fs");
|
||||
|
||||
var NR_TEST_UTILS = require("nr-test-utils");
|
||||
var library = NR_TEST_UTILS.require("@node-red/runtime/lib/library/index")
|
||||
var localLibrary = NR_TEST_UTILS.require("@node-red/runtime/lib/library/local")
|
||||
var examplesLibrary = NR_TEST_UTILS.require("@node-red/runtime/lib/library/examples")
|
||||
|
||||
var mockLog = {
|
||||
log: sinon.stub(),
|
||||
@@ -34,6 +35,36 @@ var mockLog = {
|
||||
|
||||
|
||||
describe("runtime/library", function() {
|
||||
before(function() {
|
||||
sinon.stub(localLibrary,"getEntry",function(type,path) {
|
||||
return Promise.resolve({
|
||||
library: "local",
|
||||
type:type,
|
||||
path:path
|
||||
})
|
||||
});
|
||||
sinon.stub(localLibrary,"saveEntry",function(type, path, meta, body) {
|
||||
return Promise.resolve({
|
||||
library: "local",
|
||||
type:type,
|
||||
path:path,
|
||||
meta:meta,
|
||||
body:body
|
||||
})
|
||||
});
|
||||
sinon.stub(examplesLibrary,"getEntry",function(type,path) {
|
||||
return Promise.resolve({
|
||||
library: "_examples_",
|
||||
type:type,
|
||||
path:path
|
||||
})
|
||||
});
|
||||
});
|
||||
after(function() {
|
||||
localLibrary.getEntry.restore();
|
||||
localLibrary.saveEntry.restore();
|
||||
examplesLibrary.getEntry.restore();
|
||||
})
|
||||
describe("register", function() {
|
||||
// it("throws error for duplicate type", function() {
|
||||
// library.init({});
|
||||
@@ -43,47 +74,19 @@ describe("runtime/library", function() {
|
||||
})
|
||||
describe("getEntry", function() {
|
||||
before(function() {
|
||||
library.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
getLibraryEntry: function(type,path) {
|
||||
return Promise.resolve({type,path});
|
||||
},
|
||||
getFlow: function(path) {
|
||||
return Promise.resolve({path});
|
||||
}
|
||||
},
|
||||
nodes: {
|
||||
getNodeExampleFlowPath: function(module,entryPath) {
|
||||
if (module === "unknown") {
|
||||
return null;
|
||||
}
|
||||
return "/tmp/"+module+"/"+entryPath;
|
||||
}
|
||||
}
|
||||
});
|
||||
sinon.stub(fs,"readFile", function(path,opts,callback) {
|
||||
if (path === "/tmp/test-module/abc") {
|
||||
callback(null,"Example flow result");
|
||||
} else if (path === "/tmp/@scope/test-module/abc") {
|
||||
callback(null,"Example scope flow result");
|
||||
} else if (path === "/tmp/test-module/throw") {
|
||||
throw new Error("Instant error")
|
||||
} else {
|
||||
callback(new Error("Unexpected path:"+path))
|
||||
}
|
||||
})
|
||||
library.init({});
|
||||
});
|
||||
after(function() {
|
||||
fs.readFile.restore();
|
||||
})
|
||||
it('throws error for unregistered type', function() {
|
||||
should(()=>{library.getEntry("unknown","/abc")} ).throw();
|
||||
should(()=>{library.getEntry("local","unknown","/abc")} ).throw();
|
||||
});
|
||||
it('throws error for unknown library', function() {
|
||||
should(()=>{library.getEntry("unknown","unknown","/abc")} ).throw();
|
||||
});
|
||||
|
||||
it('returns a registered non-flow entry', function(done) {
|
||||
library.register("test-module","test-type");
|
||||
library.getEntry("test-type","/abc").then(function(result) {
|
||||
library.getEntry("local","test-type","/abc").then(function(result) {
|
||||
result.should.have.property("library","local")
|
||||
result.should.have.property("type","test-type")
|
||||
result.should.have.property("path","/abc")
|
||||
done();
|
||||
@@ -91,76 +94,37 @@ describe("runtime/library", function() {
|
||||
});
|
||||
|
||||
it ('returns a flow entry', function(done) {
|
||||
library.getEntry("flows","/abc").then(function(result) {
|
||||
library.getEntry("local","flows","/abc").then(function(result) {
|
||||
result.should.have.property("library","local")
|
||||
result.should.have.property("path","/abc")
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
|
||||
it ('returns a flow example entry', function(done) {
|
||||
library.getEntry("flows","_examples_/test-module/abc").then(function(result) {
|
||||
result.should.eql("Example flow result");
|
||||
library.getEntry("_examples_","flows","/test-module/abc").then(function(result) {
|
||||
result.should.have.property("library","_examples_")
|
||||
result.should.have.property("path","/test-module/abc")
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
|
||||
it ('returns a flow example entry from scoped module', function(done) {
|
||||
library.getEntry("flows","_examples_/@scope/test-module/abc").then(function(result) {
|
||||
result.should.eql("Example scope flow result");
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
it ('returns an error for unknown flow example entry', function(done) {
|
||||
library.getEntry("flows","_examples_/unknown/abc").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
err.should.have.property("code","not_found");
|
||||
done();
|
||||
});
|
||||
});
|
||||
it ('returns an error for file load error - async', function(done) {
|
||||
library.getEntry("flows","_examples_/test-module/unknown").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
done();
|
||||
});
|
||||
});
|
||||
it ('returns an error for file load error - sync', function(done) {
|
||||
library.getEntry("flows","_examples_/test-module/throw").then(function(result) {
|
||||
done(new Error("No error thrown"))
|
||||
}).catch(function(err) {
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("saveEntry", function() {
|
||||
before(function() {
|
||||
library.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
saveLibraryEntry: function(type, path, meta, body) {
|
||||
return Promise.resolve({type,path,meta,body})
|
||||
},
|
||||
saveFlow: function(path,body) {
|
||||
return Promise.resolve({path,body});
|
||||
}
|
||||
},
|
||||
nodes: {
|
||||
getNodeExampleFlowPath: function(module,entryPath) {
|
||||
if (module === "unknown") {
|
||||
return null;
|
||||
}
|
||||
return "/tmp/"+module+"/"+entryPath;
|
||||
}
|
||||
}
|
||||
});
|
||||
library.init({});
|
||||
});
|
||||
it('throws error for unknown library', function() {
|
||||
should(()=>{library.saveEntry("unknown","unknown","/abc",{id:"meta"},{id:"body"})} ).throw();
|
||||
});
|
||||
it('throws error for unregistered type', function() {
|
||||
should(()=>{library.saveEntry("unknown","/abc",{id:"meta"},{id:"body"})} ).throw();
|
||||
should(()=>{library.saveEntry("local","unknown","/abc",{id:"meta"},{id:"body"})} ).throw();
|
||||
});
|
||||
it('throws error for save to readonly library', function() {
|
||||
should(()=>{library.saveEntry("_examples_","unknown","/abc",{id:"meta"},{id:"body"})} ).throw();
|
||||
});
|
||||
it('saves a flow entry', function(done) {
|
||||
library.saveEntry('flows','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
library.saveEntry('local','flows','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
result.should.have.property("path","/abc");
|
||||
result.should.have.property("body",{id:"body"});
|
||||
done();
|
||||
@@ -168,7 +132,7 @@ describe("runtime/library", function() {
|
||||
})
|
||||
it('saves a non-flow entry', function(done) {
|
||||
library.register("test-module","test-type");
|
||||
library.saveEntry('test-type','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
library.saveEntry('local','test-type','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
result.should.have.property("type","test-type");
|
||||
result.should.have.property("path","/abc");
|
||||
result.should.have.property("meta",{id:"meta"});
|
||||
|
||||
93
test/unit/@node-red/runtime/lib/library/local_spec.js
Normal file
93
test/unit/@node-red/runtime/lib/library/local_spec.js
Normal file
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
* 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 NR_TEST_UTILS = require("nr-test-utils");
|
||||
var localLibrary = NR_TEST_UTILS.require("@node-red/runtime/lib/library/local")
|
||||
|
||||
var mockLog = {
|
||||
log: sinon.stub(),
|
||||
debug: sinon.stub(),
|
||||
trace: sinon.stub(),
|
||||
warn: sinon.stub(),
|
||||
info: sinon.stub(),
|
||||
metric: sinon.stub(),
|
||||
audit: sinon.stub(),
|
||||
_: function() { return "abc"}
|
||||
}
|
||||
|
||||
describe("runtime/library/local", function() {
|
||||
|
||||
describe("getEntry", function() {
|
||||
before(function() {
|
||||
localLibrary.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
getLibraryEntry: function(type,path) {
|
||||
return Promise.resolve({type,path});
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
it('returns a registered non-flow entry', function(done) {
|
||||
localLibrary.getEntry("test-type","/abc").then(function(result) {
|
||||
result.should.have.property("type","test-type")
|
||||
result.should.have.property("path","/abc")
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
|
||||
it ('returns a flow entry', function(done) {
|
||||
localLibrary.getEntry("flows","/abc").then(function(result) {
|
||||
result.should.have.property("path","/abc")
|
||||
done();
|
||||
}).catch(done);
|
||||
});
|
||||
});
|
||||
|
||||
describe("saveEntry", function() {
|
||||
before(function() {
|
||||
localLibrary.init({
|
||||
log: mockLog,
|
||||
storage: {
|
||||
saveLibraryEntry: function(type, path, meta, body) {
|
||||
return Promise.resolve({type,path,meta,body})
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
it('saves a flow entry', function(done) {
|
||||
localLibrary.saveEntry('flows','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
result.should.have.property("path","/abc");
|
||||
result.should.have.property("body",{id:"body"});
|
||||
done();
|
||||
}).catch(done);
|
||||
})
|
||||
it('saves a non-flow entry', function(done) {
|
||||
localLibrary.saveEntry('test-type','/abc',{id:"meta"},{id:"body"}).then(function(result) {
|
||||
result.should.have.property("type","test-type");
|
||||
result.should.have.property("path","/abc");
|
||||
result.should.have.property("meta",{id:"meta"});
|
||||
result.should.have.property("body",{id:"body"});
|
||||
done();
|
||||
}).catch(done);
|
||||
})
|
||||
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user