diff --git a/.bob.json b/.bob.json index c8c1e02c..2ae59b4e 100644 --- a/.bob.json +++ b/.bob.json @@ -1,12 +1,12 @@ { - "build": "clean lint coverage test", + "build": "clean lint test coverage", "lint": { "type": "jshint" }, "coverage": { - "type": "vows" + "type": "mocha-istanbul" }, "test": { - "type": "vows" + "type": "mocha" } } diff --git a/.jshintrc b/.jshintrc index a4ef28b2..af9aa466 100644 --- a/.jshintrc +++ b/.jshintrc @@ -5,11 +5,14 @@ "globalstrict": true, "maxparams": 6, "maxdepth": 3, - "maxstatements": 20, - "maxcomplexity": 10, + "maxstatements": 25, + "maxcomplexity": 5, "maxlen": 100, "globals": { "describe": true, - "it": true + "it": true, + "before": true, + "beforeEach": true, + "after": true } } diff --git a/0.7-changes b/0.7-changes new file mode 100644 index 00000000..d05dc6e5 --- /dev/null +++ b/0.7-changes @@ -0,0 +1,38 @@ +changes +======= +LogEvent.categoryName -> LogEvent.category +Logger is immutable (no setLevel any more) +Log levels defined in configure call, nowhere else +References to Loggers not retained +Clustered appender, multiprocess appender removed - core handles clusters now +Default category needs to be defined, with appender +connect logger, gelf, smtp, hookio appenders removed from core. +reload configuration removed from core - use 'watchr' or something instead +appenders now only need to provide configure function +log4js.configure now only takes single argument (no options) +tests use mocha not vows +replaced my debug lib with tjholowaychuk's debug (more of a standard) +options.cwd removed - filenames should always be specified in full, not relative +loglevelfilter changed to accept a list of log levels it allows +appenders that wrap other appenders must reference them by name +extracted streams to streamroller +extracted date_format.js to date-format +console.log replacement has been removed. + +to-do +===== +documentation pages (gh-pages) +* configuration +* file appenders +* layouts +* optional components +* writing your own appender (use couchdb as example) +readme +* getting started +* typical config - file with max size, file with date rolling +* optional components +fix and publish the optional components +* connect +* smtp +* gelf +* hookio ? diff --git a/README.md b/README.md index eaf9851b..8b6af75e 100644 --- a/README.md +++ b/README.md @@ -1,139 +1,125 @@ # log4js-node [![Build Status](https://secure.travis-ci.org/nomiddlename/log4js-node.png?branch=master)](http://travis-ci.org/nomiddlename/log4js-node) -[![NPM](https://nodei.co/npm/log4js.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/log4js/) - -This is a conversion of the [log4js](https://github.com/stritti/log4js) -framework to work with [node](http://nodejs.org). I've mainly stripped out the browser-specific code and tidied up some of the javascript. + +This was a conversion of the [log4js](http://log4js.berlios.de/index.html) +framework to work with [node](http://nodejs.org). It's changed a lot since then, but there are still plenty of the original parts involved. Out of the box it supports the following features: -* coloured console logging to stdout or stderr -* replacement of node's console.log functions (optional) -* file appender, with log rolling based on file size -* SMTP appender -* GELF appender -* hook.io appender -* Loggly appender -* Logstash UDP appender -* logFaces appender -* multiprocess appender (useful when you've got worker processes) -* a logger for connect/express servers +* coloured console logging +* file appender, with log rolling based on file size or date +* multi-process logging (works fine with node's clusters) * configurable log message layout/patterns * different log levels for different log categories (make some parts of your app log as DEBUG, others only ERRORS, etc.) -NOTE: from log4js 0.5 onwards you'll need to explicitly enable replacement of node's console.log functions. Do this either by calling `log4js.replaceConsole()` or configuring with an object or json file like this: - -```javascript -{ - appenders: [ - { type: "console" } - ], - replaceConsole: true -} -``` +NOTE: There have been a lot of changes in version 0.7.x, if you're upgrading from an older version, you should read [0.7-changes](http://github.com/nomiddlename/log4js-node/0.7-changes) ## installation -npm install log4js + npm install log4js ## usage Minimalist version: -```javascript -var log4js = require('log4js'); -var logger = log4js.getLogger(); -logger.debug("Some debug messages"); -``` + + var log4js = require('log4js'); + var logger = log4js.getLogger(); + logger.debug("Some debug messages"); + By default, log4js outputs to stdout with the coloured layout (thanks to [masylum](http://github.com/masylum)), so for the above you would see: -```bash -[2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages -``` -See example.js for a full example, but here's a snippet (also in fromreadme.js): -```javascript -var log4js = require('log4js'); -//console log is loaded by default, so you won't normally need to do this -//log4js.loadAppender('console'); -log4js.loadAppender('file'); -//log4js.addAppender(log4js.appenders.console()); -log4js.addAppender(log4js.appenders.file('logs/cheese.log'), 'cheese'); - -var logger = log4js.getLogger('cheese'); -logger.setLevel('ERROR'); - -logger.trace('Entering cheese testing'); -logger.debug('Got cheese.'); -logger.info('Cheese is Gouda.'); -logger.warn('Cheese is quite smelly.'); -logger.error('Cheese is too ripe!'); -logger.fatal('Cheese was breeding ground for listeria.'); -``` -Output: -```bash -[2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe! -[2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria. -``` -The first 5 lines of the code above could also be written as: -```javascript -var log4js = require('log4js'); -log4js.configure({ - appenders: [ - { type: 'console' }, - { type: 'file', filename: 'logs/cheese.log', category: 'cheese' } - ] -}); -``` - -## configuration - -You can configure the appenders and log levels manually (as above), or provide a -configuration file (`log4js.configure('path/to/file.json')`), or a configuration object. The -configuration file location may also be specified via the environment variable -LOG4JS_CONFIG (`export LOG4JS_CONFIG=path/to/file.json`). -An example file can be found in `test/log4js.json`. An example config file with log rolling is in `test/with-log-rolling.json`. -You can configure log4js to check for configuration file changes at regular intervals, and if changed, reload. This allows changes to logging levels to occur without restarting the application. - -To turn it on and specify a period: - -```javascript -log4js.configure('file.json', { reloadSecs: 300 }); -``` -For FileAppender you can also pass the path to the log directory as an option where all your log files would be stored. - -```javascript -log4js.configure('my_log4js_configuration.json', { cwd: '/absolute/path/to/log/dir' }); -``` -If you have already defined an absolute path for one of the FileAppenders in the configuration file, you could add a "absolute": true to the particular FileAppender to override the cwd option passed. Here is an example configuration file: - -#### my_log4js_configuration.json #### -```json -{ - "appenders": [ - { - "type": "file", - "filename": "relative/path/to/log_file.log", - "maxLogSize": 20480, - "backups": 3, - "category": "relative-logger" - }, + + [2010-01-17 11:43:37.987] [DEBUG] default - Some debug messages + +See the examples directory for lots of sample setup and usage code. + +## API +Log4js exposes two public functions: `configure` and `getLogger`. If +you're writing your own appender, your code will get access to some +internal APIs, see +[writing-appenders](http://github.com/nomiddlename/log4js-node/writing-appenders.md). + +### log4js.configure(config) +Configure takes a single argument. If that argument is a string, it is +considered the path to a JSON file containing the configuration +object. If the argument is an object, it must have the following +fields: + +* `appenders` (Object) - this should be a map of named appenders to + their configuration. At least one appender must be defined. +* `categories` (Object) - this should be a map of logger categories to + their levels and configuration. The "default" logger category must + be defined, as this is used to route all log events that do not have + an explicit category defined in the config. Category objects have + two fields: + * `level` - (String) the log level for that category: "trace", + "debug", "info", "warn", "error", "fatal", "off" + * `appenders` - (Array) the list of appender names to which log + events for this category should be sent + +The default configuration for log4js, the one used if `configure` is +not called, looks like this: + { - "type": "file", - "absolute": true, - "filename": "/absolute/path/to/log_file.log", - "maxLogSize": 20480, - "backups": 10, - "category": "absolute-logger" + "appenders": { + "console": { "type": "console" } + }, + "categories": { + "default": { level: "TRACE", appenders: [ "console" ] } + } } - ] -} -``` -Documentation for most of the core appenders can be found on the [wiki](https://github.com/nomiddlename/log4js-node/wiki/Appenders), otherwise take a look at the tests and the examples. + +Use of the default configuration can be overridden by setting the +`LOG4JS_CONFIG` environment variable to the location of a JSON +configuration file. log4js will use this file in preference to the +defaults, if `configure` is not called. An example file can be found +in `test/log4js.json`. An example config file with log rolling is in +`test/with-log-rolling.json`. + +### log4js.getLogger([category]) + +* `category` (String), optional. Category to use for log events + generated by the Logger. + +Returns a Logger instance. Unlike in previous versions, log4js +does not hold a reference to Loggers so feel free to use as many as +you like. + +### Logger + +Loggers provide the following functions: + +* `trace` +* `debug` +* `info` +* `warn` +* `error` +* `fatal` + +All can take a variable list of arguments which are used to construct +a log event. They work the same way as console.log, so you can pass a +format string with placeholders. e.g. + + logger.debug("number of widgets is %d", widgets); + + +## Appenders + +Log4js comes with file appenders included, which can be configured to +roll over based on a time or a file size. Other appenders are +available as separate modules: + +* [log4js-gelf](http://github.com/nomiddlename/log4js-gelf) +* [log4js-smtp](http://github.com/nomiddlename/log4js-smtp) +* [log4js-hookio](http://github.com/nomiddlename/log4js-hookio) + +There's also +[log4js-connect](http://github.com/nomiddlename/log4s-connect), for +logging http access in connect-based servers, like express. ## Documentation See the [wiki](https://github.com/nomiddlename/log4js-node/wiki). Improve the [wiki](https://github.com/nomiddlename/log4js-node/wiki), please. -There's also [an example application](https://github.com/nomiddlename/log4js-example). - ## Contributing Contributions welcome, but take a look at the [rules](https://github.com/nomiddlename/log4js-node/wiki/Contributing) first. diff --git a/examples/fromreadme.js b/examples/fromreadme.js index 71b399ad..c1a28d05 100644 --- a/examples/fromreadme.js +++ b/examples/fromreadme.js @@ -1,15 +1,8 @@ +"use strict"; //remember to change the require to just 'log4js' if you've npm install'ed it -var log4js = require('./lib/log4js'); -//by default the console appender is loaded -//log4js.loadAppender('console'); -//you'd only need to add the console appender if you -//had previously called log4js.clearAppenders(); -//log4js.addAppender(log4js.appenders.console()); -log4js.loadAppender('file'); -log4js.addAppender(log4js.appenders.file('cheese.log'), 'cheese'); +var log4js = require('../lib/log4js'); var logger = log4js.getLogger('cheese'); -logger.setLevel('ERROR'); logger.trace('Entering cheese testing'); logger.debug('Got cheese.'); diff --git a/lib/appenders/clustered.js b/lib/appenders/clustered.js deleted file mode 100755 index 3af1ecac..00000000 --- a/lib/appenders/clustered.js +++ /dev/null @@ -1,153 +0,0 @@ -"use strict"; - -var cluster = require('cluster'); -var log4js = require('../log4js'); - -/** - * Takes a loggingEvent object, returns string representation of it. - */ -function serializeLoggingEvent(loggingEvent) { - // JSON.stringify(new Error('test')) returns {}, which is not really useful for us. - // The following allows us to serialize errors correctly. - for (var i = 0; i < loggingEvent.data.length; i++) { - var item = loggingEvent.data[i]; - // Validate that we really are in this case - if (item && item.stack && JSON.stringify(item) === '{}') { - loggingEvent.data[i] = {stack : item.stack}; - } - } - return JSON.stringify(loggingEvent); -} - -/** - * Takes a string, returns an object with - * the correct log properties. - * - * This method has been "borrowed" from the `multiprocess` appender - * by `nomiddlename` - * (https://github.com/nomiddlename/log4js-node/blob/master/lib/appenders/multiprocess.js) - * - * Apparently, node.js serializes everything to strings when using `process.send()`, - * so we need smart deserialization that will recreate log date and level for further - * processing by log4js internals. - */ -function deserializeLoggingEvent(loggingEventString) { - - var loggingEvent; - - try { - - loggingEvent = JSON.parse(loggingEventString); - loggingEvent.startTime = new Date(loggingEvent.startTime); - loggingEvent.level = log4js.levels.toLevel(loggingEvent.level.levelStr); - // Unwrap serialized errors - for (var i = 0; i < loggingEvent.data.length; i++) { - var item = loggingEvent.data[i]; - if (item && item.stack) { - loggingEvent.data[i] = item.stack; - } - } - - } catch (e) { - - // JSON.parse failed, just log the contents probably a naughty. - loggingEvent = { - startTime: new Date(), - categoryName: 'log4js', - level: log4js.levels.ERROR, - data: [ 'Unable to parse log:', loggingEventString ] - }; - } - return loggingEvent; -} - -/** - * Creates an appender. - * - * If the current process is a master (`cluster.isMaster`), then this will be a "master appender". - * Otherwise this will be a worker appender, that just sends loggingEvents to the master process. - * - * If you are using this method directly, make sure to provide it with `config.actualAppenders` - * array of actual appender instances. - * - * Or better use `configure(config, options)` - */ -function createAppender(config) { - - if (cluster.isMaster) { - - var masterAppender = function(loggingEvent) { - - if (config.actualAppenders) { - var size = config.actualAppenders.length; - for(var i = 0; i < size; i++) { - if ( - !config.appenders[i].category || - config.appenders[i].category === loggingEvent.categoryName - ) { - // Relying on the index is not a good practice but otherwise - // the change would have been bigger. - config.actualAppenders[i](loggingEvent); - } - } - } - }; - - // Listen on new workers - cluster.on('fork', function(worker) { - - worker.on('message', function(message) { - if (message.type && message.type === '::log-message') { - var loggingEvent = deserializeLoggingEvent(message.event); - - // Adding PID metadata - loggingEvent.pid = worker.process.pid; - loggingEvent.cluster = { - master: process.pid, - worker: worker.process.pid, - workerId: worker.id - }; - - masterAppender(loggingEvent); - } - }); - - }); - - return masterAppender; - - } else { - - return function(loggingEvent) { - // If inside the worker process, then send the logger event to master. - if (cluster.isWorker) { - // console.log("worker " + cluster.worker.id + " is sending message"); - process.send({ type: '::log-message', event: serializeLoggingEvent(loggingEvent)}); - } - }; - } -} - -function configure(config, options) { - - if (config.appenders && cluster.isMaster) { - - var size = config.appenders.length; - config.actualAppenders = new Array(size); - - for(var i = 0; i < size; i++) { - - log4js.loadAppender(config.appenders[i].type); - config.actualAppenders[i] = log4js.appenderMakers[config.appenders[i].type]( - config.appenders[i], - options - ); - - } - } - - return createAppender(config); -} - -exports.appender = createAppender; -exports.configure = configure; diff --git a/lib/appenders/console.js b/lib/appenders/console.js index 20f80b13..09299d70 100644 --- a/lib/appenders/console.js +++ b/lib/appenders/console.js @@ -1,21 +1,21 @@ "use strict"; -var layouts = require('../layouts') -, consoleLog = console.log.bind(console); +var consoleLog = console.log.bind(console); -function consoleAppender (layout, timezoneOffset) { - layout = layout || layouts.colouredLayout; - return function(loggingEvent) { - consoleLog(layout(loggingEvent, timezoneOffset)); - }; -} +module.exports = function(layouts, levels) { -function configure(config) { - var layout; - if (config.layout) { - layout = layouts.layout(config.layout.type, config.layout); + function consoleAppender (layout) { + layout = layout || layouts.colouredLayout; + return function(loggingEvent) { + consoleLog(layout(loggingEvent)); + }; } - return consoleAppender(layout, config.timezoneOffset); -} -exports.appender = consoleAppender; -exports.configure = configure; + return function configure(config) { + var layout; + if (config.layout) { + layout = layouts.layout(config.layout.type, config.layout); + } + return consoleAppender(layout); + }; + +}; diff --git a/lib/appenders/dateFile.js b/lib/appenders/dateFile.js index 55c8fd81..d32226e9 100644 --- a/lib/appenders/dateFile.js +++ b/lib/appenders/dateFile.js @@ -1,6 +1,5 @@ "use strict"; -var streams = require('../streams') -, layouts = require('../layouts') +var streams = require('streamroller') , path = require('path') , os = require('os') , eol = os.EOL || '\n' @@ -13,78 +12,42 @@ process.on('exit', function() { }); }); -/** - * File appender that rolls files according to a date pattern. - * @filename base filename. - * @pattern the format that will be added to the end of filename when rolling, - * also used to check when to roll files - defaults to '.yyyy-MM-dd' - * @layout layout function for log messages - defaults to basicLayout - * @timezoneOffset optional timezone offset in minutes - defaults to system local - */ -function appender(filename, pattern, alwaysIncludePattern, layout, timezoneOffset) { - layout = layout || layouts.basicLayout; +module.exports = function(layouts, levels) { + /** + * File appender that rolls files according to a date pattern. + * @filename base filename. + * @pattern the format that will be added to the end of filename when rolling, + * also used to check when to roll files - defaults to '.yyyy-MM-dd' + * @layout layout function for log messages - defaults to basicLayout + */ + function appender(filename, pattern, alwaysIncludePattern, layout) { + layout = layout || layouts.basicLayout; + + var logFile = new streams.DateRollingFileStream( + filename, + pattern, + { alwaysIncludePattern: alwaysIncludePattern } + ); + openFiles.push(logFile); + + return function(logEvent) { + logFile.write(layout(logEvent) + eol, "utf8"); + }; - var logFile = new streams.DateRollingFileStream( - filename, - pattern, - { alwaysIncludePattern: alwaysIncludePattern } - ); - openFiles.push(logFile); - - return function(logEvent) { - logFile.write(layout(logEvent, timezoneOffset) + eol, "utf8"); - }; - -} - -function configure(config, options) { - var layout; - - if (config.layout) { - layout = layouts.layout(config.layout.type, config.layout); - } - - if (!config.alwaysIncludePattern) { - config.alwaysIncludePattern = false; } - if (options && options.cwd && !config.absolute) { - config.filename = path.join(options.cwd, config.filename); - } - - return appender( - config.filename, - config.pattern, - config.alwaysIncludePattern, - layout, - config.timezoneOffset - ); -} - -function shutdown(cb) { - var completed = 0; - var error; - var complete = function(err) { - error = error || err; - completed++; - if (completed >= openFiles.length) { - cb(error); + return function configure(config) { + var layout; + + if (config.layout) { + layout = layouts.layout(config.layout.type, config.layout); } - }; - if (!openFiles.length) { - return cb(); - } - openFiles.forEach(function(file) { - if (!file.write(eol, "utf-8")) { - file.once('drain', function() { - file.end(complete); - }); - } else { - file.end(complete); + + if (!config.alwaysIncludePattern) { + config.alwaysIncludePattern = false; } - }); -} + + return appender(config.filename, config.pattern, config.alwaysIncludePattern, layout); + }; -exports.appender = appender; -exports.configure = configure; -exports.shutdown = shutdown; +}; diff --git a/lib/appenders/file.js b/lib/appenders/file.js index 60883777..eddc06cf 100644 --- a/lib/appenders/file.js +++ b/lib/appenders/file.js @@ -1,12 +1,10 @@ "use strict"; -var layouts = require('../layouts') -, path = require('path') +var path = require('path') , fs = require('fs') -, streams = require('../streams') +, streams = require('streamroller') , os = require('os') , eol = os.EOL || '\n' -, openFiles = [] -, levels = require('../levels'); +, openFiles = []; //close open files on process exit. process.on('exit', function() { @@ -15,105 +13,66 @@ process.on('exit', function() { }); }); -/** - * File Appender writing the logs to a text file. Supports rolling of logs by size. - * - * @param file file log messages will be written to - * @param layout a function that takes a logevent and returns a string - * (defaults to basicLayout). - * @param logSize - the maximum size (in bytes) for a log file, - * if not provided then logs won't be rotated. - * @param numBackups - the number of log files to keep after logSize - * has been reached (default 5) - * @param compress - flag that controls log file compression - * @param timezoneOffset - optional timezone offset in minutes (default system local) - */ -function fileAppender (file, layout, logSize, numBackups, compress, timezoneOffset) { - var bytesWritten = 0; - file = path.normalize(file); - layout = layout || layouts.basicLayout; - numBackups = numBackups === undefined ? 5 : numBackups; - //there has to be at least one backup if logSize has been specified - numBackups = numBackups === 0 ? 1 : numBackups; +module.exports = function(layouts, levels) { - function openTheStream(file, fileSize, numFiles) { - var stream; - if (fileSize) { - stream = new streams.RollingFileStream( - file, - fileSize, - numFiles, - { "compress": compress } - ); - } else { - stream = fs.createWriteStream( - file, - { encoding: "utf8", - mode: parseInt('0644', 8), - flags: 'a' } - ); + /** + * File Appender writing the logs to a text file. Supports rolling of logs by size. + * + * @param file file log messages will be written to + * @param layout a function that takes a logevent and returns a string + * (defaults to basicLayout). + * @param logSize - the maximum size (in bytes) for a log file, + * if not provided then logs won't be rotated. + * @param numBackups - the number of log files to keep after logSize + * has been reached (default 5) + */ + function fileAppender (file, layout, logSize, numBackups) { + var bytesWritten = 0; + file = path.normalize(file); + layout = layout || layouts.basicLayout; + numBackups = numBackups === undefined ? 5 : numBackups; + //there has to be at least one backup if logSize has been specified + numBackups = numBackups === 0 ? 1 : numBackups; + + function openTheStream(file, fileSize, numFiles) { + var stream; + if (fileSize) { + stream = new streams.RollingFileStream( + file, + fileSize, + numFiles + ); + } else { + stream = fs.createWriteStream( + file, + { encoding: "utf8", + mode: parseInt('0644', 8), + flags: 'a' } + ); + } + stream.on("error", function (err) { + console.error("log4js.fileAppender - Writing to file %s, error happened ", file, err); + }); + return stream; } - stream.on("error", function (err) { - console.error("log4js.fileAppender - Writing to file %s, error happened ", file, err); - }); - return stream; - } - - var logFile = openTheStream(file, logSize, numBackups); - - // push file to the stack of open handlers - openFiles.push(logFile); - return function(loggingEvent) { - logFile.write(layout(loggingEvent, timezoneOffset) + eol, "utf8"); - }; - -} - -function configure(config, options) { - var layout; - if (config.layout) { - layout = layouts.layout(config.layout.type, config.layout); + var logFile = openTheStream(file, logSize, numBackups); + + // push file to the stack of open handlers + openFiles.push(logFile); + + return function(loggingEvent) { + logFile.write(layout(loggingEvent) + eol, "utf8"); + }; } - if (options && options.cwd && !config.absolute) { - config.filename = path.join(options.cwd, config.filename); - } - - return fileAppender( - config.filename, - layout, - config.maxLogSize, - config.backups, - config.compress, - config.timezoneOffset - ); -} - -function shutdown(cb) { - var completed = 0; - var error; - var complete = function(err) { - error = error || err; - completed++; - if (completed >= openFiles.length) { - cb(error); + return function configure(config) { + var layout; + if (config.layout) { + layout = layouts.layout(config.layout.type, config.layout); } + + return fileAppender(config.filename, layout, config.maxLogSize, config.backups); }; - if (!openFiles.length) { - return cb(); - } - openFiles.forEach(function(file) { - if (!file.write(eol, "utf-8")) { - file.once('drain', function() { - file.end(complete); - }); - } else { - file.end(complete); - } - }); -} -exports.appender = fileAppender; -exports.configure = configure; -exports.shutdown = shutdown; +}; diff --git a/lib/appenders/gelf.js b/lib/appenders/gelf.js deleted file mode 100644 index a367ef57..00000000 --- a/lib/appenders/gelf.js +++ /dev/null @@ -1,155 +0,0 @@ -"use strict"; -var zlib = require('zlib'); -var layouts = require('../layouts'); -var levels = require('../levels'); -var dgram = require('dgram'); -var util = require('util'); -var debug = require('../debug')('GELF Appender'); - -var LOG_EMERG=0; // system is unusable -var LOG_ALERT=1; // action must be taken immediately -var LOG_CRIT=2; // critical conditions -var LOG_ERR=3; // error conditions -var LOG_ERROR=3; // because people WILL typo -var LOG_WARNING=4; // warning conditions -var LOG_NOTICE=5; // normal, but significant, condition -var LOG_INFO=6; // informational message -var LOG_DEBUG=7; // debug-level message - -var levelMapping = {}; -levelMapping[levels.ALL] = LOG_DEBUG; -levelMapping[levels.TRACE] = LOG_DEBUG; -levelMapping[levels.DEBUG] = LOG_DEBUG; -levelMapping[levels.INFO] = LOG_INFO; -levelMapping[levels.WARN] = LOG_WARNING; -levelMapping[levels.ERROR] = LOG_ERR; -levelMapping[levels.FATAL] = LOG_CRIT; - -var client; - -/** - * GELF appender that supports sending UDP packets to a GELF compatible server such as Graylog - * - * @param layout a function that takes a logevent and returns a string (defaults to none). - * @param host - host to which to send logs (default:localhost) - * @param port - port at which to send logs to (default:12201) - * @param hostname - hostname of the current host (default:os hostname) - * @param facility - facility to log to (default:nodejs-server) - */ - /* jshint maxstatements:21 */ -function gelfAppender (layout, host, port, hostname, facility) { - var config, customFields; - if (typeof(host) === 'object') { - config = host; - host = config.host; - port = config.port; - hostname = config.hostname; - facility = config.facility; - customFields = config.customFields; - } - - host = host || 'localhost'; - port = port || 12201; - hostname = hostname || require('os').hostname(); - layout = layout || layouts.messagePassThroughLayout; - - var defaultCustomFields = customFields || {}; - - if(facility) { - defaultCustomFields._facility = facility; - } - - client = dgram.createSocket("udp4"); - - process.on('exit', function() { - if (client) client.close(); - }); - - /** - * Add custom fields (start with underscore ) - * - if the first object passed to the logger contains 'GELF' field, - * copy the underscore fields to the message - * @param loggingEvent - * @param msg - */ - function addCustomFields(loggingEvent, msg){ - - /* append defaultCustomFields firsts */ - Object.keys(defaultCustomFields).forEach(function(key) { - // skip _id field for graylog2, skip keys not starts with UNDERSCORE - if (key.match(/^_/) && key !== "_id") { - msg[key] = defaultCustomFields[key]; - } - }); - - /* append custom fields per message */ - var data = loggingEvent.data; - if (!Array.isArray(data) || data.length === 0) return; - var firstData = data[0]; - - if (!firstData.GELF) return; // identify with GELF field defined - // Remove the GELF key, some gelf supported logging systems drop the message with it - delete firstData.GELF; - Object.keys(firstData).forEach(function(key) { - // skip _id field for graylog2, skip keys not starts with UNDERSCORE - if (key.match(/^_/) || key !== "_id") { - msg[key] = firstData[key]; - } - }); - - /* the custom field object should be removed, so it will not be looged by the later appenders */ - loggingEvent.data.shift(); - } - - function preparePacket(loggingEvent) { - var msg = {}; - addCustomFields(loggingEvent, msg); - msg.short_message = layout(loggingEvent); - - msg.version="1.1"; - msg.timestamp = msg.timestamp || new Date().getTime() / 1000; // log should use millisecond - msg.host = hostname; - msg.level = levelMapping[loggingEvent.level || levels.DEBUG]; - return msg; - } - - function sendPacket(packet) { - client.send(packet, 0, packet.length, port, host, function(err) { - if (err) { console.error(err); } - }); - } - - return function(loggingEvent) { - var message = preparePacket(loggingEvent); - zlib.gzip(new Buffer(JSON.stringify(message)), function(err, packet) { - if (err) { - console.error(err.stack); - } else { - if (packet.length > 8192) { - debug("Message packet length (" + packet.length + ") is larger than 8k. Not sending"); - } else { - sendPacket(packet); - } - } - }); - }; -} - -function configure(config) { - var layout; - if (config.layout) { - layout = layouts.layout(config.layout.type, config.layout); - } - return gelfAppender(layout, config); -} - -function shutdown(cb) { - if (client) { - client.close(cb); - client = null; - } -} - -exports.appender = gelfAppender; -exports.configure = configure; -exports.shutdown = shutdown; diff --git a/lib/appenders/hipchat.js b/lib/appenders/hipchat.js index 3fd65df0..a73d5a58 100644 --- a/lib/appenders/hipchat.js +++ b/lib/appenders/hipchat.js @@ -1,11 +1,7 @@ "use strict"; var hipchat = require('hipchat-notifier'); -var layouts = require('../layouts'); - -exports.name = 'hipchat'; -exports.appender = hipchatAppender; -exports.configure = hipchatConfigure; +// var layouts = require('../layouts'); /** @invoke as @@ -29,62 +25,56 @@ exports.configure = hipchatConfigure; @invoke */ - -function hipchatNotifierResponseCallback(err, response, body){ - if(err) { - throw err; +module.exports = function(layouts, levels) { + function hipchatNotifierResponseCallback(err, response, body){ + if(err) { + throw err; + } } -} -function hipchatAppender(config) { + var notifierLevel = {}; + notifierLevel[levels.TRACE] = "info"; + notifierLevel[levels.DEBUG] = "info"; + notifierLevel[levels.WARN] = "warning"; + notifierLevel[levels.ERROR] = "failure"; + notifierLevel[levels.FATAL] = "failure"; - var notifier = hipchat.make(config.hipchat_room, config.hipchat_token); - - // @lint W074 This function's cyclomatic complexity is too high. (10) - return function(loggingEvent){ - - var notifierFn; + function hipchatAppender(config, appenderByName) { + var notifier = hipchat.make(config.hipchat_room, config.hipchat_token); notifier.setRoom(config.hipchat_room); notifier.setFrom(config.hipchat_from || ''); notifier.setNotify(config.hipchat_notify || false); - if(config.hipchat_host) { + if (config.hipchat_host) { notifier.setHost(config.hipchat_host); } - switch (loggingEvent.level.toString()) { - case "TRACE": - case "DEBUG": - notifierFn = "info"; - break; - case "WARN": - notifierFn = "warning"; - break; - case "ERROR": - case "FATAL": - notifierFn = "failure"; - break; - default: - notifierFn = "success"; - } + var layout = layouts.layout(config.layout); - // @TODO, re-work in timezoneOffset ? - var layoutMessage = config.layout(loggingEvent); + // @lint W074 This function's cyclomatic complexity is too high. (10) + return function(loggingEvent) { - // dispatch hipchat api request, do not return anything - // [overide hipchatNotifierResponseCallback] - notifier[notifierFn](layoutMessage, config.hipchat_response_callback || - hipchatNotifierResponseCallback); - }; -} + var notifierFn = notifierLevel[loggingEvent.level] || "success"; + + // @TODO, re-work in timezoneOffset ? + var layoutMessage = layout(loggingEvent); + + // dispatch hipchat api request, do not return anything + // [overide hipchatNotifierResponseCallback] + notifier[notifierFn](layoutMessage, config.hipchat_response_callback || + hipchatNotifierResponseCallback); + }; + } + + return function hipchatConfigure(config) { + var layout; -function hipchatConfigure(config) { - var layout; + if (!config.layout) { + config.layout = layouts.messagePassThroughLayout; + } - if (!config.layout) { - config.layout = layouts.messagePassThroughLayout; - } + return hipchatAppender(config, layout); + }; - return hipchatAppender(config, layout); -} +}; diff --git a/lib/appenders/logLevelFilter.js b/lib/appenders/logLevelFilter.js index cdd273f0..e4d40e15 100644 --- a/lib/appenders/logLevelFilter.js +++ b/lib/appenders/logLevelFilter.js @@ -1,23 +1,40 @@ "use strict"; -var levels = require('../levels') -, log4js = require('../log4js'); +var debug = require('debug')('log4js:logLevelFilter'); -function logLevelFilter (minLevelString, maxLevelString, appender) { - var minLevel = levels.toLevel(minLevelString); - var maxLevel = levels.toLevel(maxLevelString, levels.FATAL); - return function(logEvent) { - var eventLevel = logEvent.level; - if (eventLevel.isGreaterThanOrEqualTo(minLevel) && eventLevel.isLessThanOrEqualTo(maxLevel)) { - appender(logEvent); +module.exports = function(layouts, levels) { + + function logLevelFilter(allowedLevels, appender) { + return function(logEvent) { + debug("Checking ", logEvent.level, " against ", allowedLevels); + if (allowedLevels.some(function(item) { return item.level === logEvent.level.level; })) { + debug("Sending ", logEvent, " to appender ", appender); + appender(logEvent); + } + }; + } + + return function configure(config, appenderByName) { + if (!Array.isArray(config.allow)) { + throw new Error("No allowed log levels specified."); } - }; -} -function configure(config, options) { - log4js.loadAppender(config.appender.type); - var appender = log4js.appenderMakers[config.appender.type](config.appender, options); - return logLevelFilter(config.level, config.maxLevel, appender); -} + var allowedLevels = config.allow.map(function(allowed) { + var level = levels.toLevel(allowed); + if (!level) { + throw new Error("Unrecognised log level '" + allowed + "'."); + } + return level; + }); + + if (allowedLevels.length === 0) { + throw new Error("No allowed log levels specified."); + } + + if (!config.appender) { + throw new Error("Missing an appender."); + } + + return logLevelFilter(allowedLevels, appenderByName(config.appender)); + }; -exports.appender = logLevelFilter; -exports.configure = configure; +}; diff --git a/lib/appenders/multiprocess.js b/lib/appenders/multiprocess.js deleted file mode 100644 index 0f142493..00000000 --- a/lib/appenders/multiprocess.js +++ /dev/null @@ -1,135 +0,0 @@ -"use strict"; -var log4js = require('../log4js') -, net = require('net') -, END_MSG = '__LOG4JS__'; - -/** - * Creates a server, listening on config.loggerPort, config.loggerHost. - * Output goes to config.actualAppender (config.appender is used to - * set up that appender). - */ -function logServer(config) { - - /** - * Takes a utf-8 string, returns an object with - * the correct log properties. - */ - function deserializeLoggingEvent(clientSocket, msg) { - var loggingEvent; - try { - loggingEvent = JSON.parse(msg); - loggingEvent.startTime = new Date(loggingEvent.startTime); - loggingEvent.level = log4js.levels.toLevel(loggingEvent.level.levelStr); - } catch (e) { - // JSON.parse failed, just log the contents probably a naughty. - loggingEvent = { - startTime: new Date(), - categoryName: 'log4js', - level: log4js.levels.ERROR, - data: [ 'Unable to parse log:', msg ] - }; - } - - loggingEvent.remoteAddress = clientSocket.remoteAddress; - loggingEvent.remotePort = clientSocket.remotePort; - - return loggingEvent; - } - - var actualAppender = config.actualAppender, - server = net.createServer(function serverCreated(clientSocket) { - clientSocket.setEncoding('utf8'); - var logMessage = ''; - - function logTheMessage(msg) { - if (logMessage.length > 0) { - actualAppender(deserializeLoggingEvent(clientSocket, msg)); - } - } - - function chunkReceived(chunk) { - var event; - logMessage += chunk || ''; - if (logMessage.indexOf(END_MSG) > -1) { - event = logMessage.substring(0, logMessage.indexOf(END_MSG)); - logTheMessage(event); - logMessage = logMessage.substring(event.length + END_MSG.length) || ''; - //check for more, maybe it was a big chunk - chunkReceived(); - } - } - - clientSocket.on('data', chunkReceived); - clientSocket.on('end', chunkReceived); - }); - - server.listen(config.loggerPort || 5000, config.loggerHost || 'localhost'); - - return actualAppender; -} - -function workerAppender(config) { - var canWrite = false, - buffer = [], - socket; - - createSocket(); - - function createSocket() { - socket = net.createConnection(config.loggerPort || 5000, config.loggerHost || 'localhost'); - socket.on('connect', function() { - emptyBuffer(); - canWrite = true; - }); - socket.on('timeout', socket.end.bind(socket)); - //don't bother listening for 'error', 'close' gets called after that anyway - socket.on('close', createSocket); - } - - function emptyBuffer() { - var evt; - while ((evt = buffer.shift())) { - write(evt); - } - } - - function write(loggingEvent) { - // JSON.stringify(new Error('test')) returns {}, which is not really useful for us. - // The following allows us to serialize errors correctly. - // Validate that we really are in this case - if (loggingEvent && loggingEvent.stack && JSON.stringify(loggingEvent) === '{}') { - loggingEvent = {stack : loggingEvent.stack}; - } - socket.write(JSON.stringify(loggingEvent), 'utf8'); - socket.write(END_MSG, 'utf8'); - } - - return function log(loggingEvent) { - if (canWrite) { - write(loggingEvent); - } else { - buffer.push(loggingEvent); - } - }; -} - -function createAppender(config) { - if (config.mode === 'master') { - return logServer(config); - } else { - return workerAppender(config); - } -} - -function configure(config, options) { - var actualAppender; - if (config.appender && config.mode === 'master') { - log4js.loadAppender(config.appender.type); - actualAppender = log4js.appenderMakers[config.appender.type](config.appender, options); - config.actualAppender = actualAppender; - } - return createAppender(config); -} - -exports.appender = createAppender; -exports.configure = configure; diff --git a/lib/appenders/smtp.js b/lib/appenders/smtp.js deleted file mode 100644 index 161e72c5..00000000 --- a/lib/appenders/smtp.js +++ /dev/null @@ -1,152 +0,0 @@ -"use strict"; - -var layouts = require("../layouts"); -var mailer = require("nodemailer"); -var os = require('os'); - -var logEventBuffer = []; -var subjectLayout; -var layout; - -var unsentCount = 0; -var shutdownTimeout; - -var sendInterval; -var sendTimer; - -var config; - -function sendBuffer() { - if (logEventBuffer.length > 0) { - - var transportOpts = getTransportOptions(config); - var transport = mailer.createTransport(transportOpts); - var firstEvent = logEventBuffer[0]; - var body = ""; - var count = logEventBuffer.length; - while (logEventBuffer.length > 0) { - body += layout(logEventBuffer.shift(), config.timezoneOffset) + "\n"; - } - - var msg = { - to: config.recipients, - subject: config.subject || subjectLayout(firstEvent), - headers: {"Hostname": os.hostname()} - }; - - if (true === config.attachment.enable) { - msg[config.html ? "html" : "text"] = config.attachment.message; - msg.attachments = [ - { - filename: config.attachment.filename, - contentType: 'text/x-log', - content: body - } - ]; - } else { - msg[config.html ? "html" : "text"] = body; - } - - if (config.sender) { - msg.from = config.sender; - } - transport.sendMail(msg, function (error) { - if (error) { - console.error("log4js.smtpAppender - Error happened", error); - } - transport.close(); - unsentCount -= count; - }); - } -} - -function getTransportOptions() { - var transportOpts = null; - if (config.SMTP) { - transportOpts = config.SMTP; - } else if (config.transport) { - var plugin = config.transport.plugin || 'smtp'; - var transportModule = 'nodemailer-' + plugin + '-transport'; - var transporter = require(transportModule); - transportOpts = transporter(config.transport.options); - } - - return transportOpts; -} - -function scheduleSend() { - if (!sendTimer) { - sendTimer = setTimeout(function () { - sendTimer = null; - sendBuffer(); - }, sendInterval); - } -} - -/** - * SMTP Appender. Sends logging events using SMTP protocol. - * It can either send an email on each event or group several - * logging events gathered during specified interval. - * - * @param _config appender configuration data - * config.sendInterval time between log emails (in seconds), if 0 - * then every event sends an email - * config.shutdownTimeout time to give up remaining emails (in seconds; defaults to 5). - * @param _layout a function that takes a logevent and returns a string (defaults to basicLayout). - */ -function smtpAppender(_config, _layout) { - config = _config; - - if (!config.attachment) { - config.attachment = {}; - } - - config.attachment.enable = !!config.attachment.enable; - config.attachment.message = config.attachment.message || "See logs as attachment"; - config.attachment.filename = config.attachment.filename || "default.log"; - layout = _layout || layouts.basicLayout; - subjectLayout = layouts.messagePassThroughLayout; - sendInterval = config.sendInterval * 1000 || 0; - - shutdownTimeout = ('shutdownTimeout' in config ? config.shutdownTimeout : 5) * 1000; - - return function (loggingEvent) { - unsentCount++; - logEventBuffer.push(loggingEvent); - if (sendInterval > 0) { - scheduleSend(); - } else { - sendBuffer(); - } - }; -} - -function configure(_config) { - config = _config; - if (_config.layout) { - layout = layouts.layout(_config.layout.type, _config.layout); - } - return smtpAppender(_config, layout); -} - -function shutdown(cb) { - if (shutdownTimeout > 0) { - setTimeout(function () { - if (sendTimer) - clearTimeout(sendTimer); - sendBuffer(); - }, shutdownTimeout); - } - (function checkDone() { - if (unsentCount > 0) { - setTimeout(checkDone, 100); - } else { - cb(); - } - })(); -} - -exports.name = "smtp"; -exports.appender = smtpAppender; -exports.configure = configure; -exports.shutdown = shutdown; diff --git a/lib/connect-logger.js b/lib/connect-logger.js deleted file mode 100755 index 2bded775..00000000 --- a/lib/connect-logger.js +++ /dev/null @@ -1,262 +0,0 @@ -"use strict"; -var levels = require("./levels"); -var DEFAULT_FORMAT = ':remote-addr - -' + - ' ":method :url HTTP/:http-version"' + - ' :status :content-length ":referrer"' + - ' ":user-agent"'; -/** - * Log requests with the given `options` or a `format` string. - * - * Options: - * - * - `format` Format string, see below for tokens - * - `level` A log4js levels instance. Supports also 'auto' - * - * Tokens: - * - * - `:req[header]` ex: `:req[Accept]` - * - `:res[header]` ex: `:res[Content-Length]` - * - `:http-version` - * - `:response-time` - * - `:remote-addr` - * - `:date` - * - `:method` - * - `:url` - * - `:referrer` - * - `:user-agent` - * - `:status` - * - * @param {String|Function|Object} format or options - * @return {Function} - * @api public - */ - -function getLogger(logger4js, options) { - if ('object' == typeof options) { - options = options || {}; - } else if (options) { - options = { format: options }; - } else { - options = {}; - } - - var thislogger = logger4js - , level = levels.toLevel(options.level, levels.INFO) - , fmt = options.format || DEFAULT_FORMAT - , nolog = options.nolog ? createNoLogCondition(options.nolog) : null; - - return function (req, res, next) { - // mount safety - if (req._logging) return next(); - - // nologs - if (nolog && nolog.test(req.originalUrl)) return next(); - if (thislogger.isLevelEnabled(level) || options.level === 'auto') { - - var start = new Date() - , statusCode - , writeHead = res.writeHead - , url = req.originalUrl; - - // flag as logging - req._logging = true; - - // proxy for statusCode. - res.writeHead = function(code, headers){ - res.writeHead = writeHead; - res.writeHead(code, headers); - res.__statusCode = statusCode = code; - res.__headers = headers || {}; - - //status code response level handling - if(options.level === 'auto'){ - level = levels.INFO; - if(code >= 300) level = levels.WARN; - if(code >= 400) level = levels.ERROR; - } else { - level = levels.toLevel(options.level, levels.INFO); - } - }; - - //hook on end request to emit the log entry of the HTTP request. - res.on('finish', function() { - res.responseTime = new Date() - start; - //status code response level handling - if(res.statusCode && options.level === 'auto'){ - level = levels.INFO; - if(res.statusCode >= 300) level = levels.WARN; - if(res.statusCode >= 400) level = levels.ERROR; - } - if (thislogger.isLevelEnabled(level)) { - var combined_tokens = assemble_tokens(req, res, options.tokens || []); - if (typeof fmt === 'function') { - var line = fmt(req, res, function(str){ return format(str, combined_tokens); }); - if (line) thislogger.log(level, line); - } else { - thislogger.log(level, format(fmt, combined_tokens)); - } - } - }); - } - - //ensure next gets always called - next(); - }; -} - -/** - * Adds custom {token, replacement} objects to defaults, - * overwriting the defaults if any tokens clash - * - * @param {IncomingMessage} req - * @param {ServerResponse} res - * @param {Array} custom_tokens - * [{ token: string-or-regexp, replacement: string-or-replace-function }] - * @return {Array} - */ -function assemble_tokens(req, res, custom_tokens) { - var array_unique_tokens = function(array) { - var a = array.concat(); - for(var i=0; i -1 ? vYearLong : vYearShort); - var vHour = addZero(date.getUTCHours()); - var vMinute = addZero(date.getUTCMinutes()); - var vSecond = addZero(date.getUTCSeconds()); - var vMillisecond = padWithZeros(date.getUTCMilliseconds(), 3); - var vTimeZone = offset(timezoneOffset); - date.setUTCMinutes(date.getUTCMinutes() + timezoneOffset); - var formatted = format - .replace(/dd/g, vDay) - .replace(/MM/g, vMonth) - .replace(/y{1,4}/g, vYear) - .replace(/hh/g, vHour) - .replace(/mm/g, vMinute) - .replace(/ss/g, vSecond) - .replace(/SSS/g, vMillisecond) - .replace(/O/g, vTimeZone); - return formatted; - -}; -/*jshint +W071 */ diff --git a/lib/debug.js b/lib/debug.js deleted file mode 100644 index e3e65816..00000000 --- a/lib/debug.js +++ /dev/null @@ -1,15 +0,0 @@ -"use strict"; - -module.exports = function(label) { - var debug; - - if (process.env.NODE_DEBUG && /\blog4js\b/.test(process.env.NODE_DEBUG)) { - debug = function(message) { - console.error('LOG4JS: (%s) %s', label, message); - }; - } else { - debug = function() { }; - } - - return debug; -}; diff --git a/lib/layouts.js b/lib/layouts.js index 75b6e1e6..354b2114 100644 --- a/lib/layouts.js +++ b/lib/layouts.js @@ -1,9 +1,9 @@ "use strict"; -var dateFormat = require('./date_format') +var dateFormat = require('date-format') +, semver = require('semver') , os = require('os') , eol = os.EOL || '\n' , util = require('util') -, semver = require('semver') , replacementRegExp = /%[sdj]/g , layoutMakers = { "messagePassThrough": function() { return messagePassThroughLayout; }, @@ -12,8 +12,7 @@ var dateFormat = require('./date_format') "coloured": function() { return colouredLayout; }, "pattern": function (config) { return patternLayout(config && config.pattern, config && config.tokens); - }, - "dummy": function() { return dummyLayout; } + } } , colours = { ALL: "grey", @@ -33,7 +32,7 @@ function wrapErrorsWithInspect(items) { if (semver.satisfies(process.version, '>=6')) { return util.format(item); } else { - return util.format(item) + '\n' + item.stack; + return util.format(item) + '\n' + item.stack; } } }; } else { @@ -79,13 +78,13 @@ function colorize (str, style) { return colorizeStart(style) + str + colorizeEnd(style); } -function timestampLevelAndCategory(loggingEvent, colour, timezoneOffest) { +function timestampLevelAndCategory(loggingEvent, colour) { var output = colorize( formatLogData( '[%s] [%s] %s - ' - , dateFormat.asString(loggingEvent.startTime, timezoneOffest) + , dateFormat.asString(loggingEvent.startTime) , loggingEvent.level - , loggingEvent.categoryName + , loggingEvent.category ) , colour ); @@ -96,28 +95,23 @@ function timestampLevelAndCategory(loggingEvent, colour, timezoneOffest) { * BasicLayout is a simple layout for storing the logs. The logs are stored * in following format: * 
- * [startTime] [logLevel] categoryName - message\n
+ * [startTime] [logLevel] category - message\n
  *
* * @author Stephan Strittmatter */ -function basicLayout (loggingEvent, timezoneOffset) { - return timestampLevelAndCategory( - loggingEvent, - undefined, - timezoneOffset - ) + formatLogData(loggingEvent.data); +function basicLayout (loggingEvent) { + return timestampLevelAndCategory(loggingEvent) + formatLogData(loggingEvent.data); } /** * colouredLayout - taken from masylum's fork. * same as basicLayout, but with colours. */ -function colouredLayout (loggingEvent, timezoneOffset) { +function colouredLayout (loggingEvent) { return timestampLevelAndCategory( loggingEvent, - colours[loggingEvent.level.toString()], - timezoneOffset + colours[loggingEvent.level.toString()] ) + formatLogData(loggingEvent.data); } @@ -156,20 +150,18 @@ function dummyLayout(loggingEvent) { * Takes a pattern string, array of tokens and returns a layout function. * @param {String} Log format pattern String * @param {object} map object of different tokens - * @param {number} timezone offset in minutes * @return {Function} * @author Stephan Strittmatter * @author Jan Schmidle */ -function patternLayout (pattern, tokens, timezoneOffset) { - // jshint maxstatements:22 +function patternLayout (pattern, tokens) { var TTCC_CONVERSION_PATTERN = "%r %p %c - %m%n"; var regex = /%(-?[0-9]+)?(\.?[0-9]+)?([\[\]cdhmnprzxy%])(\{([^\}]+)\})?|([^%]+)/; pattern = pattern || TTCC_CONVERSION_PATTERN; - function categoryName(loggingEvent, specifier) { - var loggerName = loggingEvent.categoryName; + function category(loggingEvent, specifier) { + var loggerName = loggingEvent.category; if (specifier) { var precision = parseInt(specifier, 10); var loggerNameBits = loggerName.split("."); @@ -180,23 +172,20 @@ function patternLayout (pattern, tokens, timezoneOffset) { return loggerName; } + var formats = { + "ISO8601": dateFormat.ISO8601_FORMAT, + "ISO8601_WITH_TZ_OFFSET": dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, + "ABSOLUTE": dateFormat.ABSOLUTETIME_FORMAT, + "DATE": dateFormat.DATETIME_FORMAT + }; + function formatAsDate(loggingEvent, specifier) { var format = dateFormat.ISO8601_FORMAT; if (specifier) { - format = specifier; - // Pick up special cases - if (format == "ISO8601") { - format = dateFormat.ISO8601_FORMAT; - } else if (format == "ISO8601_WITH_TZ_OFFSET") { - format = dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT; - } else if (format == "ABSOLUTE") { - format = dateFormat.ABSOLUTETIME_FORMAT; - } else if (format == "DATE") { - format = dateFormat.DATETIME_FORMAT; - } + format = formats[specifier] || specifier; } // Format the date - return dateFormat.asString(format, loggingEvent.startTime, timezoneOffset); + return dateFormat.asString(format, loggingEvent.startTime); } function hostname() { @@ -216,7 +205,7 @@ function patternLayout (pattern, tokens, timezoneOffset) { } function startTime(loggingEvent) { - return dateFormat.asString('hh:mm:ss', loggingEvent.startTime, timezoneOffset); + return "" + loggingEvent.startTime.toLocaleTimeString(); } function startColour(loggingEvent) { @@ -264,7 +253,7 @@ function patternLayout (pattern, tokens, timezoneOffset) { } var replacers = { - 'c': categoryName, + 'c': category, 'd': formatAsDate, 'h': hostname, 'm': formatMessage, @@ -355,10 +344,6 @@ module.exports = { patternLayout: patternLayout, colouredLayout: colouredLayout, coloredLayout: colouredLayout, - dummyLayout: dummyLayout, - addLayout: function(name, serializerGenerator) { - layoutMakers[name] = serializerGenerator; - }, layout: function(name, config) { return layoutMakers[name] && layoutMakers[name](config); } diff --git a/lib/levels.js b/lib/levels.js index cb9243a2..cec1fcd1 100644 --- a/lib/levels.js +++ b/lib/levels.js @@ -30,37 +30,51 @@ Level.prototype.toString = function() { return this.levelStr; }; -Level.prototype.isLessThanOrEqualTo = function(otherLevel) { - if (typeof otherLevel === "string") { - otherLevel = toLevel(otherLevel); +function convertAndCompare(comparison) { + return function(otherLevel) { + if (typeof otherLevel === "string") { + otherLevel = toLevel(otherLevel); + } + return comparison.call(this, otherLevel); + }; +} + +Level.prototype.isLessThanOrEqualTo = convertAndCompare( + function(otherLevel) { + return this.level <= otherLevel.level; } - return this.level <= otherLevel.level; -}; +); -Level.prototype.isGreaterThanOrEqualTo = function(otherLevel) { - if (typeof otherLevel === "string") { - otherLevel = toLevel(otherLevel); +Level.prototype.isGreaterThanOrEqualTo = convertAndCompare( + function(otherLevel) { + return this.level >= otherLevel.level; } - return this.level >= otherLevel.level; -}; +); -Level.prototype.isEqualTo = function(otherLevel) { - if (typeof otherLevel === "string") { - otherLevel = toLevel(otherLevel); +Level.prototype.isEqualTo = convertAndCompare( + function(otherLevel) { + return this.level === otherLevel.level; } - return this.level === otherLevel.level; -}; +); -module.exports = { - ALL: new Level(Number.MIN_VALUE, "ALL"), - TRACE: new Level(5000, "TRACE"), - DEBUG: new Level(10000, "DEBUG"), - INFO: new Level(20000, "INFO"), - WARN: new Level(30000, "WARN"), - ERROR: new Level(40000, "ERROR"), - FATAL: new Level(50000, "FATAL"), - MARK: new Level(9007199254740992, "MARK"), // 2^53 - OFF: new Level(Number.MAX_VALUE, "OFF"), - toLevel: toLevel, - Level: Level -}; + +exports.ALL = new Level(Number.MIN_VALUE, "ALL"); +exports.TRACE = new Level(5000, "TRACE"); +exports.DEBUG = new Level(10000, "DEBUG"); +exports.INFO = new Level(20000, "INFO"); +exports.WARN = new Level(30000, "WARN"); +exports.ERROR = new Level(40000, "ERROR"); +exports.FATAL = new Level(50000, "FATAL"); +exports.OFF = new Level(Number.MAX_VALUE, "OFF"); + +exports.levels = [ + exports.OFF, + exports.TRACE, + exports.DEBUG, + exports.INFO, + exports.WARN, + exports.ERROR, + exports.FATAL +]; + +exports.toLevel = toLevel; diff --git a/lib/log4js.js b/lib/log4js.js index 629aed51..237e6818 100644 --- a/lib/log4js.js +++ b/lib/log4js.js @@ -20,18 +20,21 @@ *

Example:

* 
  *  var logging = require('log4js');
- *  //add an appender that logs all messages to stdout.
- *  logging.addAppender(logging.consoleAppender());
- *  //add an appender that logs "some-category" to a file
- *  logging.addAppender(logging.fileAppender("file.log"), "some-category");
+ *  logging.configure({
+ *    appenders: {
+ *      "errorFile": { type: "file", filename: "error.log" }
+ *    },
+ *    categories: {
+ *      "default": { level: "ERROR", appenders: [ "errorFile" ] }
+ *    }
+ *  });
  *  //get a logger
  *  var log = logging.getLogger("some-category");
- *  log.setLevel(logging.levels.TRACE); //set the Level
  *
  *  ...
  *
  *  //call the log
- *  log.trace("trace me" );
+ *  log.error("oh noes");
  *
* * NOTE: the authors below are the original browser-based log4js authors @@ -43,462 +46,239 @@ * @static * Website: http://log4js.berlios.de */ -var events = require('events') +var debug = require('debug')('log4js:core') , fs = require('fs') -, path = require('path') +, cluster = require('cluster') , util = require('util') , layouts = require('./layouts') , levels = require('./levels') -, loggerModule = require('./logger') -, LoggingEvent = loggerModule.LoggingEvent -, Logger = loggerModule.Logger -, ALL_CATEGORIES = '[all]' +, Logger = require('./logger') , appenders = {} -, loggers = {} +, categories = {} , appenderMakers = {} -, appenderShutdowns = {} , defaultConfig = { - appenders: [ - { type: "console" } - ], - replaceConsole: false -}; - -require('./appenders/console'); - -function hasLogger(logger) { - return loggers.hasOwnProperty(logger); -} - -levels.forName = function(levelStr, levelVal) { - var level; - if (typeof levelStr === "string" && typeof levelVal === "number") { - var levelUpper = levelStr.toUpperCase(); - level = new levels.Level(levelVal, levelUpper); - loggerModule.addLevelMethods(level); - } - return level; -}; - -levels.getLevel = function(levelStr) { - var level; - if (typeof levelStr === "string") { - var levelUpper = levelStr.toUpperCase(); - level = levels.toLevel(levelStr); + appenders: { + console: { type: "console" } + }, + categories: { + default: { level: levels.DEBUG, appenders: [ "console" ] } } - return level; }; -function getBufferedLogger(categoryName) { - var base_logger = getLogger(categoryName); - var logger = {}; - logger.temp = []; - logger.target = base_logger; - logger.flush = function () { - for (var i = 0; i < logger.temp.length; i++) { - var log = logger.temp[i]; - logger.target[log.level](log.message); - delete logger.temp[i]; - } - }; - logger.trace = function (message) { logger.temp.push({level: 'trace', message: message}); }; - logger.debug = function (message) { logger.temp.push({level: 'debug', message: message}); }; - logger.info = function (message) { logger.temp.push({level: 'info', message: message}); }; - logger.warn = function (message) { logger.temp.push({level: 'warn', message: message}); }; - logger.error = function (message) { logger.temp.push({level: 'error', message: message}); }; - logger.fatal = function (message) { logger.temp.push({level: 'fatal', message: message}); }; - - return logger; -} - -function normalizeCategory (category) { - return category + '.'; +function serialise(event) { + return JSON.stringify(event); } -function doesLevelEntryContainsLogger (levelCategory, loggerCategory) { - var normalizedLevelCategory = normalizeCategory(levelCategory); - var normalizedLoggerCategory = normalizeCategory(loggerCategory); - return normalizedLoggerCategory.substring(0, normalizedLevelCategory.length) == normalizedLevelCategory; //jshint ignore:line -} +function deserialise(serialised) { + var event; + try { + event = JSON.parse(serialised); + event.startTime = new Date(event.startTime); + event.level = levels.toLevel(event.level.levelStr); + } catch(e) { + event = { + startTime: new Date(), + category: 'log4js', + level: levels.ERROR, + data: [ 'Unable to parse log:', serialised ] + }; + } -function doesAppenderContainsLogger (appenderCategory, loggerCategory) { - var normalizedAppenderCategory = normalizeCategory(appenderCategory); - var normalizedLoggerCategory = normalizeCategory(loggerCategory); - return normalizedLoggerCategory.substring(0, normalizedAppenderCategory.length) == normalizedAppenderCategory; //jshint ignore:line + return event; } +//in a multi-process node environment, worker loggers will use +//process.send +cluster.on('fork', function(worker) { + debug('listening to worker: ', worker); + worker.on('message', function(message) { + if (message.type && message.type === '::log4js-message') { + debug("received message: ", message.event); + dispatch(deserialise(message.event)); + } + }); +}); /** - * Get a logger instance. Instance is cached on categoryName level. - * @param {String} categoryName name of category to log to. + * Get a logger instance. + * @param {String} category to log to. * @return {Logger} instance of logger for the category * @static */ -function getLogger (loggerCategoryName) { +function getLogger (category) { + debug("getLogger(", category, ")"); - // Use default logger if categoryName is not specified or invalid - if (typeof loggerCategoryName !== "string") { - loggerCategoryName = Logger.DEFAULT_CATEGORY; - } - - if (!hasLogger(loggerCategoryName)) { - - var level; - - /* jshint -W073 */ - // If there's a "levels" entry in the configuration - if (levels.config) { - // Goes through the categories in the levels configuration entry, - // starting with the "higher" ones. - var keys = Object.keys(levels.config).sort(); - for (var idx = 0; idx < keys.length; idx++) { - var levelCategory = keys[idx]; - if (doesLevelEntryContainsLogger(levelCategory, loggerCategoryName)) { - // level for the logger - level = levels.config[levelCategory]; - } - } - } - /* jshint +W073 */ - - // Create the logger for this name if it doesn't already exist - loggers[loggerCategoryName] = new Logger(loggerCategoryName, level); - - /* jshint -W083 */ - var appenderList; - for(var appenderCategory in appenders) { - if (doesAppenderContainsLogger(appenderCategory, loggerCategoryName)) { - appenderList = appenders[appenderCategory]; - appenderList.forEach(function(appender) { - loggers[loggerCategoryName].addListener("log", appender); - }); - } - } - /* jshint +W083 */ + return new Logger( + cluster.isMaster ? dispatch : workerDispatch, + category || 'default' + ); +} - if (appenders[ALL_CATEGORIES]) { - appenderList = appenders[ALL_CATEGORIES]; - appenderList.forEach(function(appender) { - loggers[loggerCategoryName].addListener("log", appender); - }); - } - } - - return loggers[loggerCategoryName]; +function workerDispatch(event) { + process.send({ type: "::log4js-message", event: serialise(event) }); } /** - * args are appender, then zero or more categories + * Log event routing to appenders + * This would be a good place to implement category hierarchies/wildcards, etc */ -function addAppender () { - var args = Array.prototype.slice.call(arguments); - var appender = args.shift(); - if (args.length === 0 || args[0] === undefined) { - args = [ ALL_CATEGORIES ]; - } - //argument may already be an array - if (Array.isArray(args[0])) { - args = args[0]; +function dispatch(event) { + debug("event is ", event); + var category = categories[event.category] || categories.default; + debug( + "category.level[", + category.level, + "] <= ", + event.level, + " ? ", + category.level.isLessThanOrEqualTo(event.level) + ); + + if (category.level.isLessThanOrEqualTo(event.level)) { + category.appenders.forEach(function(appender) { + appenders[appender](event); + }); } - - args.forEach(function(appenderCategory) { - addAppenderToCategory(appender, appenderCategory); - - if (appenderCategory === ALL_CATEGORIES) { - addAppenderToAllLoggers(appender); - } else { - - for(var loggerCategory in loggers) { - if (doesAppenderContainsLogger(appenderCategory,loggerCategory)) { - loggers[loggerCategory].addListener("log", appender); - } - } - - } - }); } -function addAppenderToAllLoggers(appender) { - for (var logger in loggers) { - if (hasLogger(logger)) { - loggers[logger].addListener("log", appender); - } - } +function load(file) { + debug("loading ", file); + var contents = fs.readFileSync(file, "utf-8"); + debug("file contents ", contents); + return JSON.parse(contents); } -function addAppenderToCategory(appender, category) { - if (!appenders[category]) { - appenders[category] = []; - } - appenders[category].push(appender); -} +function configure(configurationFileOrObject) { + debug("configure(", configurationFileOrObject, ")"); + debug("process.env.LOG4JS_CONFIG = ", process.env.LOG4JS_CONFIG); -function clearAppenders () { - appenders = {}; - for (var logger in loggers) { - if (hasLogger(logger)) { - loggers[logger].removeAllListeners("log"); - } - } -} + var config = validateAndParse(configurationFileOrObject); -function configureAppenders(appenderList, options) { - clearAppenders(); - if (appenderList) { - appenderList.forEach(function(appenderConfig) { - loadAppender(appenderConfig.type); - var appender; - appenderConfig.makers = appenderMakers; - try { - appender = appenderMakers[appenderConfig.type](appenderConfig, options); - addAppender(appender, appenderConfig.category); - } catch(e) { - throw new Error("log4js configuration problem for " + util.inspect(appenderConfig), e); - } - }); - } -} + debug("config = ", config); -function configureLevels(_levels) { - levels.config = _levels; // Keep it so we can create loggers later using this cfg - if (_levels) { - var keys = Object.keys(levels.config).sort(); - for (var idx in keys) { - var category = keys[idx]; - if(category === ALL_CATEGORIES) { - setGlobalLogLevel(_levels[category]); - } - /* jshint -W073 */ - for(var loggerCategory in loggers) { - if (doesLevelEntryContainsLogger(category, loggerCategory)) { - loggers[loggerCategory].setLevel(_levels[category]); - } - } - /* jshint +W073 */ - } - } -} + configureAppenders(config.appenders); + validateCategories(config.categories); + categories = config.categories; -function setGlobalLogLevel(level) { - Logger.prototype.level = levels.toLevel(level, levels.TRACE); } -/** - * Get the default logger instance. - * @return {Logger} instance of default logger - * @static - */ -function getDefaultLogger () { - return getLogger(Logger.DEFAULT_CATEGORY); -} +function validateAndParse(configurationFileOrObject) { + var filename, config = process.env.LOG4JS_CONFIG || configurationFileOrObject; -var configState = {}; + checkThatConfigIsStringOrObject(config); -function loadConfigurationFile(filename) { - if (filename) { - return JSON.parse(fs.readFileSync(filename, "utf8")); - } - return undefined; -} + if (typeof config === 'string') { + debug("config is string"); + filename = config; + config = load(filename); + } -function configureOnceOff(config, options) { - if (config) { - try { - configureLevels(config.levels); - configureAppenders(config.appenders, options); - - if (config.replaceConsole) { - replaceConsole(); - } else { - restoreConsole(); - } - } catch (e) { - throw new Error( - "Problem reading log4js config " + util.inspect(config) + - ". Error was \"" + e.message + "\" (" + e.stack + ")" - ); + if (!config.appenders || !Object.keys(config.appenders).length) { + throw new Error("You must specify at least one appender."); } - } -} -function reloadConfiguration(options) { - var mtime = getMTime(configState.filename); - if (!mtime) return; - - if (configState.lastMTime && (mtime.getTime() > configState.lastMTime.getTime())) { - configureOnceOff(loadConfigurationFile(configState.filename), options); - } - configState.lastMTime = mtime; + return config; } -function getMTime(filename) { - var mtime; - try { - mtime = fs.statSync(configState.filename).mtime; - } catch (e) { - getLogger('log4js').warn('Failed to load configuration file ' + filename); +function checkThatConfigIsStringOrObject(config) { + if (!config || !(typeof config === 'string' || typeof config === 'object')) { + throw new Error("You must specify configuration as an object or a filename."); } - return mtime; } -function initReloadConfiguration(filename, options) { - if (configState.timerId) { - clearInterval(configState.timerId); - delete configState.timerId; +function validateCategories(cats) { + if (!cats || !cats.default) { + throw new Error("You must specify an appender for the default category"); } - configState.filename = filename; - configState.lastMTime = getMTime(filename); - configState.timerId = setInterval(reloadConfiguration, options.reloadSecs*1000, options); -} -function configure(configurationFileOrObject, options) { - var config = configurationFileOrObject; - config = config || process.env.LOG4JS_CONFIG; - options = options || {}; - - if (config === undefined || config === null || typeof(config) === 'string') { - if (options.reloadSecs) { - initReloadConfiguration(config, options); + Object.keys(cats).forEach(function(categoryName) { + var category = cats[categoryName], inputLevel = category.level; + if (!category.level) { + throw new Error("You must specify a level for category '" + categoryName + "'."); } - config = loadConfigurationFile(config) || defaultConfig; - } else { - if (options.reloadSecs) { - getLogger('log4js').warn( - 'Ignoring configuration reload parameter for "object" configuration.' + category.level = levels.toLevel(inputLevel); + if (!category.level) { + throw new Error( + "Level '" + inputLevel + + "' is not valid for category '" + categoryName + + "'. Acceptable values are: " + levels.levels.join(', ') + "." ); } - } - configureOnceOff(config, options); -} -var originalConsoleFunctions = { - log: console.log, - debug: console.debug, - info: console.info, - warn: console.warn, - error: console.error -}; + if (!category.appenders || !category.appenders.length) { + throw new Error("You must specify an appender for category '" + categoryName + "'."); + } -function replaceConsole(logger) { - function replaceWith(fn) { - return function() { - fn.apply(logger, arguments); - }; - } - logger = logger || getLogger("console"); - ['log','debug','info','warn','error'].forEach(function (item) { - console[item] = replaceWith(item === 'log' ? logger.info : logger[item]); + category.appenders.forEach(function(appender) { + if (!appenders[appender]) { + throw new Error( + "Appender '" + appender + + "' for category '" + categoryName + + "' does not exist. Known appenders are: " + Object.keys(appenders).join(', ') + "." + ); + } + }); }); } -function restoreConsole() { - ['log', 'debug', 'info', 'warn', 'error'].forEach(function (item) { - console[item] = originalConsoleFunctions[item]; - }); +function clearAppenders () { + debug("clearing appenders and appender makers"); + appenders = {}; + appenderMakers = {}; } -/** - * Load an appenderModule based on the provided appender filepath. Will first - * check if the appender path is a subpath of the log4js "lib/appenders" directory. - * If not, it will attempt to load the the appender as complete path. - * - * @param {string} appender The filepath for the appender. - * @returns {Object|null} The required appender or null if appender could not be loaded. - * @private - */ -function requireAppender(appender) { - var appenderModule; - try { - appenderModule = require('./appenders/' + appender); - } catch (e) { - appenderModule = require(appender); +function appenderByName(name) { + if (appenders.hasOwnProperty(name)) { + return appenders[name]; + } else { + throw new Error("Appender '" + name + "' not found."); } - return appenderModule; } -/** - * Load an appender. Provided the appender path to be loaded. If appenderModule is defined, - * it will be used in place of requiring the appender module. - * - * @param {string} appender The path to the appender module. - * @param {Object|void} [appenderModule] The pre-required appender module. When provided, - * instead of requiring the appender by its path, this object will be used. - * @returns {void} - * @private - */ -function loadAppender(appender, appenderModule) { - appenderModule = appenderModule || requireAppender(appender); - - if (!appenderModule) { - throw new Error("Invalid log4js appender: " + util.inspect(appender)); - } - - module.exports.appenders[appender] = appenderModule.appender.bind(appenderModule); - if (appenderModule.shutdown) { - appenderShutdowns[appender] = appenderModule.shutdown.bind(appenderModule); - } - appenderMakers[appender] = appenderModule.configure.bind(appenderModule); +function configureAppenders(appenderMap) { + clearAppenders(); + Object.keys(appenderMap).forEach(function(appenderName) { + var appender, appenderConfig = appenderMap[appenderName]; + loadAppender(appenderConfig.type); + try { + appenders[appenderName] = appenderMakers[appenderConfig.type]( + appenderConfig, + appenderByName + ); + } catch(e) { + throw new Error( + "log4js configuration problem for appender '" + appenderName + + "'. Error was " + e.stack + ); + } + }); } -/** - * Shutdown all log appenders. This will first disable all writing to appenders - * and then call the shutdown function each appender. - * - * @params {Function} cb - The callback to be invoked once all appenders have - * shutdown. If an error occurs, the callback will be given the error object - * as the first argument. - * @returns {void} - */ -function shutdown(cb) { - // First, disable all writing to appenders. This prevents appenders from - // not being able to be drained because of run-away log writes. - loggerModule.disableAllLogWrites(); - - // Call each of the shutdown functions in parallel - var completed = 0; - var error; - var shutdownFcts = []; - var complete = function(err) { - error = error || err; - completed++; - if (completed >= shutdownFcts.length) { - cb(error); - } - }; - for (var category in appenderShutdowns) { - if (appenderShutdowns.hasOwnProperty(category)) { - shutdownFcts.push(appenderShutdowns[category]); +function loadAppender(appender) { + var appenderModule; + + if (!appenderMakers[appender]) { + debug("Loading appender ", appender); + try { + appenderModule = require('./appenders/' + appender); + } catch (e) { + try { + debug("Appender ", appender, " is not a core log4js appender."); + appenderModule = require(appender); + } catch (err) { + debug("Error loading appender %s: ", appender, err); + throw new Error("Could not load appender of type '" + appender + "'."); + } } + appenderMakers[appender] = appenderModule(layouts, levels); } - if (!shutdownFcts.length) { - return cb(); - } - shutdownFcts.forEach(function(shutdownFct) { shutdownFct(complete); }); } module.exports = { - getBufferedLogger: getBufferedLogger, getLogger: getLogger, - getDefaultLogger: getDefaultLogger, - hasLogger: hasLogger, - - addAppender: addAppender, - loadAppender: loadAppender, - clearAppenders: clearAppenders, - configure: configure, - shutdown: shutdown, - - replaceConsole: replaceConsole, - restoreConsole: restoreConsole, - - levels: levels, - setGlobalLogLevel: setGlobalLogLevel, - - layouts: layouts, - appenders: {}, - appenderMakers: appenderMakers, - connectLogger: require('./connect-logger').connectLogger + configure: configure }; //set ourselves up -configure(); +debug("Starting configuration"); +configure(defaultConfig); diff --git a/lib/log4js.json b/lib/log4js.json deleted file mode 100644 index 7b6d3e7d..00000000 --- a/lib/log4js.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "appenders": [ - { - "type": "console" - } - ] -} \ No newline at end of file diff --git a/lib/logger.js b/lib/logger.js index 984bd384..6c138d8b 100644 --- a/lib/logger.js +++ b/lib/logger.js @@ -1,123 +1,49 @@ "use strict"; -var levels = require('./levels') -, util = require('util') -, events = require('events') -, DEFAULT_CATEGORY = '[default]'; +var debug = require('debug')('log4js:logger') +, levels = require('./levels'); -var logWritesEnabled = true; - -/** - * Models a logging event. - * @constructor - * @param {String} categoryName name of category - * @param {Log4js.Level} level level of message - * @param {Array} data objects to log - * @param {Log4js.Logger} logger the associated logger - * @author Seth Chisamore - */ -function LoggingEvent (categoryName, level, data, logger) { - this.startTime = new Date(); - this.categoryName = categoryName; - this.data = data; - this.level = level; - this.logger = logger; -} - -/** - * Logger to log messages. - * use {@see Log4js#getLogger(String)} to get an instance. - * @constructor - * @param name name of category to log to - * @author Stephan Strittmatter - */ -function Logger (name, level) { - this.category = name || DEFAULT_CATEGORY; - - if (level) { - this.setLevel(level); +module.exports = function Logger(dispatch, category) { + if (typeof dispatch !== 'function') { + throw new Error("Logger must have a dispatch delegate."); } -} -util.inherits(Logger, events.EventEmitter); -Logger.DEFAULT_CATEGORY = DEFAULT_CATEGORY; -Logger.prototype.level = levels.TRACE; - -Logger.prototype.setLevel = function(level) { - this.level = levels.toLevel(level, this.level || levels.TRACE); -}; - -Logger.prototype.removeLevel = function() { - delete this.level; -}; -Logger.prototype.log = function() { - var logLevel = levels.toLevel(arguments[0], levels.INFO); - if (!this.isLevelEnabled(logLevel)) { - return; - } - var numArgs = arguments.length - 1; - var args = new Array(numArgs); - for (var i = 0; i < numArgs; i++) { - args[i] = arguments[i + 1]; + if (!category) { + throw new Error("Logger must have a category."); } - this._log(logLevel, args); -}; - -Logger.prototype.isLevelEnabled = function(otherLevel) { - return this.level.isLessThanOrEqualTo(otherLevel); -}; -['Trace','Debug','Info','Warn','Error','Fatal', 'Mark'].forEach( - function(levelString) { - addLevelMethods(levelString); + function log() { + var args = Array.prototype.slice.call(arguments) + , logLevel = args.shift() + , loggingEvent = new LoggingEvent(category, logLevel, args); + debug("Logging event ", loggingEvent, " to dispatch = ", dispatch); + dispatch(loggingEvent); } -); -function addLevelMethods(level) { - level = levels.toLevel(level); - - var levelStrLower = level.toString().toLowerCase(); - var levelMethod = levelStrLower.replace(/_([a-z])/g, function(g) { return g[1].toUpperCase(); } ); - var isLevelMethod = levelMethod[0].toUpperCase() + levelMethod.slice(1); - - Logger.prototype['is'+isLevelMethod+'Enabled'] = function() { - return this.isLevelEnabled(level.toString()); - }; - - Logger.prototype[levelMethod] = function () { - if (logWritesEnabled && this.isLevelEnabled(level)) { - var numArgs = arguments.length; - var args = new Array(numArgs); - for (var i = 0; i < numArgs; i++) { - args[i] = arguments[i]; - } - this._log(level, args); + var self = this; + ['trace','debug','info','warn','error','fatal'].forEach( + function(level) { + self[level] = function() { + var args = Array.prototype.slice.call(arguments); + args.unshift(level); + log.apply(this, args); + }; } - }; -} + ); -Logger.prototype._log = function(level, data) { - var loggingEvent = new LoggingEvent(this.category, level, data, this); - this.emit('log', loggingEvent); }; /** - * Disable all log writes. - * @returns {void} - */ -function disableAllLogWrites() { - logWritesEnabled = false; -} - -/** - * Enable log writes. - * @returns {void} + * Models a logging event. + * @constructor + * @param {String} category name of category + * @param {Log4js.Level} level level of message + * @param {Array} data objects to log + * @author Seth Chisamore */ -function enableAllLogWrites() { - logWritesEnabled = true; +function LoggingEvent (category, level, data) { + this.startTime = new Date(); + this.category = category; + this.data = data; + this.level = levels.toLevel(level); } -exports.LoggingEvent = LoggingEvent; -exports.Logger = Logger; -exports.disableAllLogWrites = disableAllLogWrites; -exports.enableAllLogWrites = enableAllLogWrites; -exports.addLevelMethods = addLevelMethods; \ No newline at end of file diff --git a/lib/streams/BaseRollingFileStream.js b/lib/streams/BaseRollingFileStream.js deleted file mode 100644 index 9c441ad9..00000000 --- a/lib/streams/BaseRollingFileStream.js +++ /dev/null @@ -1,94 +0,0 @@ -"use strict"; -var fs = require('fs') -, stream -, debug = require('../debug')('BaseRollingFileStream') -, util = require('util') -, semver = require('semver'); - -if (semver.satisfies(process.version, '>=0.10.0')) { - stream = require('stream'); -} else { - stream = require('readable-stream'); -} - -module.exports = BaseRollingFileStream; - -function BaseRollingFileStream(filename, options) { - debug("In BaseRollingFileStream"); - this.filename = filename; - this.options = options || {}; - this.options.encoding = this.options.encoding || 'utf8'; - this.options.mode = this.options.mode || parseInt('0644', 8); - this.options.flags = this.options.flags || 'a'; - - this.currentSize = 0; - - function currentFileSize(file) { - var fileSize = 0; - try { - fileSize = fs.statSync(file).size; - } catch (e) { - // file does not exist - } - return fileSize; - } - - function throwErrorIfArgumentsAreNotValid() { - if (!filename) { - throw new Error("You must specify a filename"); - } - } - - throwErrorIfArgumentsAreNotValid(); - debug("Calling BaseRollingFileStream.super"); - BaseRollingFileStream.super_.call(this); - this.openTheStream(); - this.currentSize = currentFileSize(this.filename); -} -util.inherits(BaseRollingFileStream, stream.Writable); - -BaseRollingFileStream.prototype._write = function(chunk, encoding, callback) { - var that = this; - function writeTheChunk() { - debug("writing the chunk to the underlying stream"); - that.currentSize += chunk.length; - try { - that.theStream.write(chunk, encoding, callback); - } - catch (err){ - debug(err); - callback(); - } - } - - debug("in _write"); - - if (this.shouldRoll()) { - this.currentSize = 0; - this.roll(this.filename, writeTheChunk); - } else { - writeTheChunk(); - } -}; - -BaseRollingFileStream.prototype.openTheStream = function(cb) { - debug("opening the underlying stream"); - this.theStream = fs.createWriteStream(this.filename, this.options); - if (cb) { - this.theStream.on("open", cb); - } -}; - -BaseRollingFileStream.prototype.closeTheStream = function(cb) { - debug("closing the underlying stream"); - this.theStream.end(cb); -}; - -BaseRollingFileStream.prototype.shouldRoll = function() { - return false; // default behaviour is never to roll -}; - -BaseRollingFileStream.prototype.roll = function(filename, callback) { - callback(); // default behaviour is not to do anything -}; - diff --git a/lib/streams/DateRollingFileStream.js b/lib/streams/DateRollingFileStream.js deleted file mode 100644 index 5ef2081f..00000000 --- a/lib/streams/DateRollingFileStream.js +++ /dev/null @@ -1,91 +0,0 @@ -"use strict"; -var BaseRollingFileStream = require('./BaseRollingFileStream') -, debug = require('../debug')('DateRollingFileStream') -, format = require('../date_format') -, fs = require('fs') -, util = require('util'); - -module.exports = DateRollingFileStream; - -function findTimestampFromFileIfExists(filename, now) { - return fs.existsSync(filename) ? fs.statSync(filename).mtime : new Date(now()); -} - -function DateRollingFileStream(filename, pattern, options, now) { - debug("Now is " + now); - if (pattern && typeof(pattern) === 'object') { - now = options; - options = pattern; - pattern = null; - } - this.pattern = pattern || '.yyyy-MM-dd'; - this.now = now || Date.now; - this.lastTimeWeWroteSomething = format.asString( - this.pattern, - findTimestampFromFileIfExists(filename, this.now) - ); - - this.baseFilename = filename; - this.alwaysIncludePattern = false; - - if (options) { - if (options.alwaysIncludePattern) { - this.alwaysIncludePattern = true; - filename = this.baseFilename + this.lastTimeWeWroteSomething; - } - delete options.alwaysIncludePattern; - if (Object.keys(options).length === 0) { - options = null; - } - } - debug("this.now is " + this.now + ", now is " + now); - - DateRollingFileStream.super_.call(this, filename, options); -} -util.inherits(DateRollingFileStream, BaseRollingFileStream); - -DateRollingFileStream.prototype.shouldRoll = function() { - var lastTime = this.lastTimeWeWroteSomething, - thisTime = format.asString(this.pattern, new Date(this.now())); - - debug("DateRollingFileStream.shouldRoll with now = " + - this.now() + ", thisTime = " + thisTime + ", lastTime = " + lastTime); - - this.lastTimeWeWroteSomething = thisTime; - this.previousTime = lastTime; - - return thisTime !== lastTime; -}; - -DateRollingFileStream.prototype.roll = function(filename, callback) { - var that = this; - - debug("Starting roll"); - - if (this.alwaysIncludePattern) { - this.filename = this.baseFilename + this.lastTimeWeWroteSomething; - this.closeTheStream(this.openTheStream.bind(this, callback)); - } else { - var newFilename = this.baseFilename + this.previousTime; - this.closeTheStream( - deleteAnyExistingFile.bind(null, - renameTheCurrentFile.bind(null, - this.openTheStream.bind(this, - callback)))); - } - - function deleteAnyExistingFile(cb) { - //on windows, you can get a EEXIST error if you rename a file to an existing file - //so, we'll try to delete the file we're renaming to first - fs.unlink(newFilename, function (err) { - //ignore err: if we could not delete, it's most likely that it doesn't exist - cb(); - }); - } - - function renameTheCurrentFile(cb) { - debug("Renaming the " + filename + " -> " + newFilename); - fs.rename(filename, newFilename, cb); - } - -}; diff --git a/lib/streams/RollingFileStream.js b/lib/streams/RollingFileStream.js deleted file mode 100644 index af1e52e2..00000000 --- a/lib/streams/RollingFileStream.js +++ /dev/null @@ -1,117 +0,0 @@ -"use strict"; -var BaseRollingFileStream = require('./BaseRollingFileStream') -, debug = require('../debug')('RollingFileStream') -, util = require('util') -, path = require('path') -, child_process = require('child_process') -, zlib = require("zlib") -, fs = require('fs'); - -module.exports = RollingFileStream; - -function RollingFileStream (filename, size, backups, options) { - this.size = size; - this.backups = backups || 1; - - function throwErrorIfArgumentsAreNotValid() { - if (!filename || !size || size <= 0) { - throw new Error("You must specify a filename and file size"); - } - } - - throwErrorIfArgumentsAreNotValid(); - - RollingFileStream.super_.call(this, filename, options); -} -util.inherits(RollingFileStream, BaseRollingFileStream); - -RollingFileStream.prototype.shouldRoll = function() { - debug("should roll with current size " + this.currentSize + " and max size " + this.size); - return this.currentSize >= this.size; -}; - -RollingFileStream.prototype.roll = function(filename, callback) { - var that = this, - nameMatcher = new RegExp('^' + path.basename(filename)); - - function justTheseFiles (item) { - return nameMatcher.test(item); - } - - function index(filename_) { - debug('Calculating index of '+filename_); - return parseInt(filename_.substring((path.basename(filename) + '.').length), 10) || 0; - } - - function byIndex(a, b) { - if (index(a) > index(b)) { - return 1; - } else if (index(a) < index(b) ) { - return -1; - } else { - return 0; - } - } - - function compress (filename, cb) { - - var gzip = zlib.createGzip(); - var inp = fs.createReadStream(filename); - var out = fs.createWriteStream(filename+".gz"); - inp.pipe(gzip).pipe(out); - fs.unlink(filename, cb); - - } - - function increaseFileIndex (fileToRename, cb) { - var idx = index(fileToRename); - debug('Index of ' + fileToRename + ' is ' + idx); - if (idx < that.backups) { - - var ext = path.extname(fileToRename); - var destination = filename + '.' + (idx+1); - if (that.options.compress && /^gz$/.test(ext.substring(1))) { - destination+=ext; - } - //on windows, you can get a EEXIST error if you rename a file to an existing file - //so, we'll try to delete the file we're renaming to first - fs.unlink(destination, function (err) { - //ignore err: if we could not delete, it's most likely that it doesn't exist - debug('Renaming ' + fileToRename + ' -> ' + destination); - fs.rename(path.join(path.dirname(filename), fileToRename), destination, function(err) { - if (err) { - cb(err); - } else { - if (that.options.compress && ext!=".gz") { - compress(destination, cb); - } else { - cb(); - } - } - }); - }); - } else { - cb(); - } - } - - function renameTheFiles(cb) { - //roll the backups (rename file.n to file.n+1, where n <= numBackups) - debug("Renaming the old files"); - fs.readdir(path.dirname(filename), function (err, files) { - var filesToProcess = files.filter(justTheseFiles).sort(byIndex); - (function processOne(err) { - var file = filesToProcess.pop(); - if (!file || err) { return cb(err); } - increaseFileIndex(file, processOne); - })(); - }); - } - - debug("Rolling, rolling, rolling"); - this.closeTheStream( - renameTheFiles.bind(null, - this.openTheStream.bind(this, - callback))); - -}; diff --git a/lib/streams/index.js b/lib/streams/index.js deleted file mode 100644 index d8e026dc..00000000 --- a/lib/streams/index.js +++ /dev/null @@ -1,3 +0,0 @@ -"use strict"; -exports.RollingFileStream = require('./RollingFileStream'); -exports.DateRollingFileStream = require('./DateRollingFileStream'); diff --git a/package.json b/package.json index 202a9b82..48992875 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "log4js", - "version": "0.6.38", + "version": "0.7.0", "description": "Port of Log4js to work with node.", "keywords": [ "logging", @@ -23,20 +23,23 @@ }, "scripts": { "pretest": "jshint lib/ test/", - "test": "vows" + "test": "mocha --recursive" }, "directories": { "test": "test", "lib": "lib" }, "dependencies": { - "readable-stream": "~1.0.2", - "semver": "~4.3.3" + "debug": "~0.7.2", + "streamroller": "0.0.1", + "date-format": "0.0.0" }, "devDependencies": { + "async": "0.1.15", "jshint": "^2.9.2", "sandboxed-module": "0.1.3", - "vows": "0.7.0" + "mocha": "~1.12.0", + "should": "~1.2.2" }, "browser": { "os": false diff --git a/test/categoryFilter-test.js b/test/categoryFilter-test.js index 15a7b906..dcdc1112 100644 --- a/test/categoryFilter-test.js +++ b/test/categoryFilter-test.js @@ -1,84 +1,99 @@ 'use strict'; -var vows = require('vows') +var async = require('async') +, should = require('should') , fs = require('fs') -, assert = require('assert') -, EOL = require('os').EOL || '\n'; +, path = require('path') +, assert = require('assert'); -function remove(filename) { - try { - fs.unlinkSync(filename); - } catch (e) { - //doesn't really matter if it failed - } +function remove() { + var files = Array.prototype.slice.call(arguments); + return function(done) { + async.forEach( + files.map(function(file) { return path.join(__dirname, file); }), + fs.unlink.bind(fs), + function() { done(); } + ); + }; } -vows.describe('log4js categoryFilter').addBatch({ - 'appender': { - topic: function() { +describe('log4js', function() { - var log4js = require('../lib/log4js'), logEvents = [], webLogger, appLogger; - log4js.clearAppenders(); - var appender = require('../lib/appenders/categoryFilter') - .appender( - ['app'], - function(evt) { logEvents.push(evt); } - ); - log4js.addAppender(appender, ["app","web"]); + before( + remove( + 'test-category-filter-web.log', + 'test-category-filter-all.log' + ) + ); - webLogger = log4js.getLogger("web"); - appLogger = log4js.getLogger("app"); + after( + remove( + 'test-category-filter-web.log', + 'test-category-filter-all.log' + ) + ); + describe('category filtering', function() { + before(function() { + var log4js = require('../lib/log4js') + , webLogger = log4js.getLogger("web") + , appLogger = log4js.getLogger("app"); + + log4js.configure({ + appenders: { + rest: { + type: "file", + layout: { type: "messagePassThrough" }, + filename: path.join(__dirname, "test-category-filter-all.log") + }, + web: { + type: "file", + layout: { type: "messagePassThrough"}, + filename: path.join(__dirname, "test-category-filter-web.log") + } + }, + categories: { + "default": { level: "debug", appenders: [ "rest" ] }, + web: { level: "debug", appenders: [ "web" ] } + } + }); + webLogger.debug('This should get logged'); appLogger.debug('This should not'); webLogger.debug('Hello again'); log4js.getLogger('db').debug('This shouldn\'t be included by the appender anyway'); + }); - return logEvents; - }, - 'should only pass matching category' : function(logEvents) { - assert.equal(logEvents.length, 2); - assert.equal(logEvents[0].data[0], 'This should get logged'); - assert.equal(logEvents[1].data[0], 'Hello again'); - } - }, - - 'configure': { - topic: function() { - var log4js = require('../lib/log4js') - , logger, weblogger; - - remove(__dirname + '/categoryFilter-web.log'); - remove(__dirname + '/categoryFilter-noweb.log'); - - log4js.configure('test/with-categoryFilter.json'); - logger = log4js.getLogger("app"); - weblogger = log4js.getLogger("web"); + it('should only pass matching category', function(done) { + setTimeout(function() { + fs.readFile( + path.join(__dirname, 'test-category-filter-web.log'), + 'utf8', + function(err, contents) { + var lines = contents.trim().split('\n'); + lines.should.eql(["This should get logged", "Hello again"]); + done(err); + } + ); + }, 50); + }); + + it('should send everything else to default appender', function(done) { + setTimeout(function() { + fs.readFile( + path.join(__dirname, 'test-category-filter-all.log'), + 'utf8', + function(err, contents) { + var lines = contents.trim().split('\n'); + lines.should.eql([ + "This should not", + "This shouldn't be included by the appender anyway" + ]); + done(err); + } + ); + }, 50); + }); - logger.info('Loading app'); - logger.debug('Initialising indexes'); - weblogger.info('00:00:00 GET / 200'); - weblogger.warn('00:00:00 GET / 500'); - //wait for the file system to catch up - setTimeout(this.callback, 500); - }, - 'tmp-tests.log': { - topic: function() { - fs.readFile(__dirname + '/categoryFilter-noweb.log', 'utf8', this.callback); - }, - 'should contain all log messages': function(contents) { - var messages = contents.trim().split(EOL); - assert.deepEqual(messages, ['Loading app','Initialising indexes']); - } - }, - 'tmp-tests-web.log': { - topic: function() { - fs.readFile(__dirname + '/categoryFilter-web.log','utf8',this.callback); - }, - 'should contain only error and warning log messages': function(contents) { - var messages = contents.trim().split(EOL); - assert.deepEqual(messages, ['00:00:00 GET / 200','00:00:00 GET / 500']); - } - } - } -}).export(module); + }); +}); diff --git a/test/clusteredAppender-test.js b/test/clusteredAppender-test.js index 76cb37a8..46e4d626 100755 --- a/test/clusteredAppender-test.js +++ b/test/clusteredAppender-test.js @@ -1,166 +1,147 @@ "use strict"; -var assert = require('assert'); -var vows = require('vows'); -var layouts = require('../lib/layouts'); -var sandbox = require('sandboxed-module'); -var LoggingEvent = require('../lib/logger').LoggingEvent; -var cluster = require('cluster'); - -vows.describe('log4js cluster appender').addBatch({ - 'when in master mode': { - topic: function() { - - var registeredClusterEvents = []; - var loggingEvents = []; - var onChildProcessForked; - var onMasterReceiveChildMessage; - - // Fake cluster module, so no real cluster listeners be really added - var fakeCluster = { - - on: function(event, callback) { - registeredClusterEvents.push(event); - onChildProcessForked = callback; - }, - - isMaster: true, - isWorker: false, - - }; - var fakeWorker = { - on: function(event, callback) { - onMasterReceiveChildMessage = callback; - }, - process: { - pid: 123 - }, - id: 'workerid' - }; - - var fakeActualAppender = function(loggingEvent) { - loggingEvents.push(loggingEvent); - }; - - // Load appender and fake modules in it - var appenderModule = sandbox.require('../lib/appenders/clustered', { - requires: { - 'cluster': fakeCluster, - } - }); - - var masterAppender = appenderModule.appender({ - actualAppenders: [fakeActualAppender, fakeActualAppender, fakeActualAppender], - appenders: [{}, {category: "test"}, {category: "wovs"}] - }); - - // Actual test - log message using masterAppender - masterAppender(new LoggingEvent('wovs', 'Info', ['masterAppender test'])); - - // Simulate a 'fork' event to register the master's message handler on our fake worker. - onChildProcessForked(fakeWorker); - // Simulate a cluster message received by the masterAppender. - var simulatedLoggingEvent = new LoggingEvent( - 'wovs', - 'Error', - [ - 'message deserialization test', - {stack: 'my wrapped stack'} - ] - ); - onMasterReceiveChildMessage({ - type : '::log-message', - event : JSON.stringify(simulatedLoggingEvent) - }); - - var returnValue = { - registeredClusterEvents: registeredClusterEvents, - loggingEvents: loggingEvents, - }; - - return returnValue; - }, - - "should register 'fork' event listener on 'cluster'": function(topic) { - assert.equal(topic.registeredClusterEvents[0], 'fork'); - }, - - "should log using actual appender": function(topic) { - assert.equal(topic.loggingEvents.length, 4); - assert.equal(topic.loggingEvents[0].data[0], 'masterAppender test'); - assert.equal(topic.loggingEvents[1].data[0], 'masterAppender test'); - assert.equal(topic.loggingEvents[2].data[0], 'message deserialization test'); - assert.equal(topic.loggingEvents[2].data[1], 'my wrapped stack'); - assert.equal(topic.loggingEvents[3].data[0], 'message deserialization test'); - assert.equal(topic.loggingEvents[3].data[1], 'my wrapped stack'); - }, - - }, - - 'when in worker mode': { - - topic: function() { - - var registeredProcessEvents = []; - - // Fake cluster module, to fake we're inside a worker process - var fakeCluster = { - - isMaster: false, - isWorker: true, - - }; - - var fakeProcess = { - - send: function(data) { - registeredProcessEvents.push(data); - }, - - }; - - // Load appender and fake modules in it - var appenderModule = sandbox.require('../lib/appenders/clustered', { - requires: { - 'cluster': fakeCluster, - }, - globals: { - 'process': fakeProcess, - } - }); - - var workerAppender = appenderModule.appender(); - - // Actual test - log message using masterAppender - workerAppender(new LoggingEvent('wovs', 'Info', ['workerAppender test'])); - workerAppender(new LoggingEvent('wovs', 'Info', [new Error('Error test')])); - - var returnValue = { - registeredProcessEvents: registeredProcessEvents, - }; - - return returnValue; - - }, - - "worker appender should call process.send" : function(topic) { - assert.equal(topic.registeredProcessEvents[0].type, '::log-message'); - assert.equal( - JSON.parse(topic.registeredProcessEvents[0].event).data[0], - "workerAppender test" - ); - }, - - "worker should serialize an Error correctly" : function(topic) { - assert.equal(topic.registeredProcessEvents[1].type, '::log-message'); - assert(JSON.parse(topic.registeredProcessEvents[1].event).data[0].stack); - var actual = JSON.parse(topic.registeredProcessEvents[1].event).data[0].stack; - var expectedRegex = /^Error: Error test/; - assert( - actual.match(expectedRegex), - "Expected: \n\n " + actual + "\n\n to match " + expectedRegex - ); - } - - } - -}).exportTo(module); +var should = require('should') +, sandbox = require('sandboxed-module'); + + +describe('log4js in a cluster', function() { + describe('when in master mode', function() { + + var log4js + , clusterOnFork = false + , workerCb + , events = [] + , worker = { + on: function(evt, cb) { + evt.should.eql('message'); + this.cb = cb; + } + }; + + before(function() { + log4js = sandbox.require( + '../lib/log4js', + { + requires: { + 'cluster': { + isMaster: true, + on: function(evt, cb) { + evt.should.eql('fork'); + clusterOnFork = true; + cb(worker); + } + }, + './appenders/console': function() { + return function() { + return function(event) { + events.push(event); + }; + }; + } + } + } + ); + }); + + it('should listen for fork events', function() { + clusterOnFork.should.eql(true); + }); + + it('should listen for messages from workers', function() { + //workerCb was created in a different context to the test + //(thanks to sandbox.require), so doesn't pick up the should prototype + (typeof worker.cb).should.eql('function'); + }); + + it('should log valid ::log4js-message events', function() { + worker.cb({ + type: '::log4js-message', + event: JSON.stringify({ + startTime: '2010-10-10 18:54:06', + category: 'cheese', + level: { levelStr: 'DEBUG' }, + data: [ "blah" ] + }) + }); + events.should.have.length(1); + events[0].data[0].should.eql("blah"); + events[0].category.should.eql('cheese'); + //startTime was created in a different context to the test + //(thanks to sandbox.require), so instanceof doesn't think + //it's a Date. + events[0].startTime.constructor.name.should.eql('Date'); + events[0].level.toString().should.eql('DEBUG'); + }); + + it('should handle invalid ::log4js-message events', function() { + worker.cb({ + type: '::log4js-message', + event: "biscuits" + }); + worker.cb({ + type: '::log4js-message', + event: JSON.stringify({ + startTime: 'whatever' + }) + }); + + events.should.have.length(3); + events[1].data[0].should.eql('Unable to parse log:'); + events[1].data[1].should.eql('biscuits'); + events[1].category.should.eql('log4js'); + events[1].level.toString().should.eql('ERROR'); + + events[2].data[0].should.eql('Unable to parse log:'); + events[2].data[1].should.eql(JSON.stringify({ startTime: 'whatever'})); + + }); + + it('should ignore other events', function() { + worker.cb({ + type: "::blah-blah", + event: "blah" + }); + + events.should.have.length(3); + }); + + }); + + describe('when in worker mode', function() { + var log4js, events = []; + + before(function() { + log4js = sandbox.require( + '../lib/log4js', + { + requires: { + 'cluster': { + isMaster: false, + on: function() {} + } + }, + globals: { + 'process': { + 'send': function(event) { + events.push(event); + }, + 'env': { + } + } + } + } + ); + log4js.getLogger('test').debug("just testing"); + }); + + it('should emit ::log4js-message events', function() { + events.should.have.length(1); + events[0].type.should.eql('::log4js-message'); + events[0].event.should.be.a('string'); + + var evt = JSON.parse(events[0].event); + evt.category.should.eql('test'); + evt.level.levelStr.should.eql('DEBUG'); + evt.data[0].should.eql('just testing'); + }); + }); +}); diff --git a/test/configuration-test.js b/test/configuration-test.js deleted file mode 100644 index ddbf7dff..00000000 --- a/test/configuration-test.js +++ /dev/null @@ -1,149 +0,0 @@ -"use strict"; -var assert = require('assert') -, vows = require('vows') -, sandbox = require('sandboxed-module'); - -function makeTestAppender() { - return { - configure: function(config, options) { - this.configureCalled = true; - this.config = config; - this.options = options; - return this.appender(); - }, - appender: function() { - var self = this; - return function(logEvt) { self.logEvt = logEvt; }; - } - }; -} - -vows.describe('log4js configure').addBatch({ - 'appenders': { - 'when specified by type': { - topic: function() { - var testAppender = makeTestAppender(), - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/cheese': testAppender - } - } - ); - log4js.configure( - { - appenders: [ - { type: "cheese", flavour: "gouda" } - ] - }, - { pants: "yes" } - ); - return testAppender; - }, - 'should load appender': function(testAppender) { - assert.ok(testAppender.configureCalled); - }, - 'should pass config to appender': function(testAppender) { - assert.equal(testAppender.config.flavour, 'gouda'); - }, - 'should pass log4js options to appender': function(testAppender) { - assert.equal(testAppender.options.pants, 'yes'); - } - }, - 'when core appender loaded via loadAppender': { - topic: function() { - var testAppender = makeTestAppender(), - log4js = sandbox.require( - '../lib/log4js', - { requires: { './appenders/cheese': testAppender } } - ); - - log4js.loadAppender('cheese'); - return log4js; - }, - 'should load appender from ../lib/appenders': function(log4js) { - assert.ok(log4js.appenders.cheese); - }, - 'should add appender configure function to appenderMakers' : function(log4js) { - assert.isFunction(log4js.appenderMakers.cheese); - } - }, - 'when appender in node_modules loaded via loadAppender': { - topic: function() { - var testAppender = makeTestAppender(), - log4js = sandbox.require( - '../lib/log4js', - { requires: { 'some/other/external': testAppender } } - ); - log4js.loadAppender('some/other/external'); - return log4js; - }, - 'should load appender via require': function(log4js) { - assert.ok(log4js.appenders['some/other/external']); - }, - 'should add appender configure function to appenderMakers': function(log4js) { - assert.isFunction(log4js.appenderMakers['some/other/external']); - } - }, - 'when appender object loaded via loadAppender': { - topic: function() { - var testAppender = makeTestAppender(), - log4js = sandbox.require('../lib/log4js'); - - log4js.loadAppender('some/other/external', testAppender); - return log4js; - }, - 'should load appender with provided object': function(log4js) { - assert.ok(log4js.appenders['some/other/external']); - }, - 'should add appender configure function to appenderMakers': function(log4js) { - assert.isFunction(log4js.appenderMakers['some/other/external']); - } - }, - 'when configuration file loaded via LOG4JS_CONFIG environment variable': { - topic: function() { - process.env.LOG4JS_CONFIG = 'some/path/to/mylog4js.json'; - var fileRead = 0, - modulePath = 'some/path/to/mylog4js.json', - pathsChecked = [], - mtime = new Date(), - fakeFS = { - config: { appenders: [ { type: 'console', layout: { type: 'messagePassThrough' } } ], - levels: { 'a-test' : 'INFO' } }, - readdirSync: function(dir) { - return require('fs').readdirSync(dir); - }, - readFileSync: function (file, encoding) { - fileRead += 1; - assert.isString(file); - assert.equal(file, modulePath); - assert.equal(encoding, 'utf8'); - return JSON.stringify(fakeFS.config); - }, - statSync: function (path) { - pathsChecked.push(path); - if (path === modulePath) { - return { mtime: mtime }; - } else { - throw new Error("no such file"); - } - } - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - 'fs': fakeFS, - } - } - ); - delete process.env.LOG4JS_CONFIG; - return fileRead; - }, - 'should load the specified local configuration file' : function(fileRead) { - assert.equal(fileRead, 1); - } - } - } -}).exportTo(module); diff --git a/test/configureNoLevels-test.js b/test/configureNoLevels-test.js deleted file mode 100644 index 55bd987b..00000000 --- a/test/configureNoLevels-test.js +++ /dev/null @@ -1,173 +0,0 @@ -"use strict"; -// This test shows unexpected behaviour for log4js.configure() in log4js-node@0.4.3 and earlier: -// 1) log4js.configure(), log4js.configure(null), -// log4js.configure({}), log4js.configure() -// all set all loggers levels to trace, even if they were previously set to something else. -// 2) log4js.configure({levels:{}}), log4js.configure({levels: {foo: -// bar}}) leaves previously set logger levels intact. -// - -// Basic set up -var vows = require('vows'); -var assert = require('assert'); -var toLevel = require('../lib/levels').toLevel; - -// uncomment one or other of the following to see progress (or not) while running the tests -// var showProgress = console.log; -var showProgress = function() {}; - - -// Define the array of levels as string to iterate over. -var strLevels= ['Trace','Debug','Info','Warn','Error','Fatal']; - -// setup the configurations we want to test -var configs = { - 'nop': 'nop', // special case where the iterating vows generator will not call log4js.configure - 'is undefined': undefined, - 'is null': null, - 'is empty': {}, - 'has no levels': {foo: 'bar'}, - 'has null levels': {levels: null}, - 'has empty levels': {levels: {}}, - 'has random levels': {levels: {foo: 'bar'}}, - 'has some valid levels': {levels: {A: 'INFO'}} -}; - -// Set up the basic vows batches for this test -var batches = []; - - -function getLoggerName(level) { - return level+'-logger'; -} - -// the common vows top-level context, whether log4js.configure is called or not -// just making sure that the code is common, -// so that there are no spurious errors in the tests themselves. -function getTopLevelContext(nop, configToTest, name) { - return { - topic: function() { - var log4js = require('../lib/log4js'); - // create loggers for each level, - // keeping the level in the logger's name for traceability - strLevels.forEach(function(l) { - log4js.getLogger(getLoggerName(l)).setLevel(l); - }); - - if (!nop) { - showProgress('** Configuring log4js with', configToTest); - log4js.configure(configToTest); - } - else { - showProgress('** Not configuring log4js'); - } - return log4js; - } - }; -} - -showProgress('Populating batch object...'); - -function checkForMismatch(topic) { - var er = topic.log4js.levels.toLevel(topic.baseLevel) - .isLessThanOrEqualTo(topic.log4js.levels.toLevel(topic.comparisonLevel)); - - assert.equal( - er, - topic.expectedResult, - 'Mismatch: for setLevel(' + topic.baseLevel + - ') was expecting a comparison with ' + topic.comparisonLevel + - ' to be ' + topic.expectedResult - ); -} - -function checkExpectedResult(topic) { - var result = topic.log4js - .getLogger(getLoggerName(topic.baseLevel)) - .isLevelEnabled(topic.log4js.levels.toLevel(topic.comparisonLevel)); - - assert.equal( - result, - topic.expectedResult, - 'Failed: ' + getLoggerName(topic.baseLevel) + - '.isLevelEnabled( ' + topic.comparisonLevel + ' ) returned ' + result - ); -} - -function setupBaseLevelAndCompareToOtherLevels(baseLevel) { - var baseLevelSubContext = 'and checking the logger whose level was set to '+baseLevel ; - var subContext = { topic: baseLevel }; - batch[context][baseLevelSubContext] = subContext; - - // each logging level has strLevels sub-contexts, - // to exhaustively test all the combinations of - // setLevel(baseLevel) and isLevelEnabled(comparisonLevel) per config - strLevels.forEach(compareToOtherLevels(subContext)); -} - -function compareToOtherLevels(subContext) { - var baseLevel = subContext.topic; - - return function (comparisonLevel) { - var comparisonLevelSubContext = 'with isLevelEnabled('+comparisonLevel+')'; - - // calculate this independently of log4js, but we'll add a vow - // later on to check that we're not mismatched with log4js - var expectedResult = strLevels.indexOf(baseLevel) <= strLevels.indexOf(comparisonLevel); - - // the topic simply gathers all the parameters for the vow - // into an object, to simplify the vow's work. - subContext[comparisonLevelSubContext] = { - topic: function(baseLevel, log4js) { - return { - comparisonLevel: comparisonLevel, - baseLevel: baseLevel, - log4js: log4js, - expectedResult: expectedResult - }; - } - }; - - var vow = 'should return '+expectedResult; - subContext[comparisonLevelSubContext][vow] = checkExpectedResult; - - // the extra vow to check the comparison between baseLevel and - // comparisonLevel we performed earlier matches log4js' - // comparison too - var subSubContext = subContext[comparisonLevelSubContext]; - subSubContext['finally checking for comparison mismatch with log4js'] = checkForMismatch; - }; -} - -// Populating the batches programmatically, as there are -// (configs.length x strLevels.length x strLevels.length) = 324 -// possible test combinations -for (var cfg in configs) { - var configToTest = configs[cfg]; - var nop = configToTest === 'nop'; - var context; - if (nop) { - context = 'Setting up loggers with initial levels, then NOT setting a configuration,'; - } - else { - context = 'Setting up loggers with initial levels, then setting a configuration which '+cfg+','; - } - - showProgress('Setting up the vows batch and context for '+context); - // each config to be tested has its own vows batch with a single top-level context - var batch={}; - batch[context]= getTopLevelContext(nop, configToTest, context); - batches.push(batch); - - // each top-level context has strLevels sub-contexts, one per logger - // which has set to a specific level in the top-level context's topic - strLevels.forEach(setupBaseLevelAndCompareToOtherLevels); -} - -showProgress('Running tests'); -var v = vows.describe('log4js.configure(), with or without a "levels" property'); - -batches.forEach(function(batch) {v=v.addBatch(batch);}); - -v.export(module); - diff --git a/test/connect-logger-test.js b/test/connect-logger-test.js deleted file mode 100644 index 9fda2575..00000000 --- a/test/connect-logger-test.js +++ /dev/null @@ -1,303 +0,0 @@ -/* jshint maxparams:7 */ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, util = require('util') -, EE = require('events').EventEmitter -, levels = require('../lib/levels'); - -function MockLogger() { - - var that = this; - this.messages = []; - - this.log = function(level, message, exception) { - that.messages.push({ level: level, message: message }); - }; - - this.isLevelEnabled = function(level) { - return level.isGreaterThanOrEqualTo(that.level); - }; - - this.level = levels.TRACE; - -} - -function MockRequest(remoteAddr, method, originalUrl, headers) { - - this.socket = { remoteAddress: remoteAddr }; - this.originalUrl = originalUrl; - this.method = method; - this.httpVersionMajor = '5'; - this.httpVersionMinor = '0'; - this.headers = headers || {}; - - var self = this; - Object.keys(this.headers).forEach(function(key) { - self.headers[key.toLowerCase()] = self.headers[key]; - }); -} - -function MockResponse() { - var r = this; - this.end = function(chunk, encoding) { - r.emit('finish'); - }; - - this.writeHead = function(code, headers) { - this.statusCode = code; - this._headers = headers; - }; -} - -util.inherits(MockResponse, EE); - -function request(cl, method, url, code, reqHeaders, resHeaders) { - var req = new MockRequest('my.remote.addr', method, url, reqHeaders); - var res = new MockResponse(); - cl(req, res, function() {}); - res.writeHead(code, resHeaders); - res.end('chunk','encoding'); -} - -vows.describe('log4js connect logger').addBatch({ - 'getConnectLoggerModule': { - topic: function() { - var clm = require('../lib/connect-logger'); - return clm; - }, - - 'should return a "connect logger" factory' : function(clm) { - assert.isObject(clm); - }, - - 'take a log4js logger and return a "connect logger"' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml); - return cl; - }, - - 'should return a "connect logger"': function(cl) { - assert.isFunction(cl); - } - }, - - 'log events' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml); - var cb = this.callback; - request(cl, 'GET', 'http://url', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.include(messages[0].message, 'GET'); - assert.include(messages[0].message, 'http://url'); - assert.include(messages[0].message, 'my.remote.addr'); - assert.include(messages[0].message, '200'); - } - }, - - 'log events with level below logging level' : { - topic: function(clm) { - var ml = new MockLogger(); - ml.level = levels.FATAL; - var cl = clm.connectLogger(ml); - request(cl, 'GET', 'http://url', 200); - return ml.messages; - }, - - 'check message': function(messages) { - assert.isArray(messages); - assert.isEmpty(messages); - } - }, - - 'log events with non-default level and custom format' : { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, { level: levels.INFO, format: ':method :url' } ); - request(cl, 'GET', 'http://url', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); }, - - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.equal(messages[0].message, 'GET http://url'); - } - }, - - 'logger with options as string': { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, ':method :url'); - request(cl, 'POST', 'http://meh', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - 'should use the passed in format': function(messages) { - assert.equal(messages[0].message, 'POST http://meh'); - } - }, - - 'auto log levels': { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, { level: 'auto', format: ':method :url' }); - request(cl, 'GET', 'http://meh', 200); - request(cl, 'GET', 'http://meh', 201); - request(cl, 'GET', 'http://meh', 302); - request(cl, 'GET', 'http://meh', 404); - request(cl, 'GET', 'http://meh', 500); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'should use INFO for 2xx': function(messages) { - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.ok(levels.INFO.isEqualTo(messages[1].level)); - }, - - 'should use WARN for 3xx': function(messages) { - assert.ok(levels.WARN.isEqualTo(messages[2].level)); - }, - - 'should use ERROR for 4xx': function(messages) { - assert.ok(levels.ERROR.isEqualTo(messages[3].level)); - }, - - 'should use ERROR for 5xx': function(messages) { - assert.ok(levels.ERROR.isEqualTo(messages[4].level)); - } - }, - - 'format using a function': { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, function(req, res, formatFn) { return "I was called"; }); - request(cl, 'GET', 'http://blah', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'should call the format function': function(messages) { - assert.equal(messages[0].message, 'I was called'); - } - }, - - 'format that includes request headers': { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, ':req[Content-Type]'); - request( - cl, - 'GET', 'http://blah', 200, - { 'Content-Type': 'application/json' } - ); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - 'should output the request header': function(messages) { - assert.equal(messages[0].message, 'application/json'); - } - }, - - 'format that includes response headers': { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, ':res[Content-Type]'); - request( - cl, - 'GET', 'http://blah', 200, - null, - { 'Content-Type': 'application/cheese' } - ); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'should output the response header': function(messages) { - assert.equal(messages[0].message, 'application/cheese'); - } - }, - - 'log events with custom token' : { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, { - level: levels.INFO, - format: ':method :url :custom_string', - tokens: [{ - token: ':custom_string', replacement: 'fooBAR' - }] - }); - request(cl, 'GET', 'http://url', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.equal(messages[0].message, 'GET http://url fooBAR'); - } - }, - - 'log events with custom override token' : { - topic: function(clm) { - var ml = new MockLogger(); - var cb = this.callback; - ml.level = levels.INFO; - var cl = clm.connectLogger(ml, { - level: levels.INFO, - format: ':method :url :date', - tokens: [{ - token: ':date', replacement: "20150310" - }] - }); - request(cl, 'GET', 'http://url', 200); - setTimeout(function() { - cb(null, ml.messages); - },10); - }, - - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.equal(messages[0].message, 'GET http://url 20150310'); - } - } - } -}).export(module); diff --git a/test/consoleAppender-test.js b/test/consoleAppender-test.js index 3887ce5a..6f6a020f 100644 --- a/test/consoleAppender-test.js +++ b/test/consoleAppender-test.js @@ -1,33 +1,31 @@ "use strict"; -var assert = require('assert') -, vows = require('vows') -, layouts = require('../lib/layouts') +var should = require('should') , sandbox = require('sandboxed-module'); -vows.describe('../lib/appenders/console').addBatch({ - 'appender': { - topic: function() { - var messages = [] - , fakeConsole = { - log: function(msg) { messages.push(msg); } - } - , appenderModule = sandbox.require( - '../lib/appenders/console', - { - globals: { - 'console': fakeConsole - } +describe('../lib/appenders/console', function() { + var messages = []; + + before(function() { + var fakeConsole = { + log: function(msg) { messages.push(msg); } + } + , appenderModule = sandbox.require( + '../lib/appenders/console', + { + globals: { + 'console': fakeConsole } - ) - , appender = appenderModule.appender(layouts.messagePassThroughLayout); + } + ) + , appender = appenderModule(require('../lib/layouts'))( + { layout: { type: "messagePassThrough" } } + ); - appender({ data: ["blah"] }); - return messages; - }, + appender({ data: ["blah"] }); + }); - 'should output to console': function(messages) { - assert.equal(messages[0], 'blah'); - } - } + it('should output to console', function() { + messages.should.eql(["blah"]); + }); -}).exportTo(module); +}); diff --git a/test/dateFileAppender-test.js b/test/dateFileAppender-test.js index 8fa115f0..33028cf7 100644 --- a/test/dateFileAppender-test.js +++ b/test/dateFileAppender-test.js @@ -1,157 +1,174 @@ "use strict"; -var vows = require('vows') -, assert = require('assert') +/*jshint expr:true */ +var should = require('should') +, async = require('async') , path = require('path') , fs = require('fs') -, sandbox = require('sandboxed-module') -, log4js = require('../lib/log4js') -, EOL = require('os').EOL || '\n'; - -function removeFile(filename) { - return function() { - fs.unlink(path.join(__dirname, filename), function(err) { - if (err) { - console.log("Could not delete ", filename, err); +, sandbox = require('sandboxed-module'); + +function remove(filename, cb) { + fs.unlink(path.join(__dirname, filename), function(err) { + cb(); + }); +} + +describe('../lib/appenders/dateFile', function() { + describe('adding multiple dateFileAppenders', function() { + var files = [], initialListeners; + + before(function() { + var dateFileAppender = require('../lib/appenders/dateFile')({ basicLayout: function() {} }), + count = 5, + logfile; + + initialListeners = process.listeners('exit').length; + + while (count--) { + logfile = path.join(__dirname, 'datefa-default-test' + count + '.log'); + dateFileAppender({ + filename: logfile + }); + files.push(logfile); } }); - }; -} -vows.describe('../lib/appenders/dateFile').addBatch({ - 'appender': { - 'adding multiple dateFileAppenders': { - topic: function () { - var listenersCount = process.listeners('exit').length, - dateFileAppender = require('../lib/appenders/dateFile'), - count = 5, - logfile; - - while (count--) { - logfile = path.join(__dirname, 'datefa-default-test' + count + '.log'); - log4js.addAppender(dateFileAppender.appender(logfile)); - } - - return listenersCount; - }, - teardown: function() { - removeFile('datefa-default-test0.log')(); - removeFile('datefa-default-test1.log')(); - removeFile('datefa-default-test2.log')(); - removeFile('datefa-default-test3.log')(); - removeFile('datefa-default-test4.log')(); - }, + after(function(done) { + async.forEach(files, remove, done); + }); - 'should only add one `exit` listener': function (initialCount) { - assert.equal(process.listeners('exit').length, initialCount + 1); - }, - - }, - - 'exit listener': { - topic: function() { - var exitListener - , openedFiles = [] - , dateFileAppender = sandbox.require( - '../lib/appenders/dateFile', - { - globals: { - process: { - on: function(evt, listener) { - exitListener = listener; - } + it('should only add one `exit` listener', function () { + process.listeners('exit').length.should.be.below(initialListeners + 2); + }); + + }); + + describe('exit listener', function() { + var openedFiles = []; + + before(function() { + var exitListener + , dateFileAppender = sandbox.require( + '../lib/appenders/dateFile', + { + globals: { + process: { + on: function(evt, listener) { + exitListener = listener; } - }, - requires: { - '../streams': { - DateRollingFileStream: function(filename) { - openedFiles.push(filename); - - this.end = function() { - openedFiles.shift(); - }; - } + } + }, + requires: { + 'streamroller': { + DateRollingFileStream: function(filename) { + openedFiles.push(filename); + + this.end = function() { + openedFiles.shift(); + }; } - } - } - ); - for (var i=0; i < 5; i += 1) { - dateFileAppender.appender('test' + i); + } + } } - assert.isNotEmpty(openedFiles); - exitListener(); - return openedFiles; - }, - 'should close all open files': function(openedFiles) { - assert.isEmpty(openedFiles); + )({ basicLayout: function() {} }); + + for (var i=0; i < 5; i += 1) { + dateFileAppender({ + filename: 'test' + i + }); } - }, - - 'with default settings': { - topic: function() { - var that = this, - testFile = path.join(__dirname, 'date-appender-default.log'), - appender = require('../lib/appenders/dateFile').appender(testFile), - logger = log4js.getLogger('default-settings'); - log4js.clearAppenders(); - log4js.addAppender(appender, 'default-settings'); + + openedFiles.should.not.be.empty; + exitListener(); + }); + + it('should close all open files', function() { + openedFiles.should.be.empty; + }); + }); + + describe('with default settings', function() { + var contents; + + before(function(done) { + var testFile = path.join(__dirname, 'date-appender-default.log'), + log4js = require('../lib/log4js'), + logger = log4js.getLogger('default-settings'); + + log4js.configure({ + appenders: { + "date": { type: "dateFile", filename: testFile } + }, + categories: { + default: { level: "debug", appenders: [ "date" ] } + } + }); - logger.info("This should be in the file."); + logger.info("This should be in the file."); - setTimeout(function() { - fs.readFile(testFile, "utf8", that.callback); - }, 100); + setTimeout(function() { + fs.readFile(testFile, "utf8", function(err, data) { + contents = data; + done(err); + }); + }, 100); - }, - teardown: removeFile('date-appender-default.log'), + }); + + after(function(done) { + remove('date-appender-default.log', done); + }); - 'should write to the file': function(contents) { - assert.include(contents, 'This should be in the file'); - }, + it('should write to the file', function() { + contents.should.include('This should be in the file'); + }); - 'should use the basic layout': function(contents) { - assert.match( - contents, - /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / - ); - } - } - - } -}).addBatch({ - 'configure': { - 'with dateFileAppender': { - topic: function() { + it('should use the basic layout', function() { + contents.should.match( + /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / + ); + }); + }); + + describe('configure', function() { + describe('with dateFileAppender', function() { + var contents; + + before(function(done) { var log4js = require('../lib/log4js') - , logger; + , logger = log4js.getLogger('tests'); + //this config file defines one file appender (to ./date-file-test.log) //and sets the log level for "tests" to WARN log4js.configure('test/with-dateFile.json'); - logger = log4js.getLogger('tests'); logger.info('this should not be written to the file'); logger.warn('this should be written to the file'); - fs.readFile(path.join(__dirname, 'date-file-test.log'), 'utf8', this.callback); - }, - teardown: removeFile('date-file-test.log'), + fs.readFile(path.join(__dirname, 'date-file-test.log'), 'utf8', function(err, data) { + contents = data; + done(err); + }); + }); + + after(function(done) { + remove('date-file-test.log', done); + }); - 'should load appender configuration from a json file': function(err, contents) { - if (err) { - throw err; - } - assert.include(contents, 'this should be written to the file' + EOL); - assert.equal(contents.indexOf('this should not be written to the file'), -1); - } - }, - 'with options.alwaysIncludePattern': { - topic: function() { - var self = this - , log4js = require('../lib/log4js') - , format = require('../lib/date_format') + it('should load appender configuration from a json file', function() { + contents.should.include('this should be written to the file' + require('os').EOL); + contents.should.not.include('this should not be written to the file'); + }); + }); + + describe('with options.alwaysIncludePattern', function() { + var contents, thisTime; + + before(function(done) { + var log4js = require('../lib/log4js') + , format = require('date-format') , logger , options = { - "appenders": [ - { - "category": "tests", + "appenders": { + "datefile": { "type": "dateFile", "filename": "test/date-file-test", "pattern": "-from-MM-dd.log", @@ -160,64 +177,45 @@ vows.describe('../lib/appenders/dateFile').addBatch({ "type": "messagePassThrough" } } - ] - } - , thisTime = format.asString(options.appenders[0].pattern, new Date()); - fs.writeFileSync( + }, + categories: { default: { level: "debug", appenders: [ "datefile" ] } } + }; + thisTime = format.asString(options.appenders.datefile.pattern, new Date()); + + fs.writeFile( path.join(__dirname, 'date-file-test' + thisTime), - "this is existing data" + EOL, - 'utf8' - ); - log4js.clearAppenders(); - log4js.configure(options); - logger = log4js.getLogger('tests'); - logger.warn('this should be written to the file with the appended date'); - this.teardown = removeFile('date-file-test' + thisTime); - //wait for filesystem to catch up - setTimeout(function() { - fs.readFile(path.join(__dirname, 'date-file-test' + thisTime), 'utf8', self.callback); - }, 100); - }, - 'should create file with the correct pattern': function(contents) { - assert.include(contents, 'this should be written to the file with the appended date'); - }, - 'should not overwrite the file on open (bug found in issue #132)': function(contents) { - assert.include(contents, 'this is existing data'); - } - }, - 'with cwd option': { - topic: function () { - var fileOpened, - appender = sandbox.require( - '../lib/appenders/dateFile', - { requires: - { '../streams': - { DateRollingFileStream: - function(file) { - fileOpened = file; - return { - on: function() {}, - end: function() {} - }; + "this is existing data" + require('os').EOL, + 'utf8', + function(err) { + log4js.configure(options); + logger = log4js.getLogger('tests'); + logger.warn('this should be written to the file with the appended date'); + //wait for filesystem to catch up + setTimeout(function() { + fs.readFile( + path.join(__dirname, 'date-file-test' + thisTime), + 'utf8', + function(err, data) { + contents = data; + done(err); } - } - } + ); + }, 200); } ); - appender.configure( - { - filename: "whatever.log", - maxLogSize: 10 - }, - { cwd: '/absolute/path/to' } - ); - return fileOpened; - }, - 'should prepend options.cwd to config.filename': function (fileOpened) { - var expected = path.sep + path.join("absolute", "path", "to", "whatever.log"); - assert.equal(fileOpened, expected); - } - } - - } -}).exportTo(module); + }); + + after(function(done) { + remove('date-file-test' + thisTime, done); + }); + + it('should create file with the correct pattern', function() { + contents.should.include('this should be written to the file with the appended date'); + }); + + it('should not overwrite the file on open (bug found in issue #132)', function() { + contents.should.include('this is existing data'); + }); + }); + }); +}); diff --git a/test/date_format-test.js b/test/date_format-test.js deleted file mode 100644 index 04adb08b..00000000 --- a/test/date_format-test.js +++ /dev/null @@ -1,58 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, dateFormat = require('../lib/date_format'); - -function createFixedDate() { - return new Date(2010, 0, 11, 14, 31, 30, 5); -} - -vows.describe('date_format').addBatch({ - 'Date extensions': { - topic: createFixedDate, - 'should format a date as string using a pattern': function(date) { - assert.equal( - dateFormat.asString(dateFormat.DATETIME_FORMAT, date), - "11 01 2010 14:31:30.005" - ); - }, - 'should default to the ISO8601 format': function(date) { - assert.equal( - dateFormat.asString(date), - '2010-01-11 14:31:30.005' - ); - }, - 'should provide a ISO8601 with timezone offset format': function() { - var date = createFixedDate(); - date.setMinutes(date.getMinutes() - date.getTimezoneOffset() - 660); - date.getTimezoneOffset = function() { return -660; }; - assert.equal( - dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, date), - "2010-01-11T14:31:30+1100" - ); - date = createFixedDate(); - date.setMinutes(date.getMinutes() - date.getTimezoneOffset() + 120); - date.getTimezoneOffset = function() { return 120; }; - assert.equal( - dateFormat.asString(dateFormat.ISO8601_WITH_TZ_OFFSET_FORMAT, date), - "2010-01-11T14:31:30-0200" - ); - - }, - 'should provide a just-the-time format': function(date) { - assert.equal( - dateFormat.asString(dateFormat.ABSOLUTETIME_FORMAT, date), - '14:31:30.005' - ); - }, - 'should provide a custom format': function() { - var date = createFixedDate(); - date.setMinutes(date.getMinutes() - date.getTimezoneOffset() + 120); - date.getTimezoneOffset = function() { return 120; }; - assert.equal( - dateFormat.asString("O.SSS.ss.mm.hh.dd.MM.yy", date), - '-0200.005.30.31.14.11.01.10' - ); - } - } -}).export(module); diff --git a/test/debug-test.js b/test/debug-test.js deleted file mode 100644 index 92dd915b..00000000 --- a/test/debug-test.js +++ /dev/null @@ -1,72 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, sandbox = require('sandboxed-module') -, fakeConsole = { - error: function(format, label, message) { - this.logged = [ format, label, message ]; - } -} -, globals = function(debugValue) { - return { - process: { - env: { - 'NODE_DEBUG': debugValue - } - }, - console: fakeConsole - }; -}; - -vows.describe('../lib/debug').addBatch({ - 'when NODE_DEBUG is set to log4js': { - topic: function() { - var debug = sandbox.require( - '../lib/debug', - { 'globals': globals('log4js') } - ); - - fakeConsole.logged = []; - debug('cheese')('biscuits'); - return fakeConsole.logged; - }, - 'it should log to console.error': function(logged) { - assert.equal(logged[0], 'LOG4JS: (%s) %s'); - assert.equal(logged[1], 'cheese'); - assert.equal(logged[2], 'biscuits'); - } - }, - - 'when NODE_DEBUG is set to not log4js': { - topic: function() { - var debug = sandbox.require( - '../lib/debug', - { globals: globals('other_module') } - ); - - fakeConsole.logged = []; - debug('cheese')('biscuits'); - return fakeConsole.logged; - }, - 'it should not log to console.error': function(logged) { - assert.equal(logged.length, 0); - } - }, - - 'when NODE_DEBUG is not set': { - topic: function() { - var debug = sandbox.require( - '../lib/debug', - { globals: globals(null) } - ); - - fakeConsole.logged = []; - debug('cheese')('biscuits'); - return fakeConsole.logged; - }, - 'it should not log to console.error': function(logged) { - assert.equal(logged.length, 0); - } - } - -}).exportTo(module); diff --git a/test/fileAppender-test.js b/test/fileAppender-test.js index 007dbbd5..5901b7b2 100644 --- a/test/fileAppender-test.js +++ b/test/fileAppender-test.js @@ -1,6 +1,7 @@ "use strict"; -var vows = require('vows') -, fs = require('fs') +/*jshint expr:true */ +var fs = require('fs') +, async = require('async') , path = require('path') , sandbox = require('sandboxed-module') , log4js = require('../lib/log4js') @@ -8,40 +9,50 @@ var vows = require('vows') , zlib = require('zlib') , EOL = require('os').EOL || '\n'; -log4js.clearAppenders(); - -function remove(filename) { - try { - fs.unlinkSync(filename); - } catch (e) { - //doesn't really matter if it failed - } +function remove(filename, cb) { + fs.unlink(filename, function(err) { cb(); }); } -vows.describe('log4js fileAppender').addBatch({ - 'adding multiple fileAppenders': { - topic: function () { - var listenersCount = process.listeners('exit').length - , logger = log4js.getLogger('default-settings') - , count = 5, logfile; +describe('log4js fileAppender', function() { + + describe('adding multiple fileAppenders', function() { + var files = [], initialCount, listenersCount; + + before(function() { + var logfile + , count = 5 + , config = { + appenders: {}, + categories: { default: { level: "debug", appenders: ["file0"] } } + }; + + initialCount = process.listeners('exit').length; while (count--) { logfile = path.join(__dirname, '/fa-default-test' + count + '.log'); - log4js.addAppender(require('../lib/appenders/file').appender(logfile), 'default-settings'); + config.appenders["file" + count] = { type: "file", filename: logfile }; + files.push(logfile); } - return listenersCount; - }, + log4js.configure(config); - 'does not add more than one `exit` listeners': function (initialCount) { - assert.ok(process.listeners('exit').length <= initialCount + 1); - } - }, + listenersCount = process.listeners('exit').length; + }); - 'exit listener': { - topic: function() { + after(function(done) { + async.forEach(files, remove, done); + }); + + it('does not add more than one `exit` listeners', function () { + listenersCount.should.be.below(initialCount + 2); + }); + }); + + describe('exit listener', function() { + var openedFiles = []; + + before(function() { var exitListener - , openedFiles = [] , fileAppender = sandbox.require( '../lib/appenders/file', { @@ -53,7 +64,7 @@ vows.describe('log4js fileAppender').addBatch({ } }, requires: { - '../streams': { + 'streamroller': { RollingFileStream: function(filename) { openedFiles.push(filename); @@ -66,342 +77,224 @@ vows.describe('log4js fileAppender').addBatch({ } } } - ); + )(require('../lib/layouts')); for (var i=0; i < 5; i += 1) { - fileAppender.appender('test' + i, null, 100); + fileAppender({ filename: 'test' + i, maxLogSize: 100 }); } - assert.isNotEmpty(openedFiles); + openedFiles.should.not.be.empty; exitListener(); - return openedFiles; - }, - 'should close all open files': function(openedFiles) { - assert.isEmpty(openedFiles); - } - }, - - 'with default fileAppender settings': { - topic: function() { - var that = this - , testFile = path.join(__dirname, '/fa-default-test.log') - , logger = log4js.getLogger('default-settings'); - remove(testFile); - - log4js.clearAppenders(); - log4js.addAppender(require('../lib/appenders/file').appender(testFile), 'default-settings'); - - logger.info("This should be in the file."); - - setTimeout(function() { - fs.readFile(testFile, "utf8", that.callback); - }, 100); - }, - 'should write log messages to the file': function (err, fileContents) { - assert.include(fileContents, "This should be in the file." + EOL); - }, - 'log messages should be in the basic layout format': function(err, fileContents) { - assert.match( - fileContents, - /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / - ); - } - }, - 'fileAppender subcategories': { - topic: function() { - var that = this; - - log4js.clearAppenders(); - - function addAppender(cat) { - var testFile = path.join( - __dirname, - '/fa-subcategories-test-'+cat.join('-').replace(/\./g, "_")+'.log' - ); - remove(testFile); - log4js.addAppender(require('../lib/appenders/file').appender(testFile), cat); - return testFile; - } - - var file_sub1 = addAppender([ 'sub1']); - - var file_sub1_sub12$sub1_sub13 = addAppender([ 'sub1.sub12', 'sub1.sub13' ]); - - var file_sub1_sub12 = addAppender([ 'sub1.sub12' ]); - + }); - var logger_sub1_sub12_sub123 = log4js.getLogger('sub1.sub12.sub123'); + it('should close all open files', function() { + openedFiles.should.be.empty; + }); + }); - var logger_sub1_sub13_sub133 = log4js.getLogger('sub1.sub13.sub133'); + describe('with default fileAppender settings', function() { + var fileContents + , testFile = path.join(__dirname, '/fa-default-test.log'); - var logger_sub1_sub14 = log4js.getLogger('sub1.sub14'); + before(function(done) { + var logger = log4js.getLogger('default-settings'); - var logger_sub2 = log4js.getLogger('sub2'); + remove(testFile, function() { + log4js.configure({ + appenders: { + "file": { type: "file", filename: testFile } + }, + categories: { + "default": { level: "debug", appenders: [ "file" ] } + } + }); + + logger.info("This should be in the file."); + + setTimeout(function() { + fs.readFile(testFile, "utf8", function(err, contents) { + if (!err) { + fileContents = contents; + } + done(err); + }); + }, 100); + }); + }); + + after(function(done) { + remove(testFile, done); + }); + + it('should write log messages to the file', function() { + fileContents.should.include("This should be in the file.\n"); + }); + + it('log messages should be in the basic layout format', function() { + fileContents.should.match( + /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / + ); + }); + }); - logger_sub1_sub12_sub123.info('sub1_sub12_sub123'); - - logger_sub1_sub13_sub133.info('sub1_sub13_sub133'); - - logger_sub1_sub14.info('sub1_sub14'); + describe('with a max file size and no backups', function() { + var testFile = path.join(__dirname, '/fa-maxFileSize-test.log'); - logger_sub2.info('sub2'); + before(function(done) { + var logger = log4js.getLogger('max-file-size'); + async.forEach([ + testFile, + testFile + '.1' + ], remove, function() { - setTimeout(function() { - that.callback(null, { - file_sub1: fs.readFileSync(file_sub1).toString(), - file_sub1_sub12$sub1_sub13: fs.readFileSync(file_sub1_sub12$sub1_sub13).toString(), - file_sub1_sub12: fs.readFileSync(file_sub1_sub12).toString() + //log file of 100 bytes maximum, no backups + log4js.configure({ + appenders: { + "file": { type: "file", filename: testFile, maxLogSize: 100, backups: 0 } + }, + categories: { + "default": { level: "debug", appenders: [ "file" ] } + } }); - }, 3000); - }, - 'check file contents': function (err, fileContents) { - - // everything but category 'sub2' - assert.match( - fileContents.file_sub1, - /^(\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] (sub1.sub12.sub123 - sub1_sub12_sub123|sub1.sub13.sub133 - sub1_sub13_sub133|sub1.sub14 - sub1_sub14)[\s\S]){3}$/ // jshint ignore:line - ); - assert.ok( - fileContents.file_sub1.match(/sub123/) && - fileContents.file_sub1.match(/sub133/) && - fileContents.file_sub1.match(/sub14/) - ); - assert.ok(!fileContents.file_sub1.match(/sub2/)); - - // only catgories starting with 'sub1.sub12' and 'sub1.sub13' - assert.match( - fileContents.file_sub1_sub12$sub1_sub13, - /^(\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] (sub1.sub12.sub123 - sub1_sub12_sub123|sub1.sub13.sub133 - sub1_sub13_sub133)[\s\S]){2}$/ //jshint ignore:line - ); - assert.ok( - fileContents.file_sub1_sub12$sub1_sub13.match(/sub123/) && - fileContents.file_sub1_sub12$sub1_sub13.match(/sub133/) - ); - assert.ok(!fileContents.file_sub1_sub12$sub1_sub13.match(/sub14|sub2/)); - - // only catgories starting with 'sub1.sub12' - assert.match( - fileContents.file_sub1_sub12, - /^(\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] (sub1.sub12.sub123 - sub1_sub12_sub123)[\s\S]){1}$/ //jshint ignore:line - ); - assert.ok(!fileContents.file_sub1_sub12.match(/sub14|sub2|sub13/)); - - } - }, - 'with a max file size and no backups': { - topic: function() { - var testFile = path.join(__dirname, '/fa-maxFileSize-test.log') - , logger = log4js.getLogger('max-file-size') - , that = this; - remove(testFile); - remove(testFile + '.1'); - //log file of 100 bytes maximum, no backups - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/file').appender(testFile, log4js.layouts.basicLayout, 100, 0), - 'max-file-size' - ); - logger.info("This is the first log message."); - logger.info("This is an intermediate log message."); - logger.info("This is the second log message."); - //wait for the file system to catch up - setTimeout(function() { - fs.readFile(testFile, "utf8", that.callback); - }, 100); - }, - 'log file should only contain the second message': function(err, fileContents) { - assert.include(fileContents, "This is the second log message."); - assert.equal(fileContents.indexOf("This is the first log message."), -1); - }, - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'starting with the test file name should be two': function(err, files) { - //there will always be one backup if you've specified a max log size - var logFiles = files.filter( - function(file) { return file.indexOf('fa-maxFileSize-test.log') > -1; } - ); - assert.equal(logFiles.length, 2); - } - } - }, - 'with a max file size and 2 backups': { - topic: function() { - var testFile = path.join(__dirname, '/fa-maxFileSize-with-backups-test.log') - , logger = log4js.getLogger('max-file-size-backups'); - remove(testFile); - remove(testFile+'.1'); - remove(testFile+'.2'); - - //log file of 50 bytes maximum, 2 backups - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/file').appender(testFile, log4js.layouts.basicLayout, 50, 2), - 'max-file-size-backups' - ); - logger.info("This is the first log message."); - logger.info("This is the second log message."); - logger.info("This is the third log message."); - logger.info("This is the fourth log message."); - var that = this; - //give the system a chance to open the stream - setTimeout(function() { + logger.info("This is the first log message."); + logger.info("This is an intermediate log message."); + logger.info("This is the second log message."); + done(); + }); + }); + + after(function(done) { + async.forEach([ testFile, testFile + '.1' ], remove, done); + }); + + describe('log file', function() { + it('should only contain the second message', function(done) { + //wait for the file system to catch up + setTimeout(function() { + fs.readFile(testFile, "utf8", function(err, fileContents) { + fileContents.should.include("This is the second log message.\n"); + fileContents.should.not.include("This is the first log message."); + done(err); + }); + }, 100); + }); + }); + + describe('the number of files starting with the test file name', function() { + it('should be two', function(done) { fs.readdir(__dirname, function(err, files) { - if (files) { - that.callback(null, files.sort()); - } else { - that.callback(err, files); + //there will always be one backup if you've specified a max log size + var logFiles = files.filter( + function(file) { return file.indexOf('fa-maxFileSize-test.log') > -1; } + ); + logFiles.should.have.length(2); + done(err); + }); + }); + }); + }); + + describe('with a max file size and 2 backups', function() { + var testFile = path.join(__dirname, '/fa-maxFileSize-with-backups-test.log'); + + before(function(done) { + var logger = log4js.getLogger('max-file-size-backups'); + + async.forEach([ + testFile, + testFile+'.1', + testFile+'.2' + ], remove, function() { + + //log file of 50 bytes maximum, 2 backups + log4js.configure({ + appenders: { + "file": { type: "file", filename: testFile, maxLogSize: 50, backups: 2 } + }, + categories: { + "default": { level: "debug", appenders: [ "file" ] } } }); - }, 200); - }, - 'the log files': { - topic: function(files) { - var logFiles = files.filter( - function(file) { return file.indexOf('fa-maxFileSize-with-backups-test.log') > -1; } - ); - return logFiles; - }, - 'should be 3': function (files) { - assert.equal(files.length, 3); - }, - 'should be named in sequence': function (files) { - assert.deepEqual(files, [ - 'fa-maxFileSize-with-backups-test.log', - 'fa-maxFileSize-with-backups-test.log.1', + + logger.info("This is the first log message."); + logger.info("This is the second log message."); + logger.info("This is the third log message."); + logger.info("This is the fourth log message."); + + done(); + }); + }); + + describe('the log files', function() { + var logFiles; + + before(function(done) { + setTimeout(function() { + fs.readdir(__dirname, function(err, files) { + if (files) { + logFiles = files.sort().filter( + function(file) { + return file.indexOf('fa-maxFileSize-with-backups-test.log') > -1; + } + ); + done(null); + } else { + done(err); + } + }); + }, 200); + }); + + after(function(done) { + async.forEach(logFiles, remove, done); + }); + + it('should be 3', function () { + logFiles.should.have.length(3); + }); + + it('should be named in sequence', function() { + logFiles.should.eql([ + 'fa-maxFileSize-with-backups-test.log', + 'fa-maxFileSize-with-backups-test.log.1', 'fa-maxFileSize-with-backups-test.log.2' ]); - }, - 'and the contents of the first file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[0]), "utf8", this.callback); - }, - 'should be the last log message': function(contents) { - assert.include(contents, 'This is the fourth log message.'); - } - }, - 'and the contents of the second file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[1]), "utf8", this.callback); - }, - 'should be the third log message': function(contents) { - assert.include(contents, 'This is the third log message.'); - } - }, - 'and the contents of the third file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[2]), "utf8", this.callback); - }, - 'should be the second log message': function(contents) { - assert.include(contents, 'This is the second log message.'); - } - } - } - }, - 'with a max file size and 2 compressed backups': { - topic: function() { - var testFile = path.join(__dirname, '/fa-maxFileSize-with-backups-compressed-test.log') - , logger = log4js.getLogger('max-file-size-backups'); - remove(testFile); - remove(testFile+'.1.gz'); - remove(testFile+'.2.gz'); - - //log file of 50 bytes maximum, 2 backups - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/file').appender( - testFile, log4js.layouts.basicLayout, 50, 2, true - ), - 'max-file-size-backups' - ); - logger.info("This is the first log message."); - logger.info("This is the second log message."); - logger.info("This is the third log message."); - logger.info("This is the fourth log message."); - var that = this; - //give the system a chance to open the stream - setTimeout(function() { - fs.readdir(__dirname, function(err, files) { - if (files) { - that.callback(null, files.sort()); - } else { - that.callback(err, files); - } + }); + + describe('and the contents of the first file', function() { + it('should be the last log message', function(done) { + fs.readFile(path.join(__dirname, logFiles[0]), "utf8", function(err, contents) { + contents.should.include('This is the fourth log message.'); + done(err); + }); }); - }, 1000); - }, - 'the log files': { - topic: function(files) { - var logFiles = files.filter( - function(file) { - return file.indexOf('fa-maxFileSize-with-backups-compressed-test.log') > -1; - } - ); - return logFiles; - }, - 'should be 3': function (files) { - assert.equal(files.length, 3); - }, - 'should be named in sequence': function (files) { - assert.deepEqual(files, [ - 'fa-maxFileSize-with-backups-compressed-test.log', - 'fa-maxFileSize-with-backups-compressed-test.log.1.gz', - 'fa-maxFileSize-with-backups-compressed-test.log.2.gz' - ]); - }, - 'and the contents of the first file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[0]), "utf8", this.callback); - }, - 'should be the last log message': function(contents) { - assert.include(contents, 'This is the fourth log message.'); - } - }, - 'and the contents of the second file': { - topic: function(logFiles) { - zlib.gunzip(fs.readFileSync(path.join(__dirname, logFiles[1])), this.callback); - }, - 'should be the third log message': function(contents) { - assert.include(contents.toString('utf8'), 'This is the third log message.'); - } - }, - 'and the contents of the third file': { - topic: function(logFiles) { - zlib.gunzip(fs.readFileSync(path.join(__dirname, logFiles[2])), this.callback); - }, - 'should be the second log message': function(contents) { - assert.include(contents.toString('utf8'), 'This is the second log message.'); - } - } - } - } -}).addBatch({ - 'configure' : { - 'with fileAppender': { - topic: function() { - var log4js = require('../lib/log4js') - , logger; - //this config file defines one file appender (to ./tmp-tests.log) - //and sets the log level for "tests" to WARN - log4js.configure('./test/log4js.json'); - logger = log4js.getLogger('tests'); - logger.info('this should not be written to the file'); - logger.warn('this should be written to the file'); - - fs.readFile('tmp-tests.log', 'utf8', this.callback); - }, - 'should load appender configuration from a json file': function (err, contents) { - assert.include(contents, 'this should be written to the file' + EOL); - assert.equal(contents.indexOf('this should not be written to the file'), -1); - } - } - } -}).addBatch({ - 'when underlying stream errors': { - topic: function() { - var consoleArgs - , errorHandler + }); + + describe('and the contents of the second file', function() { + it('should be the third log message', function(done) { + fs.readFile(path.join(__dirname, logFiles[1]), "utf8", function(err, contents) { + contents.should.include('This is the third log message.'); + done(err); + }); + }); + }); + + describe('and the contents of the third file', function() { + it('should be the second log message', function(done) { + fs.readFile(path.join(__dirname, logFiles[2]), "utf8", function(err, contents) { + contents.should.include('This is the second log message.'); + done(err); + }); + }); + }); + }); + }); + + describe('when underlying stream errors', function() { + var consoleArgs; + + before(function() { + var errorHandler , fileAppender = sandbox.require( '../lib/appenders/file', { @@ -413,7 +306,7 @@ vows.describe('log4js fileAppender').addBatch({ } }, requires: { - '../streams': { + 'streamroller': { RollingFileStream: function(filename) { this.end = function() {}; @@ -426,17 +319,19 @@ vows.describe('log4js fileAppender').addBatch({ } } } - ); - fileAppender.appender('test1.log', null, 100); + )(require('../lib/layouts')); + fileAppender({ + filename: 'test1.log', + maxLogSize: 100 + }); errorHandler({ error: 'aargh' }); - return consoleArgs; - }, - 'should log the error to console.error': function(consoleArgs) { - assert.isNotEmpty(consoleArgs); - assert.equal(consoleArgs[0], 'log4js.fileAppender - Writing to file %s, error happened '); - assert.equal(consoleArgs[1], 'test1.log'); - assert.equal(consoleArgs[2].error, 'aargh'); - } - } - -}).export(module); + }); + + it('should log the error to console.error', function() { + consoleArgs.should.not.be.empty; + consoleArgs[0].should.eql('log4js.fileAppender - Writing to file %s, error happened '); + consoleArgs[1].should.eql('test1.log'); + consoleArgs[2].error.should.eql('aargh'); + }); + }); +}); diff --git a/test/fileSyncAppender-test.js b/test/fileSyncAppender-test.js index d6e2b29a..7e957b59 100755 --- a/test/fileSyncAppender-test.js +++ b/test/fileSyncAppender-test.js @@ -1,14 +1,11 @@ "use strict"; -var vows = require('vows') -, fs = require('fs') +var fs = require('fs') , path = require('path') , sandbox = require('sandboxed-module') , log4js = require('../lib/log4js') , assert = require('assert') , EOL = require('os').EOL || '\n'; -log4js.clearAppenders(); - function remove(filename) { try { fs.unlinkSync(filename); @@ -17,169 +14,183 @@ function remove(filename) { } } -vows.describe('log4js fileSyncAppender').addBatch({ - 'with default fileSyncAppender settings': { - topic: function() { - var that = this - , testFile = path.join(__dirname, '/fa-default-sync-test.log') - , logger = log4js.getLogger('default-settings'); - remove(testFile); +describe('log4js fileSyncAppender', function() { + describe('with default fileSyncAppender settings', function() { + var that = this + , testFile = path.join(__dirname, '/fa-default-sync-test.log') + , logger = log4js.getLogger('default-settings'); - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/fileSync').appender(testFile), - 'default-settings' - ); + before(function() { + log4js.configure({ + appenders: { + "testFile": { type: "fileSync", filename: testFile } + }, + categories: { + "default-settings": { appender: "testFile" } + } + }); logger.info("This should be in the file."); + }); - fs.readFile(testFile, "utf8", that.callback); - }, - 'should write log messages to the file': function (err, fileContents) { - assert.include(fileContents, "This should be in the file." + EOL); - }, - 'log messages should be in the basic layout format': function(err, fileContents) { - assert.match( - fileContents, - /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / - ); - } - }, - 'with a max file size and no backups': { - topic: function() { - var testFile = path.join(__dirname, '/fa-maxFileSize-sync-test.log') - , logger = log4js.getLogger('max-file-size') - , that = this; + after(function() { remove(testFile); - remove(testFile + '.1'); + }); + + it('should write messages to the file', function(done) { + fs.readFile(testFile, "utf8", function(err, contents) { + assert.include(contents, "This should be in the file." + EOL); + done(err); + }); + }); + + it('log messages should be in the basic layout format', function(done) { + fs.readFile(testFile, "utf8", function(err, fileContents) { + assert.match( + fileContents, + /\[\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d{3}\] \[INFO\] default-settings - / + ); + done(err); + }); + }); + }); + + describe('with a max file size and no backups', function() { + var testFile = path.join(__dirname, '/fa-maxFileSize-sync-test.log') + , logger = log4js.getLogger('max-file-size'); + + before(function() { + //log file of 100 bytes maximum, no backups - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/fileSync').appender(testFile, log4js.layouts.basicLayout, 100, 0), - 'max-file-size' - ); + log4js.configure({ + appenders: { + "testFile": { type: "fileSync", filename: testFile, maxLogSize: 100, backups: 0 } + }, + categories: { + "max-file-size": { appender: "testFile" } + } + }); logger.info("This is the first log message."); logger.info("This is an intermediate log message."); logger.info("This is the second log message."); + }); - fs.readFile(testFile, "utf8", that.callback); - }, - 'log file should only contain the second message': function (err, fileContents) { - assert.include(fileContents, "This is the second log message." + EOL); - assert.equal(fileContents.indexOf("This is the first log message."), -1); - }, - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'starting with the test file name should be two': function(err, files) { - //there will always be one backup if you've specified a max log size - var logFiles = files.filter( - function(file) { return file.indexOf('fa-maxFileSize-sync-test.log') > -1; } - ); - assert.equal(logFiles.length, 2); - } - } - }, - 'with a max file size and 2 backups': { - topic: function() { - var testFile = path.join(__dirname, '/fa-maxFileSize-with-backups-sync-test.log') - , logger = log4js.getLogger('max-file-size-backups'); + after(function() { remove(testFile); - remove(testFile+'.1'); - remove(testFile+'.2'); + remove(testFile + '.1'); + }); + + it('log file should only contain the second message', function(done) { + fs.readFile(testFile, "utf8", function (err, fileContents) { + assert.include(fileContents, "This is the second log message." + EOL); + assert.equal(fileContents.indexOf("This is the first log message."), -1); + done(err); + }); + }); + + describe('the number of files', function() { + it('starting with the test file name should be two', function(done) { + fs.readdir(__dirname, function(err, files) { + //there will always be one backup if you've specified a max log size + var logFiles = files.filter( + function(file) { return file.indexOf('fa-maxFileSize-sync-test.log') > -1; } + ); + assert.equal(logFiles.length, 2); + done(err); + }); + }); + }); + }); + + describe('with a max file size and 2 backups', function() { + var testFile = path.join(__dirname, '/fa-maxFileSize-with-backups-sync-test.log') + , logger = log4js.getLogger('max-file-size-backups'); + before(function() { //log file of 50 bytes maximum, 2 backups - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/fileSync').appender(testFile, log4js.layouts.basicLayout, 50, 2), - 'max-file-size-backups' - ); + log4js.configure({ + appenders: { + "testFile": { type: "fileSync", filename: testFile, maxLogSize: 50, backups: 2 } + }, + categories: { + 'max-file-size-backups': { appender: "testFile" } + } + }); logger.info("This is the first log message."); logger.info("This is the second log message."); logger.info("This is the third log message."); logger.info("This is the fourth log message."); - var that = this; + }); + after(function() { + remove(testFile); + remove(testFile+'.1'); + remove(testFile+'.2'); + }); + + it('should produce 3 files, named in sequence', function(done) { fs.readdir(__dirname, function(err, files) { if (files) { - that.callback(null, files.sort()); + var testFiles = files + .sort() + .filter(function(f) { + return f.contains('fa-maxFileSize-with-backups-sync-test.log'); } + ); + testFiles.length.should.equal(3); + assert.deepEqual(testFiles, [ + 'fa-maxFileSize-with-backups-sync-test.log', + 'fa-maxFileSize-with-backups-sync-test.log.1', + 'fa-maxFileSize-with-backups-sync-test.log.2' + ]); + assert.include( + fs.readFileSync(path.join(__dirname, testFiles[0]), "utf8"), + "This is the fourth log message" + ); + assert.include( + fs.readFileSync(path.join(__dirname, testFiles[1]), "utf8"), + "This is the third log message" + ); + assert.include( + fs.readFileSync(path.join(__dirname, testFiles[2]), "utf8"), + "This is the second log message" + ); + done(); } else { - that.callback(err, files); + done(err, files); } }); - }, - 'the log files': { - topic: function(files) { - var logFiles = files.filter( - function(file) { return file.indexOf('fa-maxFileSize-with-backups-sync-test.log') > -1; } - ); - return logFiles; - }, - 'should be 3': function (files) { - assert.equal(files.length, 3); - }, - 'should be named in sequence': function (files) { - assert.deepEqual(files, [ - 'fa-maxFileSize-with-backups-sync-test.log', - 'fa-maxFileSize-with-backups-sync-test.log.1', - 'fa-maxFileSize-with-backups-sync-test.log.2' - ]); - }, - 'and the contents of the first file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[0]), "utf8", this.callback); - }, - 'should be the last log message': function(contents) { - assert.include(contents, 'This is the fourth log message.'); - } - }, - 'and the contents of the second file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[1]), "utf8", this.callback); - }, - 'should be the third log message': function(contents) { - assert.include(contents, 'This is the third log message.'); - } - }, - 'and the contents of the third file': { - topic: function(logFiles) { - fs.readFile(path.join(__dirname, logFiles[2]), "utf8", this.callback); - }, - 'should be the second log message': function(contents) { - assert.include(contents, 'This is the second log message.'); - } - } - } - } -}).addBatch({ - 'configure' : { - 'with fileSyncAppender': { - topic: function() { - var log4js = require('../lib/log4js') - , logger; - //this config defines one file appender (to ./tmp-sync-tests.log) - //and sets the log level for "tests" to WARN - log4js.configure({ - appenders: [{ - category: "tests", - type: "file", - filename: "tmp-sync-tests.log", - layout: { type: "messagePassThrough" } - }], - - levels: { tests: "WARN" } - }); - logger = log4js.getLogger('tests'); - logger.info('this should not be written to the file'); - logger.warn('this should be written to the file'); - fs.readFile('tmp-sync-tests.log', 'utf8', this.callback); - }, - 'should load appender configuration from a json file': function(err, contents) { + }); + }); + + describe('configuration', function() { + before(function() { + var log4js = require('../lib/log4js') + , logger; + //this config defines one file appender (to ./tmp-sync-tests.log) + //and sets the log level for "tests" to WARN + log4js.configure({ + appenders: [{ + category: "tests", + type: "file", + filename: "tmp-sync-tests.log", + layout: { type: "messagePassThrough" } + }], + + levels: { tests: "WARN" } + }); + logger = log4js.getLogger('tests'); + logger.info('this should not be written to the file'); + logger.warn('this should be written to the file'); + }); + + it('should load appender configuration from a json file', function(done) { + fs.readFile('tmp-sync-tests.log', 'utf8', function(err, contents) { assert.include(contents, 'this should be written to the file' + EOL); assert.equal(contents.indexOf('this should not be written to the file'), -1); - } - } - } -}).export(module); + done(err); + }); + }); + + }); +}); diff --git a/test/gelfAppender-test.js b/test/gelfAppender-test.js deleted file mode 100644 index 76fb5ea3..00000000 --- a/test/gelfAppender-test.js +++ /dev/null @@ -1,257 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, sandbox = require('sandboxed-module') -, log4js = require('../lib/log4js') -, realLayouts = require('../lib/layouts') -, setupLogging = function(options, category, compressedLength) { - var fakeDgram = { - sent: false, - socket: { - packetLength: 0, - closed: false, - close: function() { - this.closed = true; - }, - send: function(pkt, offset, pktLength, port, host) { - fakeDgram.sent = true; - this.packet = pkt; - this.offset = offset; - this.packetLength = pktLength; - this.port = port; - this.host = host; - } - }, - createSocket: function(type) { - this.type = type; - return this.socket; - } - } - , fakeZlib = { - gzip: function(objectToCompress, callback) { - fakeZlib.uncompressed = objectToCompress; - if (this.shouldError) { - callback({ stack: "oh noes" }); - return; - } - - if (compressedLength) { - callback(null, { length: compressedLength }); - } else { - callback(null, "I've been compressed"); - } - } - } - , exitHandler - , fakeConsole = { - error: function(message) { - this.message = message; - } - } - , fakeLayouts = { - layout: function(type, options) { - this.type = type; - this.options = options; - return realLayouts.messagePassThroughLayout; - }, - messagePassThroughLayout: realLayouts.messagePassThroughLayout - } - , appender = sandbox.require('../lib/appenders/gelf', { - requires: { - dgram: fakeDgram, - zlib: fakeZlib, - '../layouts': fakeLayouts - }, - globals: { - process: { - on: function(evt, handler) { - if (evt === 'exit') { - exitHandler = handler; - } - } - }, - console: fakeConsole - } - }); - - log4js.clearAppenders(); - log4js.addAppender(appender.configure(options || {}), category || "gelf-test"); - return { - dgram: fakeDgram, - compress: fakeZlib, - exitHandler: exitHandler, - console: fakeConsole, - layouts: fakeLayouts, - logger: log4js.getLogger(category || "gelf-test") - }; -}; - -vows.describe('log4js gelfAppender').addBatch({ - - 'with default gelfAppender settings': { - topic: function() { - var setup = setupLogging(); - setup.logger.info("This is a test"); - return setup; - }, - 'the dgram packet': { - topic: function(setup) { - return setup.dgram; - }, - 'should be sent via udp to the localhost gelf server': function(dgram) { - assert.equal(dgram.type, "udp4"); - assert.equal(dgram.socket.host, "localhost"); - assert.equal(dgram.socket.port, 12201); - assert.equal(dgram.socket.offset, 0); - assert.ok(dgram.socket.packetLength > 0, "Received blank message"); - }, - 'should be compressed': function(dgram) { - assert.equal(dgram.socket.packet, "I've been compressed"); - } - }, - 'the uncompressed log message': { - topic: function(setup) { - var message = JSON.parse(setup.compress.uncompressed); - return message; - }, - 'should be in the gelf format': function(message) { - assert.equal(message.version, '1.1'); - assert.equal(message.host, require('os').hostname()); - assert.equal(message.level, 6); //INFO - assert.equal(message.short_message, 'This is a test'); - } - } - }, - 'with a message longer than 8k': { - topic: function() { - var setup = setupLogging(undefined, undefined, 10240); - setup.logger.info("Blah."); - return setup; - }, - 'the dgram packet': { - topic: function(setup) { - return setup.dgram; - }, - 'should not be sent': function(dgram) { - assert.equal(dgram.sent, false); - } - } - }, - 'with non-default options': { - topic: function() { - var setup = setupLogging({ - host: 'somewhere', - port: 12345, - hostname: 'cheese', - facility: 'nonsense' - }); - setup.logger.debug("Just testing."); - return setup; - }, - 'the dgram packet': { - topic: function(setup) { - return setup.dgram; - }, - 'should pick up the options': function(dgram) { - assert.equal(dgram.socket.host, 'somewhere'); - assert.equal(dgram.socket.port, 12345); - } - }, - 'the uncompressed packet': { - topic: function(setup) { - var message = JSON.parse(setup.compress.uncompressed); - return message; - }, - 'should pick up the options': function(message) { - assert.equal(message.host, 'cheese'); - assert.equal(message._facility, 'nonsense'); - } - } - }, - - 'on process.exit': { - topic: function() { - var setup = setupLogging(); - setup.exitHandler(); - return setup; - }, - 'should close open sockets': function(setup) { - assert.isTrue(setup.dgram.socket.closed); - } - }, - - 'on zlib error': { - topic: function() { - var setup = setupLogging(); - setup.compress.shouldError = true; - setup.logger.info('whatever'); - return setup; - }, - 'should output to console.error': function(setup) { - assert.equal(setup.console.message, 'oh noes'); - } - }, - - 'with layout in configuration': { - topic: function() { - var setup = setupLogging({ - layout: { - type: 'madeuplayout', - earlgrey: 'yes, please' - } - }); - return setup; - }, - 'should pass options to layout': function(setup) { - assert.equal(setup.layouts.type, 'madeuplayout'); - assert.equal(setup.layouts.options.earlgrey, 'yes, please'); - } - }, - - 'with custom fields options': { - topic: function() { - var setup = setupLogging({ - host: 'somewhere', - port: 12345, - hostname: 'cheese', - facility: 'nonsense', - customFields: { - _every1: 'Hello every one', - _every2: 'Hello every two' - } - }); - var myFields = { - GELF: true, - _every2: 'Overwritten!', - _myField: 'This is my field!' - }; - setup.logger.debug(myFields, "Just testing."); - return setup; - }, - 'the dgram packet': { - topic: function(setup) { - return setup.dgram; - }, - 'should pick up the options': function(dgram) { - assert.equal(dgram.socket.host, 'somewhere'); - assert.equal(dgram.socket.port, 12345); - } - }, - 'the uncompressed packet': { - topic: function(setup) { - var message = JSON.parse(setup.compress.uncompressed); - return message; - }, - 'should pick up the options': function(message) { - assert.equal(message.host, 'cheese'); - assert.isUndefined(message.GELF); // make sure flag was removed - assert.equal(message._facility, 'nonsense'); - assert.equal(message._every1, 'Hello every one'); // the default value - assert.equal(message._every2, 'Overwritten!'); // the overwritten value - assert.equal(message._myField, 'This is my field!'); // the value for this message only - assert.equal(message.short_message, 'Just testing.'); // skip the field object - } - } - } - -}).export(module); diff --git a/test/global-log-level-test.js b/test/global-log-level-test.js deleted file mode 100644 index 4ccc5832..00000000 --- a/test/global-log-level-test.js +++ /dev/null @@ -1,121 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert'); - -vows.describe('log4js global loglevel').addBatch({ - 'global loglevel' : { - topic: function() { - var log4js = require('../lib/log4js'); - return log4js; - }, - - 'set global loglevel on creation': function(log4js) { - var log1 = log4js.getLogger('log1'); - var level = 'OFF'; - if (log1.level.toString() == level) { - level = 'TRACE'; - } - assert.notEqual(log1.level.toString(), level); - - log4js.setGlobalLogLevel(level); - assert.equal(log1.level.toString(), level); - - var log2 = log4js.getLogger('log2'); - assert.equal(log2.level.toString(), level); - }, - - 'global change loglevel': function(log4js) { - var log1 = log4js.getLogger('log1'); - var log2 = log4js.getLogger('log2'); - var level = 'OFF'; - if (log1.level.toString() == level) { - level = 'TRACE'; - } - assert.notEqual(log1.level.toString(), level); - - log4js.setGlobalLogLevel(level); - assert.equal(log1.level.toString(), level); - assert.equal(log2.level.toString(), level); - }, - - 'override loglevel': function(log4js) { - var log1 = log4js.getLogger('log1'); - var log2 = log4js.getLogger('log2'); - var level = 'OFF'; - if (log1.level.toString() == level) { - level = 'TRACE'; - } - assert.notEqual(log1.level.toString(), level); - - var oldLevel = log1.level.toString(); - assert.equal(log2.level.toString(), oldLevel); - - log2.setLevel(level); - assert.equal(log1.level.toString(), oldLevel); - assert.equal(log2.level.toString(), level); - assert.notEqual(oldLevel, level); - - log2.removeLevel(); - assert.equal(log1.level.toString(), oldLevel); - assert.equal(log2.level.toString(), oldLevel); - }, - - 'preload loglevel': function(log4js) { - var log1 = log4js.getLogger('log1'); - var level = 'OFF'; - if (log1.level.toString() == level) { - level = 'TRACE'; - } - assert.notEqual(log1.level.toString(), level); - - var oldLevel = log1.level.toString(); - log4js.getLogger('log2').setLevel(level); - - assert.equal(log1.level.toString(), oldLevel); - - // get again same logger but as different variable - var log2 = log4js.getLogger('log2'); - assert.equal(log2.level.toString(), level); - assert.notEqual(oldLevel, level); - - log2.removeLevel(); - assert.equal(log1.level.toString(), oldLevel); - assert.equal(log2.level.toString(), oldLevel); - }, - - 'set level on all categories': function(log4js) { - // Get 2 loggers - var log1 = log4js.getLogger('log1'); - var log2 = log4js.getLogger('log2'); - - // First a test with 2 categories with different levels - var config = { - 'levels': { - 'log1': 'ERROR', - 'log2': 'WARN' - } - }; - log4js.configure(config); - - // Check if the levels are set correctly - assert.equal('ERROR', log1.level.toString()); - assert.equal('WARN', log2.level.toString()); - - log1.removeLevel(); - log2.removeLevel(); - - // Almost identical test, but now we set - // level on all categories - var config2 = { - 'levels': { - '[all]': 'DEBUG' - } - }; - log4js.configure(config2); - - // Check if the loggers got the DEBUG level - assert.equal('DEBUG', log1.level.toString()); - assert.equal('DEBUG', log2.level.toString()); - } - } -}).export(module); diff --git a/test/layouts-test.js b/test/layouts-test.js index 1b7d2ef0..714e6bff 100644 --- a/test/layouts-test.js +++ b/test/layouts-test.js @@ -6,146 +6,153 @@ var vows = require('vows') , EOL = os.EOL || '\n'; //used for patternLayout tests. -function test(args, pattern, value) { - var layout = args[0] - , event = args[1] - , tokens = args[2]; - +function test(layout, event, tokens, pattern, value) { assert.equal(layout(pattern, tokens)(event), value); } -vows.describe('log4js layouts').addBatch({ - 'colouredLayout': { - topic: function() { - return require('../lib/layouts').colouredLayout; - }, +describe('log4js layouts', function() { + describe('colouredLayout', function() { + var layout = require('../lib/layouts').colouredLayout; - 'should apply level colour codes to output': function(layout) { + it('should apply level colour codes to output', function() { var output = layout({ data: ["nonsense"], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level: { toString: function() { return "ERROR"; } } }); assert.equal(output, '\x1B[31m[2010-12-05 14:18:30.045] [ERROR] cheese - \x1B[39mnonsense'); - }, - 'should support the console.log format for the message': function(layout) { + }); + + it('should support the console.log format for the message', function() { var output = layout({ data: ["thing %d", 2], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level: { toString: function() { return "ERROR"; } } }); assert.equal(output, '\x1B[31m[2010-12-05 14:18:30.045] [ERROR] cheese - \x1B[39mthing 2'); - } - }, + }); - 'messagePassThroughLayout': { - topic: function() { - return require('../lib/layouts').messagePassThroughLayout; - }, - 'should take a logevent and output only the message' : function(layout) { + }); + + describe('messagePassThroughLayout', function() { + var layout = require('../lib/layouts').messagePassThroughLayout; + + it('should take a logevent and output only the message', function() { assert.equal(layout({ data: ["nonsense"], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level: { colour: "green", toString: function() { return "ERROR"; } } }), "nonsense"); - }, - 'should support the console.log format for the message' : function(layout) { + }); + + it('should support the console.log format for the message', function() { assert.equal(layout({ data: ["thing %d", 1, "cheese"], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level : { colour: "green", toString: function() { return "ERROR"; } } }), "thing 1 cheese"); - }, - 'should output the first item even if it is not a string': function(layout) { + }); + + it('should output the first item even if it is not a string', function() { assert.equal(layout({ data: [ { thing: 1} ], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level: { colour: "green", toString: function() { return "ERROR"; } } }), "{ thing: 1 }"); - }, - 'should print the stacks of a passed error objects': function(layout) { - assert.isArray(layout({ - data: [ new Error() ], - startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", - level: { - colour: "green", - toString: function() { return "ERROR"; } - } - }).match(/Error\s+at Object\..*\s+\((.*)test[\\\/]layouts-test\.js\:\d+\:\d+\)\s+at runTest/) - , 'regexp did not return a match'); - }, - 'with passed augmented errors': { - topic: function(layout){ + }); + + it('should print the stacks of a passed error objects', function() { + assert.ok(Array.isArray( + layout({ + data: [ new Error() ], + startTime: new Date(2010, 11, 5, 14, 18, 30, 45), + category: "cheese", + level: { + colour: "green", + toString: function() { return "ERROR"; } + } + }).match( + /Error\s+at Context\..*\s+\((.*)test[\\\/]layouts-test\.js\:\d+\:\d+\)\s/ + ) + ), 'regexp did not return a match'); + }); + + describe('with passed augmented errors', function() { + var layoutOutput; + + before(function() { var e = new Error("My Unique Error Message"); e.augmented = "My Unique attribute value"; e.augObj = { at1: "at2" }; - return layout({ + + layoutOutput = layout({ data: [ e ], startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "cheese", + category: "cheese", level: { colour: "green", toString: function() { return "ERROR"; } } }); - }, - 'should print error the contained error message': function(layoutOutput) { - var m = layoutOutput.match(/Error: My Unique Error Message/); - assert.isArray(m); - }, - 'should print error augmented string attributes': function(layoutOutput) { + }); + + it('should print error the contained error message', function() { + var m = layoutOutput.match(/\{ \[Error: My Unique Error Message\]/); + assert.ok(Array.isArray(m)); + }); + + it('should print error augmented string attributes', function() { var m = layoutOutput.match(/augmented:\s'My Unique attribute value'/); - assert.isArray(m); - }, - 'should print error augmented object attributes': function(layoutOutput) { + assert.ok(Array.isArray(m)); + }); + + it('should print error augmented object attributes', function() { var m = layoutOutput.match(/augObj:\s\{ at1: 'at2' \}/); - assert.isArray(m); - } - } + assert.ok(Array.isArray(m)); + }); + }); + }); - }, + describe('basicLayout', function() { + var layout = require('../lib/layouts').basicLayout + , event = { + data: ['this is a test'], + startTime: new Date(2010, 11, 5, 14, 18, 30, 45), + category: "tests", + level: { + toString: function() { return "DEBUG"; } + } + }; - 'basicLayout': { - topic: function() { - var layout = require('../lib/layouts').basicLayout, - event = { - data: ['this is a test'], - startTime: new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "tests", - level: { - toString: function() { return "DEBUG"; } - } - }; - return [layout, event]; - }, - 'should take a logevent and output a formatted string': function(args) { - var layout = args[0], event = args[1]; + it('should take a logevent and output a formatted string', function() { assert.equal(layout(event), "[2010-12-05 14:18:30.045] [DEBUG] tests - this is a test"); - }, - 'should output a stacktrace, message if the event has an error attached': function(args) { - var i, layout = args[0], event = args[1], output, lines, - error = new Error("Some made-up error"), - stack = error.stack.split(/\n/); + }); + + it('should output a stacktrace, message if the event has an error attached', function() { + var output + , lines + , i + , error = new Error("Some made-up error") + , stack = error.stack.split(/\n/); event.data = ['this is a test', error]; output = layout(event); @@ -170,161 +177,189 @@ vows.describe('log4js layouts').addBatch({ assert.equal(lines[i+2], stack[i+1]); } } + }); + + it('should output any extra data in the log event as util.inspect strings', function() { + var output, lines; - }, - 'should output any extra data in the log event as util.inspect strings': function(args) { - var layout = args[0], event = args[1], output, lines; event.data = ['this is a test', { name: 'Cheese', message: 'Gorgonzola smells.' }]; output = layout(event); + assert.equal( output, "[2010-12-05 14:18:30.045] [DEBUG] tests - this is a test " + "{ name: 'Cheese', message: 'Gorgonzola smells.' }" ); + }); + }); + + describe('patternLayout', function() { + var event = { + data: ['this is a test'], + startTime: new Date(2010, 11, 5, 14, 18, 30, 45), + category: "multiple.levels.of.tests", + level: { + toString: function() { return "DEBUG"; } + } } - }, - - 'patternLayout': { - topic: function() { - var event = { - data: ['this is a test'], - startTime: new Date('2010-12-05T14:18:30.045Z'), //new Date(2010, 11, 5, 14, 18, 30, 45), - categoryName: "multiple.levels.of.tests", - level: { - toString: function() { return "DEBUG"; } - } - }, layout = require('../lib/layouts').patternLayout - , tokens = { - testString: 'testStringToken', - testFunction: function() { return 'testFunctionToken'; }, - fnThatUsesLogEvent: function(logEvent) { return logEvent.level.toString(); } - }; - - //override getTimezoneOffset - event.startTime.getTimezoneOffset = function() { return 0; }; - return [layout, event, tokens]; - }, - - 'should default to "time logLevel loggerName - message"': function(args) { - test(args, null, "14:18:30 DEBUG multiple.levels.of.tests - this is a test" + EOL); - }, - '%r should output time only': function(args) { - test(args, '%r', '14:18:30'); - }, - '%p should output the log level': function(args) { - test(args, '%p', 'DEBUG'); - }, - '%c should output the log category': function(args) { - test(args, '%c', 'multiple.levels.of.tests'); - }, - '%m should output the log data': function(args) { - test(args, '%m', 'this is a test'); - }, - '%n should output a new line': function(args) { - test(args, '%n', EOL); - }, - '%h should output hostname' : function(args) { - test(args, '%h', os.hostname().toString()); - }, - '%z should output pid' : function(args) { - test(args, '%z', process.pid); - }, - '%c should handle category names like java-style package names': function(args) { - test(args, '%c{1}', 'tests'); - test(args, '%c{2}', 'of.tests'); - test(args, '%c{3}', 'levels.of.tests'); - test(args, '%c{4}', 'multiple.levels.of.tests'); - test(args, '%c{5}', 'multiple.levels.of.tests'); - test(args, '%c{99}', 'multiple.levels.of.tests'); - }, - '%d should output the date in ISO8601 format': function(args) { - test(args, '%d', '2010-12-05 14:18:30.045'); - }, - '%d should allow for format specification': function(args) { - test(args, '%d{ISO8601_WITH_TZ_OFFSET}', '2010-12-05T14:18:30-0000'); - test(args, '%d{ISO8601}', '2010-12-05 14:18:30.045'); - test(args, '%d{ABSOLUTE}', '14:18:30.045'); - test(args, '%d{DATE}', '05 12 2010 14:18:30.045'); - test(args, '%d{yy MM dd hh mm ss}', '10 12 05 14 18 30'); - test(args, '%d{yyyy MM dd}', '2010 12 05'); - test(args, '%d{yyyy MM dd hh mm ss SSS}', '2010 12 05 14 18 30 045'); - }, - '%% should output %': function(args) { - test(args, '%%', '%'); - }, - 'should output anything not preceded by % as literal': function(args) { - test(args, 'blah blah blah', 'blah blah blah'); - }, - 'should output the original string if no replacer matches the token': function(args) { - test(args, '%a{3}', 'a{3}'); - }, - 'should handle complicated patterns': function(args) { - test(args, + , layout = require('../lib/layouts').patternLayout + , tokens = { + testString: 'testStringToken', + testFunction: function() { return 'testFunctionToken'; }, + fnThatUsesLogEvent: function(logEvent) { return logEvent.level.toString(); } + }; + + event.startTime.getTimezoneOffset = function() { return 0; }; + + it('should default to "time logLevel loggerName - message"', function() { + test( + layout, + event, + tokens, + null, + "14:18:30 DEBUG multiple.levels.of.tests - this is a test\n" + ); + }); + + it('%r should output time only', function() { + test(layout, event, tokens, '%r', '14:18:30'); + }); + + it('%p should output the log level', function() { + test(layout, event, tokens, '%p', 'DEBUG'); + }); + + it('%c should output the log category', function() { + test(layout, event, tokens, '%c', 'multiple.levels.of.tests'); + }); + + it('%m should output the log data', function() { + test(layout, event, tokens, '%m', 'this is a test'); + }); + + it('%n should output a new line', function() { + test(layout, event, tokens, '%n', '\n'); + }); + + it('%h should output hostname', function() { + test(layout, event, tokens, '%h', require('os').hostname().toString()); + }); + + it('%c should handle category names like java-style package names', function() { + test(layout, event, tokens, '%c{1}', 'tests'); + test(layout, event, tokens, '%c{2}', 'of.tests'); + test(layout, event, tokens, '%c{3}', 'levels.of.tests'); + test(layout, event, tokens, '%c{4}', 'multiple.levels.of.tests'); + test(layout, event, tokens, '%c{5}', 'multiple.levels.of.tests'); + test(layout, event, tokens, '%c{99}', 'multiple.levels.of.tests'); + }); + + it('%d should output the date in ISO8601 format', function() { + test(layout, event, tokens, '%d', '2010-12-05 14:18:30.045'); + }); + + it('%d should allow for format specification', function() { + test(layout, event, tokens, '%d{ISO8601_WITH_TZ_OFFSET}', '2010-12-05T14:18:30-0000'); + test(layout, event, tokens, '%d{ISO8601}', '2010-12-05 14:18:30.045'); + test(layout, event, tokens, '%d{ABSOLUTE}', '14:18:30.045'); + test(layout, event, tokens, '%d{DATE}', '05 12 2010 14:18:30.045'); + test(layout, event, tokens, '%d{yy MM dd hh mm ss}', '10 12 05 14 18 30'); + test(layout, event, tokens, '%d{yyyy MM dd}', '2010 12 05'); + test(layout, event, tokens, '%d{yyyy MM dd hh mm ss SSS}', '2010 12 05 14 18 30 045'); + }); + + it('%% should output %', function() { + test(layout, event, tokens, '%%', '%'); + }); + + it('should output anything not preceded by % as literal', function() { + test(layout, event, tokens, 'blah blah blah', 'blah blah blah'); + }); + + it('should output the original string if no replacer matches the token', function() { + test(layout, event, tokens, '%a{3}', 'a{3}'); + }); + + it('should handle complicated patterns', function() { + test(layout, event, tokens, '%m%n %c{2} at %d{ABSOLUTE} cheese %p%n', 'this is a test'+ EOL +' of.tests at 14:18:30.045 cheese DEBUG' + EOL ); - }, - 'should truncate fields if specified': function(args) { - test(args, '%.4m', 'this'); - test(args, '%.7m', 'this is'); - test(args, '%.9m', 'this is a'); - test(args, '%.14m', 'this is a test'); - test(args, '%.2919102m', 'this is a test'); - }, - 'should pad fields if specified': function(args) { - test(args, '%10p', ' DEBUG'); - test(args, '%8p', ' DEBUG'); - test(args, '%6p', ' DEBUG'); - test(args, '%4p', 'DEBUG'); - test(args, '%-4p', 'DEBUG'); - test(args, '%-6p', 'DEBUG '); - test(args, '%-8p', 'DEBUG '); - test(args, '%-10p', 'DEBUG '); - }, - '%[%r%] should output colored time': function(args) { - test(args, '%[%r%]', '\x1B[36m14:18:30\x1B[39m'); - }, - '%x{testString} should output the string stored in tokens': function(args) { - test(args, '%x{testString}', 'testStringToken'); - }, - '%x{testFunction} should output the result of the function stored in tokens': function(args) { - test(args, '%x{testFunction}', 'testFunctionToken'); - }, - '%x{doesNotExist} should output the string stored in tokens': function(args) { - test(args, '%x{doesNotExist}', 'null'); - }, - '%x{fnThatUsesLogEvent} should be able to use the logEvent': function(args) { - test(args, '%x{fnThatUsesLogEvent}', 'DEBUG'); - }, - '%x should output the string stored in tokens': function(args) { - test(args, '%x', 'null'); - } - }, - 'layout makers': { - topic: require('../lib/layouts'), - 'should have a maker for each layout': function(layouts) { + }); + + it('should truncate fields if specified', function() { + test(layout, event, tokens, '%.4m', 'this'); + test(layout, event, tokens, '%.7m', 'this is'); + test(layout, event, tokens, '%.9m', 'this is a'); + test(layout, event, tokens, '%.14m', 'this is a test'); + test(layout, event, tokens, '%.2919102m', 'this is a test'); + }); + + it('should pad fields if specified', function() { + test(layout, event, tokens, '%10p', ' DEBUG'); + test(layout, event, tokens, '%8p', ' DEBUG'); + test(layout, event, tokens, '%6p', ' DEBUG'); + test(layout, event, tokens, '%4p', 'DEBUG'); + test(layout, event, tokens, '%-4p', 'DEBUG'); + test(layout, event, tokens, '%-6p', 'DEBUG '); + test(layout, event, tokens, '%-8p', 'DEBUG '); + test(layout, event, tokens, '%-10p', 'DEBUG '); + }); + + it('%[%r%] should output colored time', function() { + test(layout, event, tokens, '%[%r%]', '\x1B[36m14:18:30\x1B[39m'); + }); + + describe('%x{}', function() { + it('%x{testString} should output the string stored in tokens', function() { + test(layout, event, tokens, '%x{testString}', 'testStringToken'); + }); + + it('%x{testFunction} should output the result of the function stored in tokens', function() { + test(layout, event, tokens, '%x{testFunction}', 'testFunctionToken'); + }); + + it('%x{doesNotExist} should output the string stored in tokens', function() { + test(layout, event, tokens, '%x{doesNotExist}', '%x{doesNotExist}'); + }); + + it('%x{fnThatUsesLogEvent} should be able to use the logEvent', function() { + test(layout, event, tokens, '%x{fnThatUsesLogEvent}', 'DEBUG'); + }); + + it('%x should output the string stored in tokens', function() { + test(layout, event, tokens, '%x', '%x'); + }); + }); + }); + + describe('layout makers', function() { + var layouts = require('../lib/layouts'); + + it('should have a maker for each layout', function() { assert.ok(layouts.layout("messagePassThrough")); assert.ok(layouts.layout("basic")); assert.ok(layouts.layout("colored")); assert.ok(layouts.layout("coloured")); assert.ok(layouts.layout("pattern")); - } - }, - 'add layout': { - topic: require('../lib/layouts'), - 'should be able to add a layout': function(layouts) { - layouts.addLayout('test_layout', function(config){ - assert.equal(config, 'test_config'); - return function(logEvent) { - return "TEST LAYOUT >"+logEvent.data; - }; - }); - var serializer = layouts.layout('test_layout', 'test_config'); - assert.ok(serializer); - assert.equal(serializer({data: "INPUT"}), "TEST LAYOUT >INPUT"); - } - } -}).export(module); + }); + + it('should return falsy if a layout does not exist', function() { + assert.ok(!layouts.layout("cheese")); + }); + + it('should pass config to layouts that need it', function() { + var layout = layouts.layout( + "pattern", + { + pattern: "%m" + } + ); + + assert.equal(layout({ data: [ "blah" ] }), "blah"); + }); + }); +}); diff --git a/test/levels-test.js b/test/levels-test.js index df655fd1..e901f268 100644 --- a/test/levels-test.js +++ b/test/levels-test.js @@ -1,464 +1,427 @@ "use strict"; -var vows = require('vows') -, assert = require('assert') +var assert = require('assert') +, should = require('should') , levels = require('../lib/levels'); function assertThat(level) { - function assertForEach(assertion, test, otherLevels) { + function assertForEach(val, test, otherLevels) { otherLevels.forEach(function(other) { - assertion.call(assert, test.call(level, other)); + test.call(level, other).should.eql(val); }); } return { isLessThanOrEqualTo: function(levels) { - assertForEach(assert.isTrue, level.isLessThanOrEqualTo, levels); + assertForEach(true, level.isLessThanOrEqualTo, levels); }, isNotLessThanOrEqualTo: function(levels) { - assertForEach(assert.isFalse, level.isLessThanOrEqualTo, levels); + assertForEach(false, level.isLessThanOrEqualTo, levels); }, isGreaterThanOrEqualTo: function(levels) { - assertForEach(assert.isTrue, level.isGreaterThanOrEqualTo, levels); + assertForEach(true, level.isGreaterThanOrEqualTo, levels); }, isNotGreaterThanOrEqualTo: function(levels) { - assertForEach(assert.isFalse, level.isGreaterThanOrEqualTo, levels); + assertForEach(false, level.isGreaterThanOrEqualTo, levels); }, isEqualTo: function(levels) { - assertForEach(assert.isTrue, level.isEqualTo, levels); + assertForEach(true, level.isEqualTo, levels); }, isNotEqualTo: function(levels) { - assertForEach(assert.isFalse, level.isEqualTo, levels); + assertForEach(false, level.isEqualTo, levels); } }; } -vows.describe('levels').addBatch({ - 'values': { - topic: levels, - 'should define some levels': function(levels) { - assert.isNotNull(levels.ALL); - assert.isNotNull(levels.TRACE); - assert.isNotNull(levels.DEBUG); - assert.isNotNull(levels.INFO); - assert.isNotNull(levels.WARN); - assert.isNotNull(levels.ERROR); - assert.isNotNull(levels.FATAL); - assert.isNotNull(levels.MARK); - assert.isNotNull(levels.OFF); - }, - 'ALL': { - topic: levels.ALL, - 'should be less than the other levels': function(all) { - assertThat(all).isLessThanOrEqualTo( - [ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - }, - 'should be greater than no levels': function(all) { - assertThat(all).isNotGreaterThanOrEqualTo( - [ - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - }, - 'should only be equal to ALL': function(all) { - assertThat(all).isEqualTo([levels.toLevel("ALL")]); - assertThat(all).isNotEqualTo( - [ - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - } - }, - 'TRACE': { - topic: levels.TRACE, - 'should be less than DEBUG': function(trace) { - assertThat(trace).isLessThanOrEqualTo( - [ - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - assertThat(trace).isNotLessThanOrEqualTo([levels.ALL]); - }, - 'should be greater than ALL': function(trace) { - assertThat(trace).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE]); - assertThat(trace).isNotGreaterThanOrEqualTo( - [ - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - }, - 'should only be equal to TRACE': function(trace) { - assertThat(trace).isEqualTo([levels.toLevel("TRACE")]); - assertThat(trace).isNotEqualTo( - [ - levels.ALL, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - } - }, - 'DEBUG': { - topic: levels.DEBUG, - 'should be less than INFO': function(debug) { - assertThat(debug).isLessThanOrEqualTo( - [ - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - assertThat(debug).isNotLessThanOrEqualTo([levels.ALL, levels.TRACE]); - }, - 'should be greater than TRACE': function(debug) { - assertThat(debug).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE]); - assertThat(debug).isNotGreaterThanOrEqualTo( - [ - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - }, - 'should only be equal to DEBUG': function(trace) { - assertThat(trace).isEqualTo([levels.toLevel("DEBUG")]); - assertThat(trace).isNotEqualTo( - [ - levels.ALL, - levels.TRACE, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, - levels.OFF - ] - ); - } - }, - 'INFO': { - topic: levels.INFO, - 'should be less than WARN': function(info) { - assertThat(info).isLessThanOrEqualTo([ - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, +describe('../lib/levels', function() { + it('should define some levels', function() { + should.exist(levels.ALL); + should.exist(levels.TRACE); + should.exist(levels.DEBUG); + should.exist(levels.INFO); + should.exist(levels.WARN); + should.exist(levels.ERROR); + should.exist(levels.FATAL); + should.exist(levels.OFF); + }); + + describe('ALL', function() { + var all = levels.ALL; + + it('should be less than the other levels', function() { + assertThat(all).isLessThanOrEqualTo( + [ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - assertThat(info).isNotLessThanOrEqualTo([levels.ALL, levels.TRACE, levels.DEBUG]); - }, - 'should be greater than DEBUG': function(info) { - assertThat(info).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE, levels.DEBUG]); - assertThat(info).isNotGreaterThanOrEqualTo([ - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, + ] + ); + }); + + it('should be greater than no levels', function() { + assertThat(all).isNotGreaterThanOrEqualTo( + [ + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - }, - 'should only be equal to INFO': function(trace) { - assertThat(trace).isEqualTo([levels.toLevel("INFO")]); - assertThat(trace).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK, + ] + ); + }); + + it('should only be equal to ALL', function() { + assertThat(all).isEqualTo([levels.toLevel("ALL")]); + assertThat(all).isNotEqualTo( + [ + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - } - }, - 'WARN': { - topic: levels.WARN, - 'should be less than ERROR': function(warn) { - assertThat(warn).isLessThanOrEqualTo([levels.ERROR, levels.FATAL, levels.MARK, levels.OFF]); - assertThat(warn).isNotLessThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO - ]); - }, - 'should be greater than INFO': function(warn) { - assertThat(warn).isGreaterThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO - ]); - assertThat(warn).isNotGreaterThanOrEqualTo([ - levels.ERROR, levels.FATAL, levels.MARK, levels.OFF - ]); - }, - 'should only be equal to WARN': function(trace) { - assertThat(trace).isEqualTo([levels.toLevel("WARN")]); - assertThat(trace).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.ERROR, - levels.FATAL, + ] + ); + }); + }); + + describe('TRACE', function() { + var trace = levels.TRACE; + + it('should be less than DEBUG', function() { + assertThat(trace).isLessThanOrEqualTo( + [ + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - } - }, - 'ERROR': { - topic: levels.ERROR, - 'should be less than FATAL': function(error) { - assertThat(error).isLessThanOrEqualTo([levels.FATAL, levels.MARK, levels.OFF]); - assertThat(error).isNotLessThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN - ]); - }, - 'should be greater than WARN': function(error) { - assertThat(error).isGreaterThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN - ]); - assertThat(error).isNotGreaterThanOrEqualTo([levels.FATAL, levels.MARK, levels.OFF]); - }, - 'should only be equal to ERROR': function(trace) { - assertThat(trace).isEqualTo([levels.toLevel("ERROR")]); - assertThat(trace).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.FATAL, - levels.MARK, + ] + ); + assertThat(trace).isNotLessThanOrEqualTo([levels.ALL]); + }); + + it('should be greater than ALL', function() { + assertThat(trace).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE]); + assertThat(trace).isNotGreaterThanOrEqualTo( + [ + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - } - }, - 'FATAL': { - topic: levels.FATAL, - 'should be less than OFF': function(fatal) { - assertThat(fatal).isLessThanOrEqualTo([levels.MARK, levels.OFF]); - assertThat(fatal).isNotLessThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR - ]); - }, - 'should be greater than ERROR': function(fatal) { - assertThat(fatal).isGreaterThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR - ]); - assertThat(fatal).isNotGreaterThanOrEqualTo([levels.MARK, levels.OFF]); - }, - 'should only be equal to FATAL': function(fatal) { - assertThat(fatal).isEqualTo([levels.toLevel("FATAL")]); - assertThat(fatal).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.MARK, + ] + ); + }); + + it('should only be equal to TRACE', function() { + assertThat(trace).isEqualTo([levels.toLevel("TRACE")]); + assertThat(trace).isNotEqualTo( + [ + levels.ALL, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - } - }, - 'MARK': { - topic: levels.MARK, - 'should be less than OFF': function(mark) { - assertThat(mark).isLessThanOrEqualTo([levels.OFF]); - assertThat(mark).isNotLessThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.FATAL, - levels.ERROR - ]); - }, - 'should be greater than FATAL': function(mark) { - assertThat(mark).isGreaterThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL - ]); - assertThat(mark).isNotGreaterThanOrEqualTo([levels.OFF]); - }, - 'should only be equal to MARK': function(mark) { - assertThat(mark).isEqualTo([levels.toLevel("MARK")]); - assertThat(mark).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, + ] + ); + }); + + }); + + describe('DEBUG', function() { + var debug = levels.DEBUG; + + it('should be less than INFO', function() { + assertThat(debug).isLessThanOrEqualTo( + [ + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, levels.OFF - ]); - } - }, - 'OFF': { - topic: levels.OFF, - 'should not be less than anything': function(off) { - assertThat(off).isNotLessThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK - ]); - }, - 'should be greater than everything': function(off) { - assertThat(off).isGreaterThanOrEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK - ]); - }, - 'should only be equal to OFF': function(off) { - assertThat(off).isEqualTo([levels.toLevel("OFF")]); - assertThat(off).isNotEqualTo([ - levels.ALL, - levels.TRACE, - levels.DEBUG, - levels.INFO, - levels.WARN, - levels.ERROR, - levels.FATAL, - levels.MARK - ]); - } - } - }, - 'isGreaterThanOrEqualTo': { - topic: levels.INFO, - 'should handle string arguments': function(info) { + ] + ); + assertThat(debug).isNotLessThanOrEqualTo([levels.ALL, levels.TRACE]); + }); + + it('should be greater than TRACE', function() { + assertThat(debug).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE]); + assertThat(debug).isNotGreaterThanOrEqualTo( + [ + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, + levels.OFF + ] + ); + }); + + it('should only be equal to DEBUG', function() { + assertThat(debug).isEqualTo([levels.toLevel("DEBUG")]); + assertThat(debug).isNotEqualTo( + [ + levels.ALL, + levels.TRACE, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL, + levels.OFF + ] + ); + }); + }); + + describe('INFO', function() { + var info = levels.INFO; + + it('should be less than WARN', function() { + assertThat(info).isLessThanOrEqualTo([ + levels.WARN, + levels.ERROR, + levels.FATAL, + levels.OFF + ]); + assertThat(info).isNotLessThanOrEqualTo([levels.ALL, levels.TRACE, levels.DEBUG]); + }); + + it('should be greater than DEBUG', function() { + assertThat(info).isGreaterThanOrEqualTo([levels.ALL, levels.TRACE, levels.DEBUG]); + assertThat(info).isNotGreaterThanOrEqualTo([ + levels.WARN, + levels.ERROR, + levels.FATAL, + levels.OFF + ]); + }); + + it('should only be equal to INFO', function() { + assertThat(info).isEqualTo([levels.toLevel("INFO")]); + assertThat(info).isNotEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.WARN, + levels.ERROR, + levels.FATAL, + levels.OFF + ]); + }); + }); + + describe('WARN', function() { + var warn = levels.WARN; + + it('should be less than ERROR', function() { + assertThat(warn).isLessThanOrEqualTo([levels.ERROR, levels.FATAL, levels.OFF]); + assertThat(warn).isNotLessThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO + ]); + }); + + it('should be greater than INFO', function() { + assertThat(warn).isGreaterThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO + ]); + assertThat(warn).isNotGreaterThanOrEqualTo([levels.ERROR, levels.FATAL, levels.OFF]); + }); + + it('should only be equal to WARN', function() { + assertThat(warn).isEqualTo([levels.toLevel("WARN")]); + assertThat(warn).isNotEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.ERROR, + levels.FATAL, + levels.OFF + ]); + }); + }); + + describe('ERROR', function() { + var error = levels.ERROR; + + it('should be less than FATAL', function() { + assertThat(error).isLessThanOrEqualTo([levels.FATAL, levels.OFF]); + assertThat(error).isNotLessThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN + ]); + }); + + it('should be greater than WARN', function() { + assertThat(error).isGreaterThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN + ]); + assertThat(error).isNotGreaterThanOrEqualTo([levels.FATAL, levels.OFF]); + }); + + it('should only be equal to ERROR', function() { + assertThat(error).isEqualTo([levels.toLevel("ERROR")]); + assertThat(error).isNotEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.FATAL, + levels.OFF + ]); + }); + }); + + describe('FATAL', function() { + var fatal = levels.FATAL; + + it('should be less than OFF', function() { + assertThat(fatal).isLessThanOrEqualTo([levels.OFF]); + assertThat(fatal).isNotLessThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR + ]); + }); + + it('should be greater than ERROR', function() { + assertThat(fatal).isGreaterThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR + ]); + assertThat(fatal).isNotGreaterThanOrEqualTo([levels.OFF]); + }); + + it('should only be equal to FATAL', function() { + assertThat(fatal).isEqualTo([levels.toLevel("FATAL")]); + assertThat(fatal).isNotEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.OFF + ]); + }); + }); + + describe('OFF', function() { + var off = levels.OFF; + + it('should not be less than anything', function() { + assertThat(off).isNotLessThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL + ]); + }); + + it('should be greater than everything', function() { + assertThat(off).isGreaterThanOrEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL + ]); + }); + + it('should only be equal to OFF', function() { + assertThat(off).isEqualTo([levels.toLevel("OFF")]); + assertThat(off).isNotEqualTo([ + levels.ALL, + levels.TRACE, + levels.DEBUG, + levels.INFO, + levels.WARN, + levels.ERROR, + levels.FATAL + ]); + }); + }); + + describe('isGreaterThanOrEqualTo', function() { + var info = levels.INFO; + it('should handle string arguments', function() { assertThat(info).isGreaterThanOrEqualTo(["all", "trace", "debug"]); - assertThat(info).isNotGreaterThanOrEqualTo(['warn', 'ERROR', 'Fatal', 'MARK', 'off']); - } - }, - 'isLessThanOrEqualTo': { - topic: levels.INFO, - 'should handle string arguments': function(info) { + assertThat(info).isNotGreaterThanOrEqualTo(['warn', 'ERROR', 'Fatal', 'off']); + }); + }); + + describe('isLessThanOrEqualTo', function() { + var info = levels.INFO; + it('should handle string arguments', function() { assertThat(info).isNotLessThanOrEqualTo(["all", "trace", "debug"]); - assertThat(info).isLessThanOrEqualTo(['warn', 'ERROR', 'Fatal', 'MARK', 'off']); - } - }, - 'isEqualTo': { - topic: levels.INFO, - 'should handle string arguments': function(info) { + assertThat(info).isLessThanOrEqualTo(['warn', 'ERROR', 'Fatal', 'off']); + }); + }); + + describe('isEqualTo', function() { + var info = levels.INFO; + it('should handle string arguments', function() { assertThat(info).isEqualTo(["info", "INFO", "iNfO"]); - } - }, - 'toLevel': { - 'with lowercase argument': { - topic: levels.toLevel("debug"), - 'should take the string and return the corresponding level': function(level) { - assert.equal(level, levels.DEBUG); - } - }, - 'with uppercase argument': { - topic: levels.toLevel("DEBUG"), - 'should take the string and return the corresponding level': function(level) { - assert.equal(level, levels.DEBUG); - } - }, - 'with varying case': { - topic: levels.toLevel("DeBuG"), - 'should take the string and return the corresponding level': function(level) { - assert.equal(level, levels.DEBUG); - } - }, - 'with unrecognised argument': { - topic: levels.toLevel("cheese"), - 'should return undefined': function(level) { - assert.isUndefined(level); - } - }, - 'with unrecognised argument and default value': { - topic: levels.toLevel("cheese", levels.DEBUG), - 'should return default value': function(level) { - assert.equal(level, levels.DEBUG); - } - } - } -}).export(module); + }); + }); + + describe('toLevel', function() { + it('should ignore the case of arguments', function() { + levels.toLevel("debug").should.eql(levels.DEBUG); + levels.toLevel("DEBUG").should.eql(levels.DEBUG); + levels.toLevel("DeBuG").should.eql(levels.DEBUG); + }); + + it('should return undefined when argument is not recognised', function() { + should.not.exist(levels.toLevel("cheese")); + }); + + it('should return the default value if argument is not recognised', function() { + levels.toLevel("cheese", levels.DEBUG).should.eql(levels.DEBUG); + }); + + it('should return the default value if argument is falsy', function() { + levels.toLevel(undefined, levels.DEBUG).should.eql(levels.DEBUG); + levels.toLevel(null, levels.DEBUG).should.eql(levels.DEBUG); + }); + }); + +}); diff --git a/test/log-abspath-test.js b/test/log-abspath-test.js deleted file mode 100644 index 5bb64d35..00000000 --- a/test/log-abspath-test.js +++ /dev/null @@ -1,77 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, path = require('path') -, sandbox = require('sandboxed-module'); - -vows.describe('log4js-abspath').addBatch({ - 'options': { - topic: function() { - var appenderOptions, - log4js = sandbox.require( - '../lib/log4js', - { requires: - { './appenders/fake': - { name: "fake", - appender: function() {}, - configure: function(configuration, options) { - appenderOptions = options; - return function() {}; - } - } - } - } - ), - config = { - "appenders": [ - { - "type" : "fake", - "filename" : "cheesy-wotsits.log" - } - ] - }; - - log4js.configure(config, { - cwd: '/absolute/path/to' - }); - return appenderOptions; - }, - 'should be passed to appenders during configuration': function(options) { - assert.equal(options.cwd, '/absolute/path/to'); - } - }, - - 'file appender': { - topic: function() { - var fileOpened, - fileAppender = sandbox.require( - '../lib/appenders/file', - { requires: - { '../streams': - { RollingFileStream: - function(file) { - fileOpened = file; - return { - on: function() {}, - end: function() {} - }; - } - } - } - } - ); - fileAppender.configure( - { - filename: "whatever.log", - maxLogSize: 10 - }, - { cwd: '/absolute/path/to' } - ); - return fileOpened; - }, - 'should prepend options.cwd to config.filename': function(fileOpened) { - var expected = path.sep + path.join("absolute", "path", "to", "whatever.log"); - assert.equal(fileOpened, expected); - } - }, -}).export(module); diff --git a/test/log4js-test.js b/test/log4js-test.js new file mode 100644 index 00000000..196f9af6 --- /dev/null +++ b/test/log4js-test.js @@ -0,0 +1,423 @@ +"use strict"; +var should = require('should') +, fs = require('fs') +, sandbox = require('sandboxed-module') +, log4js = require('../lib/log4js'); + +describe('../lib/log4js', function() { + describe('#getLogger', function() { + it('should return a Logger', function() { + log4js.getLogger().should.have.property('debug').be.a('function'); + log4js.getLogger().should.have.property('info').be.a('function'); + log4js.getLogger().should.have.property('error').be.a('function'); + }); + }); + + describe('#configure', function() { + it('should require an object or a filename', function() { + [ + undefined, + null, + true, + 42, + function() {} + ].forEach(function(arg) { + (function() { log4js.configure(arg); }).should.throw( + "You must specify configuration as an object or a filename." + ); + }); + }); + + it('should complain if the file cannot be found', function() { + (function() { log4js.configure("pants"); }).should.throw( + "ENOENT, no such file or directory 'pants'" + ); + }); + + it('should pick up the configuration filename from env.LOG4JS_CONFIG', function() { + process.env.LOG4JS_CONFIG = 'made-up-file'; + (function() { log4js.configure(); }).should.throw( + "ENOENT, no such file or directory 'made-up-file'" + ); + delete process.env.LOG4JS_CONFIG; + }); + + it('should complain if the config does not specify any appenders', function() { + + (function() { log4js.configure({}); }).should.throw( + "You must specify at least one appender." + ); + + (function() { log4js.configure({ appenders: {} }); }).should.throw( + "You must specify at least one appender." + ); + + }); + + it( + 'should complain if the config does not specify an appender for the default category', + function() { + + (function() { + log4js.configure( + { + appenders: { + "console": { type: "console" } + }, + categories: {} + } + ); + }).should.throw( + "You must specify an appender for the default category" + ); + + (function() { + log4js.configure({ + appenders: { + "console": { type: "console" } + }, + categories: { + "cheese": { level: "DEBUG", appenders: [ "console" ] } + } + }); + }).should.throw( + "You must specify an appender for the default category" + ); + + } + ); + + it('should complain if a category does not specify level or appenders', function() { + (function() { + log4js.configure( + { + appenders: { "console": { type: "console" } }, + categories: { + "default": { thing: "thing" } + } + } + ); + }).should.throw( + "You must specify a level for category 'default'." + ); + + (function() { + log4js.configure( + { + appenders: { "console": { type: "console" } }, + categories: { + "default": { level: "DEBUG" } + } + } + ); + }).should.throw( + "You must specify an appender for category 'default'." + ); + }); + + it('should complain if a category specifies a level that does not exist', function() { + (function() { + log4js.configure( + { + appenders: { "console": { type: "console" }}, + categories: { + "default": { level: "PICKLES" } + } + } + ); + }).should.throw( + "Level 'PICKLES' is not valid for category 'default'. " + + "Acceptable values are: OFF, TRACE, DEBUG, INFO, WARN, ERROR, FATAL." + ); + }); + + it('should complain if a category specifies an appender that does not exist', function() { + (function() { + log4js.configure( + { + appenders: { "console": { type: "console" }}, + categories: { + "default": { level: "DEBUG", appenders: [ "cheese" ] } + } + } + ); + }).should.throw( + "Appender 'cheese' for category 'default' does not exist. Known appenders are: console." + ); + }); + + before(function(done) { + fs.unlink("test.log", function (err) { done(); }); + }); + + it('should set up the included appenders', function(done) { + log4js.configure({ + appenders: { + "file": { type: "file", filename: "test.log" } + }, + categories: { + default: { level: "DEBUG", appenders: [ "file" ] } + } + }); + log4js.getLogger('test').debug("cheese"); + + setTimeout(function() { + fs.readFile("test.log", "utf-8", function(err, contents) { + contents.should.include("cheese"); + done(err); + }); + }, 50); + }); + + after(function(done) { + fs.unlink("test.log", function (err) { done(); }); + }); + + it('should set up third-party appenders', function() { + var events = [], log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function() { + return function() { + return function(evt) { events.push(evt); }; + }; + } + } + } + ); + log4js_sandbox.configure({ + appenders: { + "thing": { type: "cheese" } + }, + categories: { + default: { level: "DEBUG", appenders: [ "thing" ] } + } + }); + log4js_sandbox.getLogger().info("edam"); + + events.should.have.length(1); + events[0].data[0].should.eql("edam"); + + }); + + it('should only load third-party appenders once', function() { + var moduleCalled = 0 + , log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function() { + moduleCalled += 1; + return function() { + return function() {}; + }; + } + } + } + ); + log4js_sandbox.configure({ + appenders: { + "thing1": { type: "cheese" }, + "thing2": { type: "cheese" } + }, + categories: { + default: { level: "DEBUG", appenders: [ "thing1", "thing2" ] } + } + }); + + moduleCalled.should.eql(1); + }); + + it('should pass layouts and levels to appender modules', function() { + var layouts + , levels + , log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function(arg1, arg2) { + layouts = arg1; + levels = arg2; + return function() { + return function() {}; + }; + } + } + } + ); + log4js_sandbox.configure({ + appenders: { + "thing": { type: "cheese" } + }, + categories: { + "default": { level: "debug", appenders: [ "thing" ] } + } + }); + + layouts.should.have.property("basicLayout"); + levels.should.have.property("toLevel"); + }); + + it('should pass config and appenderByName to appender makers', function() { + var otherAppender = function() { /* I do nothing */ } + , config + , other + , log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'other': function() { + return function() { + return otherAppender; + }; + }, + 'cheese': function() { + return function(arg1, arg2) { + config = arg1; + other = arg2("other"); + return function() {}; + }; + } + } + } + ); + log4js_sandbox.configure({ + appenders: { + "other": { type: "other" }, + "thing": { type: "cheese", something: "something" } + }, + categories: { + default: { level: "debug", appenders: [ "other", "thing" ] } + } + }); + + other.should.equal(otherAppender); + config.should.have.property("something", "something"); + + }); + + it('should complain about unknown appenders', function() { + (function() { + log4js.configure({ + appenders: { + "thing": { type: "madeupappender" } + }, + categories: { + default: { level: "DEBUG", appenders: [ "thing" ] } + } + }); + }).should.throw( + "Could not load appender of type 'madeupappender'." + ); + }); + + it('should read config from a file', function() { + var events = [], log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function() { + return function() { + return function(event) { events.push(event); }; + }; + } + } + } + ); + + log4js_sandbox.configure(__dirname + "/with-cheese.json"); + log4js_sandbox.getLogger().debug("gouda"); + + events.should.have.length(1); + events[0].data[0].should.eql("gouda"); + }); + + it('should set up log levels for categories', function() { + var events = [] + , noisyLogger + , log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function() { + return function() { + return function(event) { events.push(event); }; + }; + } + } + } + ); + + log4js_sandbox.configure(__dirname + "/with-cheese.json"); + noisyLogger = log4js_sandbox.getLogger("noisy"); + noisyLogger.debug("pow"); + noisyLogger.info("crash"); + noisyLogger.warn("bang"); + noisyLogger.error("boom"); + noisyLogger.fatal("aargh"); + + events.should.have.length(2); + events[0].data[0].should.eql("boom"); + events[1].data[0].should.eql("aargh"); + + }); + + it('should have a default log level for all categories', function() { + var events = [] + , log4js_sandbox = sandbox.require( + '../lib/log4js', + { + requires: { + 'cheese': function() { + return function() { + return function(event) { events.push(event); }; + }; + } + } + } + ); + + //with-cheese.json only specifies categories noisy and default + //unspecified categories should use the default category config + log4js_sandbox.configure(__dirname + "/with-cheese.json"); + log4js_sandbox.getLogger("surprise").trace("not seen"); + log4js_sandbox.getLogger("surprise").info("should be seen"); + + events.should.have.length(1); + events[0].data[0].should.eql("should be seen"); + + }); + + }); + + describe('with no configuration', function() { + var events = [] + , log4js_sandboxed = sandbox.require( + '../lib/log4js', + { + requires: { + './appenders/console': function() { + return function() { + return function(event) { events.push(event); }; + }; + } + } + } + ); + + log4js_sandboxed.getLogger("blah").debug("goes to console"); + log4js_sandboxed.getLogger("yawn").trace("does not go to console"); + log4js_sandboxed.getLogger().error("also goes to console"); + + it('should log events of debug level and higher to console', function() { + events.should.have.length(2); + events[0].data[0].should.eql("goes to console"); + events[0].category.should.eql("blah"); + events[0].level.toString().should.eql("DEBUG"); + events[1].data[0].should.eql("also goes to console"); + events[1].category.should.eql("default"); + events[1].level.toString().should.eql("ERROR"); + }); + }); +}); diff --git a/test/logLevelFilter-test.js b/test/logLevelFilter-test.js index b3deb058..93760404 100644 --- a/test/logLevelFilter-test.js +++ b/test/logLevelFilter-test.js @@ -1,93 +1,141 @@ "use strict"; -var vows = require('vows') -, fs = require('fs') -, assert = require('assert') -, os = require('os') -, EOL = require('os').EOL || '\n'; +var should = require('should') +, sandbox = require('sandboxed-module') +, log4js = require('../lib/log4js'); -function remove(filename) { - try { - fs.unlinkSync(filename); - } catch (e) { - //doesn't really matter if it failed - } -} +describe('log level filter', function() { + describe('when configured correctly', function() { + var events = [], logger; -vows.describe('log4js logLevelFilter').addBatch({ - 'appender': { - topic: function() { - var log4js = require('../lib/log4js'), logEvents = [], logger; - log4js.clearAppenders(); - log4js.addAppender( - require('../lib/appenders/logLevelFilter') - .appender( - 'ERROR', - undefined, - function(evt) { logEvents.push(evt); } - ), - "logLevelTest" + before(function() { + var log4js_sandboxed = sandbox.require( + '../lib/log4js', + { requires: + { './appenders/console': function() { + return function() { + return function(evt) { events.push(evt); }; + }; + } + } + } ); + log4js_sandboxed.configure({ + appenders: { + "console": { type: "console", layout: { type: "messagePassThrough" } }, + "errors only": { + type: "logLevelFilter", + allow: [ "ERROR", "FATAL" ], + appender: "console" + } + }, + categories: { + default: { level: "DEBUG", appenders: [ "errors only" ] } + } + }); + logger = log4js_sandboxed.getLogger("test"); + }); - logger = log4js.getLogger("logLevelTest"); - logger.debug('this should not trigger an event'); - logger.warn('neither should this'); - logger.error('this should, though'); - logger.fatal('so should this'); - return logEvents; - }, - 'should only pass log events greater than or equal to its own level' : function(logEvents) { - assert.equal(logEvents.length, 2); - assert.equal(logEvents[0].data[0], 'this should, though'); - assert.equal(logEvents[1].data[0], 'so should this'); - } - }, + it('should pass events to an appender if they match', function() { + logger.error("oh no"); + logger.fatal("boom"); - 'configure': { - topic: function() { - var log4js = require('../lib/log4js') - , logger; + events.should.have.length(2); + events[0].data[0].should.eql("oh no"); + events[1].data[0].should.eql("boom"); + }); - remove(__dirname + '/logLevelFilter.log'); - remove(__dirname + '/logLevelFilter-warnings.log'); - remove(__dirname + '/logLevelFilter-debugs.log'); + it('should not pass events to the appender if they do not match', function() { + events.should.have.length(2); + logger.debug("cheese"); + events.should.have.length(2); + logger.info("yawn"); + events.should.have.length(2); + }); + }); - log4js.configure('test/with-logLevelFilter.json'); - logger = log4js.getLogger("tests"); - logger.debug('debug'); - logger.info('info'); - logger.error('error'); - logger.warn('warn'); - logger.debug('debug'); - logger.trace('trace'); - //wait for the file system to catch up - setTimeout(this.callback, 500); - }, - 'tmp-tests.log': { - topic: function() { - fs.readFile(__dirname + '/logLevelFilter.log', 'utf8', this.callback); - }, - 'should contain all log messages': function (contents) { - var messages = contents.trim().split(EOL); - assert.deepEqual(messages, ['debug','info','error','warn','debug','trace']); - } - }, - 'tmp-tests-warnings.log': { - topic: function() { - fs.readFile(__dirname + '/logLevelFilter-warnings.log','utf8',this.callback); - }, - 'should contain only error and warning log messages': function(contents) { - var messages = contents.trim().split(EOL); - assert.deepEqual(messages, ['error','warn']); - } - }, - 'tmp-tests-debugs.log': { - topic: function() { - fs.readFile(__dirname + '/logLevelFilter-debugs.log','utf8',this.callback); - }, - 'should contain only trace and debug log messages': function(contents) { - var messages = contents.trim().split(EOL); - assert.deepEqual(messages, ['debug','debug','trace']); - } - } - } -}).export(module); + it('should complain if it has no appender', function() { + (function() { + log4js.configure({ + appenders: { + "errors": { + type: "logLevelFilter", + allow: [ "ERROR", "FATAL" ] + } + }, + categories: { + default: { level: "DEBUG", appenders: [ "errors" ] } + } + }); + }).should.throw(/Missing an appender\./); + }); + + it('should complain if it has no list of allowed levels', function() { + (function() { + log4js.configure({ + appenders: { + "console": { type: "console" }, + "errors": { + type: "logLevelFilter", + appender: "console" + } + }, + categories: { + default: { level: "DEBUG", appenders: [ "errors" ] } + } + }); + }).should.throw(/No allowed log levels specified\./); + }); + + it('should complain if the referenced appender does not exist', function() { + (function() { + log4js.configure({ + appenders: { + "errors": { + type: "logLevelFilter", + allow: [ "ERROR" ], + appender: "console" + } + }, + categories: { + default: { level: "DEBUG", appenders: [ "errors" ] } + } + }); + }).should.throw(/Appender 'console' not found\./); + }); + + it('should complain if the list of levels is not valid', function() { + (function() { + log4js.configure({ + appenders: { + "errors": { + type: "logLevelFilter", + allow: [ "cheese", "biscuits", "ERROR" ], + appender: "console" + } + }, + categories: { + default: { level: "DEBUG", appenders: [ "errors" ] } + } + }); + }).should.throw(/Unrecognised log level 'cheese'\./); + }); + + it('should complain if the list of levels is empty', function() { + (function() { + log4js.configure({ + appenders: { + "console": { type: "console" }, + "errors": { + type: "logLevelFilter", + allow: [], + appender: "console" + } + }, + categories: { + default: { level: "debug", appenders: [ "errors" ] } + } + }); + }).should.throw(/No allowed log levels specified\./); + }); + +}); diff --git a/test/logger-test.js b/test/logger-test.js index 0bd29e1c..d2df5d03 100644 --- a/test/logger-test.js +++ b/test/logger-test.js @@ -1,81 +1,53 @@ "use strict"; -var vows = require('vows') -, assert = require('assert') +var should = require('should') , levels = require('../lib/levels') -, loggerModule = require('../lib/logger') -, Logger = loggerModule.Logger; +, Logger = require('../lib/logger'); -vows.describe('../lib/logger').addBatch({ - 'constructor with no parameters': { - topic: new Logger(), - 'should use default category': function(logger) { - assert.equal(logger.category, Logger.DEFAULT_CATEGORY); - }, - 'should use TRACE log level': function(logger) { - assert.equal(logger.level, levels.TRACE); - } - }, +describe('../lib/logger', function() { + describe('Logger constructor', function() { + it('must be passed a dispatch delegate and a category', function() { + (function() { new Logger(); }).should.throw( + "Logger must have a dispatch delegate." + ); + (function() { new Logger(function() {}); }).should.throw( + "Logger must have a category." + ); + }); - 'constructor with category': { - topic: new Logger('cheese'), - 'should use category': function(logger) { - assert.equal(logger.category, 'cheese'); - }, - 'should use TRACE log level': function(logger) { - assert.equal(logger.level, levels.TRACE); - } - }, + }); - 'constructor with category and level': { - topic: new Logger('cheese', 'debug'), - 'should use category': function(logger) { - assert.equal(logger.category, 'cheese'); - }, - 'should use level': function(logger) { - assert.equal(logger.level, levels.DEBUG); - } - }, + describe('Logger instance', function() { + var event + , logger = new Logger( + function(evt) { event = evt; }, + "exciting category" + ); - 'isLevelEnabled': { - topic: new Logger('cheese', 'info'), - 'should provide a level enabled function for all levels': function(logger) { - assert.isFunction(logger.isTraceEnabled); - assert.isFunction(logger.isDebugEnabled); - assert.isFunction(logger.isInfoEnabled); - assert.isFunction(logger.isWarnEnabled); - assert.isFunction(logger.isErrorEnabled); - assert.isFunction(logger.isFatalEnabled); - }, - 'should return the right values': function(logger) { - assert.isFalse(logger.isTraceEnabled()); - assert.isFalse(logger.isDebugEnabled()); - assert.isTrue(logger.isInfoEnabled()); - assert.isTrue(logger.isWarnEnabled()); - assert.isTrue(logger.isErrorEnabled()); - assert.isTrue(logger.isFatalEnabled()); - } - }, + beforeEach(function() { + event = null; + }); - 'should emit log events': { - topic: function() { - var events = [], - logger = new Logger(); - logger.addListener('log', function (logEvent) { events.push(logEvent); }); - logger.debug('Event 1'); - loggerModule.disableAllLogWrites(); - logger.debug('Event 2'); - loggerModule.enableAllLogWrites(); - logger.debug('Event 3'); - return events; - }, + it('should be immutable', function() { + logger.category = "rubbish"; + logger.debug("thing"); - 'when log writes are enabled': function(events) { - assert.equal(events[0].data[0], 'Event 1'); - }, + event.category.should.equal("exciting category"); + }); + + ['trace', 'debug', 'info', 'warn', 'error', 'fatal'].forEach(function(level) { + it('should have a ' + level + ' function', function() { + logger[level].should.be.a('function'); + }); + }); + + it('should send log events to the dispatch delegate', function() { + logger.debug("interesting thing"); + event.should.have.property('category').equal('exciting category'); + event.should.have.property('level').equal(levels.DEBUG); + event.should.have.property('data').eql(["interesting thing"]); + event.should.have.property('startTime'); + }); + }); + +}); - 'but not when log writes are disabled': function(events) { - assert.equal(events.length, 2); - assert.equal(events[1].data[0], 'Event 3'); - } - } -}).exportTo(module); diff --git a/test/logging-test.js b/test/logging-test.js deleted file mode 100644 index 2d71d426..00000000 --- a/test/logging-test.js +++ /dev/null @@ -1,636 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, sandbox = require('sandboxed-module'); - -function setupConsoleTest() { - var fakeConsole = {} - , logEvents = [] - , log4js; - - ['trace','debug','log','info','warn','error'].forEach(function(fn) { - fakeConsole[fn] = function() { - throw new Error("this should not be called."); - }; - }); - - log4js = sandbox.require( - '../lib/log4js', - { - globals: { - console: fakeConsole - } - } - ); - - log4js.clearAppenders(); - log4js.addAppender(function(evt) { - logEvents.push(evt); - }); - - return { log4js: log4js, logEvents: logEvents, fakeConsole: fakeConsole }; -} - -vows.describe('log4js').addBatch({ - - 'getBufferedLogger': { - topic: function () { - var log4js = require('../lib/log4js'); - log4js.clearAppenders(); - var logger = log4js.getBufferedLogger('tests'); - return logger; - }, - - 'should take a category and return a logger': function (logger) { - assert.equal(logger.target.category, 'tests'); - assert.isFunction(logger.flush); - assert.isFunction(logger.trace); - assert.isFunction(logger.debug); - assert.isFunction(logger.info); - assert.isFunction(logger.warn); - assert.isFunction(logger.error); - assert.isFunction(logger.fatal); - }, - - 'cache events': { - topic: function () { - var log4js = require('../lib/log4js'); - log4js.clearAppenders(); - var logger = log4js.getBufferedLogger('tests1'); - var events = []; - logger.target.addListener("log", function (logEvent) { events.push(logEvent); }); - logger.debug("Debug event"); - logger.trace("Trace event 1"); - logger.trace("Trace event 2"); - logger.warn("Warning event"); - logger.error("Aargh!", new Error("Pants are on fire!")); - logger.error( - "Simulated CouchDB problem", - { err: 127, cause: "incendiary underwear" } - ); - return events; - }, - - 'should not emit log events if .flush() is not called.': function (events) { - assert.equal(events.length, 0); - } - }, - - 'log events after flush() is called': { - topic: function () { - var log4js = require('../lib/log4js'); - log4js.clearAppenders(); - var logger = log4js.getBufferedLogger('tests2'); - logger.target.setLevel("TRACE"); - var events = []; - logger.target.addListener("log", function (logEvent) { events.push(logEvent); }); - logger.debug("Debug event"); - logger.trace("Trace event 1"); - logger.trace("Trace event 2"); - logger.warn("Warning event"); - logger.error("Aargh!", new Error("Pants are on fire!")); - logger.error( - "Simulated CouchDB problem", - { err: 127, cause: "incendiary underwear" } - ); - logger.flush(); - return events; - }, - - 'should emit log events when .flush() is called.': function (events) { - assert.equal(events.length, 6); - } - } - }, - - - 'getLogger': { - topic: function() { - var log4js = require('../lib/log4js'); - log4js.clearAppenders(); - var logger = log4js.getLogger('tests'); - logger.setLevel("DEBUG"); - return logger; - }, - - 'should take a category and return a logger': function(logger) { - assert.equal(logger.category, 'tests'); - assert.equal(logger.level.toString(), "DEBUG"); - assert.isFunction(logger.debug); - assert.isFunction(logger.info); - assert.isFunction(logger.warn); - assert.isFunction(logger.error); - assert.isFunction(logger.fatal); - }, - - 'log events' : { - topic: function(logger) { - var events = []; - logger.addListener("log", function (logEvent) { events.push(logEvent); }); - logger.debug("Debug event"); - logger.trace("Trace event 1"); - logger.trace("Trace event 2"); - logger.warn("Warning event"); - logger.error("Aargh!", new Error("Pants are on fire!")); - logger.error("Simulated CouchDB problem", { err: 127, cause: "incendiary underwear" }); - return events; - }, - - 'should emit log events': function(events) { - assert.equal(events[0].level.toString(), 'DEBUG'); - assert.equal(events[0].data[0], 'Debug event'); - assert.instanceOf(events[0].startTime, Date); - }, - - 'should not emit events of a lower level': function(events) { - assert.equal(events.length, 4); - assert.equal(events[1].level.toString(), 'WARN'); - }, - - 'should include the error if passed in': function(events) { - assert.instanceOf(events[2].data[1], Error); - assert.equal(events[2].data[1].message, 'Pants are on fire!'); - } - } - }, - - 'when shutdown is called': { - topic: function() { - var callback = this.callback; - var events = { - appenderShutdownCalled: false, - shutdownCallbackCalled: false - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/file': - { - name: "file", - appender: function() {}, - configure: function(configuration) { - return function() {}; - }, - shutdown: function(cb) { - events.appenderShutdownCalled = true; - cb(); - } - } - } - } - ), - config = { appenders: - [ { "type" : "file", - "filename" : "cheesy-wotsits.log", - "maxLogSize" : 1024, - "backups" : 3 - } - ] - }; - - log4js.configure(config); - log4js.shutdown(function shutdownCallback() { - events.shutdownCallbackCalled = true; - // Re-enable log writing so other tests that use logger are not - // affected. - require('../lib/logger').enableAllLogWrites(); - callback(null, events); - }); - }, - - 'should invoke appender shutdowns': function(events) { - assert.ok(events.appenderShutdownCalled); - }, - - 'should call callback': function(events) { - assert.ok(events.shutdownCallbackCalled); - } - }, - - 'invalid configuration': { - 'should throw an exception': function() { - assert.throws(function() { - require('log4js').configure({ "type": "invalid" }); - }); - } - }, - - 'configuration when passed as object': { - topic: function() { - var appenderConfig, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/file': - { - name: "file", - appender: function() {}, - configure: function(configuration) { - appenderConfig = configuration; - return function() {}; - } - } - } - } - ), - config = { appenders: - [ { "type" : "file", - "filename" : "cheesy-wotsits.log", - "maxLogSize" : 1024, - "backups" : 3 - } - ] - }; - log4js.configure(config); - return appenderConfig; - }, - 'should be passed to appender config': function(configuration) { - assert.equal(configuration.filename, 'cheesy-wotsits.log'); - } - }, - - 'configuration that causes an error': { - topic: function() { - var log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/file': - { - name: "file", - appender: function() {}, - configure: function(configuration) { - throw new Error("oh noes"); - } - } - } - } - ), - config = { appenders: - [ { "type" : "file", - "filename" : "cheesy-wotsits.log", - "maxLogSize" : 1024, - "backups" : 3 - } - ] - }; - try { - log4js.configure(config); - } catch (e) { - return e; - } - }, - 'should wrap error in a meaningful message': function(e) { - assert.ok(e.message.indexOf('log4js configuration problem for') > -1); - } - }, - - 'configuration when passed as filename': { - topic: function() { - var appenderConfig, - configFilename, - log4js = sandbox.require( - '../lib/log4js', - { requires: - { 'fs': - { statSync: - function() { - return { mtime: Date.now() }; - }, - readFileSync: - function(filename) { - configFilename = filename; - return JSON.stringify({ - appenders: [ - { type: "file" - , filename: "whatever.log" - } - ] - }); - }, - readdirSync: - function() { - return ['file']; - } - }, - './appenders/file': - { name: "file", - appender: function() {}, - configure: function(configuration) { - appenderConfig = configuration; - return function() {}; - } - } - } - } - ); - log4js.configure("/path/to/cheese.json"); - return [ configFilename, appenderConfig ]; - }, - 'should read the config from a file': function(args) { - assert.equal(args[0], '/path/to/cheese.json'); - }, - 'should pass config to appender': function(args) { - assert.equal(args[1].filename, "whatever.log"); - } - }, - - 'with no appenders defined' : { - topic: function() { - var logger, - that = this, - fakeConsoleAppender = { - name: "console", - appender: function() { - return function(evt) { - that.callback(null, evt); - }; - }, - configure: function() { - return fakeConsoleAppender.appender(); - } - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/console': fakeConsoleAppender - } - } - ); - logger = log4js.getLogger("some-logger"); - logger.debug("This is a test"); - }, - 'should default to the console appender': function(evt) { - assert.equal(evt.data[0], "This is a test"); - } - }, - - 'addAppender' : { - topic: function() { - var log4js = require('../lib/log4js'); - log4js.clearAppenders(); - return log4js; - }, - 'without a category': { - 'should register the function as a listener for all loggers': function (log4js) { - var appenderEvent, - appender = function(evt) { appenderEvent = evt; }, - logger = log4js.getLogger("tests"); - - log4js.addAppender(appender); - logger.debug("This is a test"); - assert.equal(appenderEvent.data[0], "This is a test"); - assert.equal(appenderEvent.categoryName, "tests"); - assert.equal(appenderEvent.level.toString(), "DEBUG"); - }, - 'if an appender for a category is defined': { - 'should register for that category': function (log4js) { - var otherEvent, - appenderEvent, - cheeseLogger; - - log4js.addAppender(function (evt) { appenderEvent = evt; }); - log4js.addAppender(function (evt) { otherEvent = evt; }, 'cheese'); - - cheeseLogger = log4js.getLogger('cheese'); - cheeseLogger.debug('This is a test'); - assert.deepEqual(appenderEvent, otherEvent); - assert.equal(otherEvent.data[0], 'This is a test'); - assert.equal(otherEvent.categoryName, 'cheese'); - - otherEvent = undefined; - appenderEvent = undefined; - log4js.getLogger('pants').debug("this should not be propagated to otherEvent"); - assert.isUndefined(otherEvent); - assert.equal(appenderEvent.data[0], "this should not be propagated to otherEvent"); - } - } - }, - - 'with a category': { - 'should only register the function as a listener for that category': function(log4js) { - var appenderEvent, - appender = function(evt) { appenderEvent = evt; }, - logger = log4js.getLogger("tests"); - - log4js.addAppender(appender, 'tests'); - logger.debug('this is a category test'); - assert.equal(appenderEvent.data[0], 'this is a category test'); - - appenderEvent = undefined; - log4js.getLogger('some other category').debug('Cheese'); - assert.isUndefined(appenderEvent); - } - }, - - 'with multiple categories': { - 'should register the function as a listener for all the categories': function(log4js) { - var appenderEvent, - appender = function(evt) { appenderEvent = evt; }, - logger = log4js.getLogger('tests'); - - log4js.addAppender(appender, 'tests', 'biscuits'); - - logger.debug('this is a test'); - assert.equal(appenderEvent.data[0], 'this is a test'); - appenderEvent = undefined; - - var otherLogger = log4js.getLogger('biscuits'); - otherLogger.debug("mmm... garibaldis"); - assert.equal(appenderEvent.data[0], "mmm... garibaldis"); - - appenderEvent = undefined; - - log4js.getLogger("something else").debug("pants"); - assert.isUndefined(appenderEvent); - }, - 'should register the function when the list of categories is an array': function(log4js) { - var appenderEvent, - appender = function(evt) { appenderEvent = evt; }; - - log4js.addAppender(appender, ['tests', 'pants']); - - log4js.getLogger('tests').debug('this is a test'); - assert.equal(appenderEvent.data[0], 'this is a test'); - - appenderEvent = undefined; - - log4js.getLogger('pants').debug("big pants"); - assert.equal(appenderEvent.data[0], "big pants"); - - appenderEvent = undefined; - - log4js.getLogger("something else").debug("pants"); - assert.isUndefined(appenderEvent); - } - } - }, - - 'default setup': { - topic: function() { - var appenderEvents = [], - fakeConsole = { - 'name': 'console', - 'appender': function () { - return function(evt) { - appenderEvents.push(evt); - }; - }, - 'configure': function (config) { - return fakeConsole.appender(); - } - }, - globalConsole = { - log: function() { } - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - './appenders/console': fakeConsole - }, - globals: { - console: globalConsole - } - } - ), - logger = log4js.getLogger('a-test'); - - logger.debug("this is a test"); - globalConsole.log("this should not be logged"); - - return appenderEvents; - }, - - 'should configure a console appender': function(appenderEvents) { - assert.equal(appenderEvents[0].data[0], 'this is a test'); - }, - - 'should not replace console.log with log4js version': function(appenderEvents) { - assert.equal(appenderEvents.length, 1); - } - }, - - 'console' : { - topic: setupConsoleTest, - - 'when replaceConsole called': { - topic: function(test) { - test.log4js.replaceConsole(); - - test.fakeConsole.log("Some debug message someone put in a module"); - test.fakeConsole.debug("Some debug"); - test.fakeConsole.error("An error"); - test.fakeConsole.info("some info"); - test.fakeConsole.warn("a warning"); - - test.fakeConsole.log("cheese (%s) and biscuits (%s)", "gouda", "garibaldis"); - test.fakeConsole.log({ lumpy: "tapioca" }); - test.fakeConsole.log("count %d", 123); - test.fakeConsole.log("stringify %j", { lumpy: "tapioca" }); - - return test.logEvents; - }, - - 'should replace console.log methods with log4js ones': function(logEvents) { - assert.equal(logEvents.length, 9); - assert.equal(logEvents[0].data[0], "Some debug message someone put in a module"); - assert.equal(logEvents[0].level.toString(), "INFO"); - assert.equal(logEvents[1].data[0], "Some debug"); - assert.equal(logEvents[1].level.toString(), "DEBUG"); - assert.equal(logEvents[2].data[0], "An error"); - assert.equal(logEvents[2].level.toString(), "ERROR"); - assert.equal(logEvents[3].data[0], "some info"); - assert.equal(logEvents[3].level.toString(), "INFO"); - assert.equal(logEvents[4].data[0], "a warning"); - assert.equal(logEvents[4].level.toString(), "WARN"); - assert.equal(logEvents[5].data[0], "cheese (%s) and biscuits (%s)"); - assert.equal(logEvents[5].data[1], "gouda"); - assert.equal(logEvents[5].data[2], "garibaldis"); - } - }, - 'when turned off': { - topic: function(test) { - test.log4js.restoreConsole(); - try { - test.fakeConsole.log("This should cause the error described in the setup"); - } catch (e) { - return e; - } - }, - 'should call the original console methods': function (err) { - assert.instanceOf(err, Error); - assert.equal(err.message, "this should not be called."); - } - } - }, - 'console configuration': { - topic: setupConsoleTest, - 'when disabled': { - topic: function(test) { - test.log4js.replaceConsole(); - test.log4js.configure({ replaceConsole: false }); - try { - test.fakeConsole.log("This should cause the error described in the setup"); - } catch (e) { - return e; - } - }, - 'should allow for turning off console replacement': function (err) { - assert.instanceOf(err, Error); - assert.equal(err.message, 'this should not be called.'); - } - }, - 'when enabled': { - topic: function(test) { - test.log4js.restoreConsole(); - test.log4js.configure({ replaceConsole: true }); - //log4js.configure clears all appenders - test.log4js.addAppender(function(evt) { - test.logEvents.push(evt); - }); - - test.fakeConsole.debug("Some debug"); - return test.logEvents; - }, - - 'should allow for turning on console replacement': function (logEvents) { - assert.equal(logEvents.length, 1); - assert.equal(logEvents[0].level.toString(), "DEBUG"); - assert.equal(logEvents[0].data[0], "Some debug"); - } - } - }, - 'configuration persistence' : { - topic: function() { - var logEvent, - firstLog4js = require('../lib/log4js'), - secondLog4js; - - firstLog4js.clearAppenders(); - firstLog4js.addAppender(function(evt) { logEvent = evt; }); - - secondLog4js = require('../lib/log4js'); - secondLog4js.getLogger().info("This should go to the appender defined in firstLog4js"); - - return logEvent; - }, - 'should maintain appenders between requires': function (logEvent) { - assert.equal(logEvent.data[0], "This should go to the appender defined in firstLog4js"); - } - }, - - 'getDefaultLogger': { - topic: function() { - return require('../lib/log4js').getDefaultLogger(); - }, - 'should return a logger': function(logger) { - assert.ok(logger.info); - assert.ok(logger.debug); - assert.ok(logger.error); - } - } -}).export(module); diff --git a/test/logglyAppender-test.js b/test/logglyAppender-test.js index 688e43ee..e9d391c5 100644 --- a/test/logglyAppender-test.js +++ b/test/logglyAppender-test.js @@ -1,5 +1,5 @@ "use strict"; -var vows = require('vows') +var should = require('should') , assert = require('assert') , log4js = require('../lib/log4js') , sandbox = require('sandboxed-module') @@ -60,7 +60,7 @@ function setupLogging(category, options) { }; } -log4js.clearAppenders(); +zlog4js.clearAppenders(); function setupTaggedLogging() { return setupLogging('loggly', { diff --git a/test/multiprocess-test.js b/test/multiprocess-test.js deleted file mode 100644 index d193e836..00000000 --- a/test/multiprocess-test.js +++ /dev/null @@ -1,317 +0,0 @@ -"use strict"; -var vows = require('vows') -, sandbox = require('sandboxed-module') -, assert = require('assert') -; - -function makeFakeNet() { - return { - logEvents: [], - data: [], - cbs: {}, - createConnectionCalled: 0, - fakeAppender: function(logEvent) { - this.logEvents.push(logEvent); - }, - createConnection: function(port, host) { - var fakeNet = this; - this.port = port; - this.host = host; - this.createConnectionCalled += 1; - return { - on: function(evt, cb) { - fakeNet.cbs[evt] = cb; - }, - write: function(data, encoding) { - fakeNet.data.push(data); - fakeNet.encoding = encoding; - }, - end: function() { - fakeNet.closeCalled = true; - } - }; - }, - createServer: function(cb) { - var fakeNet = this; - cb({ - remoteAddress: '1.2.3.4', - remotePort: '1234', - setEncoding: function(encoding) { - fakeNet.encoding = encoding; - }, - on: function(event, cb) { - fakeNet.cbs[event] = cb; - } - }); - - return { - listen: function(port, host) { - fakeNet.port = port; - fakeNet.host = host; - } - }; - } - }; -} - -vows.describe('Multiprocess Appender').addBatch({ - 'worker': { - topic: function() { - var fakeNet = makeFakeNet(), - appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet - } - } - ).appender({ mode: 'worker', loggerPort: 1234, loggerHost: 'pants' }); - - //don't need a proper log event for the worker tests - appender('before connect'); - fakeNet.cbs.connect(); - appender('after connect'); - fakeNet.cbs.close(true); - appender('after error, before connect'); - fakeNet.cbs.connect(); - appender('after error, after connect'); - appender(new Error('Error test')); - - return fakeNet; - }, - 'should open a socket to the loggerPort and loggerHost': function(net) { - assert.equal(net.port, 1234); - assert.equal(net.host, 'pants'); - }, - 'should buffer messages written before socket is connected': function(net) { - assert.equal(net.data[0], JSON.stringify('before connect')); - }, - 'should write log messages to socket as json strings with a terminator string': function(net) { - assert.equal(net.data[0], JSON.stringify('before connect')); - assert.equal(net.data[1], '__LOG4JS__'); - assert.equal(net.data[2], JSON.stringify('after connect')); - assert.equal(net.data[3], '__LOG4JS__'); - assert.equal(net.encoding, 'utf8'); - }, - 'should attempt to re-open the socket on error': function(net) { - assert.equal(net.data[4], JSON.stringify('after error, before connect')); - assert.equal(net.data[5], '__LOG4JS__'); - assert.equal(net.data[6], JSON.stringify('after error, after connect')); - assert.equal(net.data[7], '__LOG4JS__'); - assert.equal(net.createConnectionCalled, 2); - }, - 'should serialize an Error correctly': function(net) { - assert( - JSON.parse(net.data[8]).stack, - "Expected:\n\n" + net.data[8] + "\n\n to have a 'stack' property" - ); - var actual = JSON.parse(net.data[8]).stack; - var expectedRegex = /^Error: Error test/; - assert( - actual.match(expectedRegex), - "Expected: \n\n " + actual + "\n\n to match " + expectedRegex - ); - - } - }, - 'worker with timeout': { - topic: function() { - var fakeNet = makeFakeNet(), - appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet - } - } - ).appender({ mode: 'worker' }); - - //don't need a proper log event for the worker tests - appender('before connect'); - fakeNet.cbs.connect(); - appender('after connect'); - fakeNet.cbs.timeout(); - appender('after timeout, before close'); - fakeNet.cbs.close(); - appender('after close, before connect'); - fakeNet.cbs.connect(); - appender('after close, after connect'); - - return fakeNet; - }, - 'should attempt to re-open the socket': function(net) { - //skipping the __LOG4JS__ separators - assert.equal(net.data[0], JSON.stringify('before connect')); - assert.equal(net.data[2], JSON.stringify('after connect')); - assert.equal(net.data[4], JSON.stringify('after timeout, before close')); - assert.equal(net.data[6], JSON.stringify('after close, before connect')); - assert.equal(net.data[8], JSON.stringify('after close, after connect')); - assert.equal(net.createConnectionCalled, 2); - } - }, - 'worker defaults': { - topic: function() { - var fakeNet = makeFakeNet(), - appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet - } - } - ).appender({ mode: 'worker' }); - - return fakeNet; - }, - 'should open a socket to localhost:5000': function(net) { - assert.equal(net.port, 5000); - assert.equal(net.host, 'localhost'); - } - }, - 'master': { - topic: function() { - var fakeNet = makeFakeNet(), - appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet - } - } - ).appender({ mode: 'master', - loggerHost: 'server', - loggerPort: 1234, - actualAppender: fakeNet.fakeAppender.bind(fakeNet) - }); - - appender('this should be sent to the actual appender directly'); - - return fakeNet; - }, - 'should listen for log messages on loggerPort and loggerHost': function(net) { - assert.equal(net.port, 1234); - assert.equal(net.host, 'server'); - }, - 'should return the underlying appender': function(net) { - assert.equal(net.logEvents[0], 'this should be sent to the actual appender directly'); - }, - 'when a client connects': { - topic: function(net) { - var logString = JSON.stringify( - { level: { level: 10000, levelStr: 'DEBUG' } - , data: ['some debug']} - ) + '__LOG4JS__'; - - net.cbs.data( - JSON.stringify( - { level: { level: 40000, levelStr: 'ERROR' } - , data: ['an error message'] } - ) + '__LOG4JS__' - ); - net.cbs.data(logString.substring(0, 10)); - net.cbs.data(logString.substring(10)); - net.cbs.data(logString + logString + logString); - net.cbs.end( - JSON.stringify( - { level: { level: 50000, levelStr: 'FATAL' } - , data: ["that's all folks"] } - ) + '__LOG4JS__' - ); - net.cbs.data('bad message__LOG4JS__'); - return net; - }, - 'should parse log messages into log events and send to appender': function(net) { - assert.equal(net.logEvents[1].level.toString(), 'ERROR'); - assert.equal(net.logEvents[1].data[0], 'an error message'); - assert.equal(net.logEvents[1].remoteAddress, '1.2.3.4'); - assert.equal(net.logEvents[1].remotePort, '1234'); - }, - 'should parse log messages split into multiple chunks': function(net) { - assert.equal(net.logEvents[2].level.toString(), 'DEBUG'); - assert.equal(net.logEvents[2].data[0], 'some debug'); - assert.equal(net.logEvents[2].remoteAddress, '1.2.3.4'); - assert.equal(net.logEvents[2].remotePort, '1234'); - }, - 'should parse multiple log messages in a single chunk': function(net) { - assert.equal(net.logEvents[3].data[0], 'some debug'); - assert.equal(net.logEvents[4].data[0], 'some debug'); - assert.equal(net.logEvents[5].data[0], 'some debug'); - }, - 'should handle log messages sent as part of end event': function(net) { - assert.equal(net.logEvents[6].data[0], "that's all folks"); - }, - 'should handle unparseable log messages': function(net) { - assert.equal(net.logEvents[7].level.toString(), 'ERROR'); - assert.equal(net.logEvents[7].categoryName, 'log4js'); - assert.equal(net.logEvents[7].data[0], 'Unable to parse log:'); - assert.equal(net.logEvents[7].data[1], 'bad message'); - } - } - }, - 'master defaults': { - topic: function() { - var fakeNet = makeFakeNet(), - appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet - } - } - ).appender({ mode: 'master' }); - - return fakeNet; - }, - 'should listen for log messages on localhost:5000': function(net) { - assert.equal(net.port, 5000); - assert.equal(net.host, 'localhost'); - } - } -}).addBatch({ - 'configure': { - topic: function() { - var results = {} - , fakeNet = makeFakeNet() - , appender = sandbox.require( - '../lib/appenders/multiprocess', - { - requires: { - 'net': fakeNet, - '../log4js': { - loadAppender: function(app) { - results.appenderLoaded = app; - }, - appenderMakers: { - 'madeupappender': function(config, options) { - results.config = config; - results.options = options; - } - } - } - } - } - ).configure( - { - mode: 'master', - appender: { - type: 'madeupappender', - cheese: 'gouda' - } - }, - { crackers: 'jacobs' } - ); - - return results; - - }, - 'should load underlying appender for master': function(results) { - assert.equal(results.appenderLoaded, 'madeupappender'); - }, - 'should pass config to underlying appender': function(results) { - assert.equal(results.config.cheese, 'gouda'); - }, - 'should pass options to underlying appender': function(results) { - assert.equal(results.options.crackers, 'jacobs'); - } - } -}).exportTo(module); diff --git a/test/nolog-test.js b/test/nolog-test.js deleted file mode 100644 index 80c3c184..00000000 --- a/test/nolog-test.js +++ /dev/null @@ -1,297 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, util = require('util') -, EE = require('events').EventEmitter -, levels = require('../lib/levels'); - -function MockLogger() { - - var that = this; - this.messages = []; - - this.log = function(level, message, exception) { - that.messages.push({ level: level, message: message }); - }; - - this.isLevelEnabled = function(level) { - return level.isGreaterThanOrEqualTo(that.level); - }; - - this.level = levels.TRACE; - -} - -function MockRequest(remoteAddr, method, originalUrl) { - - this.socket = { remoteAddress: remoteAddr }; - this.originalUrl = originalUrl; - this.method = method; - this.httpVersionMajor = '5'; - this.httpVersionMinor = '0'; - this.headers = {}; -} - -function MockResponse(statusCode) { - var r = this; - this.statusCode = statusCode; - - this.end = function(chunk, encoding) { - r.emit('finish'); - }; -} -util.inherits(MockResponse, EE); - -vows.describe('log4js connect logger').addBatch({ - 'getConnectLoggerModule': { - topic: function() { - var clm = require('../lib/connect-logger'); - return clm; - }, - - 'should return a "connect logger" factory' : function(clm) { - assert.isObject(clm); - }, - - 'nolog String' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml, { nolog: "\\.gif" }); - return {cl: cl, ml: ml}; - }, - - 'check unmatch url request': { - topic: function(d){ - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.png'); // not gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - },10); - }, - 'check message': function(messages){ - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.include(messages[0].message, 'GET'); - assert.include(messages[0].message, 'http://url'); - assert.include(messages[0].message, 'my.remote.addr'); - assert.include(messages[0].message, '200'); - messages.pop(); - } - }, - - 'check match url request': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.gif'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - },10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - } - }, - - 'nolog Strings' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml, {nolog: "\\.gif|\\.jpe?g"}); - return {cl: cl, ml: ml}; - }, - - 'check unmatch url request (png)': { - topic: function(d){ - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.png'); // not gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages){ - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.include(messages[0].message, 'GET'); - assert.include(messages[0].message, 'http://url'); - assert.include(messages[0].message, 'my.remote.addr'); - assert.include(messages[0].message, '200'); - messages.pop(); - } - }, - - 'check match url request (gif)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.gif'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - }, - 'check match url request (jpeg)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.jpeg'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - } - }, - 'nolog Array' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml, {nolog: ["\\.gif", "\\.jpe?g"]}); - return {cl: cl, ml: ml}; - }, - - 'check unmatch url request (png)': { - topic: function(d){ - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.png'); // not gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages){ - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.include(messages[0].message, 'GET'); - assert.include(messages[0].message, 'http://url'); - assert.include(messages[0].message, 'my.remote.addr'); - assert.include(messages[0].message, '200'); - messages.pop(); - } - }, - - 'check match url request (gif)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.gif'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - }, - - 'check match url request (jpeg)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.jpeg'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - }, - }, - 'nolog RegExp' : { - topic: function(clm) { - var ml = new MockLogger(); - var cl = clm.connectLogger(ml, {nolog: /\.gif|\.jpe?g/}); - return {cl: cl, ml: ml}; - }, - - 'check unmatch url request (png)': { - topic: function(d){ - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.png'); // not gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages){ - assert.isArray(messages); - assert.equal(messages.length, 1); - assert.ok(levels.INFO.isEqualTo(messages[0].level)); - assert.include(messages[0].message, 'GET'); - assert.include(messages[0].message, 'http://url'); - assert.include(messages[0].message, 'my.remote.addr'); - assert.include(messages[0].message, '200'); - messages.pop(); - } - }, - - 'check match url request (gif)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.gif'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - }, - - 'check match url request (jpeg)': { - topic: function(d) { - var req = new MockRequest('my.remote.addr', 'GET', 'http://url/hoge.jpeg'); // gif - var res = new MockResponse(200); - var cb = this.callback; - d.cl(req, res, function() { }); - res.end('chunk', 'encoding'); - setTimeout(function() { - cb(null, d.ml.messages); - }, 10); - }, - 'check message': function(messages) { - assert.isArray(messages); - assert.equal(messages.length, 0); - } - } - } - } - -}).export(module); diff --git a/test/reloadConfiguration-test.js b/test/reloadConfiguration-test.js deleted file mode 100644 index 060f0895..00000000 --- a/test/reloadConfiguration-test.js +++ /dev/null @@ -1,340 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, sandbox = require('sandboxed-module'); - -function setupConsoleTest() { - var fakeConsole = {} - , logEvents = [] - , log4js; - - ['trace','debug','log','info','warn','error'].forEach(function(fn) { - fakeConsole[fn] = function() { - throw new Error("this should not be called."); - }; - }); - - log4js = sandbox.require( - '../lib/log4js', - { - globals: { - console: fakeConsole - } - } - ); - - log4js.clearAppenders(); - log4js.addAppender(function(evt) { - logEvents.push(evt); - }); - - return { log4js: log4js, logEvents: logEvents, fakeConsole: fakeConsole }; -} - -vows.describe('reload configuration').addBatch({ - 'with config file changing' : { - topic: function() { - var pathsChecked = [], - logEvents = [], - logger, - modulePath = 'path/to/log4js.json', - fakeFS = { - lastMtime: Date.now(), - config: { - appenders: [ - { type: 'console', layout: { type: 'messagePassThrough' } } - ], - levels: { 'a-test' : 'INFO' } - }, - readFileSync: function (file, encoding) { - assert.equal(file, modulePath); - assert.equal(encoding, 'utf8'); - return JSON.stringify(fakeFS.config); - }, - statSync: function (path) { - pathsChecked.push(path); - if (path === modulePath) { - fakeFS.lastMtime += 1; - return { mtime: new Date(fakeFS.lastMtime) }; - } else { - throw new Error("no such file"); - } - } - }, - fakeConsole = { - 'name': 'console', - 'appender': function () { - return function(evt) { logEvents.push(evt); }; - }, - 'configure': function (config) { - return fakeConsole.appender(); - } - }, - setIntervalCallback, - fakeSetInterval = function(cb, timeout) { - setIntervalCallback = cb; - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - 'fs': fakeFS, - './appenders/console': fakeConsole - }, - globals: { - 'console': fakeConsole, - 'setInterval' : fakeSetInterval, - } - } - ); - - log4js.configure('path/to/log4js.json', { reloadSecs: 30 }); - logger = log4js.getLogger('a-test'); - logger.info("info1"); - logger.debug("debug2 - should be ignored"); - fakeFS.config.levels['a-test'] = "DEBUG"; - setIntervalCallback(); - logger.info("info3"); - logger.debug("debug4"); - - return logEvents; - }, - 'should configure log4js from first log4js.json found': function(logEvents) { - assert.equal(logEvents[0].data[0], 'info1'); - assert.equal(logEvents[1].data[0], 'info3'); - assert.equal(logEvents[2].data[0], 'debug4'); - assert.equal(logEvents.length, 3); - } - }, - - 'with config file staying the same' : { - topic: function() { - var pathsChecked = [], - fileRead = 0, - logEvents = [], - logger, - modulePath = require('path').normalize(__dirname + '/../lib/log4js.json'), - mtime = new Date(), - fakeFS = { - config: { - appenders: [ - { type: 'console', layout: { type: 'messagePassThrough' } } - ], - levels: { 'a-test' : 'INFO' } - }, - readFileSync: function (file, encoding) { - fileRead += 1; - assert.isString(file); - assert.equal(file, modulePath); - assert.equal(encoding, 'utf8'); - return JSON.stringify(fakeFS.config); - }, - statSync: function (path) { - pathsChecked.push(path); - if (path === modulePath) { - return { mtime: mtime }; - } else { - throw new Error("no such file"); - } - } - }, - fakeConsole = { - 'name': 'console', - 'appender': function () { - return function(evt) { logEvents.push(evt); }; - }, - 'configure': function (config) { - return fakeConsole.appender(); - } - }, - setIntervalCallback, - fakeSetInterval = function(cb, timeout) { - setIntervalCallback = cb; - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - 'fs': fakeFS, - './appenders/console': fakeConsole - }, - globals: { - 'console': fakeConsole, - 'setInterval' : fakeSetInterval, - } - } - ); - - log4js.configure(modulePath, { reloadSecs: 3 }); - logger = log4js.getLogger('a-test'); - logger.info("info1"); - logger.debug("debug2 - should be ignored"); - setIntervalCallback(); - logger.info("info3"); - logger.debug("debug4"); - - return [ pathsChecked, logEvents, modulePath, fileRead ]; - }, - 'should only read the configuration file once': function(args) { - var fileRead = args[3]; - assert.equal(fileRead, 1); - }, - 'should configure log4js from first log4js.json found': function(args) { - var logEvents = args[1]; - assert.equal(logEvents.length, 2); - assert.equal(logEvents[0].data[0], 'info1'); - assert.equal(logEvents[1].data[0], 'info3'); - } - }, - - 'when config file is removed': { - topic: function() { - var pathsChecked = [], - fileRead = 0, - logEvents = [], - logger, - modulePath = require('path').normalize(__dirname + '/../lib/log4js.json'), - mtime = new Date(), - fakeFS = { - config: { - appenders: [ - { type: 'console', layout: { type: 'messagePassThrough' } } - ], - levels: { 'a-test' : 'INFO' } - }, - readFileSync: function (file, encoding) { - fileRead += 1; - assert.isString(file); - assert.equal(file, modulePath); - assert.equal(encoding, 'utf8'); - return JSON.stringify(fakeFS.config); - }, - statSync: function (path) { - this.statSync = function() { - throw new Error("no such file"); - }; - return { mtime: new Date() }; - } - }, - fakeConsole = { - 'name': 'console', - 'appender': function () { - return function(evt) { logEvents.push(evt); }; - }, - 'configure': function (config) { - return fakeConsole.appender(); - } - }, - setIntervalCallback, - fakeSetInterval = function(cb, timeout) { - setIntervalCallback = cb; - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - 'fs': fakeFS, - './appenders/console': fakeConsole - }, - globals: { - 'console': fakeConsole, - 'setInterval' : fakeSetInterval, - } - } - ); - - log4js.configure(modulePath, { reloadSecs: 3 }); - logger = log4js.getLogger('a-test'); - logger.info("info1"); - logger.debug("debug2 - should be ignored"); - setIntervalCallback(); - logger.info("info3"); - logger.debug("debug4"); - - return [ pathsChecked, logEvents, modulePath, fileRead ]; - }, - 'should only read the configuration file once': function(args) { - var fileRead = args[3]; - assert.equal(fileRead, 1); - }, - 'should not clear configuration when config file not found': function(args) { - var logEvents = args[1]; - assert.equal(logEvents.length, 3); - assert.equal(logEvents[0].data[0], 'info1'); - assert.equal(logEvents[1].level.toString(), 'WARN'); - assert.include(logEvents[1].data[0], 'Failed to load configuration file'); - assert.equal(logEvents[2].data[0], 'info3'); - } - }, - - 'when passed an object': { - topic: function() { - var test = setupConsoleTest(); - test.log4js.configure({}, { reloadSecs: 30 }); - return test.logEvents; - }, - 'should log a warning': function(events) { - assert.equal(events[0].level.toString(), 'WARN'); - assert.equal( - events[0].data[0], - 'Ignoring configuration reload parameter for "object" configuration.' - ); - } - }, - - 'when called twice with reload options': { - topic: function() { - var modulePath = require('path').normalize(__dirname + '/../lib/log4js.json'), - fakeFS = { - readFileSync: function (file, encoding) { - return JSON.stringify({}); - }, - statSync: function (path) { - return { mtime: new Date() }; - } - }, - fakeConsole = { - 'name': 'console', - 'appender': function () { - return function(evt) { }; - }, - 'configure': function (config) { - return fakeConsole.appender(); - } - }, - setIntervalCallback, - intervalCleared = false, - clearedId, - fakeSetInterval = function(cb, timeout) { - setIntervalCallback = cb; - return 1234; - }, - log4js = sandbox.require( - '../lib/log4js', - { - requires: { - 'fs': fakeFS, - './appenders/console': fakeConsole - }, - globals: { - 'console': fakeConsole, - 'setInterval' : fakeSetInterval, - 'clearInterval': function(interval) { - intervalCleared = true; - clearedId = interval; - } - } - } - ); - - log4js.configure(modulePath, { reloadSecs: 3 }); - log4js.configure(modulePath, { reloadSecs: 15 }); - - return { cleared: intervalCleared, id: clearedId }; - }, - 'should clear the previous interval': function(result) { - assert.isTrue(result.cleared); - assert.equal(result.id, 1234); - } - } -}).exportTo(module); diff --git a/test/setLevel-asymmetry-test.js b/test/setLevel-asymmetry-test.js deleted file mode 100644 index 95ba84b4..00000000 --- a/test/setLevel-asymmetry-test.js +++ /dev/null @@ -1,100 +0,0 @@ -"use strict"; -/* jshint loopfunc: true */ -// This test shows an asymmetry between setLevel and isLevelEnabled -// (in log4js-node@0.4.3 and earlier): -// 1) setLevel("foo") works, but setLevel(log4js.levels.foo) silently -// does not (sets the level to TRACE). -// 2) isLevelEnabled("foo") works as does isLevelEnabled(log4js.levels.foo). -// - -// Basic set up -var vows = require('vows'); -var assert = require('assert'); -var log4js = require('../lib/log4js'); -var logger = log4js.getLogger('test-setLevel-asymmetry'); - -// uncomment one or other of the following to see progress (or not) while running the tests -// var showProgress = console.log; -var showProgress = function() {}; - - -// Define the array of levels as string to iterate over. -var strLevels= ['Trace','Debug','Info','Warn','Error','Fatal']; - -var log4jsLevels =[]; -// populate an array with the log4js.levels that match the strLevels. -// Would be nice if we could iterate over log4js.levels instead, -// but log4js.levels.toLevel prevents that for now. -strLevels.forEach(function(l) { - log4jsLevels.push(log4js.levels.toLevel(l)); -}); - - -// We are going to iterate over this object's properties to define an exhaustive list of vows. -var levelTypes = { - 'string': strLevels, - 'log4js.levels.level': log4jsLevels, -}; - -// Set up the basic vows batch for this test -var batch = { - setLevel: { - } -}; - -showProgress('Populating batch object...'); - -// Populating the batch object programmatically, -// as I don't have the patience to manually populate it with -// the (strLevels.length x levelTypes.length) ^ 2 = 144 possible test combinations -for (var type in levelTypes) { - var context = 'is called with a '+type; - var levelsToTest = levelTypes[type]; - showProgress('Setting up the vows context for '+context); - - batch.setLevel[context]= {}; - levelsToTest.forEach( function(level) { - var subContext = 'of '+level; - var log4jsLevel=log4js.levels.toLevel(level.toString()); - - showProgress('Setting up the vows sub-context for '+subContext); - batch.setLevel[context][subContext] = {topic: level}; - for (var comparisonType in levelTypes) { - levelTypes[comparisonType].forEach(function(comparisonLevel) { - var t = type; - var ct = comparisonType; - var expectedResult = log4jsLevel.isLessThanOrEqualTo(comparisonLevel); - var vow = 'isLevelEnabled(' + comparisonLevel + - ') called with a ' + comparisonType + - ' should return ' + expectedResult; - showProgress('Setting up the vows vow for '+vow); - - batch.setLevel[context][subContext][vow] = function(levelToSet) { - logger.setLevel(levelToSet); - showProgress( - '*** Checking setLevel( ' + level + - ' ) of type ' + t + - ', and isLevelEnabled( ' + comparisonLevel + - ' ) of type ' + ct + '. Expecting: ' + expectedResult - ); - assert.equal( - logger.isLevelEnabled(comparisonLevel), - expectedResult, - 'Failed: calling setLevel( ' + level + - ' ) with type ' + type + - ', isLevelEnabled( ' + comparisonLevel + - ' ) of type ' + comparisonType + - ' did not return ' + expectedResult - ); - }; - }); - } - }); - -} - -showProgress('Running tests...'); - -vows.describe('log4js setLevel asymmetry fix').addBatch(batch).export(module); - - diff --git a/test/smtpAppender-test.js b/test/smtpAppender-test.js deleted file mode 100644 index 5ebda98a..00000000 --- a/test/smtpAppender-test.js +++ /dev/null @@ -1,318 +0,0 @@ -"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); diff --git a/test/streams/BaseRollingFileStream-test.js b/test/streams/BaseRollingFileStream-test.js deleted file mode 100644 index a414d5a5..00000000 --- a/test/streams/BaseRollingFileStream-test.js +++ /dev/null @@ -1,93 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, fs = require('fs') -, sandbox = require('sandboxed-module'); - -vows.describe('../../lib/streams/BaseRollingFileStream').addBatch({ - 'when node version < 0.10.0': { - topic: function() { - var streamLib = sandbox.load( - '../../lib/streams/BaseRollingFileStream', - { - globals: { - process: { - version: '0.8.11' - } - }, - requires: { - 'readable-stream': { - Writable: function() {} - } - } - } - ); - return streamLib.required; - }, - 'it should use readable-stream to maintain compatibility': function(required) { - assert.ok(required['readable-stream']); - assert.ok(!required.stream); - } - }, - - 'when node version > 0.10.0': { - topic: function() { - var streamLib = sandbox.load( - '../../lib/streams/BaseRollingFileStream', - { - globals: { - process: { - version: '0.10.1' - } - }, - requires: { - 'stream': { - Writable: function() {} - } - } - } - ); - return streamLib.required; - }, - 'it should use the core stream module': function(required) { - assert.ok(required.stream); - assert.ok(!required['readable-stream']); - } - }, - - 'when no filename is passed': { - topic: require('../../lib/streams/BaseRollingFileStream'), - 'it should throw an error': function(BaseRollingFileStream) { - try { - new BaseRollingFileStream(); - assert.fail('should not get here'); - } catch (e) { - assert.ok(e); - } - } - }, - - 'default behaviour': { - topic: function() { - var BaseRollingFileStream = require('../../lib/streams/BaseRollingFileStream') - , stream = new BaseRollingFileStream('basetest.log'); - return stream; - }, - teardown: function() { - try { - fs.unlink('basetest.log'); - } catch (e) { - console.error("could not remove basetest.log", e); - } - }, - 'it should not want to roll': function(stream) { - assert.isFalse(stream.shouldRoll()); - }, - 'it should not roll': function(stream) { - var cbCalled = false; - //just calls the callback straight away, no async calls - stream.roll('basetest.log', function() { cbCalled = true; }); - assert.isTrue(cbCalled); - } - } -}).exportTo(module); diff --git a/test/streams/DateRollingFileStream-test.js b/test/streams/DateRollingFileStream-test.js deleted file mode 100644 index 33f014b2..00000000 --- a/test/streams/DateRollingFileStream-test.js +++ /dev/null @@ -1,227 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, fs = require('fs') -, semver = require('semver') -, streams -, DateRollingFileStream -, testTime = new Date(2012, 8, 12, 10, 37, 11); - -if (semver.satisfies(process.version, '>=0.10.0')) { - streams = require('stream'); -} else { - streams = require('readable-stream'); -} -DateRollingFileStream = require('../../lib/streams').DateRollingFileStream; - -function cleanUp(filename) { - return function() { - fs.unlink(filename); - }; -} - -function now() { - return testTime.getTime(); -} - -vows.describe('DateRollingFileStream').addBatch({ - 'arguments': { - topic: new DateRollingFileStream( - __dirname + '/test-date-rolling-file-stream-1', - 'yyyy-mm-dd.hh' - ), - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-1'), - - 'should take a filename and a pattern and return a WritableStream': function(stream) { - assert.equal(stream.filename, __dirname + '/test-date-rolling-file-stream-1'); - assert.equal(stream.pattern, 'yyyy-mm-dd.hh'); - assert.instanceOf(stream, streams.Writable); - }, - 'with default settings for the underlying stream': function(stream) { - assert.equal(stream.theStream.mode, 420); - assert.equal(stream.theStream.flags, 'a'); - //encoding is not available on the underlying stream - //assert.equal(stream.encoding, 'utf8'); - } - }, - - 'default arguments': { - topic: new DateRollingFileStream(__dirname + '/test-date-rolling-file-stream-2'), - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-2'), - - 'pattern should be .yyyy-MM-dd': function(stream) { - assert.equal(stream.pattern, '.yyyy-MM-dd'); - } - }, - - 'with stream arguments': { - topic: new DateRollingFileStream( - __dirname + '/test-date-rolling-file-stream-3', - 'yyyy-MM-dd', - { mode: parseInt('0666', 8) } - ), - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-3'), - - 'should pass them to the underlying stream': function(stream) { - assert.equal(stream.theStream.mode, parseInt('0666', 8)); - } - }, - - 'with stream arguments but no pattern': { - topic: new DateRollingFileStream( - __dirname + '/test-date-rolling-file-stream-4', - { mode: parseInt('0666', 8) } - ), - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-4'), - - 'should pass them to the underlying stream': function(stream) { - assert.equal(stream.theStream.mode, parseInt('0666', 8)); - }, - 'should use default pattern': function(stream) { - assert.equal(stream.pattern, '.yyyy-MM-dd'); - } - }, - - 'with a pattern of .yyyy-MM-dd': { - topic: function() { - var that = this, - stream = new DateRollingFileStream( - __dirname + '/test-date-rolling-file-stream-5', '.yyyy-MM-dd', - null, - now - ); - stream.write("First message\n", 'utf8', function() { - that.callback(null, stream); - }); - }, - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-5'), - - 'should create a file with the base name': { - topic: function(stream) { - fs.readFile(__dirname + '/test-date-rolling-file-stream-5', this.callback); - }, - 'file should contain first message': function(result) { - assert.equal(result.toString(), "First message\n"); - } - }, - - 'when the day changes': { - topic: function(stream) { - testTime = new Date(2012, 8, 13, 0, 10, 12); - stream.write("Second message\n", 'utf8', this.callback); - }, - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-5.2012-09-12'), - - - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'should be two': function(files) { - assert.equal( - files.filter( - function(file) { - return file.indexOf('test-date-rolling-file-stream-5') > -1; - } - ).length, - 2 - ); - } - }, - - 'the file without a date': { - topic: function() { - fs.readFile(__dirname + '/test-date-rolling-file-stream-5', this.callback); - }, - 'should contain the second message': function(contents) { - assert.equal(contents.toString(), "Second message\n"); - } - }, - - 'the file with the date': { - topic: function() { - fs.readFile(__dirname + '/test-date-rolling-file-stream-5.2012-09-12', this.callback); - }, - 'should contain the first message': function(contents) { - assert.equal(contents.toString(), "First message\n"); - } - } - } - }, - - 'with alwaysIncludePattern': { - topic: function() { - var that = this, - testTime = new Date(2012, 8, 12, 0, 10, 12), - stream = new DateRollingFileStream( - __dirname + '/test-date-rolling-file-stream-pattern', - '.yyyy-MM-dd', - {alwaysIncludePattern: true}, - now - ); - stream.write("First message\n", 'utf8', function() { - that.callback(null, stream); - }); - }, - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-12'), - - 'should create a file with the pattern set': { - topic: function(stream) { - fs.readFile(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-12', this.callback); - }, - 'file should contain first message': function(result) { - assert.equal(result.toString(), "First message\n"); - } - }, - - 'when the day changes': { - topic: function(stream) { - testTime = new Date(2012, 8, 13, 0, 10, 12); - stream.write("Second message\n", 'utf8', this.callback); - }, - teardown: cleanUp(__dirname + '/test-date-rolling-file-stream-pattern.2012-09-13'), - - - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'should be two': function(files) { - assert.equal( - files.filter( - function(file) { - return file.indexOf('test-date-rolling-file-stream-pattern') > -1; - } - ).length, - 2 - ); - } - }, - - 'the file with the later date': { - topic: function() { - fs.readFile( - __dirname + '/test-date-rolling-file-stream-pattern.2012-09-13', - this.callback - ); - }, - 'should contain the second message': function(contents) { - assert.equal(contents.toString(), "Second message\n"); - } - }, - - 'the file with the date': { - topic: function() { - fs.readFile( - __dirname + '/test-date-rolling-file-stream-pattern.2012-09-12', - this.callback - ); - }, - 'should contain the first message': function(contents) { - assert.equal(contents.toString(), "First message\n"); - } - } - } - } - -}).exportTo(module); diff --git a/test/streams/rollingFileStream-test.js b/test/streams/rollingFileStream-test.js deleted file mode 100644 index c3d9fc32..00000000 --- a/test/streams/rollingFileStream-test.js +++ /dev/null @@ -1,207 +0,0 @@ -"use strict"; -var vows = require('vows') -, assert = require('assert') -, events = require('events') -, fs = require('fs') -, semver = require('semver') -, streams -, RollingFileStream; - -if (semver.satisfies(process.version, '>=0.10.0')) { - streams = require('stream'); -} else { - streams = require('readable-stream'); -} -RollingFileStream = require('../../lib/streams').RollingFileStream; - -function remove(filename) { - try { - fs.unlinkSync(filename); - } catch (e) { - //doesn't really matter if it failed - } -} - -function create(filename) { - fs.writeFileSync(filename, "test file"); -} - -vows.describe('RollingFileStream').addBatch({ - 'arguments': { - topic: function() { - remove(__dirname + "/test-rolling-file-stream"); - return new RollingFileStream("test-rolling-file-stream", 1024, 5); - }, - 'should take a filename, file size (bytes), no. backups, return Writable': function(stream) { - assert.instanceOf(stream, streams.Writable); - assert.equal(stream.filename, "test-rolling-file-stream"); - assert.equal(stream.size, 1024); - assert.equal(stream.backups, 5); - }, - 'with default settings for the underlying stream': function(stream) { - assert.equal(stream.theStream.mode, 420); - assert.equal(stream.theStream.flags, 'a'); - //encoding isn't a property on the underlying stream - //assert.equal(stream.theStream.encoding, 'utf8'); - } - }, - 'with stream arguments': { - topic: function() { - remove(__dirname + '/test-rolling-file-stream'); - return new RollingFileStream( - 'test-rolling-file-stream', - 1024, - 5, - { mode: parseInt('0666', 8) } - ); - }, - 'should pass them to the underlying stream': function(stream) { - assert.equal(stream.theStream.mode, parseInt('0666', 8)); - } - }, - 'without size': { - topic: function() { - try { - new RollingFileStream(__dirname + "/test-rolling-file-stream"); - } catch (e) { - return e; - } - }, - 'should throw an error': function(err) { - assert.instanceOf(err, Error); - } - }, - 'without number of backups': { - topic: function() { - remove('test-rolling-file-stream'); - return new RollingFileStream(__dirname + "/test-rolling-file-stream", 1024); - }, - 'should default to 1 backup': function(stream) { - assert.equal(stream.backups, 1); - } - }, - 'writing less than the file size': { - topic: function() { - remove(__dirname + "/test-rolling-file-stream-write-less"); - var that = this - , stream = new RollingFileStream( - __dirname + "/test-rolling-file-stream-write-less", - 100 - ); - stream.write("cheese", "utf8", function() { - stream.end(); - fs.readFile(__dirname + "/test-rolling-file-stream-write-less", "utf8", that.callback); - }); - }, - 'should write to the file': function(contents) { - assert.equal(contents, "cheese"); - }, - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'should be one': function(files) { - assert.equal( - files.filter( - function(file) { - return file.indexOf('test-rolling-file-stream-write-less') > -1; - } - ).length, - 1 - ); - } - } - }, - 'writing more than the file size': { - topic: function() { - remove(__dirname + "/test-rolling-file-stream-write-more"); - remove(__dirname + "/test-rolling-file-stream-write-more.1"); - var that = this - , stream = new RollingFileStream( - __dirname + "/test-rolling-file-stream-write-more", - 45 - ); - - write7Cheese(that, stream); - }, - 'the number of files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'should be two': function(files) { - assert.equal(files.filter( - function(file) { - return file.indexOf('test-rolling-file-stream-write-more') > -1; - } - ).length, 2); - } - }, - 'the first file': { - topic: function() { - fs.readFile(__dirname + "/test-rolling-file-stream-write-more", "utf8", this.callback); - }, - 'should contain the last two log messages': function(contents) { - assert.equal(contents, '5.cheese\n6.cheese\n'); - } - }, - 'the second file': { - topic: function() { - fs.readFile(__dirname + '/test-rolling-file-stream-write-more.1', "utf8", this.callback); - }, - 'should contain the first five log messages': function(contents) { - assert.equal(contents, '0.cheese\n1.cheese\n2.cheese\n3.cheese\n4.cheese\n'); - } - } - }, - 'when many files already exist': { - topic: function() { - remove(__dirname + '/test-rolling-stream-with-existing-files.11'); - remove(__dirname + '/test-rolling-stream-with-existing-files.20'); - remove(__dirname + '/test-rolling-stream-with-existing-files.-1'); - remove(__dirname + '/test-rolling-stream-with-existing-files.1.1'); - remove(__dirname + '/test-rolling-stream-with-existing-files.1'); - - - create(__dirname + '/test-rolling-stream-with-existing-files.11'); - create(__dirname + '/test-rolling-stream-with-existing-files.20'); - create(__dirname + '/test-rolling-stream-with-existing-files.-1'); - create(__dirname + '/test-rolling-stream-with-existing-files.1.1'); - create(__dirname + '/test-rolling-stream-with-existing-files.1'); - - var that = this - , stream = new RollingFileStream( - __dirname + "/test-rolling-stream-with-existing-files", - 45, - 5 - ); - - write7Cheese(that, stream); - }, - 'the files': { - topic: function() { - fs.readdir(__dirname, this.callback); - }, - 'should be rolled': function(files) { - assert.include(files, 'test-rolling-stream-with-existing-files'); - assert.include(files, 'test-rolling-stream-with-existing-files.1'); - assert.include(files, 'test-rolling-stream-with-existing-files.2'); - assert.include(files, 'test-rolling-stream-with-existing-files.11'); - assert.include(files, 'test-rolling-stream-with-existing-files.20'); - } - } - } -}).exportTo(module); - -function write7Cheese(that, stream) { - var streamed = 0; - [0, 1, 2, 3, 4, 5, 6].forEach(function(i) { - stream.write(i +".cheese\n", "utf8", function(e) { - streamed++; - if (e) { return that.callback(e); } - if (streamed === 7) { - stream.end(); - that.callback(); - } - }); - }); -} diff --git a/test/with-cheese.json b/test/with-cheese.json new file mode 100644 index 00000000..0fb444c2 --- /dev/null +++ b/test/with-cheese.json @@ -0,0 +1,9 @@ +{ + "appenders": { + "thing": { "type": "cheese" } + }, + "categories": { + "default": { "level": "DEBUG", "appenders": [ "thing" ] }, + "noisy": { "level": "ERROR", "appenders": [ "thing" ] } + } +} diff --git a/test/with-dateFile.json b/test/with-dateFile.json index 18727433..31a23aae 100644 --- a/test/with-dateFile.json +++ b/test/with-dateFile.json @@ -1,7 +1,6 @@ { - "appenders": [ - { - "category": "tests", + "appenders": { + "dateFile": { "type": "dateFile", "filename": "test/date-file-test.log", "pattern": "-from-MM-dd", @@ -9,9 +8,9 @@ "type": "messagePassThrough" } } - ], + }, - "levels": { - "tests": "WARN" + "categories": { + "default": { "level": "WARN", "appenders": [ "dateFile" ] } } } diff --git a/writing-appenders.md b/writing-appenders.md new file mode 100644 index 00000000..0268b346 --- /dev/null +++ b/writing-appenders.md @@ -0,0 +1,81 @@ +Writing Appenders For log4js +============================ + +Loading appenders +----------------- +log4js supports loading appender modules from outside its own code. The [log4js-gelf](http://github.com/nomiddlename/log4js-gelf), [log4js-smtp](http://github.com/nomiddlename/log4js-smtp), and [log4js-hookio](http://github.com/nomiddlename/log4js-hookio) appenders are examples of this. In the configuration for an appender, log4js will first attempt to `require` the module from `./lib/appenders/ + type` within log4js - if that fails, it will `require` just using the type. e.g. + + log4js.configure({ + appenders: { + "custom": { type: "log4js-gelf", hostname: "blah", port: 1234 } + }, + categories: { + "default": { level: "debug", appenders: ["custom"] } + } + }); + +log4js will first attempt to `require('./appenders/' + log4js-gelf)`, this will fail. It will then attempt `require('log4js-gelf')`, which (assuming you have previously run `npm install log4js-gelf`) will pick up the gelf appender. + +Writing your own custom appender +-------------------------------- +This is easiest to explain with an example. Let's assume you want to write a [CouchDB](http://couchdb.apache.org) appender. CouchDB is a document database that you talk to via HTTP and JSON. Our log4js configuration is going to look something like this: + + log4js.configure({ + appenders: { + "couch": { + type: "log4js-couchdb", + url: "http://mycouchhost:5984", + db: "logs", + layout: { + type: "messagePassThrough" + } + } + }, + categories: { + "default": { level: "debug", appenders: ["couch"] } + } + }); + +When processing this configuration, the first thing log4js will do is `require('log4js-couchdb')`. It expects this module to return a function that accepts two arguments + + module.exports = function(layouts, levels) { + ... + }; + +log4js will then call that function, passing in the `layouts` and `levels` sub-modules in case your appender might need to use them. Layouts contains functions which will format a log event as a string in various different ways. Levels contains the definitions of the log levels used by log4js - you might need this for mapping log4js levels to external definitions (the GELF appender does this). These are passed in so that appenders do not need to include a hard dependency on log4js (see below), and so that log4js does not need to expose these modules to the public API. The module function will only be called once per call to `log4js.configure`, even if there are multiple appenders of that type defined. + +The module function should return another function, a configuration function, which will be called for each appender of that type defined in the config. That function should return an appender instance. For our CouchDB example, the calling process is roughly like this: + + couchDbModule = require('log4js-couchdb'); + appenderMaker = couchDbModule(layouts, levels); + appender = appenderMaker({ + type: "log4js-couchdb", + url: "http://mycouchhost:5984", + db: "logs", + layout: { + type: "messagePassThrough" + } + }, appenderByName) + +Note that in addition to our couchdb appender config, the appenderMaker function gets an extra argument: `appenderByName`, a function which returns an appender when passed its name. This is used by appenders that wrap other appenders. The `logLevelFilter` is an example of this use. + +The `layout` portion of the config can be passed directly to `layouts.layout(config.layout)` to generate a layout function. + +The appender function returned after processing your config should just take one argument: a log event. This function will be called for every log event that should be handled by your appender. In our case, with the config above, every log event of DEBUG level and above will be sent to our appender. + +Dependencies +------------ +You should declare which version of log4js your appender works with by +including a "peerDependencies" section in your package.json. e.g. + + { + "name": "my-cool-appender", + "version": "0.0.1", + ... + "peerDependencies": { + "log4js": "0.7.x" + } + } + +For more details on peer dependencies, see +[this blog post](http://blog.nodejs.org/2013/02/07/peer-dependencies/). pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy