/src/test/java/org/log4mongo/TestMongoDbPatternLayout.java

/* Copyright (C) 2010 Robert Stewart (robert@wombatnation.com)

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package org.log4mongo;



import static org.junit.Assert.*;



import java.net.InetAddress;

import java.util.Properties;



import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

import org.junit.After;

import org.junit.AfterClass;

import org.junit.Before;

import org.junit.BeforeClass;

import org.junit.Test;



import com.mongodb.BasicDBList;

import com.mongodb.BasicDBObject;

import com.mongodb.BasicDBObjectBuilder;

import com.mongodb.DBCollection;

import com.mongodb.DBObject;

import com.mongodb.Mongo;



/**

 * JUnit unit tests for PatternLayout style logging.

 * 

 * Since tests may depend on different Log4J property settings, each test

 * reconfigures an appender using a Properties object.

 * 

 * Note: these tests require that a MongoDB server is running, and (by default)

 * assumes that server is listening on the default port (27017) on localhost.

 * 

 * @author Robert Stewart (robert@wombatnation.com)

 * @version $Id$

 */

public class TestMongoDbPatternLayout {

    private final static Logger log = Logger.getLogger(TestMongoDbPatternLayout.class);



    public final static String TEST_MONGO_SERVER_HOSTNAME = "localhost";

    public final static int TEST_MONGO_SERVER_PORT = 27017;

    private final static String TEST_DATABASE_NAME = "log4mongotest";

    private final static String TEST_COLLECTION_NAME = "logeventslayout";



    private final static String APPENDER_NAME = "MongoDBPatternLayout";



    private final Mongo mongo;

    private DBCollection collection;



    public TestMongoDbPatternLayout() throws Exception {

	mongo = new Mongo(TEST_MONGO_SERVER_HOSTNAME, TEST_MONGO_SERVER_PORT);

    }



    @BeforeClass

    public static void setUpBeforeClass() throws Exception {

	Mongo mongo = new Mongo(TEST_MONGO_SERVER_HOSTNAME,

		TEST_MONGO_SERVER_PORT);

	mongo.dropDatabase(TEST_DATABASE_NAME);

    }



    @AfterClass

    public static void tearDownAfterClass() throws Exception {

	Mongo mongo = new Mongo(TEST_MONGO_SERVER_HOSTNAME,

		TEST_MONGO_SERVER_PORT);

	mongo.dropDatabase(TEST_DATABASE_NAME);

    }



    @Before

    public void setUp() throws Exception {

	// Ensure both the appender and the JUnit test use the same collection

	// object - provides consistency across reads (JUnit) & writes (Log4J)

	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	collection.drop();



	mongo.getDB(TEST_DATABASE_NAME).requestStart();

    }



    @After

    public void tearDown() throws Exception {

	mongo.getDB(TEST_DATABASE_NAME).requestDone();

    }



    @Test

