NAME
Test::Mock::Mango - Simple stubbing for Mango to allow unit tests for code that uses it
SYNOPSIS
# Using Test::More
#
use Test::More;
use Test::Mock::Mango; # Stubs in effect!
# ...
done_testing();
# Using Test::Spec (uses Test::Spec::Mocks)
#
use Test::Spec;
describe "Whilst stubbing Mango" => {
require Test::Mock::Mango; # Stubs in effect in scope!
# ...
};
runtests unless caller;
DESCRIPTION
Simple stubbing of mango methods. Methods ignore actual queries being entered and simply return the data set in the FakeData object. To run a test you need to set up the data you expect back first - this module doesn't test your queries, it allows you to test around mango calls with known conditions.
STUBBED METHODS
The following methods are available on each faked part of the mango. We describe here briefly how far each actually simulates the real method.
Each method supports blocking and non-blocking syntax if the original method does. Non-blocking ops are not actually non blocking but simply execute your callback straight away as there's nothing to actually go off and do on an event loop.
All methhods by default execute without error state.
Collection
aggregate
Ignores query. Returns current collection documents to simulate an aggregated result.
create
Doesn't really do anything.
drop
Doesn't really do anything.
find_one
Ignores query. Returns the first document from the current fake collection given in Test::Mock::Mango::FakeData. Returns undef if the collection is empty.
find
Ignores query. Returns a new Test::Mock::Mango::Cursor instance.
full_name
Returns full name of the fake collection.
insert
Naively inserts the given doc(s) onto the end of the current fake collection.
Returns an oid
for each inserted document. If an _id
is specifiec in the inserted doc then it is returned, otherwise a new Mango::BSON::ObjectID is returned instead.
update
Doesn't perform a real update. You should set the data state in $Test::Mock::Mango::data
before making the call to be what you expect after the update.
remove
Doesn't remove anything.
Cursor
all
Return array ref containing all the documents in the current fake collection.
next
Simulates a cursor by (beginning at zero) iterating through each document on successive calls. Won't reset itself. If you want to reset the cursor then set Test::Mock::Mango-
index> to zero.
count
Returns the number of documents in the current fake collection.
backlog
Arbitarily returns '2
'
TESTING ERROR STATES
Test::Mock::Mango gives you the ability to simulate errors from your mango calls.
Simply set the error
var before the call:
$Test::Mock::Mango::error = 'oh noes!';
The next call will then run in an error state as if a real error has occurred. The error
var is automatically cleared with the call so you don't need to undef
it afterwards.
AUTHOR
J Gregory <JGREGORY@CPAN.ORG>