log4js-node/test/tap/logglyAppender-test.js

'use strict';

const test = require('tap').test;
const log4js = require('../../lib/log4js');
const sandbox = require('sandboxed-module');

function setupLogging(category, options) {
  const msgs = [];

  const fakeLoggly = {
    createClient: function (opts) {
      return {
        config: opts,
        log: function (msg, tags, cb) {
          msgs.push({
            msg: msg,
            tags: tags,
            cb: cb
          });
        }
      };
    }
  };

  const fakeLayouts = {
    layout: function (type, config) {
      this.type = type;
      this.config = config;
      return log4js.layouts.messagePassThroughLayout;
    },
    basicLayout: log4js.layouts.basicLayout,
    messagePassThroughLayout: log4js.layouts.messagePassThroughLayout
  };

  const fakeConsole = {
    errors: [],
    error: function (msg, value) {
      this.errors.push({ msg: msg, value: value });
    }
  };

  const logglyModule = sandbox.require('../../lib/appenders/loggly', {
    requires: {
      loggly: fakeLoggly,
      '../layouts': fakeLayouts
    },
    globals: {
      console: fakeConsole
    }
  });

  log4js.addAppender(
    logglyModule.configure(options),
    logglyModule.shutdown,
    category);

  return {
    logger: log4js.getLogger(category),
    loggly: fakeLoggly,
    layouts: fakeLayouts,
    console: fakeConsole,
    results: msgs
  };
}

log4js.clearAppenders();

function setupTaggedLogging() {
  return setupLogging('loggly', {
    token: 'your-really-long-input-token',
    subdomain: 'your-subdomain',
    tags: ['loggly-tag1', 'loggly-tag2', 'loggly-tagn']
  });
}

test('log4js logglyAppender', (batch) => {
  batch.test('with minimal config', (t) => {
    const setup = setupTaggedLogging();
    setup.logger.log('trace', 'Log event #1', 'Log 2', { tags: ['tag1', 'tag2'] });

    t.equal(setup.results.length, 1, 'has a results.length of 1');
    t.equal(setup.results[0].msg.msg, 'Log event #1 Log 2', 'has a result msg with both args concatenated');
    t.same(setup.results[0].tags, ['tag1', 'tag2'], 'has the correct result tags');
    t.end();
  });

  batch.test('config with object with tags and other keys', (t) => {
    const setup = setupTaggedLogging();
    // ignore this tags object b/c there are 2 keys
    setup.logger.log('trace', 'Log event #1', { other: 'other', tags: ['tag1', 'tag2'] });

    t.equal(setup.results.length, 1, 'has a results.length of 1');
    t.equal(
      setup.results[0].msg.msg,
      'Log event #1 { other: \'other\', tags: [ \'tag1\', \'tag2\' ] }',
      'has a result msg with the args concatenated'
    );
    t.same(setup.results[0].tags, [], 'has a result tags with the arg that contains no tags');
    t.end();
  });

  batch.test('with shutdown callback', (t) => {
    const setup = setupTaggedLogging();
    setup.logger.log('trace', 'Log event #1', 'Log 2', {
      tags: ['tag1', 'tag2']
    });

    log4js.shutdown(() => { t.end(); });

    // shutdown will until after the last message has been sent to loggly
    setup.results[0].cb();
  });

  batch.end();
});