    public void testValidPatternLayout() {

	PropertyConfigurator.configure(getValidPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	log.warn("Warn entry");

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	// verify log entry content

	DBObject entry = collection.findOne();

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	assertEquals("Warn entry", entry.get("message"));

	// This is the custom info. In the pattern, the field is named "extra".

	assertEquals("useful info", entry.get("extra"));

    }



    @Test

    public void testQuotesInMessage() {

	PropertyConfigurator.configure(getValidPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	String msg = "\"Quotes\" ' \"embedded\"";

	log.warn(msg);

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	// verify log entry content

	DBObject entry = collection.findOne();

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	assertEquals(msg, entry.get("message"));

    }



    @Test

    public void testNestedDoc() {

	PropertyConfigurator.configure(getNestedDocPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	String msg = "Nested warning";

	log.warn(msg);

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	// verify log entry content

	DBObject entry = collection.findOne();

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	DBObject nestedDoc = (DBObject) entry.get("nested");

	assertEquals(msg, nestedDoc.get("message"));

    }



    /**

     * Tests that the document stored in MongoDB has an array as a value if the

     * conversion pattern specifies an array as a value.

     */

    @Test

    public void testArrayValue() {

	PropertyConfigurator.configure(getArrayPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	String msg = "Message in array";

	log.warn(msg);

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	// verify log entry content

	DBObject entry = collection.findOne();

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	BasicDBList list = (BasicDBList) entry.get("array");

	assertEquals(2, list.size());

	assertEquals(this.getClass().getSimpleName(), list.get(0));

	assertEquals(msg, list.get(1));

    }



    @Test

    public void testHostInfoPatternLayout() throws Exception {

	PropertyConfigurator.configure(getHostInfoPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	String msg = "Message in array";

	log.warn(msg);

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	// verify log entry content

	DBObject entry = collection.findOne();

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	assertNotNull(entry.get("host"));

	DBObject hostinfo = (DBObject) entry.get("host");

	assertNotNull(hostinfo.get("name"));

	assertNotNull(hostinfo.get("ip_address"));

	assertNotNull(hostinfo.get("process"));

	assertEquals(InetAddress.getLocalHost().getHostName(), hostinfo.get("name"));

	assertEquals(InetAddress.getLocalHost().getHostAddress(), hostinfo.get("ip_address"));

    }

    

    @Test

    public void testBackslashInMessage() {

	PropertyConfigurator.configure(getValidPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	assertEquals(0L, countLogEntries());

	String msg = "c:\\users\\some_file\\";

	log.warn(msg);

	assertEquals(1L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("WARN"));



	String msgDoubleBackslash = "c:\\\\users\\\\some_file\\\\";

	log.info(msgDoubleBackslash);

	assertEquals(2L, countLogEntries());

	assertEquals(1L, countLogEntriesAtLevel("INFO"));



	// verify log entry content

	DBObject queryObj = new BasicDBObject();

	queryObj.put("level", "WARN");

	DBObject entry = collection.findOne(queryObj);

	assertNotNull(entry);

	assertEquals("WARN", entry.get("level"));

	assertEquals(msg, entry.get("message"));

	

	queryObj = new BasicDBObject();

	queryObj.put("level", "INFO");

	entry = collection.findOne(queryObj);

	assertNotNull(entry);

	assertEquals("INFO", entry.get("level"));

	assertEquals(msgDoubleBackslash, entry.get("message"));

    }



    @Test

    public void testPerformance() {

	PropertyConfigurator.configure(getValidPatternLayoutProperties());



	MongoDbAppender appender = (MongoDbAppender) Logger.getRootLogger()

		.getAppender(APPENDER_NAME);



	collection = mongo.getDB(TEST_DATABASE_NAME).getCollection(

		TEST_COLLECTION_NAME);

	appender.setCollection(collection);



	int NUM_MESSAGES = 1000;

	long now = System.currentTimeMillis();

	for (int i = 0; i < NUM_MESSAGES; i++) {

	    log.warn("Warn entry");

	}

	long dur = System.currentTimeMillis() - now;

	System.out.println("Milliseconds for MongoDbPatternLayoutAppender to log "

			+ NUM_MESSAGES + " messages:" + dur);

	assertEquals(NUM_MESSAGES, countLogEntries());

    }



    private long countLogEntries() {

	return (collection.getCount());

    }



    private long countLogEntriesAtLevel(final String level) {

	return (countLogEntriesWhere(BasicDBObjectBuilder.start().add("level",

		level.toUpperCase()).get()));

    }



    private long countLogEntriesWhere(final DBObject whereClause) {

	return collection.getCount(whereClause);

    }



    private Properties getValidPatternLayoutProperties() {

	Properties props = new Properties();

	props.put("log4j.rootLogger", "DEBUG, MongoDBPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout",

		"org.log4mongo.MongoDbPatternLayoutAppender");

	props.put("log4j.appender.MongoDBPatternLayout.databaseName",

		"log4mongotest");

	props.put("log4j.appender.MongoDBPatternLayout.layout",

		"org.log4mongo.CustomPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout.layout.ConversionPattern",

		"{\"extra\":\"%e\",\"timestamp\":\"%d{yyyy-MM-dd'T'HH:mm:ss'Z'}\",\"level\":\"%p\",\"class\":\"%c{1}\",\"message\":\"%m\"}");

	return props;

    }



    private Properties getNestedDocPatternLayoutProperties() {

	Properties props = new Properties();

	props.put("log4j.rootLogger", "DEBUG, MongoDBPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout",

		"org.log4mongo.MongoDbPatternLayoutAppender");

	props.put("log4j.appender.MongoDBPatternLayout.databaseName",

		"log4mongotest");

	props.put("log4j.appender.MongoDBPatternLayout.layout",

		"org.log4mongo.CustomPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout.layout.ConversionPattern",

		"{\"timestamp\":\"%d{yyyy-MM-dd'T'HH:mm:ss'Z'}\",\"level\":\"%p\",\"nested\":{\"class\":\"%c{1}\",\"message\":\"%m\"}}");

	return props;

    }



    private Properties getArrayPatternLayoutProperties() {

	Properties props = new Properties();

	props.put("log4j.rootLogger", "DEBUG, MongoDBPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout",

		"org.log4mongo.MongoDbPatternLayoutAppender");

	props.put("log4j.appender.MongoDBPatternLayout.databaseName",

		"log4mongotest");

	props.put("log4j.appender.MongoDBPatternLayout.layout",

		"org.log4mongo.CustomPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout.layout.ConversionPattern",

		"{\"timestamp\":\"%d{yyyy-MM-dd'T'HH:mm:ss'Z'}\",\"level\":\"%p\",\"array\":[\"%c{1}\",\"%m\"]}");

	return props;

    }



    private Properties getHostInfoPatternLayoutProperties() {

	Properties props = new Properties();

	props.put("log4j.rootLogger", "DEBUG, MongoDBPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout",

		"org.log4mongo.MongoDbPatternLayoutAppender");

	props.put("log4j.appender.MongoDBPatternLayout.databaseName",

		"log4mongotest");

	props.put("log4j.appender.MongoDBPatternLayout.layout",

		"org.log4mongo.contrib.HostInfoPatternLayout");

	props.put("log4j.appender.MongoDBPatternLayout.layout.ConversionPattern",

		"{\"timestamp\":\"%d{yyyy-MM-dd'T'HH:mm:ss'Z'}\",\"level\":\"%p\",\"array\":[\"%c{1}\",\"%m\"],\"host\":{\"name\":\"%H\", \"process\":\"%V\", \"ip_address\":\"%I\"}}");

	return props;

    }

}