Merge pull request #7 from lumaghg/simple-example

added simple example and added the proxy mock as default export

Author: lumaghg

examples/simple_example/README.md

@@ -0,0 +1 @@
+run this test with ```deno test --import-map=./import_map.json exampletest.ts``` from this directory

examples/simple_example/exampletest.ts

@@ -0,0 +1,29 @@
+//prodCollection will be replaced by the mockCollection via import map
+import prodCollection from "./prodCollection.ts";
+import { MockCollection } from "../../mod.ts"
+import { Filter, FindOptions } from "https://deno.land/x/[email protected]/mod.ts"
+import {assertSpyCallAsync, Spy} from "https://deno.land/x/[email protected]/mod.ts"
+
+//example function to be tested
+function exampleDatabaseCall() {
+    prodCollection.findOne({ id: "example" }, {limit: 1})
+}
+
+
+Deno.test("simple example", () => {
+    //define the MockCollections behaviour when calling the findOne function
+    MockCollection.initMock({
+        findOne: (_filter?: Filter<unknown> | undefined, _options?: FindOptions | undefined): Promise<unknown> => {
+            return new Promise((resolve, _reject) => {
+                resolve({ id:"example"})
+            })
+        }
+    })
+
+    //execute the function
+    exampleDatabaseCall()
+
+    //check whether the findOne Method was called correctly and returned the correct values
+    assertSpyCallAsync(MockCollection.getInstance().findOne as Spy<any>, 0, {args: [{id: "example"}, {limit: 1}], returned: {id: "example"}})
+
+})

examples/simple_example/import_map.json

@@ -0,0 +1,5 @@
+{
+    "imports":{
+        "./prodCollection.ts" : "https://deno.land/x/denomongo_unittest_utils/mod.ts"
+    }
+}

examples/simple_example/prodCollection.ts

@@ -0,0 +1,7 @@
+import { MongoClient} from "https://deno.land/x/[email protected]/mod.ts"
+
+interface IExample {
+    id: string
+}
+
+export default new MongoClient().database().collection("ExampleCollection")