An in-memory implementation of the Python client library for Google Cloud Firestore, intended for use in tests to replace the real thing. This project is in early stages and is only a partial implementation of the real client library.
To install:
pip install mock-firestore
Python 3.5+ is required for it to work.
db = firestore.Client() mock_db = MockFirestore() # Can be used in the same way as a firestore.Client() object would be, e.g.: db.collection('users').get() mock_db.collection('users').get()
To reset the store to an empty state, use the reset() method:
mock_db = MockFirestore() mock_db.reset()
mock_db = MockFirestore() # Collections mock_db.collection('users') mock_db.collection('users').get() mock_db.collection('users').list_documents() mock_db.collection('users').stream() # Documents mock_db.collection('users').document() mock_db.collection('users').document('alovelace') mock_db.collection('users').document('alovelace').id mock_db.collection('users').document('alovelace').parent mock_db.collection('users').document('alovelace').update_time mock_db.collection('users').document('alovelace').read_time mock_db.collection('users').document('alovelace').get() mock_db.collection('users').document('alovelace').get().exists mock_db.collection('users').document('alovelace').get().to_dict() mock_db.collection('users').document('alovelace').set({ 'first': 'Ada', 'last': 'Lovelace' }) mock_db.collection('users').document('alovelace').set({'first': 'Augusta Ada'}, merge=True) mock_db.collection('users').document('alovelace').update({'born': 1815}) mock_db.collection('users').document('alovelace').update({'associates': ['Charles Babbage', 'Michael Faraday']}) mock_db.collection('users').document('alovelace').collection('friends') mock_db.collection('users').document('alovelace').delete() mock_db.collection('users').add({'first': 'Ada', 'last': 'Lovelace'}, 'alovelace') mock_db.get_all([mock_db.collection('users').document('alovelace')]) mock_db.document('users/alovelace') mock_db.document('users/alovelace').update({'born': 1815}) mock_db.collection('users/alovelace/friends') # Querying mock_db.collection('users').order_by('born').get() mock_db.collection('users').order_by('born', direction='DESCENDING').get() mock_db.collection('users').limit(5).get() mock_db.collection('users').where('born', '==', 1815).get() mock_db.collection('users').where('born', '<', 1815).get() mock_db.collection('users').where('born', '>', 1815).get() mock_db.collection('users').where('born', '<=', 1815).get() mock_db.collection('users').where('born', '>=', 1815).get() mock_db.collection('users').where('born', 'in', [1815, 1900]).stream() mock_db.collection('users').where('born', 'in', [1815, 1900]).stream() mock_db.collection('users').where('associates', 'array_contains', 'Charles Babbage').stream() mock_db.collection('users').where('associates', 'array_contains_any', ['Charles Babbage', 'Michael Faraday']).stream() # Transforms mock_db.collection('users').document('alovelace').update({'likes': firestore.Increment(1)}) mock_db.collection('users').document('alovelace').update({'associates': firestore.ArrayUnion(['Andrew Cross', 'Charles Wheatstone'])}) # Cursors mock_db.collection('users').start_after({'id': 'alovelace'}).stream() mock_db.collection('users').end_before({'id': 'alovelace'}).stream() mock_db.collection('users').end_at({'id': 'alovelace'}).stream() mock_db.collection('users').start_after(mock_db.collection('users').document('alovelace')).stream() # Transactions transaction = mock_db.transaction() transaction.id transaction.in_progress transaction.get(mock_db.collection('users').where('born', '==', 1815)) transaction.get(mock_db.collection('users').document('alovelace')) transaction.get_all([mock_db.collection('users').document('alovelace')]) transaction.set(mock_db.collection('users').document('alovelace'), {'born': 1815}) transaction.update(mock_db.collection('users').document('alovelace'), {'born': 1815}) transaction.delete(mock_db.collection('users').document('alovelace')) transaction.commit()
- Create and activate a virtualenv with a Python version of at least 3.5
- Install dependencies with
pip install -r requirements-dev-minimal.txt - Run tests with
python -m unittest discover tests -t /