com.github.fakemongo.junit

Class FongoRule

java.lang.Object

org.junit.rules.ExternalResource

com.github.fakemongo.junit.FongoRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class FongoRule
extends org.junit.rules.ExternalResource

Create a Junit Rule to use with annotation

@Rule public FongoRule rule = new FongoRule().

Note than you can switch to a real mongodb on your localhost (for now).

WARNING : database is dropped after the test !!

Constructor Summary

Constructors

Constructor and Description
FongoRule()
FongoRule(boolean realMongo)
FongoRule(boolean realMongo, org.bson.codecs.configuration.CodecRegistry codecRegistry)
FongoRule(boolean realMongo, com.mongodb.MongoClient mongoClientIfReal)
FongoRule(boolean realMongo, com.mongodb.connection.ServerVersion serverVersion)
FongoRule(org.bson.codecs.configuration.CodecRegistry codecRegistry)
FongoRule(com.mongodb.connection.ServerVersion serverVersion)
FongoRule(String dbName)
FongoRule(String dbName, boolean realMongo)
FongoRule(String dbName, com.mongodb.connection.ServerVersion serverVersion, boolean realMongo, com.mongodb.MongoClient mongoClientIfReal)
FongoRule(String dbName, com.mongodb.connection.ServerVersion serverVersion, boolean realMongo, com.mongodb.MongoClient mongoClientIfReal, org.bson.codecs.configuration.CodecRegistry codecRegistry) Setup a rule with a real MongoDB.

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
com.mongodb.client.MongoDatabase	getDatabase()
com.mongodb.client.MongoDatabase	getDatabase(String name)
com.mongodb.DB	getDb() Deprecated.
com.mongodb.DB	getDB()
com.mongodb.DB	getDb(String name) Deprecated.
com.mongodb.DB	getDB(String name)
Fongo	getFongo()
com.mongodb.Mongo	getMongo() Deprecated.
com.mongodb.MongoClient	getMongoClient()
com.mongodb.connection.ServerVersion	getServerVersion()
com.mongodb.client.MongoCollection<org.bson.Document>	insertDocumentsFromFile(com.mongodb.client.MongoCollection<org.bson.Document> coll, String filename)
com.mongodb.client.MongoCollection<org.bson.Document>	insertDocumentsFromFile(String filename)
com.mongodb.DBCollection	insertFile(com.mongodb.DBCollection coll, String filename)
com.mongodb.DBCollection	insertJSON(com.mongodb.DBCollection coll, String json)
com.mongodb.client.MongoCollection	insertJSON(com.mongodb.client.MongoCollection coll, String json)
boolean	isRealMongo()
boolean	mustContainsSystemIndexes()
com.mongodb.DBCollection	newCollection()
com.mongodb.DBCollection	newCollection(String collectionName)
protected Fongo	newFongo(com.mongodb.connection.ServerVersion serverVersion, org.bson.codecs.configuration.CodecRegistry codecRegistry)
com.mongodb.client.MongoCollection<org.bson.Document>	newMongoCollection()
<T> com.mongodb.client.MongoCollection<T>	newMongoCollection(Class<T> documentClass)
com.mongodb.client.MongoCollection<org.bson.Document>	newMongoCollection(String collectionName)
<T> com.mongodb.client.MongoCollection<T>	newMongoCollection(String collectionName, Class<T> documentClass)
<T> T	parse(String json)
com.mongodb.DBObject	parseDBObject(String json)
List<com.mongodb.DBObject>	parseList(String json)
static String	randomName()
static String	randomName(String prefix)

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FongoRule

public FongoRule(String dbName,
                 com.mongodb.connection.ServerVersion serverVersion,
                 boolean realMongo,
                 com.mongodb.MongoClient mongoClientIfReal,
                 org.bson.codecs.configuration.CodecRegistry codecRegistry)

Setup a rule with a real MongoDB.

Parameters:

dbName - the dbName to use.

serverVersion - version of the server to use for fongo.

