Move mail related settings to new mail route

there is quite a bit of circular dep between settings, platform and
mail code. this will be removed in future commits.

src/routes/mail.js

@@ -1,10 +1,24 @@
 'use strict';
 
 exports = module.exports = {
-    getStatus: getStatus
+    getStatus: getStatus,
+
+    getMailFromValidation: getMailFromValidation,
+    setMailFromValidation: setMailFromValidation,
+
+    getCatchAllAddress: getCatchAllAddress,
+    setCatchAllAddress: setCatchAllAddress,
+
+    getMailRelay: getMailRelay,
+    setMailRelay: setMailRelay,
+
+    getMailConfig: getMailConfig,
+    setMailConfig: setMailConfig,
 };
 
-var mail = require('../mail.js'),
+var assert = require('assert'),
+    mail = require('../mail.js'),
+    MailError = mail.MailError,
     HttpError = require('connect-lastmile').HttpError,
     HttpSuccess = require('connect-lastmile').HttpSuccess;
 
@@ -15,3 +29,95 @@ function getStatus(req, res, next) {
         next(new HttpSuccess(200, records));
     });
 }
+
+function getMailFromValidation(req, res, next) {
+    mail.getMailFromValidation(function (error, enabled) {
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(200, { enabled: enabled }));
+    });
+}
+
+function setMailFromValidation(req, res, next) {
+    assert.strictEqual(typeof req.body, 'object');
+
+    if (typeof req.body.enabled !== 'boolean') return next(new HttpError(400, 'enabled is required'));
+
+    mail.setMailFromValidation(req.body.enabled, function (error) {
+        if (error && error.reason === MailError.BAD_FIELD) return next(new HttpError(400, error.message));
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(202));
+    });
+}
+
+function getCatchAllAddress(req, res, next) {
+    mail.getCatchAllAddress(function (error, address) {
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(200, { address: address }));
+    });
+}
+
+function setCatchAllAddress(req, res, next) {
+    assert.strictEqual(typeof req.body, 'object');
+
+    if (!req.body.address || !Array.isArray(req.body.address)) return next(new HttpError(400, 'address array is required'));
+
+    for (var i = 0; i < req.body.address.length; i++) {
+        if (typeof req.body.address[i] !== 'string') return next(new HttpError(400, 'address must be an array of string'));
+    }
+
+    mail.setCatchAllAddress(req.body.address, function (error) {
+        if (error && error.reason === MailError.BAD_FIELD) return next(new HttpError(400, error.message));
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(202));
+    });
+}
+
+function getMailRelay(req, res, next) {
+    mail.getMailRelay(function (error, mail) {
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(200, mail));
+    });
+}
+
+function setMailRelay(req, res, next) {
+    assert.strictEqual(typeof req.body, 'object');
+
+    if (typeof req.body.provider !== 'string') return next(new HttpError(400, 'provider is required'));
+    if ('host' in req.body && typeof req.body.host !== 'string') return next(new HttpError(400, 'host must be a string'));
+    if ('port' in req.body && typeof req.body.port !== 'number') return next(new HttpError(400, 'port must be a string'));
+    if ('username' in req.body && typeof req.body.username !== 'string') return next(new HttpError(400, 'username must be a string'));
+    if ('password' in req.body && typeof req.body.password !== 'string') return next(new HttpError(400, 'password must be a string'));
+
+    mail.setMailRelay(req.body, function (error) {
+        if (error && error.reason === MailError.BAD_FIELD) return next(new HttpError(400, error.message));
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(202));
+    });
+}
+
+function getMailConfig(req, res, next) {
+    mail.getMailConfig(function (error, mail) {
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(200, mail));
+    });
+}
+
+function setMailConfig(req, res, next) {
+    assert.strictEqual(typeof req.body, 'object');
+
+    if (typeof req.body.enabled !== 'boolean') return next(new HttpError(400, 'enabled is required'));
+
+    mail.setMailConfig({ enabled: req.body.enabled }, function (error) {
+        if (error && error.reason === MailError.BAD_FIELD) return next(new HttpError(400, error.message));
+        if (error) return next(new HttpError(500, error));
+
+        next(new HttpSuccess(202));
+    });
+}

