319 lines
10 KiB
JavaScript
319 lines
10 KiB
JavaScript
|
"use strict";
|
||
|
|
var vows = require('vows');
|
||
|
|
var assert = require('assert');
|
||
|
|
var log4js = require('../../lib/log4js');
|
||
|
|
var sandbox = require('sandboxed-module');
|
||
|
|
|
||
|
|
function setupLogging(category, options) {
|
||
|
|
var msgs = [];
|
||
|
|
|
||
|
|
var fakeMailer = {
|
||
|
|
createTransport: function (name, options) {
|
||
|
|
return {
|
||
|
|
config: options,
|
||
|
|
sendMail: function (msg, callback) {
|
||
|
|
msgs.push(msg);
|
||
|
|
callback(null, true);
|
||
|
|
},
|
||
|
|
close: function () {
|
||
|
|
}
|
||
|
|
};
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
var fakeLayouts = {
|
||
|
|
layout: function (type, config) {
|
||
|
|
this.type = type;
|
||
|
|
this.config = config;
|
||
|
|
return log4js.layouts.messagePassThroughLayout;
|
||
|
|
},
|
||
|
|
basicLayout: log4js.layouts.basicLayout,
|
||
|
|
messagePassThroughLayout: log4js.layouts.messagePassThroughLayout
|
||
|
|
};
|
||
|
|
|
||
|
|
var fakeConsole = {
|
||
|
|
errors: [],
|
||
|
|
error: function (msg, value) {
|
||
|
|
this.errors.push({msg: msg, value: value});
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
var fakeTransportPlugin = function () {
|
||
|
|
};
|
||
|
|
|
||
|
|
var smtpModule = sandbox.require('../../lib/appenders/smtp', {
|
||
|
|
requires: {
|
||
|
|
'nodemailer': fakeMailer,
|
||
|
|
'nodemailer-sendmail-transport': fakeTransportPlugin,
|
||
|
|
'nodemailer-smtp-transport': fakeTransportPlugin,
|
||
|
|
'../layouts': fakeLayouts
|
||
|
|
},
|
||
|
|
globals: {
|
||
|
|
console: fakeConsole
|
||
|
|
}
|
||
|
|
});
|
||
|
|
|
||
|
|
log4js.addAppender(smtpModule.configure(options), category);
|
||
|
|
|
||
|
|
return {
|
||
|
|
logger: log4js.getLogger(category),
|
||
|
|
mailer: fakeMailer,
|
||
|
|
layouts: fakeLayouts,
|
||
|
|
console: fakeConsole,
|
||
|
|
results: msgs
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
function checkMessages(result, sender, subject) {
|
||
|
|
for (var i = 0; i < result.results.length; ++i) {
|
||
|
|
assert.equal(result.results[i].from, sender);
|
||
|
|
assert.equal(result.results[i].to, 'recipient@domain.com');
|
||
|
|
assert.equal(result.results[i].subject, subject ? subject : 'Log event #' + (i + 1));
|
||
|
|
assert.ok(new RegExp('.+Log event #' + (i + 1) + '\n$').test(result.results[i].text));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
log4js.clearAppenders();
|
||
|
|
vows.describe('log4js smtpAppender').addBatch({
|
||
|
|
'minimal config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('minimal config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
SMTP: {
|
||
|
|
port: 25,
|
||
|
|
auth: {
|
||
|
|
user: 'user@domain.com'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'there should be one message only': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
checkMessages(result);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'fancy config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('fancy config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
sender: 'sender@domain.com',
|
||
|
|
subject: 'This is subject',
|
||
|
|
SMTP: {
|
||
|
|
port: 25,
|
||
|
|
auth: {
|
||
|
|
user: 'user@domain.com'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'there should be one message only': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
checkMessages(result, 'sender@domain.com', 'This is subject');
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'config with layout': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('config with layout', {
|
||
|
|
layout: {
|
||
|
|
type: "tester"
|
||
|
|
}
|
||
|
|
});
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'should configure layout': function (result) {
|
||
|
|
assert.equal(result.layouts.type, 'tester');
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'separate email for each event': {
|
||
|
|
topic: function () {
|
||
|
|
var self = this;
|
||
|
|
var setup = setupLogging('separate email for each event', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
SMTP: {
|
||
|
|
port: 25,
|
||
|
|
auth: {
|
||
|
|
user: 'user@domain.com'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
}, 0);
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #2');
|
||
|
|
}, 500);
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #3');
|
||
|
|
}, 1100);
|
||
|
|
setTimeout(function () {
|
||
|
|
self.callback(null, setup);
|
||
|
|
}, 3000);
|
||
|
|
},
|
||
|
|
'there should be three messages': function (result) {
|
||
|
|
assert.equal(result.results.length, 3);
|
||
|
|
},
|
||
|
|
'messages should contain proper data': function (result) {
|
||
|
|
checkMessages(result);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'multiple events in one email': {
|
||
|
|
topic: function () {
|
||
|
|
var self = this;
|
||
|
|
var setup = setupLogging('multiple events in one email', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
sendInterval: 1,
|
||
|
|
SMTP: {
|
||
|
|
port: 25,
|
||
|
|
auth: {
|
||
|
|
user: 'user@domain.com'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
}, 0);
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #2');
|
||
|
|
}, 100);
|
||
|
|
setTimeout(function () {
|
||
|
|
setup.logger.info('Log event #3');
|
||
|
|
}, 1500);
|
||
|
|
setTimeout(function () {
|
||
|
|
self.callback(null, setup);
|
||
|
|
}, 3000);
|
||
|
|
},
|
||
|
|
'there should be two messages': function (result) {
|
||
|
|
assert.equal(result.results.length, 2);
|
||
|
|
},
|
||
|
|
'messages should contain proper data': function (result) {
|
||
|
|
assert.equal(result.results[0].to, 'recipient@domain.com');
|
||
|
|
assert.equal(result.results[0].subject, 'Log event #1');
|
||
|
|
assert.equal(
|
||
|
|
result.results[0].text.match(new RegExp('.+Log event #[1-2]$', 'gm')).length,
|
||
|
|
2
|
||
|
|
);
|
||
|
|
assert.equal(result.results[1].to, 'recipient@domain.com');
|
||
|
|
assert.equal(result.results[1].subject, 'Log event #3');
|
||
|
|
assert.ok(new RegExp('.+Log event #3\n$').test(result.results[1].text));
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'error when sending email': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('error when sending email', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
sendInterval: 0,
|
||
|
|
SMTP: {port: 25, auth: {user: 'user@domain.com'}}
|
||
|
|
});
|
||
|
|
|
||
|
|
setup.mailer.createTransport = function () {
|
||
|
|
return {
|
||
|
|
sendMail: function (msg, cb) {
|
||
|
|
cb({message: "oh noes"});
|
||
|
|
},
|
||
|
|
close: function () {
|
||
|
|
}
|
||
|
|
};
|
||
|
|
};
|
||
|
|
|
||
|
|
setup.logger.info("This will break");
|
||
|
|
return setup.console;
|
||
|
|
},
|
||
|
|
'should be logged to console': function (cons) {
|
||
|
|
assert.equal(cons.errors.length, 1);
|
||
|
|
assert.equal(cons.errors[0].msg, "log4js.smtpAppender - Error happened");
|
||
|
|
assert.equal(cons.errors[0].value.message, 'oh noes');
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'transport full config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('transport full config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
transport: {
|
||
|
|
plugin: 'sendmail',
|
||
|
|
options: {
|
||
|
|
path: '/usr/sbin/sendmail'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'there should be one message only': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
checkMessages(result);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'transport no-options config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('transport no-options config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
transport: {
|
||
|
|
plugin: 'sendmail'
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'there should be one message only': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
checkMessages(result);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'transport no-plugin config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('transport no-plugin config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
transport: {
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'there should be one message only': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
checkMessages(result);
|
||
|
|
}
|
||
|
|
},
|
||
|
|
'attachment config': {
|
||
|
|
topic: function () {
|
||
|
|
var setup = setupLogging('attachment config', {
|
||
|
|
recipients: 'recipient@domain.com',
|
||
|
|
attachment: {
|
||
|
|
enable: true
|
||
|
|
},
|
||
|
|
SMTP: {
|
||
|
|
port: 25,
|
||
|
|
auth: {
|
||
|
|
user: 'user@domain.com'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
});
|
||
|
|
setup.logger.info('Log event #1');
|
||
|
|
return setup;
|
||
|
|
},
|
||
|
|
'message should contain proper data': function (result) {
|
||
|
|
assert.equal(result.results.length, 1);
|
||
|
|
assert.equal(result.results[0].attachments.length, 1);
|
||
|
|
var attachment = result.results[0].attachments[0];
|
||
|
|
assert.equal(result.results[0].text, "See logs as attachment");
|
||
|
|
assert.equal(attachment.filename, "default.log");
|
||
|
|
assert.equal(attachment.contentType, "text/x-log");
|
||
|
|
assert.ok(new RegExp('.+Log event #' + 1 + '\n$').test(attachment.content));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}).export(module);
|