1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/test/red/runtime/nodes/context/index_spec.js

562 lines
24 KiB
JavaScript
Raw Normal View History

2015-12-29 23:16:51 +01:00
/**
* Copyright JS Foundation and other contributors, http://js.foundation
2015-12-29 23:16:51 +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 sinon = require('sinon');
var rewire = require("rewire");
var Context = require("../../../../../red/runtime/nodes/context/index");
2015-12-29 23:16:51 +01:00
describe('context', function() {
2018-05-30 03:24:27 +02:00
describe('local memory',function() {
beforeEach(function() {
Context.init({});
2018-05-30 03:24:27 +02:00
return Context.load();
});
afterEach(function() {
Context.clean({allNodes:{}});
2018-05-30 03:24:27 +02:00
return Context.close();
});
it('stores local property',function() {
var context1 = Context.get("1","flowA");
should.not.exist(context1.get("foo"));
context1.set("foo","test");
context1.get("foo").should.eql("test");
});
it('stores local property - creates parent properties',function() {
var context1 = Context.get("1","flowA");
context1.set("foo.bar","test");
context1.get("foo").should.eql({bar:"test"});
});
it('deletes local property',function() {
var context1 = Context.get("1","flowA");
context1.set("foo.abc.bar1","test1");
context1.set("foo.abc.bar2","test2");
context1.get("foo.abc").should.eql({bar1:"test1",bar2:"test2"});
context1.set("foo.abc.bar1",undefined);
context1.get("foo.abc").should.eql({bar2:"test2"});
context1.set("foo.abc",undefined);
should.not.exist(context1.get("foo.abc"));
context1.set("foo",undefined);
should.not.exist(context1.get("foo"));
});
it('stores flow property',function() {
var context1 = Context.get("1","flowA");
should.not.exist(context1.flow.get("foo"));
context1.flow.set("foo","test");
context1.flow.get("foo").should.eql("test");
});
it('stores global property',function() {
var context1 = Context.get("1","flowA");
should.not.exist(context1.global.get("foo"));
context1.global.set("foo","test");
context1.global.get("foo").should.eql("test");
});
it('keeps local context local', function() {
var context1 = Context.get("1","flowA");
var context2 = Context.get("2","flowA");
should.not.exist(context1.get("foo"));
should.not.exist(context2.get("foo"));
context1.set("foo","test");
context1.get("foo").should.eql("test");
should.not.exist(context2.get("foo"));
});
it('flow context accessible to all flow nodes', function() {
var context1 = Context.get("1","flowA");
var context2 = Context.get("2","flowA");
should.not.exist(context1.flow.get("foo"));
should.not.exist(context2.flow.get("foo"));
context1.flow.set("foo","test");
context1.flow.get("foo").should.eql("test");
context2.flow.get("foo").should.eql("test");
});
it('flow context not shared to nodes on other flows', function() {
var context1 = Context.get("1","flowA");
var context2 = Context.get("2","flowB");
should.not.exist(context1.flow.get("foo"));
should.not.exist(context2.flow.get("foo"));
context1.flow.set("foo","test");
context1.flow.get("foo").should.eql("test");
should.not.exist(context2.flow.get("foo"));
});
it('global context shared to all nodes', function() {
var context1 = Context.get("1","flowA");
var context2 = Context.get("2","flowB");
should.not.exist(context1.global.get("foo"));
should.not.exist(context2.global.get("foo"));
context1.global.set("foo","test");
context1.global.get("foo").should.eql("test");
context2.global.get("foo").should.eql("test");
});
it('deletes context',function() {
var context = Context.get("1","flowA");
should.not.exist(context.get("foo"));
context.set("foo","abc");
context.get("foo").should.eql("abc");
return Context.delete("1","flowA").then(function(){
context = Context.get("1","flowA");
should.not.exist(context.get("foo"));
});
});
it('enumerates context keys', function() {
var context = Context.get("1","flowA");
var keys = context.keys();
keys.should.be.an.Array();
keys.should.be.empty();
context.set("foo","bar");
keys = context.keys();
keys.should.have.length(1);
keys[0].should.eql("foo");
context.set("abc.def","bar");
keys = context.keys();
keys.should.have.length(2);
keys[1].should.eql("abc");
});
2015-12-29 23:16:51 +01:00
2018-05-31 02:47:21 +02:00
it('should enumerate only context keys when GlobalContext was given', function() {
Context.init({functionGlobalContext: {foo:"bar"}});
return Context.load().then(function(){
var context = Context.get("1","flowA");
var keys = context.global.keys("global");
keys.should.have.length(1);
keys[0].should.eql("foo");
});
});
2018-05-30 03:24:27 +02:00
it('should store data on memory when contextStorage is not defined', function() {
var context = Context.get("1","flow");
context.set("#nonexist.key1", "val1");
context.get("#nonexist.key1").should.eql("val1");
context.flow.set("#nonexist.key2", "val2");
context.flow.get("#nonexist.key2").should.eql("val2");
context.global.set("#nonexist.key1", "val3");
context.global.get("#nonexist.key1").should.eql("val3");
});
2018-05-30 03:24:27 +02:00
});
2018-05-30 03:24:27 +02:00
describe('external context storage',function() {
var sandbox = sinon.sandbox.create();
var stubGet = sandbox.stub();
var stubSet = sandbox.stub();
var stubKeys = sandbox.stub();
var stubDelete = sandbox.stub().returns(Promise.resolve());
var stubClean = sandbox.stub().returns(Promise.resolve());
var stubOpen = sandbox.stub().returns(Promise.resolve());
var stubClose = sandbox.stub().returns(Promise.resolve());
var stubGet2 = sandbox.stub();
var stubSet2 = sandbox.stub();
var stubKeys2 = sandbox.stub();
var stubDelete2 = sandbox.stub().returns(Promise.resolve());
var stubClean2 = sandbox.stub().returns(Promise.resolve());
var stubOpen2 = sandbox.stub().returns(Promise.resolve());
var stubClose2 = sandbox.stub().returns(Promise.resolve());
var testPlugin = function(config){
function Test(){}
Test.prototype.get = stubGet;
Test.prototype.set = stubSet;
Test.prototype.keys = stubKeys;
Test.prototype.delete = stubDelete;
Test.prototype.clean = stubClean;
Test.prototype.open = stubOpen;
Test.prototype.close = stubClose;
return new Test(config);
};
var testPlugin2 = function(config){
function Test2(){}
Test2.prototype.get = stubGet2;
Test2.prototype.set = stubSet2;
Test2.prototype.keys = stubKeys2;
Test2.prototype.delete = stubDelete2;
Test2.prototype.clean = stubClean2;
Test2.prototype.open = stubOpen2;
Test2.prototype.close = stubClose2;
return new Test2(config);
};
var contextStorage={
test:{
module: testPlugin,
config:{}
}
};
var contextDefaultStorage={
default: {
module: testPlugin2,
config:{}
},
test:{
module: testPlugin,
config:{}
}
};
afterEach(function() {
sandbox.reset();
return Context.clean({allNodes:{}}).then(function(){
2018-05-30 03:24:27 +02:00
return Context.close();
});
});
describe('load modules',function(){
it('should call open()', function() {
Context.init({contextStorage:contextDefaultStorage});
return Context.load().then(function(){
stubOpen.called.should.be.true();
stubOpen2.called.should.be.true();
});
});
2018-05-30 03:24:27 +02:00
it('should load memory module', function() {
Context.init({contextStorage:{memory:{module:"memory"}}});
return Context.load();
});
2018-05-30 03:24:27 +02:00
it('should load localfilesystem module', function() {
Context.init({contextStorage:{file:{module:"localfilesystem"}}});
return Context.load();
});
2018-05-30 03:24:27 +02:00
it('should accept special storage name', function() {
Context.init({
contextStorage:{
"#%&":{module:"memory"},
\u3042:{module:"memory"},
1:{module:"memory"},
}
});
return Context.load().then(function(){
var context = Context.get("1","flow");
context.set("##%&.sign","sign1");
context.get("##%&.sign").should.eql("sign1");
context.set("#\u3042.file2","file2");
context.get("#\u3042.file2").should.eql("file2");
context.set("#1.num","num3");
context.get("#1.num").should.eql("num3");
});
});
it('should ignore reserved storage name `_`', function() {
Context.init({contextStorage:{_:{module:testPlugin}}});
return Context.load().then(function(){
var context = Context.get("1","flow");
context.set("#_.foo","bar");
context.get("#_.foo");
context.keys("#_");
stubSet.called.should.be.false();
stubGet.called.should.be.false();
stubKeys.called.should.be.false();
});
});
2018-05-30 03:24:27 +02:00
it('should fail when using invalid default context', function(done) {
Context.init({contextStorage:{default:"noexist"}});
Context.load().then(function(){
done("An error was not thrown");
}).catch(function(){
done();
});
});
it('should fail for the storage with no module', function(done) {
Context.init({ contextStorage: { test: {}}});
Context.load().then(function(){
done("An error was not thrown");
}).catch(function(){
done();
});
});
it('should fail to load non-existent module', function(done) {
Context.init({contextStorage:{ file:{module:"nonexistent"} }});
Context.load().then(function(){
done("An error was not thrown");
}).catch(function(){
done();
});
});
});
describe('close modules',function(){
it('should call close()', function() {
Context.init({contextStorage:contextDefaultStorage});
return Context.load().then(function(){
return Context.close().then(function(){
stubClose.called.should.be.true();
stubClose2.called.should.be.true();
});
});
2018-05-30 03:24:27 +02:00
});
});
describe('store context',function() {
it('should store local property to external context storage',function() {
2018-05-30 03:24:27 +02:00
Context.init({contextStorage:contextStorage});
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.get("#test.foo"));
context.set("#test.foo","test");
context.get("#test.foo");
context.keys("#test");
stubSet.calledWithExactly("1:flow","foo","test").should.be.true();
stubGet.calledWithExactly("1:flow","foo").should.be.true();
stubKeys.calledWithExactly("1:flow").should.be.true();
});
});
it('should store flow property to external context storage',function() {
2018-05-30 03:24:27 +02:00
Context.init({contextStorage:contextStorage});
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.flow.get("#test.foo"));
context.flow.set("#test.foo","test");
context.flow.get("#test.foo");
context.flow.keys("#test");
stubSet.calledWithExactly("flow","foo","test").should.be.true();
stubGet.calledWithExactly("flow","foo").should.be.true();
stubKeys.calledWithExactly("flow").should.be.true();
});
});
it('should store global property to external context storage',function() {
2018-05-30 03:24:27 +02:00
Context.init({contextStorage:contextStorage});
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.global.get("#test.foo"));
context.global.set("#test.foo","test");
context.global.get("#test.foo");
context.global.keys("#test");
stubSet.calledWithExactly("global","foo","test").should.be.true();
stubGet.calledWithExactly("global","foo").should.be.true();
stubKeys.calledWithExactly("global").should.be.true();
});
});
2018-05-30 03:24:27 +02:00
it('should store data to the default context when non-existent context storage was specified', function() {
2018-03-28 08:54:16 +02:00
Context.init({contextStorage:contextDefaultStorage});
2018-05-30 03:24:27 +02:00
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.get("#nonexist.foo"));
context.set("#nonexist.foo","test");
context.get("#nonexist.foo");
context.keys("#nonexist");
stubGet.called.should.be.false();
stubSet.called.should.be.false();
stubKeys.called.should.be.false();
stubSet2.calledWithExactly("1:flow","foo","test").should.be.true();
stubGet2.calledWithExactly("1:flow","foo").should.be.true();
stubKeys2.calledWithExactly("1:flow").should.be.true();
});
2018-03-28 08:54:16 +02:00
});
it('should use the default context', function() {
Context.init({contextStorage:contextDefaultStorage});
2018-05-30 03:24:27 +02:00
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.get("#default.foo"));
context.set("#default.foo","default");
context.get("#default.foo");
context.keys("#default");
stubGet.called.should.be.false();
stubSet.called.should.be.false();
stubKeys.called.should.be.false();
stubSet2.calledWithExactly("1:flow","foo","default").should.be.true();
stubGet2.calledWithExactly("1:flow","foo").should.be.true();
stubKeys2.calledWithExactly("1:flow").should.be.true();
});
});
it('should use the alias of default context', function() {
Context.init({contextStorage:contextDefaultStorage});
2018-05-30 03:24:27 +02:00
return Context.load().then(function(){
var context = Context.get("1","flow");
should.not.exist(context.get("#.foo"));
context.set("#.foo","alias");
context.get("#.foo");
context.keys("#");
stubGet.called.should.be.false();
stubSet.called.should.be.false();
stubKeys.called.should.be.false();
stubSet2.calledWithExactly("1:flow","foo","alias").should.be.true();
stubGet2.calledWithExactly("1:flow","foo").should.be.true();
stubKeys2.calledWithExactly("1:flow").should.be.true();
});
});
2018-03-28 08:54:16 +02:00
it('should throw an error using undefined storage for local context', function(done) {
2018-05-30 03:24:27 +02:00
Context.init({contextStorage:contextStorage});
Context.load().then(function(){
var context = Context.get("1","flow");
2018-05-23 03:23:39 +02:00
context.get("#nonexist.local");
2018-03-28 08:54:16 +02:00
should.fail(null, null, "An error was not thrown using undefined storage for local context");
2018-05-30 03:24:27 +02:00
}).catch(function(err) {
2018-03-28 08:54:16 +02:00
if (err.name === "ContextError") {
done();
} else {
done(err);
}
2018-05-30 03:24:27 +02:00
});
});
2018-03-28 08:54:16 +02:00
it('should throw an error using undefined storage for flow context', function(done) {
2018-05-30 03:24:27 +02:00
Context.init({contextStorage:contextStorage});
Context.load().then(function(){
var context = Context.get("1","flow");
2018-05-23 03:23:39 +02:00
context.flow.set("#nonexist.flow");
2018-03-28 08:54:16 +02:00
should.fail(null, null, "An error was not thrown using undefined storage for flow context");
2018-05-30 03:24:27 +02:00
}).catch(function(err) {
2018-03-28 08:54:16 +02:00
if (err.name === "ContextError") {
done();
} else {
done(err);
}
2018-05-30 03:24:27 +02:00
});
});
2018-05-30 03:24:27 +02:00
});
describe('delete context',function(){
it('should not call delete()', function() {
Context.init({contextStorage:contextDefaultStorage});
return Context.load().then(function(){
Context.get("flowA");
return Context.delete("flowA").then(function(){
stubDelete.called.should.be.false();
stubDelete2.called.should.be.false();
});
});
});
});
describe('clean context',function(){
it('should call clean()', function() {
Context.init({contextStorage:contextDefaultStorage});
return Context.load().then(function(){
return Context.clean({allNodes:{}}).then(function(){
stubClean.calledWithExactly([]).should.be.true();
stubClean2.calledWithExactly([]).should.be.true();
});
});
});
});
2018-05-30 03:24:27 +02:00
describe('key name',function() {
beforeEach(function() {
Context.init({contextStorage:{memory:{module:"memory"}}});
return Context.load().then(function(){
context = Context.get("1","flow");
});
});
afterEach(function() {
Context.clean({allNodes:{}});
return Context.close();
2018-03-28 08:54:16 +02:00
});
2018-05-30 03:24:27 +02:00
it('should work correctly with the valid key name',function() {
context.set("#memory.azAZ09#_","valid");
context.get("#memory.azAZ09#_").should.eql("valid");
context.set("#memory.a.b","ab");
context.get("#memory.a.b").should.eql("ab");
2018-03-28 08:54:16 +02:00
});
2018-05-30 03:24:27 +02:00
it('should treat the key name without dot as a normal context',function() {
context.set("#memory","normal");
context.get("#memory").should.eql("normal");
});
it('should fail when specifying invalid characters',function() {
(function() {
2018-05-30 03:24:27 +02:00
context.set("#memory.a.-","invalid1");
}).should.throw();
(function() {
context.set("#memory.'abc","invalid2");
}).should.throw();
2018-03-28 08:54:16 +02:00
});
2018-05-30 03:24:27 +02:00
it('should fail when specifying unnecesary space characters for key name',function() {
(function() {
context.set("# memory.space","space1");
}).should.throw();
(function() {
2018-05-30 03:24:27 +02:00
context.set("#memory .space","space2");
}).should.throw();
(function() {
context.set("#memory. space","space3");
}).should.throw();
});
});
2015-12-29 23:16:51 +01:00
});
describe('#parseKey()', function() {
var parseKey = rewire("../../../../../red/runtime/nodes/context/index").__get__("parseKey");
function returnModuleAndKey(input, expectedModule, expectedKey) {
var result = parseKey(input);
2018-03-28 08:54:16 +02:00
result.storage.should.eql(expectedModule);
result.key.should.eql(expectedKey);
}
2018-03-28 08:54:16 +02:00
it('should return module and key', function() {
2018-05-23 03:23:39 +02:00
returnModuleAndKey("#test.aaa","test","aaa");
returnModuleAndKey("#test.aaa.bbb","test","aaa.bbb");
returnModuleAndKey("#1.234","1","234");
returnModuleAndKey("##test.foo","#test","foo");
returnModuleAndKey("#test.#foo","test","#foo");
returnModuleAndKey("#test.#foo.#bar","test","#foo.#bar");
returnModuleAndKey("#test..foo","test",".foo");
returnModuleAndKey("#test..","test",".");
returnModuleAndKey("#te-_st.aaa","te-_st","aaa");
returnModuleAndKey("#te{st.a2","te{st","a2");
returnModuleAndKey("#te[st.a3","te[st","a3");
returnModuleAndKey("#te'st.a4","te'st","a4");
returnModuleAndKey("#te\"st.a5","te\"st","a5");
});
2018-03-28 08:54:16 +02:00
it('should return module as default', function() {
2018-05-23 03:23:39 +02:00
returnModuleAndKey("#default.foo","default","foo");
returnModuleAndKey("#.foo","default","foo");
});
it('should return only keys', function() {
returnModuleAndKey("test.aaa", "", "test.aaa");
returnModuleAndKey("test", "", "test");
2018-05-23 03:23:39 +02:00
returnModuleAndKey("#test", "", "#test");
});
it('should fail with null key', function() {
(function() {
parseKey("");
}).should.throw();
2018-03-28 08:54:16 +02:00
(function() {
parseKey(null);
}).should.throw();
});
it('should fail with space character', function() {
(function() {
2018-05-23 03:23:39 +02:00
parseKey(" #test");
}).should.throw();
(function() {
2018-05-23 03:23:39 +02:00
parseKey("#test .a");
}).should.throw();
});
2018-03-28 08:54:16 +02:00
it('should fail with empty key', function() {
(function() {
2018-05-23 03:23:39 +02:00
parseKey("#test.");
}).should.throw();
});
});
2015-12-29 23:16:51 +01:00
});