src/routes/settings.js

@@ -16,18 +16,6 @@ exports = module.exports = {
     getTimeZone: getTimeZone,
     setTimeZone: setTimeZone,
 
-    getMailConfig: getMailConfig,
-    setMailConfig: setMailConfig,
-
-    getMailRelay: getMailRelay,
-    setMailRelay: setMailRelay,
-
-    getCatchAllAddress: getCatchAllAddress,
-    setCatchAllAddress: setCatchAllAddress,
-
-    getMailFromValidation: getMailFromValidation,
-    setMailFromValidation: setMailFromValidation,
-
     getAppstoreConfig: getAppstoreConfig,
     setAppstoreConfig: setAppstoreConfig,
 
@@ -106,98 +94,6 @@ function setTimeZone(req, res, next) {
     });
 }
 
-function getMailConfig(req, res, next) {
-    settings.getMailConfig(function (error, mail) {
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(200, mail));
-    });
-}
-
-function setMailConfig(req, res, next) {
-    assert.strictEqual(typeof req.body, 'object');
-
-    if (typeof req.body.enabled !== 'boolean') return next(new HttpError(400, 'enabled is required'));
-
-    settings.setMailConfig({ enabled: req.body.enabled }, function (error) {
-        if (error && error.reason === SettingsError.BAD_FIELD) return next(new HttpError(400, error.message));
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(202));
-    });
-}
-
-function getMailFromValidation(req, res, next) {
-    settings.getMailFromValidation(function (error, enabled) {
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(200, { enabled: enabled }));
-    });
-}
-
-function setMailFromValidation(req, res, next) {
-    assert.strictEqual(typeof req.body, 'object');
-
-    if (typeof req.body.enabled !== 'boolean') return next(new HttpError(400, 'enabled is required'));
-
-    settings.setMailFromValidation(req.body.enabled, function (error) {
-        if (error && error.reason === SettingsError.BAD_FIELD) return next(new HttpError(400, error.message));
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(202));
-    });
-}
-
-function getMailRelay(req, res, next) {
-    settings.getMailRelay(function (error, mail) {
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(200, mail));
-    });
-}
-
-function setMailRelay(req, res, next) {
-    assert.strictEqual(typeof req.body, 'object');
-
-    if (typeof req.body.provider !== 'string') return next(new HttpError(400, 'provider is required'));
-    if ('host' in req.body && typeof req.body.host !== 'string') return next(new HttpError(400, 'host must be a string'));
-    if ('port' in req.body && typeof req.body.port !== 'number') return next(new HttpError(400, 'port must be a string'));
-    if ('username' in req.body && typeof req.body.username !== 'string') return next(new HttpError(400, 'username must be a string'));
-    if ('password' in req.body && typeof req.body.password !== 'string') return next(new HttpError(400, 'password must be a string'));
-
-    settings.setMailRelay(req.body, function (error) {
-        if (error && error.reason === SettingsError.BAD_FIELD) return next(new HttpError(400, error.message));
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(202));
-    });
-}
-
-function getCatchAllAddress(req, res, next) {
-    settings.getCatchAllAddress(function (error, address) {
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(200, { address: address }));
-    });
-}
-
-function setCatchAllAddress(req, res, next) {
-    assert.strictEqual(typeof req.body, 'object');
-
-    if (!req.body.address || !Array.isArray(req.body.address)) return next(new HttpError(400, 'address array is required'));
-
-    for (var i = 0; i < req.body.address.length; i++) {
-        if (typeof req.body.address[i] !== 'string') return next(new HttpError(400, 'address must be an array of string'));
-    }
-
-    settings.setCatchAllAddress(req.body.address, function (error) {
-        if (error && error.reason === SettingsError.BAD_FIELD) return next(new HttpError(400, error.message));
-        if (error) return next(new HttpError(500, error));
-
-        next(new HttpSuccess(202));
-    });
-}
-
 function setCloudronAvatar(req, res, next) {
     assert.strictEqual(typeof req.files, 'object');
 

src/routes/test/mail-test.js

@@ -10,7 +10,9 @@ var async = require('async'),
     config = require('../../config.js'),
     database = require('../../database.js'),
     expect = require('expect.js'),
+    mail = require('../../mail.js'),
     server = require('../../server.js'),
+    settingsdb = require('../../settingsdb.js'),
     superagent = require('superagent');
 
 var SERVER_URL = 'http://localhost:' + config.get('port');
@@ -302,4 +304,186 @@ describe('Mail API', function () {
                 });
         });
     });
