/** * 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 request = require('supertest'); var express = require('express'); var sinon = require('sinon'); var when = require('when'); var bodyParser = require('body-parser'); var app = express(); var info = require("../../../../red/api/editor/settings"); var theme = require("../../../../red/api/editor/theme"); describe("api/editor/settings", function() { describe("settings handler", function() { before(function() { sinon.stub(theme,"settings",function() { return { test: 456 };}); app = express(); app.use(bodyParser.json()); app.get("/settings",info.runtimeSettings); app.get("/settingsWithUser",function(req,res,next) { req.user = { username: "nick", permissions: "*", image: "http://example.com", anonymous: false, private: "secret" } next(); },info.runtimeSettings); app.get("/settings/user", info.userSettings); app.post("/settings/user", info.updateUserSettings); }); after(function() { theme.settings.restore(); }); it('returns the filtered settings', function(done) { info.init({ settings: { foo: 123, httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function(obj) { obj.testNodeSetting = "helloWorld"; } }, nodes: { paletteEditorEnabled: function() { return true; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: {} }); request(app) .get("/settings") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.have.property("httpNodeRoot","testHttpNodeRoot"); res.body.should.have.property("version","testVersion"); res.body.should.have.property("context",{default: "foo", stores: ["foo","bar"]}); res.body.should.have.property("paletteCategories",["red","blue","green"]); res.body.should.have.property("editorTheme",{test:456}); res.body.should.have.property("testNodeSetting","helloWorld"); res.body.should.not.have.property("foo",123); res.body.should.have.property("flowEncryptionType","test-key-type"); res.body.should.not.have.property("user"); done(); }); }); it('returns the filtered user in settings', function(done) { info.init({ settings: { foo: 123, httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function(obj) { obj.testNodeSetting = "helloWorld"; } }, nodes: { paletteEditorEnabled: function() { return true; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: {} }); request(app) .get("/settingsWithUser") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.have.property("user"); res.body.user.should.have.property("username","nick"); res.body.user.should.have.property("permissions","*"); res.body.user.should.have.property("image","http://example.com"); res.body.user.should.have.property("anonymous",false); res.body.user.should.not.have.property("private"); done(); }); }); it('returns user settings', function (done) { info.init({ settings: { getUserSettings: function () { return { "editor": { "view": { "view-grid-size": "20", "view-node-status": true, "view-show-tips": true, "view-snap-grid": true, "view-show-grid": true } } }; } } }); request(app) .get("/settings/user") .expect(200) .end(function (err, res) { if (err) { return done(err); } res.body.should.have.property("editor"); res.body.editor.should.have.property("view"); res.body.editor.view.should.have.property("view-grid-size", "20"); res.body.editor.view.should.have.property("view-node-status", true); res.body.editor.view.should.have.property("view-show-tips", true); res.body.editor.view.should.have.property("view-snap-grid", true); res.body.editor.view.should.have.property("view-show-grid", true); done(); }); }); it('sets user settings', function (done) { info.init({ settings: { getUserSettings: function () { return {}; }, setUserSettings: function (username, currentSettings) { currentSettings.should.have.property("editor"); currentSettings.editor.should.have.property("view"); currentSettings.editor.view.should.have.property("view-grid-size", "21"); currentSettings.editor.view.should.have.property("view-node-status", false); currentSettings.editor.view.should.have.property("view-show-tips", false); currentSettings.editor.view.should.have.property("view-snap-grid", false); currentSettings.editor.view.should.have.property("view-show-grid", false); return when.resolve(); } }, log: { audit: function () {} } }); request(app) .post("/settings/user") .send({ "editor": { "view": { "view-grid-size": "21", "view-node-status": false, "view-show-tips": false, "view-snap-grid": false, "view-show-grid": false } } }) .expect(204) .end(function (err, res) { res.should.have.property("status"); res.status.should.equal(204); res.should.have.property("text", ""); done(); }); }); it('includes project settings if projects available', function(done) { info.init({ settings: { foo: 123, httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function(obj) { obj.testNodeSetting = "helloWorld"; } }, nodes: { paletteEditorEnabled: function() { return true; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: { projects: { getActiveProject: () => 'test-active-project', getFlowFilename: () => 'test-flow-file', getCredentialsFilename: () => 'test-creds-file', getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}} } } }); request(app) .get("/settings") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.have.property("project","test-active-project"); res.body.should.not.have.property("files"); res.body.should.have.property("git"); res.body.git.should.have.property("globalUser",{name:'foo',email:'foo@example.com'}); done(); }); }); it('includes existing files details if projects enabled but no active project and files exist', function(done) { info.init({ settings: { foo: 123, httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function(obj) { obj.testNodeSetting = "helloWorld"; } }, nodes: { paletteEditorEnabled: function() { return true; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: { projects: { flowFileExists: () => true, getActiveProject: () => false, getFlowFilename: () => 'test-flow-file', getCredentialsFilename: () => 'test-creds-file', getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}} } } }); request(app) .get("/settings") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.not.have.property("project"); res.body.should.have.property("files"); res.body.files.should.have.property("flow",'test-flow-file'); res.body.files.should.have.property("credentials",'test-creds-file'); res.body.should.have.property("git"); res.body.git.should.have.property("globalUser",{name:'foo',email:'foo@example.com'}); done(); }); }); it('does not include file details if projects enabled but no active project and files do not exist', function(done) { info.init({ settings: { foo: 123, httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function(obj) { obj.testNodeSetting = "helloWorld"; } }, nodes: { paletteEditorEnabled: function() { return true; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: { projects: { flowFileExists: () => false, getActiveProject: () => false, getFlowFilename: () => 'test-flow-file', getCredentialsFilename: () => 'test-creds-file', getGlobalGitUser: () => {return {name:'foo',email:'foo@example.com'}} } } }); request(app) .get("/settings") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.not.have.property("project"); res.body.should.not.have.property("files"); res.body.should.have.property("git"); res.body.git.should.have.property("globalUser",{name:'foo',email:'foo@example.com'}); done(); }); }); it('overrides palette editable if runtime says it is disabled', function(done) { info.init({ settings: { httpNodeRoot: "testHttpNodeRoot", version: "testVersion", paletteCategories :["red","blue","green"], exportNodeSettings: function() {} }, nodes: { paletteEditorEnabled: function() { return false; }, getCredentialKeyType: function() { return "test-key-type"}, listContextStores: function() { return {default: "foo", stores: ["foo","bar"]}} }, log: { error: console.error }, storage: {} }); request(app) .get("/settings") .expect(200) .end(function(err,res) { if (err) { return done(err); } res.body.should.have.property("httpNodeRoot","testHttpNodeRoot"); res.body.should.have.property("version","testVersion"); res.body.should.have.property("paletteCategories",["red","blue","green"]); res.body.should.have.property("editorTheme"); res.body.editorTheme.should.have.property("test",456); res.body.editorTheme.should.have.property("palette",{editable:false}); done(); }); }); }); });