TestMongoDbAppenderAuth.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 com.mongodb.BasicDBObject;
import com.mongodb.MongoClient;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
import org.apache.log4j.PropertyConfigurator;
import org.bson.Document;
import org.junit.*;

import java.util.ArrayList;
import java.util.Collections;

/**
 * Authentication-related JUnit unit tests for MongoDbAppender.
 * <p>
 * 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)
 */
public class TestMongoDbAppenderAuth {

    private final static String TEST_MONGO_SERVER_HOSTNAME = "localhost";

    private final static int TEST_MONGO_SERVER_PORT = 27017;

    private final static String TEST_DATABASE_NAME = "log4mongotestauth";

    private final static String TEST_COLLECTION_NAME = "logevents";

    private final static String LOG4J_AUTH_PROPS = "src/test/resources/log4j_auth.properties";

    private final static String username = "open";

    private final static String password = "sesame";

    private final MongoClient mongo;

    private MongoCollection collection;

    public TestMongoDbAppenderAuth() throws Exception {
        mongo = new MongoClient(TEST_MONGO_SERVER_HOSTNAME, TEST_MONGO_SERVER_PORT);
    }

    @BeforeClass
    public static void setUpBeforeClass() throws Exception {
        MongoClient mongo = new MongoClient(TEST_MONGO_SERVER_HOSTNAME, TEST_MONGO_SERVER_PORT);
        mongo.dropDatabase(TEST_DATABASE_NAME);
    }

    @AfterClass
    public static void tearDownAfterClass() throws Exception {
        MongoClient mongo = new MongoClient(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.getDatabase(TEST_DATABASE_NAME).getCollection(TEST_COLLECTION_NAME);
        collection.drop();

    }

    /**
     * Catching the RuntimeException thrown when Log4J calls the MongoDbAppender activeOptions()
     * method isn't easy, since it is thrown in another thread.
     */
    @Test(expected = RuntimeException.class)
    @Ignore
    public void testAppenderActivateNoAuth() {
        PropertyConfigurator.configure(LOG4J_AUTH_PROPS);
    }

    /**
     * Adds the user to the test database before activating the appender.
     */
    @Test
    public void testAppenderActivateWithAuth() {
        Document result = null;
        MongoDatabase db = mongo.getDatabase(TEST_DATABASE_NAME);
        BasicDBObject getUsersInfoCommand = new BasicDBObject("usersInfo",
                new BasicDBObject("user", username).append("db", TEST_DATABASE_NAME));
        BasicDBObject dropUserCommand = new BasicDBObject("dropUser", username);
        BasicDBObject createUserCommand = new BasicDBObject("createUser", username).append("pwd", password).append("roles",
                            Collections.singletonList(new BasicDBObject("role", "dbOwner").append("db", TEST_DATABASE_NAME)));

        // If test user exists from a previous run, drop it
        result = db.runCommand(getUsersInfoCommand);
        ArrayList users = (ArrayList) result.get("users");
        if (!users.isEmpty()) {
            db.runCommand(dropUserCommand);
        }

        db.runCommand(createUserCommand);
        PropertyConfigurator.configure(LOG4J_AUTH_PROPS);
    }

}