Skip to main content

A test library to mock MongoDB commands with AsyncMongoClient compatibility

Project description

wiremongo

A lightweight test library for mocking MongoDB operations with AsyncMongoClient compatibility. Designed for creating integrated tests without requiring a real MongoDB instance.

Installation

pip install wiremongo

Usage

Basic Usage

Replace your real AsyncMongoClient with MockClient in your tests:

from wiremongo import MockClient, FindOneMock, InsertOneMock

# Replace AsyncMongoClient with MockClient in your tests
client = MockClient()
db = client["test_db"]
collection = db["test_collection"]

# Mock find_one operation
find_mock = FindOneMock().with_query({"_id": "123"}).returns({"_id": "123", "name": "test"})
collection.find_one = find_mock.get_result

# Use in your tests
result = await collection.find_one({"_id": "123"})
assert result["name"] == "test"

JSON File Mappings

Use the provided hook to load mock mappings from JSON files:

from wiremongo import WireMongo
from wiremongo.tools import read_filemappings

wiremongo = WireMongo()

# Load mock mappings from tests/resources/mappings/*.json
await read_filemappings(wiremongo)

Create JSON mapping files in tests/resources/mappings/:

{
  "cmd": "find_one",
  "with_database": "test_db",
  "with_collection": "users",
  "with_query": {"_id": "123"},
  "returns": {"_id": "123", "name": "John"}
}

Supported Operations

  • Collection Operations: find_one, find, insert_one, insert_many, update_one, update_many, delete_one, delete_many, count_documents, distinct, create_index, bulk_write, drop, drop_indexes
  • Database Operations: command, create_collection, drop_collection
  • Cursor Operations: find, aggregate with async iteration support

Development

# Clone and setup
git clone <repository-url>
cd wiremongo
poetry install

# Activate virtual environment
poetry shell

# Run tests
poetry run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wiremongo-0.1.0-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file wiremongo-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: wiremongo-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wiremongo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d632c8512a1dfef0c9315a8db7020d5938461463b5dd26315c07da825daf420
MD5 be19f867d0198b604860891173f5c6fa
BLAKE2b-256 e524399813d4db3a287cdf03489a0b2f5aa40ea019b7f02d3dc8b41f8de30328

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page