realMongo - set to true if you want to use a real mongoDB.

mongoClientIfReal - real client to use if realMongo si true.

FongoRule

public FongoRule(String dbName,
                 com.mongodb.connection.ServerVersion serverVersion,
                 boolean realMongo,
                 com.mongodb.MongoClient mongoClientIfReal)

FongoRule

public FongoRule()

FongoRule

public FongoRule(org.bson.codecs.configuration.CodecRegistry codecRegistry)

FongoRule

public FongoRule(com.mongodb.connection.ServerVersion serverVersion)

FongoRule

public FongoRule(boolean realMongo)

FongoRule

public FongoRule(boolean realMongo,
                 org.bson.codecs.configuration.CodecRegistry codecRegistry)

FongoRule

public FongoRule(boolean realMongo,
                 com.mongodb.connection.ServerVersion serverVersion)

FongoRule

public FongoRule(boolean realMongo,
                 com.mongodb.MongoClient mongoClientIfReal)

FongoRule

public FongoRule(String dbName,
                 boolean realMongo)

FongoRule

public FongoRule(String dbName)

Method Detail

isRealMongo

public boolean isRealMongo()

before

protected void before()
               throws UnknownHostException

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

UnknownHostException

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

insertJSON

public com.mongodb.DBCollection insertJSON(com.mongodb.DBCollection coll,
                                           String json)

insertJSON

public com.mongodb.client.MongoCollection insertJSON(com.mongodb.client.MongoCollection coll,
                                                     String json)

insertFile

public com.mongodb.DBCollection insertFile(com.mongodb.DBCollection coll,
                                           String filename)
                                    throws IOException

Throws:

IOException

insertDocumentsFromFile

public com.mongodb.client.MongoCollection<org.bson.Document> insertDocumentsFromFile(String filename)
                                                                              throws IOException

Throws:

IOException

insertDocumentsFromFile

public com.mongodb.client.MongoCollection<org.bson.Document> insertDocumentsFromFile(com.mongodb.client.MongoCollection<org.bson.Document> coll,
                                                                                     String filename)
                                                                              throws IOException

Throws:

IOException

parseList

public List<com.mongodb.DBObject> parseList(String json)

parseDBObject

public com.mongodb.DBObject parseDBObject(String json)

parse

public <T> T parse(String json)

newCollection

public com.mongodb.DBCollection newCollection()

newCollection

public com.mongodb.DBCollection newCollection(String collectionName)

newMongoCollection

public com.mongodb.client.MongoCollection<org.bson.Document> newMongoCollection()

newMongoCollection

public com.mongodb.client.MongoCollection<org.bson.Document> newMongoCollection(String collectionName)

newMongoCollection

public <T> com.mongodb.client.MongoCollection<T> newMongoCollection(Class<T> documentClass)

newMongoCollection

public <T> com.mongodb.client.MongoCollection<T> newMongoCollection(String collectionName,
                                                                    Class<T> documentClass)

newFongo

protected Fongo newFongo(com.mongodb.connection.ServerVersion serverVersion,
                         org.bson.codecs.configuration.CodecRegistry codecRegistry)

getFongo

public Fongo getFongo()

getDb

@Deprecated
public com.mongodb.DB getDb()

Deprecated.

getDb

@Deprecated
public com.mongodb.DB getDb(String name)

Deprecated.

getDB

public com.mongodb.DB getDB()

getDB

public com.mongodb.DB getDB(String name)

getDatabase

public com.mongodb.client.MongoDatabase getDatabase(String name)

getDatabase

public com.mongodb.client.MongoDatabase getDatabase()

getMongo

@Deprecated
public com.mongodb.Mongo getMongo()

Deprecated.

getMongoClient

public com.mongodb.MongoClient getMongoClient()

randomName

public static String randomName()

randomName

public static String randomName(String prefix)

mustContainsSystemIndexes

public boolean mustContainsSystemIndexes()

getServerVersion

public com.mongodb.connection.ServerVersion getServerVersion()