bertramn / mongodb-junit-test

a simple JUnit rule to bootstrap an embedded mongodb during junit integration test execution

MongoDB JUnit Test Rule

This library contains a simple JUnit rule that will bootstrap an embedded mongodb during junit integration test execution.

The library will use the embedded mongo framework from flapdoodle and will start a mongodb instance on localhost and port 27099. The port, host ip and mongodb version can be configured via fluent methods on MongoRule.

Simple Example for JUnit4:

import static org.junit.Assert.*;
import org.junit.Rule;
import org.junit.Test;

import com.mongodb.MongoClient;

public class SomeTestWithMongoDB {

  @Rule
  // this will start and stop mongodb for every test
  public MongoRule mongo = new MongoRule();

  @Test
  public void testSomethingWithMongoRule() {

    MongoClient client = mongo.getMongoClient();
    assertNotNull(client);
    // whatever needs to be done in mongo using the provided monog client

  }

  @Test
  @WithoutMongo
  public void testSomethingWithoutMongoRule() {

    MongoClient client = mongo.getMongoClient();
    assertNull(client);
    // whatever needs to be done without mongo

  }

}

Simple Example for JUnit5 starting a MongoDB for All Tests (only once):

public class SomeTestWithMongoDB {

  @RegisterExtension
  static MongoForAllExtension mongo = MongoForAllExtension.defaultMongo();

  @BeforeEach
  void setupCollection() {
    MongoDatabase db = mongo.getMongoClient().getDatabase(MongoExtension.UNIT_TEST_DB);
    // e.g. drop a collection taht was used during prior test
    db.getCollection("TestCollection").drop();
  }

  @Test
  public void testSomethingWithMongoDB() {
    MongoClient client = mongo.getMongoClient();
    // whatever needs to be done in mongo using the provided mongo client
  }

  @Test
  public void testSomethingElseWithSameMongoDB() {
    MongoClient client = mongo.getMongoClient();
    // whatever needs to be done in mongo using the provided mongo client
  }

}

Simple Example for JUnit5 starting a MongoDB for Each Test (one per test case - slow):

public class SomeTestWithMongoDB {

  @RegisterExtension
  MongoForEachExtension mongo = MongoForEachExtension.defaultMongo();

  @BeforeEach
  void setupCollection() {
    if (mongo.isStarted()) {
      MongoDatabase db = mongo.getMongoClient().getDatabase(MongoExtension.UNIT_TEST_DB);
      // setup collection for test
    }
  }

  @Test
  public void testSomethingWithMongoRule() {
    MongoClient client = mongo.getMongoClient();
    // whatever needs to be done in mongo using the provided mongo client
  }

  @Test
  @WithoutMongo
  public void testSomethingWithoutMongoRule() {
    // whatever needs to be done without mongo
  }
  
}

mongodb-junit-test's Issues

Bad compatibility with de.flapdoodle.embed version 3.0.0.

As far as I got, they're just renamed a lot of interfaces.

Extension/Plugin stuck while bootstrapping embedded mongoDb

This extension/plugin looks promising, because de.flapdoodle.embed.mongo embedded mongoDb kicks in for each test case. Running the embedded mongoDb for every test case is slow.

Couldn't find any solution, and then I found this extension that promise to run on class level for all the tests. But unfortunately this extension never kicks-in after the below line:

13:32:21.305 [Thread-1] INFO io.fares.junit.mongodb.MongoForAllExtension - 2020-04-26T13:32:21.304+0500 I COMMAND  [LogicalSessionCacheRefresh] command config.$cmd command: createIndexes { createIndexes: "system.sessions", indexes: [ { key: { lastUse: 1 }, name: "lsidTTLIndex", expireAfterSeconds: 1800 } ], $db: "config" } numYields:0 reslen:114 locks:{ Global: { acquireCount: { r: 1, w: 1 } }, Database: { acquireCount: { W: 1 } }, Collection: { acquireCount: { w: 1 } } } protocol:op_msg 9570ms[mongod output] 

Not even @BeforeEach was called.

    @BeforeEach
    void setupCollection() {
        MongoDatabase db = mongo.getMongoClient().getDatabase(MongoExtension.UNIT_TEST_DB);

        // drop a collection that was used during prior test
        db.getCollection(User.class.getName()).drop();
    }

Can you please let me know? Why this extension not working. Any help would be appreciated.

Many Thanks,
Ad.

add extension for Junit5