frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move sessionStorageModule into main storageModule

Browse Source 
Fixes #586

 - add get/saveSessions to main storage module
 - handle storage modules without those functions
 - store .session file in userDir
This commit is contained in:
Nick O'Leary
2015-03-13 23:37:59 +00:00
parent 731efe1c01
commit 51e891ff88
14 changed files with 243 additions and 517 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
test/red/api/auth/tokens/index_spec.js
View File

@@ -1,147 +0,0 @@
/**
* Copyright 2015 IBM Corp.
*
* 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 Tokens = require("../../../../../red/api/auth/tokens");
describe("Tokens", function() {
describe("#init",function() {
var module = require("module");
var originalLoader;
beforeEach(function() {
originalLoader = module._load;
});
afterEach(function() {
module._load = originalLoader;
});
it('loads default storage plugin', function(done) {
module._load = function(name) {
name.should.equal("./localfilesystem");
return {init: function(settings) {done()}};
}
try {
Tokens.init({});
} catch(err) {
done(err);
}
});
it('loads the specified storage plugin', function(done) {
module._load = function(name) {
name.should.equal("./aTestExample");
return {init: function(settings) {done()}};
}
try {
Tokens.init({sessionStorageModule:"aTestExample"});
} catch(err) {
done(err);
}
});
it('uses the provided storage plugin', function(done) {
Tokens.init({sessionStorageModule:{init:function(settings){done()}}});
});
});
describe("#get",function() {
it('returns a valid token', function(done) {
Tokens.init({sessionStorageModule:{
init:function(settings){},
get: function(token) {
return when.resolve({user:"fred"});
}
}});
Tokens.get("1234").then(function(token) {
try {
token.should.have.a.property("user","fred");
done();
} catch(err) {
done(err);
}
});
});
it('returns null for an invalid token', function(done) {
Tokens.init({sessionStorageModule:{
init:function(settings){},
get: function(token) {
return when.resolve(null);
}
}});
Tokens.get("1234").then(function(token) {
try {
should.not.exist(token);
done();
} catch(err) {
done(err);
}
});
});
});
describe("#create",function() {
it('creates a token', function(done) {
var sessionStorageModule = {
init:function(settings){},
create: sinon.stub().returns(when.resolve())
};
Tokens.init({sessionStorageModule:sessionStorageModule});
Tokens.create("user","client","scope").then(function(token) {
try {
sessionStorageModule.create.called.should.be.true;
token.should.have.a.property('accessToken',sessionStorageModule.create.args[0][0]);
sessionStorageModule.create.args[0][1].should.have.a.property('user','user');
sessionStorageModule.create.args[0][1].should.have.a.property('client','client');
sessionStorageModule.create.args[0][1].should.have.a.property('scope','scope');
done();
} catch(err) {
done(err);
}
});
});
});
describe("#revoke", function() {
it('revokes a token', function(done) {
var deletedToken;
Tokens.init({sessionStorageModule:{
init:function(settings){},
delete: function(token) {
deletedToken = token;
return when.resolve(null);
}
}});
Tokens.revoke("1234").then(function() {
try {
deletedToken.should.equal("1234");
done();
} catch(err) {
done(err);
}
});
});
});
});

96
test/red/api/auth/tokens/localfilesystem_spec.js
View File

@@ -1,96 +0,0 @@
/**
* Copyright 2015 IBM Corp.
*
* 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 fs = require('fs-extra');
var path = require('path');
var localfilesystem = require("../../../../../red/api/auth/tokens/localfilesystem.js");
describe("Tokens localfilesystem", function() {
var userDir = path.join(__dirname,".testUserHome");
beforeEach(function(done) {
fs.remove(userDir,function(err) {
fs.mkdir(userDir,done);
});
});
afterEach(function(done) {
fs.remove(userDir,done);
});
it("initialise when no session file exists",function(done) {
localfilesystem.init({userDir:userDir}).then(function() {
localfilesystem.get("1234").then(function(token) {
should.not.exist(token);
done();
});
});
});
it("initialises when session file exists", function(done) {
var sessions = {"1234":{"user":"nol","client":"node-red-admin","scope":["*"],"accessToken":"1234"}};
fs.writeFileSync(path.join(userDir,".sessions.json"),JSON.stringify(sessions),"utf8");
localfilesystem.init({userDir:userDir}).then(function() {
localfilesystem.get("1234").then(function(token) {
token.should.eql(sessions['1234']);
done();
});
});
});
it("writes new tokens to the session file",function(done) {
var sessions = {"1234":{"user":"nol","client":"node-red-admin","scope":["*"],"accessToken":"1234"}};
fs.writeFileSync(path.join(userDir,".sessions.json"),JSON.stringify(sessions),"utf8");
localfilesystem.init({userDir:userDir}).then(function() {
localfilesystem.create("5678",{
user:"fred",
client:"client",
scope:["read"],
accessToken:"5678"
}).then(function() {
var newSessions = JSON.parse(fs.readFileSync(path.join(userDir,".sessions.json"),"utf8"));
newSessions.should.have.a.property("1234");
newSessions.should.have.a.property("5678");
done();
});
});
});
it("deletes tokens from the session file",function(done) {
var sessions = {
"1234":{"user":"nol","client":"node-red-admin","scope":["*"],"accessToken":"1234"},
"5678":{"user":"fred","client":"client","scope":["read"],"accessToken":"5678"}
};
fs.writeFileSync(path.join(userDir,".sessions.json"),JSON.stringify(sessions),"utf8");
localfilesystem.init({userDir:userDir}).then(function() {
localfilesystem.delete("5678").then(function() {
var newSessions = JSON.parse(fs.readFileSync(path.join(userDir,".sessions.json"),"utf8"));
newSessions.should.have.a.property("1234");
newSessions.should.not.have.a.property("5678");
done();
});
});
});
});

127
test/red/api/auth/tokens_spec.js Normal file
View File

@@ -0,0 +1,127 @@
/**
* Copyright 2015 IBM Corp.
*
* 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 Tokens = require("../../../../red/api/auth/tokens");
describe("Tokens", function() {
describe("#init",function() {
it('loads sessions', function(done) {
Tokens.init({
getSessions:function() {
done();
return when.resolve();
}
});
});
});
describe("#get",function() {
it('returns a valid token', function(done) {
Tokens.init({
getSessions:function() {
return when.resolve({"1234":{"user":"fred"}});
}
}).then(function() {
Tokens.get("1234").then(function(token) {
try {
token.should.have.a.property("user","fred");
done();
} catch(err) {
done(err);
}
});
});
});
it('returns null for an invalid token', function(done) {
Tokens.init({
getSessions:function() {
return when.resolve({});
}
}).then(function() {
Tokens.get("1234").then(function(token) {
try {
should.not.exist(token);
done();
} catch(err) {
done(err);
}
});
});
});
});
describe("#create",function() {
it('creates a token', function(done) {
var savedSession;
Tokens.init({
getSessions:function() {
return when.resolve({});
},
saveSessions:function(sess) {
savedSession = sess;
return when.resolve();
}
});
Tokens.create("user","client","scope").then(function(token) {
try {
should.exist(savedSession);
var sessionKeys = Object.keys(savedSession);
sessionKeys.should.have.lengthOf(1);
token.should.have.a.property('accessToken',sessionKeys[0]);
savedSession[sessionKeys[0]].should.have.a.property('user','user');
savedSession[sessionKeys[0]].should.have.a.property('client','client');
savedSession[sessionKeys[0]].should.have.a.property('scope','scope');
done();
} catch(err) {
done(err);
}
});
});
});
describe("#revoke", function() {
it('revokes a token', function(done) {
var savedSession;
Tokens.init({
getSessions:function() {
return when.resolve({"1234":{"user":"fred"}});
},
saveSessions:function(sess) {
savedSession = sess;
return when.resolve();
}
}).then(function() {
Tokens.revoke("1234").then(function() {
try {
savedSession.should.not.have.a.property("1234");
done();
} catch(err) {
done(err);
}
});
});
});
});
});

3
test/red/api/index_spec.js
View File

@@ -17,6 +17,7 @@
var should = require("should");
var request = require("supertest");
var express = require("express");
var when = require("when");
var fs = require("fs");
var path = require("path");
var settings = require("../../../red/settings");
@@ -62,7 +63,7 @@ describe("api index", function() {
//settings.init({disableEditor:true});
settings.init({adminAuth:{type: "credentials",users:[],default:{permissions:"read"}}});
app = express();
api.init(app);
api.init(app,{getSessions:function(){return when.resolve({})}});
});
after(function() {
settings.reset();

129
test/red/nodes/credentials_spec.js
View File

@@ -332,134 +332,5 @@ describe('Credentials', function() {
});
});
//describe('registerEndpoint', function() {
// var path = require('path');
// var fs = require('fs-extra');
// var http = require('http');
// var express = require('express');
// var request = require('supertest');
//
// var server = require("../../../red/server");
// var localfilesystem = require("../../../red/storage/localfilesystem");
// var app = express();
// var RED = require("../../../red/red.js");
//
// var userDir = path.join(__dirname,".testUserHome");
// before(function(done) {
// fs.remove(userDir,function(err) {
// fs.mkdir(userDir,function() {
// sinon.stub(index, 'load', function() {
// return when.promise(function(resolve,reject){
// resolve([]);
// });
// });
// sinon.stub(localfilesystem, 'getCredentials', function() {
// return when.promise(function(resolve,reject) {
// resolve({"tab1":{"foo": 2, "pswd":'sticks'}});
// });
// }) ;
// RED.init(http.createServer(function(req,res){app(req,res)}),
// {userDir: userDir});
// server.start().then(function () {
// done();
// });
// });
// });
// });
//
// after(function(done) {
// fs.remove(userDir,done);
// server.stop();
// index.load.restore();
// localfilesystem.getCredentials.restore();
// });
//
// function TestNode(n) {
// index.createNode(this, n);
// var node = this;
// this.on("log", function() {
// // do nothing
// });
// }
//
// it(': valid credential type', function(done) {
// index.registerType('test', TestNode, {
// credentials: {
// foo: {type:"test"}
// }
// });
// index.loadFlows().then(function() {
// var testnode = new TestNode({id:'tab1',type:'foo',name:'barney'});
// request(RED.httpAdmin).get('/credentials/test/tab1').expect(200).end(function(err,res) {
// if (err) {
// done(err);
// }
// res.body.should.have.property('foo', 2);
// done();
// });
// }).otherwise(function(err){
// done(err);
// });
// });
//
// it(': password credential type', function(done) {
// index.registerType('password', TestNode, {
// credentials: {
// pswd: {type:"password"}
// }
// });
// index.loadFlows().then(function() {
// var testnode = new TestNode({id:'tab1',type:'pswd',name:'barney'});
// request(RED.httpAdmin).get('/credentials/password/tab1').expect(200).end(function(err,res) {
// if (err) {
// done(err);
// }
// res.body.should.have.property('has_pswd', true);
// res.body.should.not.have.property('pswd');
// done();
// });
// }).otherwise(function(err){
// done(err);
// });
// });
//
// it(': returns 404 for undefined credential type', function(done) {
// index.registerType('test', TestNode, {
// credentials: {
// foo: {type:"test"}
// }
// });
// index.loadFlows().then(function() {
// var testnode = new TestNode({id:'tab1',type:'foo',name:'barney'});
// request(RED.httpAdmin).get('/credentials/unknownType/tab1').expect(404).end(done);
// }).otherwise(function(err){
// done(err);
// });
// });
//
// it(': undefined nodeID', function(done) {
// index.registerType('test', TestNode, {
// credentials: {
// foo: {type:"test"}
// }
// });
// index.loadFlows().then(function() {
// var testnode = new TestNode({id:'tab1',type:'foo',name:'barney'});
// request(RED.httpAdmin).get('/credentials/test/unknownNode').expect(200).end(function(err,res) {
// if (err) {
// done(err);
// }
// var b = res.body;
// res.body.should.not.have.property('foo');
// done();
// });
// }).otherwise(function(err){
// done(err);
// });
// });
//
//})
})

22
test/red/server_spec.js
View File

@@ -44,13 +44,11 @@ describe("red/server", function() {
it("initialises components", function() {
var commsInit = sinon.stub(comms,"init",function() {});
var apiInit = sinon.stub(api,"init",function() {});
var dummyServer = {};
server.init(dummyServer,{httpAdminRoot:"/"});
commsInit.called.should.be.true;
apiInit.called.should.be.true;
should.exist(server.app);
should.exist(server.nodeApp);
@@ -58,26 +56,6 @@ describe("red/server", function() {
server.server.should.equal(dummyServer);
commsInit.restore();
apiInit.restore();
});
it("does not initalise api when disabled", function() {
var commsInit = sinon.stub(comms,"init",function() {});
var apiInit = sinon.stub(api,"init",function() {});
var dummyServer = {};
server.init(dummyServer,{httpAdminRoot:false});
commsInit.called.should.be.true;
apiInit.called.should.be.false;
should.exist(server.app);
should.exist(server.nodeApp);
server.server.should.equal(dummyServer);
commsInit.restore();
apiInit.restore();
});
it("stops components", function() {

58
test/red/storage/index_spec.js
View File

@@ -14,6 +14,7 @@
* limitations under the License.
**/
var should = require("should");
var storage = require("../../../red/storage/index");
describe("red/storage/index", function() {
@@ -23,7 +24,6 @@ describe("red/storage/index", function() {
storageModule : "thisaintloading"
};
var storage = require("../../../red/storage/index");
storage.init(wrongModule).then( function() {
var one = 1;
var zero = 0;
@@ -50,17 +50,18 @@ describe("red/storage/index", function() {
storageModule : moduleWithBooleanSettingInit
};
var storage = require("../../../red/storage/index");
storage.init(setsBooleanModule);
initSetsMeToTrue.should.be.true;
done();
});
it('respects storage interface', function(done) {
it('respects storage interface', function() {
var calledFlagGetFlows = false;
var calledFlagGetCredentials = false;
var calledFlagGetAllFlows = false;
var calledInit = false;
var calledFlagGetSettings = false;
var calledFlagGetSessions = false;
var interfaceCheckerModule = {
init : function (settings) {
@@ -79,6 +80,18 @@ describe("red/storage/index", function() {
saveCredentials : function(credentials) {
credentials.should.be.true;
},
getSettings : function() {
calledFlagGetSettings = true;
},
saveSettings : function(settings) {
settings.should.be.true;
},
getSessions : function() {
calledFlagGetSessions = true;
},
saveSessions : function(sessions) {
sessions.should.be.true;
},
getAllFlows : function() {
calledFlagGetAllFlows = true;
},
@@ -102,15 +115,18 @@ describe("red/storage/index", function() {
};
var moduleToLoad = {
storageModule : interfaceCheckerModule
storageModule : interfaceCheckerModule
};
var storage = require("../../../red/storage/index");
storage.init(moduleToLoad);
storage.getFlows();
storage.saveFlows(true);
storage.getCredentials();
storage.saveCredentials(true);
storage.getSettings();
storage.saveSettings(true);
storage.getSessions();
storage.saveSessions(true);
storage.getAllFlows();
storage.getFlow("name");
storage.saveFlow("name", true);
@@ -121,8 +137,38 @@ describe("red/storage/index", function() {
calledFlagGetFlows.should.be.true;
calledFlagGetCredentials.should.be.true;
calledFlagGetAllFlows.should.be.true;
});
describe('handles missing settings/sessions interface', function() {
before(function() {
var interfaceCheckerModule = {
init : function () {}
};
storage.init({storageModule: interfaceCheckerModule});
});
done();
it('defaults missing getSettings',function(done) {
storage.getSettings().then(function(settings) {
should.not.exist(settings);
done();
});
});
it('defaults missing saveSettings',function(done) {
storage.saveSettings({}).then(function() {
done();
});
});
it('defaults missing getSessions',function(done) {
storage.getSessions().then(function(settings) {
should.not.exist(settings);
done();
});
});
it('defaults missing saveSessions',function(done) {
storage.saveSessions({}).then(function() {
done();
});
});
});
});