+
+    describe('mail from validation', function () {
+        it('get mail from validation succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/mail_from_validation')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ enabled: true });
+                    done();
+                });
+        });
+
+        it('cannot set without enabled field', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_from_validation')
+                .query({ access_token: token })
+                .send({ })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('can set with enabled field', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_from_validation')
+                .query({ access_token: token })
+                .send({ enabled: false })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(202);
+                    done();
+                });
+        });
+    });
+
+    describe('catch_all', function () {
+        it('get catch_all succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/catch_all_address')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ address: [ ] });
+                    done();
+                });
+        });
+
+        it('cannot set without address field', function (done) {
+            superagent.put(SERVER_URL + '/api/v1/mail/catch_all_address')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('cannot set with bad address field', function (done) {
+            superagent.put(SERVER_URL + '/api/v1/mail/catch_all_address')
+                .query({ access_token: token })
+                .send({ address: [ 'user1', 123 ] })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('set succeeds', function (done) {
+            superagent.put(SERVER_URL + '/api/v1/mail/catch_all_address')
+                .query({ access_token: token })
+                .send({ address: [ 'user1' ] })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(202);
+                    done();
+                });
+        });
+
+        it('get succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/catch_all_address')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ address: [ 'user1' ] });
+                    done();
+                });
+        });
+    });
+
+    describe('mail relay', function () {
+        it('get mail relay succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/mail_relay')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ provider: 'cloudron-smtp' });
+                    done();
+                });
+        });
+
+        it('cannot set without provider field', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_relay')
+                .query({ access_token: token })
+                .send({ })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('cannot set with bad host', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_relay')
+                .query({ access_token: token })
+                .send({ provider: 'external-smtp', host: true })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('set fails because mail server is unreachable', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_relay')
+                .query({ access_token: token })
+                .send({ provider: 'external-smtp', host: 'host', port: 25, username: 'u', password: 'p', tls: true })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('get succeeds', function (done) {
+            var relay = { provider: 'external-smtp', host: 'host', port: 25, username: 'u', password: 'p', tls: true };
+
+            settingsdb.set(mail.MAIL_RELAY_KEY, JSON.stringify(relay), function (error) { // skip the mail server verify()
+                expect(error).to.not.be.ok();
+
+                superagent.get(SERVER_URL + '/api/v1/mail/mail_relay')
+                    .query({ access_token: token })
+                    .end(function (err, res) {
+                        expect(res.statusCode).to.equal(200);
+                        expect(res.body).to.eql(relay);
+                        done();
+                    });
+            });
+        });
+    });
+
+    describe('mail_config', function () {
+        it('get mail_config succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/mail_config')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ enabled: false });
+                    done();
+                });
+        });
+
+        it('cannot set without enabled field', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_config')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(400);
+                    done();
+                });
+        });
+
+        it('set succeeds', function (done) {
+            superagent.post(SERVER_URL + '/api/v1/mail/mail_config')
+                .query({ access_token: token })
+                .send({ enabled: true })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(202);
+                    done();
+                });
+        });
+
+        it('get succeeds', function (done) {
+            superagent.get(SERVER_URL + '/api/v1/mail/mail_config')
+                .query({ access_token: token })
+                .end(function (err, res) {
+                    expect(res.statusCode).to.equal(200);
+                    expect(res.body).to.eql({ enabled: true });
+                    done();
+                });
+        });
+    });
 });

src/routes/test/settings-test.js

@@ -8,7 +8,6 @@
 
 var async = require('async'),
     child_process = require('child_process'),
-    cloudron = require('../../cloudron.js'),
     config = require('../../config.js'),
     constants = require('../../constants.js'),
     database = require('../../database.js'),
