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/storage/localfilesystem/index_spec.js

477 lines
19 KiB
JavaScript
Raw Normal View History

2014-07-17 09:08:24 +02:00
/**
* Copyright JS Foundation and other contributors, http://js.foundation
2014-07-17 09:08:24 +02: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 fs = require('fs-extra');
var path = require('path');
var sinon = require('sinon');
var localfilesystem = require("../../../../../red/runtime/storage/localfilesystem");
2018-04-23 15:24:51 +02:00
var log = require("../../../../../red/util/log");
describe('storage/localfilesystem', function() {
2017-09-20 11:30:07 +02:00
var mockRuntime = {
log:{
_:function() { return "placeholder message"},
info: function() { },
warn: function() { },
trace: function() {}
2017-09-20 11:30:07 +02:00
}
};
var userDir = path.join(__dirname,".testUserHome");
var testFlow = [{"type":"tab","id":"d8be2a6d.2741d8","label":"Sheet 1"}];
2014-03-31 15:37:38 +02:00
beforeEach(function(done) {
fs.remove(userDir,function(err) {
fs.mkdir(userDir,done);
});
});
2014-03-31 15:37:38 +02:00
afterEach(function(done) {
fs.remove(userDir,done);
});
2014-03-31 15:37:38 +02:00
it('should initialise the user directory',function(done) {
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir}, mockRuntime).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(path.join(userDir,"lib")).should.be.true();
fs.existsSync(path.join(userDir,"lib",'flows')).should.be.true();
2014-03-31 15:37:38 +02:00
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should set userDir to NRH if .config.json presents',function(done) {
2015-03-22 18:40:12 +01:00
var oldNRH = process.env.NODE_RED_HOME;
process.env.NODE_RED_HOME = path.join(userDir,"NRH");
fs.mkdirSync(process.env.NODE_RED_HOME);
fs.writeFileSync(path.join(process.env.NODE_RED_HOME,".config.json"),"{}","utf8");
var settings = {};
2017-09-20 11:30:07 +02:00
localfilesystem.init(settings, mockRuntime).then(function() {
2015-03-22 18:40:12 +01:00
try {
2016-10-10 14:27:43 +02:00
fs.existsSync(path.join(process.env.NODE_RED_HOME,"lib")).should.be.true();
fs.existsSync(path.join(process.env.NODE_RED_HOME,"lib",'flows')).should.be.true();
2015-03-22 18:40:12 +01:00
settings.userDir.should.equal(process.env.NODE_RED_HOME);
done();
} catch(err) {
done(err);
} finally {
process.env.NODE_RED_HOME = oldNRH;
}
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
});
it('should set userDir to HOMEPATH/.node-red if .config.json presents',function(done) {
var oldNRH = process.env.NODE_RED_HOME;
process.env.NODE_RED_HOME = path.join(userDir,"NRH");
var oldHOMEPATH = process.env.HOMEPATH;
process.env.HOMEPATH = path.join(userDir,"HOMEPATH");
fs.mkdirSync(process.env.HOMEPATH);
fs.mkdirSync(path.join(process.env.HOMEPATH,".node-red"));
fs.writeFileSync(path.join(process.env.HOMEPATH,".node-red",".config.json"),"{}","utf8");
var settings = {};
2017-09-20 11:30:07 +02:00
localfilesystem.init(settings, mockRuntime).then(function() {
try {
fs.existsSync(path.join(process.env.HOMEPATH,".node-red","lib")).should.be.true();
fs.existsSync(path.join(process.env.HOMEPATH,".node-red","lib",'flows')).should.be.true();
settings.userDir.should.equal(path.join(process.env.HOMEPATH,".node-red"));
done();
} catch(err) {
done(err);
} finally {
process.env.NODE_RED_HOME = oldNRH;
process.env.NODE_HOMEPATH = oldHOMEPATH;
}
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
2015-03-22 18:40:12 +01:00
it('should set userDir to HOME/.node-red',function(done) {
var oldNRH = process.env.NODE_RED_HOME;
process.env.NODE_RED_HOME = path.join(userDir,"NRH");
var oldHOME = process.env.HOME;
process.env.HOME = path.join(userDir,"HOME");
var oldHOMEPATH = process.env.HOMEPATH;
process.env.HOMEPATH = path.join(userDir,"HOMEPATH");
2015-03-22 18:40:12 +01:00
fs.mkdirSync(process.env.HOME);
var settings = {};
2017-09-20 11:30:07 +02:00
localfilesystem.init(settings, mockRuntime).then(function() {
2015-03-22 18:40:12 +01:00
try {
2016-10-10 14:27:43 +02:00
fs.existsSync(path.join(process.env.HOME,".node-red","lib")).should.be.true();
fs.existsSync(path.join(process.env.HOME,".node-red","lib",'flows')).should.be.true();
2015-03-22 18:40:12 +01:00
settings.userDir.should.equal(path.join(process.env.HOME,".node-red"));
done();
} catch(err) {
done(err);
} finally {
process.env.NODE_RED_HOME = oldNRH;
process.env.HOME = oldHOME;
process.env.HOMEPATH = oldHOMEPATH;
}
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should set userDir to USERPROFILE/.node-red',function(done) {
var oldNRH = process.env.NODE_RED_HOME;
process.env.NODE_RED_HOME = path.join(userDir,"NRH");
var oldHOME = process.env.HOME;
process.env.HOME = "";
var oldHOMEPATH = process.env.HOMEPATH;
process.env.HOMEPATH = path.join(userDir,"HOMEPATH");
var oldUSERPROFILE = process.env.USERPROFILE;
process.env.USERPROFILE = path.join(userDir,"USERPROFILE");
fs.mkdirSync(process.env.USERPROFILE);
var settings = {};
2017-09-20 11:30:07 +02:00
localfilesystem.init(settings, mockRuntime).then(function() {
try {
fs.existsSync(path.join(process.env.USERPROFILE,".node-red","lib")).should.be.true();
fs.existsSync(path.join(process.env.USERPROFILE,".node-red","lib",'flows')).should.be.true();
settings.userDir.should.equal(path.join(process.env.USERPROFILE,".node-red"));
done();
} catch(err) {
done(err);
} finally {
process.env.NODE_RED_HOME = oldNRH;
process.env.HOME = oldHOME;
process.env.HOMEPATH = oldHOMEPATH;
process.env.USERPROFILE = oldUSERPROFILE;
2015-03-22 18:40:12 +01:00
}
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
});
it('should handle missing flow file',function(done) {
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir}, mockRuntime).then(function() {
var flowFile = 'flows_'+require('os').hostname()+'.json';
var flowFilePath = path.join(userDir,flowFile);
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFilePath).should.be.false();
localfilesystem.getFlows().then(function(flows) {
flows.should.eql([]);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
2016-03-11 23:58:11 +01:00
it('should handle empty flow file, no backup',function(done) {
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir}, mockRuntime).then(function() {
2016-03-11 23:58:11 +01:00
var flowFile = 'flows_'+require('os').hostname()+'.json';
var flowFilePath = path.join(userDir,flowFile);
var flowFileBackupPath = path.join(userDir,"."+flowFile+".backup");
fs.closeSync(fs.openSync(flowFilePath, 'w'));
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFilePath).should.be.true();
2016-03-11 23:58:11 +01:00
localfilesystem.getFlows().then(function(flows) {
flows.should.eql([]);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2016-03-11 23:58:11 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2016-03-11 23:58:11 +01:00
done(err);
});
});
it('should handle empty flow file, restores backup',function(done) {
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir}, mockRuntime).then(function() {
2016-03-11 23:58:11 +01:00
var flowFile = 'flows_'+require('os').hostname()+'.json';
var flowFilePath = path.join(userDir,flowFile);
var flowFileBackupPath = path.join(userDir,"."+flowFile+".backup");
fs.closeSync(fs.openSync(flowFilePath, 'w'));
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFilePath).should.be.true();
fs.existsSync(flowFileBackupPath).should.be.false();
2016-03-11 23:58:11 +01:00
fs.writeFileSync(flowFileBackupPath,JSON.stringify(testFlow));
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFileBackupPath).should.be.true();
setTimeout(function() {
localfilesystem.getFlows().then(function(flows) {
flows.should.eql(testFlow);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
},50);
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2016-03-11 23:58:11 +01:00
done(err);
});
});
it('should save flows to the default file',function(done) {
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir}, mockRuntime).then(function() {
var flowFile = 'flows_'+require('os').hostname()+'.json';
var flowFilePath = path.join(userDir,flowFile);
var flowFileBackupPath = path.join(userDir,"."+flowFile+".backup");
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFilePath).should.be.false();
fs.existsSync(flowFileBackupPath).should.be.false();
localfilesystem.saveFlows(testFlow).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFilePath).should.be.true();
fs.existsSync(flowFileBackupPath).should.be.false();
localfilesystem.getFlows().then(function(flows) {
flows.should.eql(testFlow);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should save flows to the specified file',function(done) {
var defaultFlowFile = 'flows_'+require('os').hostname()+'.json';
var defaultFlowFilePath = path.join(userDir,defaultFlowFile);
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(defaultFlowFilePath).should.be.false();
fs.existsSync(flowFilePath).should.be.false();
localfilesystem.saveFlows(testFlow).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(defaultFlowFilePath).should.be.false();
fs.existsSync(flowFilePath).should.be.true();
localfilesystem.getFlows().then(function(flows) {
flows.should.eql(testFlow);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
2015-03-22 18:40:12 +01:00
it('should format the flows file when flowFilePretty specified',function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath,flowFilePretty:true}, mockRuntime).then(function() {
2015-03-22 18:40:12 +01:00
localfilesystem.saveFlows(testFlow).then(function() {
var content = fs.readFileSync(flowFilePath,"utf8");
content.split("\n").length.should.be.above(1);
localfilesystem.getFlows().then(function(flows) {
flows.should.eql(testFlow);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
});
it('should fsync the flows file',function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
localfilesystem.init({editorTheme:{projects:{enabled:false}},userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
sinon.spy(fs,"fsync");
localfilesystem.saveFlows(testFlow).then(function() {
2018-01-22 15:16:31 +01:00
fs.fsync.callCount.should.be.greaterThan(0);
fs.fsync.restore();
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
fs.fsync.restore();
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should log fsync errors and continue',function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
sinon.stub(fs,"fsync", function(fd, cb) {
cb(new Error());
});
sinon.spy(log,"warn");
localfilesystem.saveFlows(testFlow).then(function() {
2018-01-22 15:16:31 +01:00
fs.fsync.callCount.should.be.greaterThan(0);
2018-01-16 12:21:54 +01:00
log.warn.restore();
2018-01-22 15:16:31 +01:00
fs.fsync.callCount.should.be.greaterThan(0);
fs.fsync.restore();
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should backup the flows file', function(done) {
var defaultFlowFile = 'flows_'+require('os').hostname()+'.json';
var defaultFlowFilePath = path.join(userDir,defaultFlowFile);
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
var flowFileBackupPath = path.join(userDir,"."+flowFile+".backup");
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(defaultFlowFilePath).should.be.false();
fs.existsSync(flowFilePath).should.be.false();
fs.existsSync(flowFileBackupPath).should.be.false();
localfilesystem.saveFlows(testFlow).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFileBackupPath).should.be.false();
fs.existsSync(defaultFlowFilePath).should.be.false();
fs.existsSync(flowFilePath).should.be.true();
var content = fs.readFileSync(flowFilePath,'utf8');
var testFlow2 = [{"type":"tab","id":"bc5672ad.2741d8","label":"Sheet 2"}];
localfilesystem.saveFlows(testFlow2).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(flowFileBackupPath).should.be.true();
fs.existsSync(defaultFlowFilePath).should.be.false();
fs.existsSync(flowFilePath).should.be.true();
var backupContent = fs.readFileSync(flowFileBackupPath,'utf8');
content.should.equal(backupContent);
var content2 = fs.readFileSync(flowFilePath,'utf8');
content2.should.not.equal(backupContent);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should handle missing credentials', function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
var credFile = path.join(userDir,"test_cred.json");
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.false();
localfilesystem.getCredentials().then(function(creds) {
creds.should.eql({});
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
it('should handle credentials', function(done) {
2014-05-03 23:38:33 +02:00
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
var credFile = path.join(userDir,"test_cred.json");
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.false();
var credentials = {"abc":{"type":"creds"}};
localfilesystem.saveCredentials(credentials).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.true();
localfilesystem.getCredentials().then(function(creds) {
creds.should.eql(credentials);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
done(err);
});
});
2015-03-22 18:40:12 +01:00
it('should backup existing credentials', function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
var credFile = path.join(userDir,"test_cred.json");
var credFileBackup = path.join(userDir,".test_cred.json.backup");
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath}, mockRuntime).then(function() {
2015-03-22 18:40:12 +01:00
fs.writeFileSync(credFile,"{}","utf8");
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.true();
fs.existsSync(credFileBackup).should.be.false();
2015-03-22 18:40:12 +01:00
var credentials = {"abc":{"type":"creds"}};
localfilesystem.saveCredentials(credentials).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.true();
fs.existsSync(credFileBackup).should.be.true();
2015-03-22 18:40:12 +01:00
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
});
2015-03-22 18:40:12 +01:00
it('should format the creds file when flowFilePretty specified',function(done) {
var flowFile = 'test.json';
var flowFilePath = path.join(userDir,flowFile);
var credFile = path.join(userDir,"test_cred.json");
2017-09-20 11:30:07 +02:00
localfilesystem.init({userDir:userDir, flowFile:flowFilePath, flowFilePretty:true}, mockRuntime).then(function() {
2015-03-22 18:40:12 +01:00
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.false();
2015-03-22 18:40:12 +01:00
var credentials = {"abc":{"type":"creds"}};
localfilesystem.saveCredentials(credentials).then(function() {
2016-10-10 14:27:43 +02:00
fs.existsSync(credFile).should.be.true();
2015-03-22 18:40:12 +01:00
var content = fs.readFileSync(credFile,"utf8");
content.split("\n").length.should.be.above(1);
localfilesystem.getCredentials().then(function(creds) {
creds.should.eql(credentials);
done();
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
2018-04-24 16:01:49 +02:00
}).catch(function(err) {
2015-03-22 18:40:12 +01:00
done(err);
});
});
});