-
Notifications
You must be signed in to change notification settings - Fork 912
GODRIVER-1686 Add tests against Atlas Data Lake #462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
divjotarora
merged 4 commits into
mongodb:master
from
divjotarora:godriver1686-data-lake-testing
Jul 24, 2020
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
===================== | ||
Atlas Data Lake Tests | ||
===================== | ||
|
||
.. contents:: | ||
|
||
---- | ||
|
||
Introduction | ||
============ | ||
|
||
The YAML and JSON files in this directory tree are platform-independent tests | ||
that drivers can use to assert compatibility with `Atlas Data Lake <https://docs.mongodb.com/datalake>`_. | ||
|
||
Running these integration tests will require a running ``mongohoused`` | ||
with data available in its ``test.driverdata`` collection. See the | ||
`ADL directory in drivers-evergreen-tools <https://github.com/mongodb-labs/drivers-evergreen-tools/tree/master/.evergreen/atlas_data_lake>`_ | ||
and `10gen/mongohouse README <https://github.com/10gen/mongohouse/blob/master/README.md>`_ | ||
for more information. | ||
|
||
Several prose tests, which are not easily expressed in YAML, are also presented | ||
in this file. Those tests will need to be manually implemented by each driver. | ||
|
||
Test Format | ||
=========== | ||
|
||
The same as the `CRUD Spec Test format <../../crud/tests/README.rst#Test-Format>`_. | ||
|
||
Test Runner Implementation | ||
========================== | ||
|
||
The same as the `CRUD Spec Test Runner Implementation <../../crud/tests#test-runner-implementation>`_, | ||
with one notable differences: the test runner for Atlas Data Lake Testing | ||
MUST NOT drop the collection and/or database under test. In contrast to other | ||
CRUD tests, which insert their own data fixtures into an empty collection, data | ||
for these tests is specified in the ``mongohoused`` configuration file. | ||
|
||
Prose Tests | ||
=========== | ||
|
||
The following tests MUST be implemented to fully test compatibility with | ||
Atlas Data Lake. | ||
|
||
#. Test that the driver properly constructs and issues a | ||
`killCursors <https://docs.mongodb.com/manual/reference/command/killCursors/>`_ | ||
command to Atlas Data Lake. For this test, configure an APM listener on a | ||
client and execute a query on the ``test.driverdata`` collection that will | ||
leave a cursor open on the server (e.g. specify ``batchSize=2`` for a query | ||
that would match 3+ documents). Drivers MAY iterate the cursor if necessary | ||
to execute the initial ``find`` command but MUST NOT iterate further to avoid | ||
executing a ``getMore``. | ||
|
||
Observe the CommandSucceededEvent event for the ``find`` command and extract | ||
the cursor's ID and namespace from the response document's ``cursor.id`` and | ||
``cursor.ns`` fields, respectively. Destroy the cursor object and observe | ||
a CommandStartedEvent and CommandSucceededEvent for the ``killCursors`` | ||
command. Assert that the cursor ID and target namespace in the outgoing | ||
command match the values from the ``find`` command's CommandSucceededEvent. | ||
When matching the namespace, note that the ``killCursors`` field will contain | ||
the collection name and the database may be inferred from either the ``$db`` | ||
field or accessed via the CommandStartedEvent directly. Finally, assert that | ||
the ``killCursors`` CommandSucceededEvent indicates that the expected cursor | ||
was killed in the ``cursorsKilled`` field. | ||
|
||
Note: this test assumes that drivers only issue a ``killCursors`` command | ||
internally when destroying a cursor that may still exist on the server. If | ||
a driver constructs and issues ``killCursors`` commands in other ways (e.g. | ||
public API), this test MUST be adapted to test all such code paths. | ||
|
||
#. Test that the driver can establish a connection with Atlas Data Lake | ||
without authentication. For these tests, create a MongoClient using a | ||
valid connection string without auth credentials and execute a ping | ||
command. | ||
|
||
#. Test that the driver can establish a connection with Atlas Data Lake | ||
with authentication. For these tests, create a MongoClient using a | ||
valid connection string with SCRAM-SHA-1 and credentials from the | ||
drivers-evergreen-tools ADL configuration and execute a ping command. | ||
Repeat this test using SCRAM-SHA-256. | ||
|
||
Changelog | ||
========= | ||
|
||
:2020-07-15: Link to CRUD test runner implementation and note that the collection | ||
under test must not be dropped before each test. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
{ | ||
"collection_name": "driverdata", | ||
"database_name": "test", | ||
"tests": [ | ||
{ | ||
"description": "Aggregate with pipeline (project, sort, limit)", | ||
"operations": [ | ||
{ | ||
"object": "collection", | ||
"name": "aggregate", | ||
"arguments": { | ||
"pipeline": [ | ||
{ | ||
"$project": { | ||
"_id": 0 | ||
} | ||
}, | ||
{ | ||
"$sort": { | ||
"a": 1 | ||
} | ||
}, | ||
{ | ||
"$limit": 2 | ||
} | ||
] | ||
}, | ||
"result": [ | ||
{ | ||
"a": 1, | ||
"b": 2, | ||
"c": 3 | ||
}, | ||
{ | ||
"a": 2, | ||
"b": 3, | ||
"c": 4 | ||
} | ||
] | ||
} | ||
], | ||
"expectations": [ | ||
{ | ||
"command_started_event": { | ||
"command": { | ||
"aggregate": "driverdata" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
collection_name: &collection_name "driverdata" | ||
database_name: &database_name "test" | ||
|
||
tests: | ||
- | ||
description: "Aggregate with pipeline (project, sort, limit)" | ||
operations: | ||
- | ||
object: collection | ||
name: aggregate | ||
arguments: | ||
pipeline: | ||
- $project: { _id: 0 } | ||
- $sort: { a: 1 } | ||
- $limit: 2 | ||
result: | ||
- { a: 1, b: 2, c: 3 } | ||
- { a: 2, b: 3, c: 4 } | ||
expectations: | ||
- | ||
command_started_event: | ||
command: | ||
aggregate: *collection_name |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"collection_name": "driverdata", | ||
"database_name": "test", | ||
"tests": [ | ||
{ | ||
"description": "estimatedDocumentCount succeeds", | ||
"operations": [ | ||
{ | ||
"object": "collection", | ||
"name": "estimatedDocumentCount", | ||
"result": 15 | ||
} | ||
], | ||
"expectations": [ | ||
{ | ||
"command_started_event": { | ||
"command": { | ||
"count": "driverdata" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
collection_name: &collection_name "driverdata" | ||
database_name: &database_name "test" | ||
|
||
tests: | ||
- | ||
description: "estimatedDocumentCount succeeds" | ||
operations: | ||
- | ||
object: collection | ||
name: estimatedDocumentCount | ||
result: 15 | ||
expectations: | ||
- | ||
command_started_event: | ||
command: | ||
count: *collection_name |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
{ | ||
"collection_name": "driverdata", | ||
"database_name": "test", | ||
"tests": [ | ||
{ | ||
"description": "Find with projection and sort", | ||
"operations": [ | ||
{ | ||
"object": "collection", | ||
"name": "find", | ||
"arguments": { | ||
"filter": { | ||
"b": { | ||
"$gt": 5 | ||
} | ||
}, | ||
"projection": { | ||
"_id": 0 | ||
}, | ||
"sort": { | ||
"a": 1 | ||
}, | ||
"limit": 5 | ||
}, | ||
"result": [ | ||
{ | ||
"a": 5, | ||
"b": 6, | ||
"c": 7 | ||
}, | ||
{ | ||
"a": 6, | ||
"b": 7, | ||
"c": 8 | ||
}, | ||
{ | ||
"a": 7, | ||
"b": 8, | ||
"c": 9 | ||
}, | ||
{ | ||
"a": 8, | ||
"b": 9, | ||
"c": 10 | ||
}, | ||
{ | ||
"a": 9, | ||
"b": 10, | ||
"c": 11 | ||
} | ||
] | ||
} | ||
], | ||
"expectations": [ | ||
{ | ||
"command_started_event": { | ||
"command": { | ||
"find": "driverdata" | ||
} | ||
} | ||
} | ||
] | ||
} | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
collection_name: &collection_name "driverdata" | ||
database_name: &database_name "test" | ||
|
||
tests: | ||
- | ||
description: "Find with projection and sort" | ||
operations: | ||
- | ||
object: collection | ||
name: find | ||
arguments: | ||
filter: { b: { $gt: 5 } } | ||
projection: { _id: 0 } | ||
sort: { a: 1 } | ||
limit: 5 | ||
result: | ||
- {"a": 5, "b": 6, "c": 7} | ||
- {"a": 6, "b": 7, "c": 8} | ||
- {"a": 7, "b": 8, "c": 9} | ||
- {"a": 8, "b": 9, "c": 10} | ||
- {"a": 9, "b": 10, "c": 11} | ||
expectations: | ||
- | ||
command_started_event: | ||
command: | ||
find: *collection_name | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.