@@ -19,7 +18,6 @@ var async = require('async'),
     paths = require('../../paths.js'),
     server = require('../../server.js'),
     settings = require('../../settings.js'),
-    settingsdb = require('../../settingsdb.js'),
     superagent = require('superagent');
 
 var SERVER_URL = 'http://localhost:' + config.get('port');
@@ -222,98 +220,6 @@ describe('Settings API', function () {
         });
     });
 
-    describe('mail_config', function () {
-        it('get mail_config succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/mail_config')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ enabled: false });
-                    done();
-                });
-        });
-
-        it('cannot set without enabled field', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_config')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('set succeeds', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_config')
-                .query({ access_token: token })
-                .send({ enabled: true })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(202);
-                    done();
-                });
-        });
-
-        it('get succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/mail_config')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ enabled: true });
-                    done();
-                });
-        });
-    });
-
-    describe('catch_all', function () {
-        it('get catch_all succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/catch_all_address')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ address: [ ] });
-                    done();
-                });
-        });
-
-        it('cannot set without address field', function (done) {
-            superagent.put(SERVER_URL + '/api/v1/settings/catch_all_address')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('cannot set with bad address field', function (done) {
-            superagent.put(SERVER_URL + '/api/v1/settings/catch_all_address')
-                .query({ access_token: token })
-                .send({ address: [ 'user1', 123 ] })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('set succeeds', function (done) {
-            superagent.put(SERVER_URL + '/api/v1/settings/catch_all_address')
-                .query({ access_token: token })
-                .send({ address: [ 'user1' ] })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(202);
-                    done();
-                });
-        });
-
-        it('get succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/catch_all_address')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ address: [ 'user1' ] });
-                    done();
-                });
-        });
-    });
-
     xdescribe('Certificates API', function () {
         var validCert0, validKey0, // example.com
             validCert1, validKey1; // *.example.com
@@ -526,94 +432,4 @@ describe('Settings API', function () {
                 });
         });
     });
-
-    describe('mail relay', function () {
-        it('get mail relay succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/mail_relay')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ provider: 'cloudron-smtp' });
-                    done();
-                });
-        });
-
-        it('cannot set without provider field', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_relay')
-                .query({ access_token: token })
-                .send({ })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('cannot set with bad host', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_relay')
-                .query({ access_token: token })
-                .send({ provider: 'external-smtp', host: true })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('set fails because mail server is unreachable', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_relay')
-                .query({ access_token: token })
-                .send({ provider: 'external-smtp', host: 'host', port: 25, username: 'u', password: 'p', tls: true })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('get succeeds', function (done) {
-            var relay = { provider: 'external-smtp', host: 'host', port: 25, username: 'u', password: 'p', tls: true };
-
-            settingsdb.set(settings.MAIL_RELAY_KEY, JSON.stringify(relay), function (error) { // skip the mail server verify()
-                expect(error).to.not.be.ok();
-
-                superagent.get(SERVER_URL + '/api/v1/settings/mail_relay')
-                    .query({ access_token: token })
-                    .end(function (err, res) {
-                        expect(res.statusCode).to.equal(200);
-                        expect(res.body).to.eql(relay);
-                        done();
-                    });
-            });
-        });
-    });
-
-    describe('mail from validation', function () {
-        it('get mail from validation succeeds', function (done) {
-            superagent.get(SERVER_URL + '/api/v1/settings/mail_from_validation')
-                .query({ access_token: token })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(200);
-                    expect(res.body).to.eql({ enabled: true });
-                    done();
-                });
-        });
-
-        it('cannot set without enabled field', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_from_validation')
-                .query({ access_token: token })
-                .send({ })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(400);
-                    done();
-                });
-        });
-
-        it('can set with enabled field', function (done) {
-            superagent.post(SERVER_URL + '/api/v1/settings/mail_from_validation')
-                .query({ access_token: token })
-                .send({ enabled: false })
-                .end(function (err, res) {
-                    expect(res.statusCode).to.equal(202);
-                    done();
-                });
-        });
-    });
 });