diff --git a/test/layouts-test.js b/test/layouts-test.js index c355bdd..d1232b7 100644 --- a/test/layouts-test.js +++ b/test/layouts-test.js @@ -1,23 +1,16 @@ "use strict"; -var vows = require('vows') -, assert = require('assert'); +var assert = require('assert'); //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), @@ -27,8 +20,9 @@ vows.describe('log4js layouts').addBatch({ } }); 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), @@ -38,14 +32,14 @@ vows.describe('log4js layouts').addBatch({ } }); 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), @@ -55,8 +49,9 @@ vows.describe('log4js layouts').addBatch({ 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), @@ -66,8 +61,9 @@ vows.describe('log4js layouts').addBatch({ 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), @@ -77,25 +73,36 @@ vows.describe('log4js layouts').addBatch({ 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), + categoryName: "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", @@ -104,45 +111,46 @@ vows.describe('log4js layouts').addBatch({ toString: function() { return "ERROR"; } } }); - }, - 'should print error the contained error message': function(layoutOutput) { + }); + + it('should print error the contained error message', function() { var m = layoutOutput.match(/\{ \[Error: My Unique Error Message\]/); - assert.isArray(m); - }, - 'should print error augmented string attributes': function(layoutOutput) { + 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)); + }); + }); - - }, + }); - '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]; + 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), + categoryName: "tests", + level: { + toString: function() { return "DEBUG"; } + } + }; + + 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 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 + , error = new Error("Some made-up error") + , stack = error.stack.split(/\n/); event.data = ['this is a test', error]; output = layout(event); @@ -157,140 +165,166 @@ vows.describe('log4js layouts').addBatch({ for (var i = 1; i < stack.length; i++) { assert.equal(lines[i+2], stack[i+1]); } - }, - 'should output any extra data in the log event as util.inspect strings': function(args) { - var layout = args[0], event = args[1], output, lines; + }); + + it('should output any extra data in the log event as util.inspect strings', function() { + var 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.' }" ); - } - }, + }); + }); - 'patternLayout': { - topic: function() { - var event = { - data: ['this is a test'], - startTime: 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(); } - }; - return [layout, event, tokens]; - }, + describe('patternLayout', function() { + var event = { + data: ['this is a test'], + startTime: 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(); } + }; + + event.startTime.getTimezoneOffset = function() { return 0; }; - 'should default to "time logLevel loggerName - message"': function(args) { - test(args, null, "14:18:30 DEBUG multiple.levels.of.tests - this is a test\n"); - }, - '%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', '\n'); - }, - '%h should output hostname' : function(args) { - test(args, '%h', require('os').hostname().toString()); - }, - '%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, + 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\n of.tests at 14:18:30.045 cheese DEBUG\n' ); - }, - '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}', '%x{doesNotExist}'); - }, - '%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', '%x'); - }, - }, - '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'); + }); + + 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")); - } - } -}).export(module); + }); + }); +});