node-bunyan-lite/test/cli.test.js

427 lines
16 KiB
JavaScript
Raw Normal View History

2012-02-24 05:19:28 +00:00
/*
* Copyright (c) 2015 Trent Mick. All rights reserved.
2012-02-24 05:19:28 +00:00
*
* Test the `bunyan` CLI.
*/
var p = console.warn;
2012-02-24 05:19:28 +00:00
var exec = require('child_process').exec;
var fs = require('fs');
var path = require('path');
2013-01-07 19:18:12 +00:00
var _ = require('util').format;
var vasync = require('vasync');
2012-02-24 05:19:28 +00:00
2013-01-07 19:18:12 +00:00
// node-tap API
if (require.cache[__dirname + '/tap4nodeunit.js'])
2013-03-29 00:42:32 +00:00
delete require.cache[__dirname + '/tap4nodeunit.js'];
2013-01-07 19:18:12 +00:00
var tap4nodeunit = require('./tap4nodeunit.js');
var after = tap4nodeunit.after;
var before = tap4nodeunit.before;
var test = tap4nodeunit.test;
2012-02-24 05:19:28 +00:00
var BUNYAN = path.resolve(__dirname, '../bin/bunyan');
//child = exec('cat *.js bad_file | wc -l',
// function (error, stdout, stderr) {
// console.log('stdout: ' + stdout);
// console.log('stderr: ' + stderr);
// if (error !== null) {
// console.log('exec error: ' + error);
// }
//});
test('--version', function (t) {
2013-03-29 00:42:32 +00:00
var version = require('../package.json').version;
exec(BUNYAN + ' --version', function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout, 'bunyan ' + version + '\n');
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('--help', function (t) {
2013-03-29 00:42:32 +00:00
exec(BUNYAN + ' --help', function (err, stdout, stderr) {
t.ifError(err)
t.ok(stdout.indexOf('General options:') !== -1);
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('-h', function (t) {
2013-03-29 00:42:32 +00:00
exec(BUNYAN + ' -h', function (err, stdout, stderr) {
t.ifError(err)
t.ok(stdout.indexOf('General options:') !== -1);
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('--bogus', function (t) {
2013-03-29 00:42:32 +00:00
exec(BUNYAN + ' --bogus', function (err, stdout, stderr) {
t.ok(err, 'should error out')
t.equal(err.code, 1, '... with exit code 1')
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('simple.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/simple.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout,
'[2012-02-08T22:56:52.856Z] INFO: myservice/123 on example.com: '
+ 'My message\n');
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('cat simple.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('cat %s/corpus/simple.log | %s', __dirname, BUNYAN),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout,
2013-04-02 00:21:01 +00:00
/* JSSTYLED */
'[2012-02-08T22:56:52.856Z] INFO: myservice/123 on example.com: My message\n');
2013-03-29 00:42:32 +00:00
t.end();
}
);
2012-02-24 05:19:28 +00:00
});
test('simple.log with color', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s --color %s/corpus/simple.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout,
2013-04-02 00:21:01 +00:00
/* JSSTYLED */
'[2012-02-08T22:56:52.856Z] \u001b[36m INFO\u001b[39m: myservice/123 on example.com: \u001b[36mMy message\u001b[39m\n\u001b[0m');
2013-03-29 00:42:32 +00:00
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('extrafield.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/extrafield.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout,
'[2012-02-08T22:56:52.856Z] INFO: myservice/123 on example.com: '
+ 'My message (extra=field)\n');
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('extrafield.log with color', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s --color %s/corpus/extrafield.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout,
2013-04-02 00:21:01 +00:00
'[2012-02-08T22:56:52.856Z] \u001b[36m INFO\u001b[39m: '
+ 'myservice/123 '
2013-03-29 00:42:32 +00:00
+ 'on example.com: \u001b[36mMy message\u001b[39m'
+ ' (extra=field)\n\u001b[0m');
2013-03-29 00:42:32 +00:00
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('bogus.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/bogus.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout, 'not a JSON line\n{"hi": "there"}\n');
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('bogus.log -j', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s -j %s/corpus/bogus.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err)
t.equal(stdout, 'not a JSON line\n{"hi": "there"}\n');
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('all.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/all.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
// Just make sure don't blow up on this.
t.ifError(err)
t.end();
});
2012-02-24 05:19:28 +00:00
});
test('simple.log doesnotexist1.log doesnotexist2.log', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/simple.log doesnotexist1.log doesnotexist2.log',
BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ok(err)
t.equal(err.code, 2)
t.equal(stdout,
2013-04-02 00:21:01 +00:00
/* JSSTYLED */
'[2012-02-08T22:56:52.856Z] INFO: myservice/123 on example.com: My message\n');
2013-03-29 00:42:32 +00:00
// Note: node v0.6.10:
// ENOENT, no such file or directory 'asdf.log'
// but node v0.6.14:
// ENOENT, open 'asdf.log'
// io.js 2.2 (at least):
// ENOENT: no such file or directory, open 'doesnotexist1.log'
var matches = [
/^bunyan: ENOENT.*?, open 'doesnotexist1.log'/m,
/^bunyan: ENOENT.*?, open 'doesnotexist2.log'/m,
];
matches.forEach(function (match) {
t.ok(match.test(stderr), 'stderr matches ' + match.toString());
});
2013-03-29 00:42:32 +00:00
t.end();
}
);
2012-02-24 05:19:28 +00:00
});
2012-05-11 23:22:28 +00:00
test('multiple logs', function (t) {
2013-04-02 00:21:01 +00:00
var cmd = _('%s %s/corpus/log1.log %s/corpus/log2.log',
BUNYAN, __dirname, __dirname);
exec(cmd, function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'[2012-05-08T16:57:55.586Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T16:58:55.586Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:01:49.339Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:02:47.404Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:02:49.339Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:57.404Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:08:01.105Z] INFO: agent2/76156 on headnode: message\n',
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join(''));
t.end();
});
2012-05-11 23:22:28 +00:00
});
2012-06-22 05:14:56 +00:00
2013-03-09 00:32:10 +00:00
test('multiple logs, bunyan format', function (t) {
2013-04-02 00:21:01 +00:00
var cmd = _('%s -o bunyan %s/corpus/log1.log %s/corpus/log2.log',
BUNYAN, __dirname, __dirname);
exec(cmd, function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'{"name":"agent1","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T16:57:55.586Z","v":0}',
'{"name":"agent2","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T16:58:55.586Z","v":0}',
'{"name":"agent2","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:01:49.339Z","v":0}',
'{"name":"agent2","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:02:47.404Z","v":0}',
'{"name":"agent1","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:02:49.339Z","v":0}',
'{"name":"agent1","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:02:49.404Z","v":0}',
'{"name":"agent1","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:02:49.404Z","v":0}',
'{"name":"agent2","pid":73267,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:02:57.404Z","v":0}',
'{"name":"agent2","pid":76156,"hostname":"headnode","level":30,"msg":"message","time":"2012-05-08T17:08:01.105Z","v":0}',
''
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join('\n'));
t.end();
});
2013-03-09 00:32:10 +00:00
});
2012-06-22 05:14:56 +00:00
test('log1.log.gz', function (t) {
2013-03-29 00:42:32 +00:00
exec(_('%s %s/corpus/log1.log.gz', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err);
t.equal(stdout, [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'[2012-05-08T16:57:55.586Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.339Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join(''));
t.end();
});
2012-06-22 05:14:56 +00:00
});
test('mixed text and gzip logs', function (t) {
2013-04-02 00:21:01 +00:00
var cmd = _('%s %s/corpus/log1.log.gz %s/corpus/log2.log',
BUNYAN, __dirname, __dirname);
exec(cmd, function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'[2012-05-08T16:57:55.586Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T16:58:55.586Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:01:49.339Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:02:47.404Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:02:49.339Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:49.404Z] INFO: agent1/73267 on headnode: message\n',
'[2012-05-08T17:02:57.404Z] INFO: agent2/73267 on headnode: message\n',
'[2012-05-08T17:08:01.105Z] INFO: agent2/76156 on headnode: message\n',
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join(''));
t.end();
});
2012-06-22 05:14:56 +00:00
});
2012-08-08 00:30:39 +00:00
test('--level 40', function (t) {
2013-03-29 00:42:32 +00:00
expect = [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'# levels\n',
'[2012-02-08T22:56:53.856Z] WARN: myservice/123 on example.com: My message\n',
'[2012-02-08T22:56:54.856Z] ERROR: myservice/123 on example.com: My message\n',
'[2012-02-08T22:56:55.856Z] LVL55: myservice/123 on example.com: My message\n',
'[2012-02-08T22:56:56.856Z] FATAL: myservice/123 on example.com: My message\n',
'\n',
'# extra fields\n',
'\n',
'# bogus\n',
'not a JSON line\n',
'{"hi": "there"}\n'
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join('');
exec(_('%s -l 40 %s/corpus/all.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err);
t.equal(stdout, expect);
exec(_('%s --level 40 %s/corpus/all.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err);
t.equal(stdout, expect);
t.end();
});
2012-08-08 00:30:39 +00:00
});
});
test('--condition "this.level === 10 && this.pid === 123"', function (t) {
2013-03-29 00:42:32 +00:00
var expect = [
'# levels\n',
2013-04-02 00:21:01 +00:00
/* JSSTYLED */
2013-03-29 00:42:32 +00:00
'[2012-02-08T22:56:50.856Z] TRACE: myservice/123 on example.com: My message\n',
'\n',
'# extra fields\n',
'\n',
'# bogus\n',
'not a JSON line\n',
'{"hi": "there"}\n'
].join('');
var cmd = _('%s -c "this.level === 10 && this.pid === 123"'
+ ' %s/corpus/all.log', BUNYAN, __dirname);
2013-04-02 00:21:01 +00:00
exec(cmd, function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, expect);
2013-04-02 00:21:01 +00:00
var cmd = _(
'%s --condition "this.level === 10 && this.pid === 123"'
+ ' %s/corpus/all.log', BUNYAN, __dirname);
2013-04-02 00:21:01 +00:00
exec(cmd, function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, expect);
t.end();
});
});
});
test('--condition "this.level === TRACE', function (t) {
var expect = [
'# levels\n',
/* JSSTYLED */
'[2012-02-08T22:56:50.856Z] TRACE: myservice/123 on example.com: My message\n',
'\n',
'# extra fields\n',
'\n',
'# bogus\n',
'not a JSON line\n',
'{"hi": "there"}\n'
].join('');
var cmd = _('%s -c "this.level === TRACE" %s/corpus/all.log',
BUNYAN, __dirname);
exec(cmd, function (err, stdout, stderr) {
t.ifError(err);
t.equal(stdout, expect);
t.done();
});
});
// multiple
test('multiple --conditions', function (t) {
2013-03-29 00:42:32 +00:00
var expect = [
'# levels\n',
2013-04-02 00:21:01 +00:00
/* JSSTYLED */
'[2012-02-08T22:56:53.856Z] WARN: myservice/123 on example.com: My message\n',
2013-03-29 00:42:32 +00:00
'\n',
'# extra fields\n',
'\n',
'# bogus\n',
'not a JSON line\n',
'{"hi": "there"}\n'
].join('');
exec(_('%s %s/corpus/all.log -c "this.level === 40" -c "this.pid === 123"',
BUNYAN, __dirname), function (err, stdout, stderr) {
2013-03-29 00:42:32 +00:00
t.ifError(err);
t.equal(stdout, expect);
t.end();
});
});
// https://github.com/trentm/node-bunyan/issues/30
//
// One of the records in corpus/withreq.log has a 'req'
// field with no 'headers'. Ditto for the 'res' field.
test('robust req handling', function (t) {
2013-03-29 00:42:32 +00:00
var expect = [
2013-04-02 00:21:01 +00:00
/* BEGIN JSSTYLED */
2013-03-29 00:42:32 +00:00
'[2012-08-08T10:25:47.636Z] DEBUG: amon-master/12859 on 9724a190-27b6-4fd8-830b-a574f839c67d: headAgentProbes respond (req_id=cce79d15-ffc2-487c-a4e4-e940bdaac31e, route=HeadAgentProbes, contentMD5=11FxOYiYfpMxmANj4kGJzg==)',
'[2012-08-08T10:25:47.637Z] INFO: amon-master/12859 on 9724a190-27b6-4fd8-830b-a574f839c67d: HeadAgentProbes handled: 200 (req_id=cce79d15-ffc2-487c-a4e4-e940bdaac31e, audit=true, remoteAddress=10.2.207.2, remotePort=50394, latency=3, secure=false, _audit=true, req.version=*)',
' HEAD /agentprobes?agent=ccf92af9-0b24-46b6-ab60-65095fdd3037 HTTP/1.1',
' accept: application/json',
' content-type: application/json',
' host: 10.2.207.16',
' connection: keep-alive',
' --',
' HTTP/1.1 200 OK',
' content-md5: 11FxOYiYfpMxmANj4kGJzg==',
' access-control-allow-origin: *',
' access-control-allow-headers: Accept, Accept-Version, Content-Length, Content-MD5, Content-Type, Date, X-Api-Version',
' access-control-allow-methods: HEAD',
' access-control-expose-headers: X-Api-Version, X-Request-Id, X-Response-Time',
' connection: Keep-Alive',
' date: Wed, 08 Aug 2012 10:25:47 GMT',
' server: Amon Master/1.0.0',
' x-request-id: cce79d15-ffc2-487c-a4e4-e940bdaac31e',
' x-response-time: 3',
' --',
' route: {',
' "name": "HeadAgentProbes",',
' "version": false',
' }',
'[2012-08-08T10:25:47.637Z] INFO: amon-master/12859 on 9724a190-27b6-4fd8-830b-a574f839c67d: HeadAgentProbes handled: 200 (req_id=cce79d15-ffc2-487c-a4e4-e940bdaac31e, audit=true, remoteAddress=10.2.207.2, remotePort=50394, latency=3, secure=false, _audit=true, req.version=*)',
' HEAD /agentprobes?agent=ccf92af9-0b24-46b6-ab60-65095fdd3037 HTTP/1.1',
' --',
' HTTP/1.1 200 OK',
' --',
2013-03-29 00:42:32 +00:00
' route: {',
' "name": "HeadAgentProbes",',
' "version": false',
' }'
2013-04-02 00:21:01 +00:00
/* END JSSTYLED */
2013-03-29 00:42:32 +00:00
].join('\n') + '\n';
exec(_('%s %s/corpus/withreq.log', BUNYAN, __dirname),
function (err, stdout, stderr) {
t.ifError(err);
t.equal(stdout, expect);
t.end();
});
});
// Some past crashes from issues.
test('should not crash on corpus/old-crashers/*.log', function (t) {
var oldCrashers = fs.readdirSync(
path.resolve(__dirname, 'corpus/old-crashers'))
.filter(function (f) { return f.slice(-4) === '.log'; });
vasync.forEachPipeline({
inputs: oldCrashers,
func: function (logName, next) {
exec(_('%s %s/corpus/old-crashers/%s', BUNYAN, __dirname, logName),
function (err, stdout, stderr) {
next(err);
});
}
}, function (err, results) {
t.ifError(err);
t.end();
});
});