Testing PyMongo As A Black Pipe

This is the second article in my six-part series on “black pipe” testing. PyMongo, the official Python client for MongoDB, is a great example of a connected application that can’t be fully tested as a black box.

It has two ends that take inputs and provide outputs: one is its public API, the methods find and insert_one and so on. But the other is its communication over the network with the MongoDB server. Only by treating it as a black pipe can we fully test its surfaces.

This year I implemented a tool for black pipe testing called MockupDB. It is a MongoDB wire protocol server written in Python, with three sets of features to aid tests:

  • First, it speaks the whole wire protocol, over TCP, just like a MongoDB server. You can even connect to it with the mongo shell.
  • Second, it can run in the same Python process as PyMongo. A black pipe test neatly interleaves PyMongo calls and MockupDB calls to choreograph a sequence of requests and responses.
  • Third, MockupDB has a rich API for validating the messages PyMongo sends.

Testing PyMongo With MockupDB

Here’s the sort of test for which “black box” fails, but “black pipe” is perfect.

Starting with version 2.6 last year, MongoDB’s wire protocol for modifying data changed. To insert a document, for example, drivers no longer send an OP_INSERT message followed by a “getLastError” command. Instead, drivers send a single command, called “insert”. A driver should use the new protocol if the server is modern enough to understand it.

But, it is impossible to know, based on its externally-observable behavior, whether a driver is using the old or new protocol. MongoDB supports the old wire protocol to this day. Even if a driver never upgrades its protocol, it can still insert data. So a black box test would pass! How do we validate that a driver uses the new protocol?

First, we start a MockupDB server that speaks the new wire protocol:

>>> from mockupdb import MockupDB
>>> server = MockupDB(auto_ismaster={"maxWireVersion": 3})
>>> from pymongo import MongoClient
>>> client = MongoClient(server.uri)
>>> collection = client.db.collection

Let us insert a document. Once the client sends its message to MockupDB, it blocks awaiting acknowledgment, so we run it on a background thread using MockupDB’s go function:

>>> from mockupdb import go
>>> document = {"_id": 1}
>>> future = go(collection.insert_one, document)

Now the client waits, and we use MockupDB to read the message it sent:

>>> request = server.receives()
>>> request
Command({"insert": "collection", "documents": [{"_id": 1}]})

We see the client has correctly sent an “insert” command, part of the new wire protocol. Respond on the main thread:

>>> request.reply({'ok': 1})

This unblocks the client, so the result of go(collection.insert_one, document) is ready:

>>> future()

Let us say the driver had a bug, and it did not speak the new wire protocol when talking to a modern server. A black box test could not detect this bug, but MockupDB can. We validate that the client sends the right message using MockupDB’s pattern-matching:

>>> # How a test would fail if PyMongo did
>>> # not correctly use the new protocol:
>>> from mockupdb import Command
>>> request = server.receives(Command({"insert": "collection"}))
expected Command({"insert": "collection"}), got OpInsert({"_id": 1})

With MockupDB we catch the bug, because we test both ends of the pipe.

A variety of MongoDB driver tests were difficult or impossible, until now. I’m excited to begin testing driver features that were only manually tested before, using tcpdump or the like. I look forward even more to deleting hacky old tests that access PyMongo internals or exploit odd MongoDB server behaviors. Most such tests can now be gracefully expressed as black pipe tests with MockupDB.

Read the whole series on black pipe testing.

Reference: Testing PyMongo As A Black Pipe from our WCG partner Jesse Davis at the A. Jesse Jiryu Davis blog.

Jesse Davis

Jesse is a senior engineer at MongoDB in New York City. He specializes in Python, MongoDB drivers, and asynchronous frameworks.
Notify of

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Inline Feedbacks
View all comments
Back to top button