README.md

mongomery

Simple and useful util for unit and integration testing with mongodb (java 1.5+)

This library allows you easily populate db with predefined data from a json file and also do assertions about db state using a json file.

<dependency>
  <groupId>com.github.kirilldev</groupId>
  <artifactId>mongomery</artifactId>
  <version>1.0.0</version>
</dependency>

Assume you have "predefinedTestData.json" file in you resources folder that looks like this:

{
  "Books": [
    {
      "_id": {
        "$oid": "55f3ed00b1375a40e61830bf"
      },
      "englishTitle": "The Little Prince",
      "originalTitle": "Le Petit Prince",
      "author": "Antoine de Saint-Exupéry"
    }
  ],
  "Movies": [
    {
      "_id": {
        "$oid": "55f3ed00b1375a48e61830bf"
      },
      "name": "Titanic",
      "year": 1997
    }
  ]
}

To load all this data in database you need write only two lines of code:

//db here is a com.mongodb.DB instance
MongoDBTester mongoDBTester = new MongoDBTester(db);
mongoDBTester.setDBState("predefinedTestData.json");

To check db state:

mongoDBTester.assertDBStateEquals("expectedTestData.json");

There is two ways to write json files with expected data:

1. Strict match. This is usual json file like you have seen above. In most cases you don't need more than exact describing of db state after test.

2. Pattern match. If you want to use random strings in your test or for example your business logic generates random ids for entities you may want a little more than strict match:

   { "Movies": [ { "_id": "$anyObject()", "name": "Titanic", "year": 1997 } ] }

json above says that test expects one document in "Movies" collection that will have name Titanic and a year 1997. Also it must have non null field _id with any object in it.

Currently available next special functions:

$anyObject() - placeholder for any non null object
$anyObject(int) - placeholder for any non null object which has exactly "int" number of fields. ("int" here is any positive integer) 

$anyString() - placeholder for any non null string
$anyString(/regex/) - placeholder for any non null string which matches with given regex. ("regex" here is a valid regular expression)

TODO:
1. Write more useful tests
2. Refactor and optimize it
3. Add better error messages for pattern match.