Python Mocks Test Helpers
I’ve been writing a python wrapper for the CircleCI API over the last week. I wanted to do this “the right way” with test driven development.
I have a couple integration tests that actually hit the CircleCI API, but most of the unit tests so far are using MagicMock to ensure that the basic functions are working as expected.
This generally involves the tedious process of dumping out JSON, saving it to a file, and then reloading that file later on to actually test it.
I wrote two helper functions that make this process slightly less tedious.
Load Mock
The first is a function that loads a file and overrides every request to return that file (typically as JSON). def loadMock(self, filename):
"""helper function to open mock responses"""
filename = 'tests/mocks/{0}'.format(filename)
with open(filename, 'r') as f:
self.c._request = MagicMock(return_value=f.read())
Test Helper
The second is a function that runs a real request for the first time and dumps the output to a file. def test_helper(self):
resp = self.c.add_circle_key()
print(resp)
with open('tests/mocks/mock_add_circle_key_response', 'w') as f:
json.dump(resp, f)
test_helper allows it to be picked up and ran when you run your test suite since by default unittest will capture any methods that start with test.Usage
An actual example is shown below. def test_clear_cache(self):
self.loadMock('mock_clear_cache_response')
resp = json.loads(self.c.clear_cache('levlaz', 'circleci-sandbox'))
self.assertEqual('build dependency caches deleted', resp['status'])
test_helper and verify that the contents are what we expect them to be.This approach has been working very well for me so far. One thing to keep in mind with writing these types of tests is that you should also include some general integration tests against the API that you are working with. This way you can catch any regressions with your library in the event that the API changes in any way. However, as a basic sanity check mocking these requests is a good practice and less prone to flakiness.
Thank you for reading! Share your thoughts with me on bluesky, mastodon, or via email.
Check out some more stuff to read down below.
Most popular posts this month
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- The contagion of fear from The Observation Deck
- The revolt of the reader from The Observation Deck
- Deeper dive: Were Touch Bar’s problems software rather than hardware? from Unsung
- Joining Cursor from Fatih Arslan
- Pluralistic: Digital sewer socialism (08 Aug 2026) from Pluralistic: Daily links from Cory Doctorow
- Pluralistic: Enshittification and Reverse Centaurs go global (29 Jul 2026) from Pluralistic: Daily links from Cory Doctorow
- AI Mania Is Eviscerating Global Decision-Making from Ludicity
- The default person from https://popagandhi.com/
Articles from blogs I follow around the net
Pluralistic: Remembrance of proteins past (17 Nov 2026)
Today's links Remembrance of proteins past: People like what they like. Hey look at this: Delights to delectate. Object permanence: BBC's bullshit DRM story; Radical hotel-room coffee independence; Foreclosure map predicts Trump vote; Pinkest pink v Anish...
via Pluralistic: Daily links from Cory Doctorow November 17, 2026Pumped Up Kicks
ALICE Experiment/CERN A simulated collision of lead ions, showing the spray of generated particles. There are two ways to study the earliest moments of the Universe. One is to peer into the deepest, darkest regions of space. The other is to study the most...
via Brian Koberlein November 17, 2026Actual curl rewrites in rust
For a long time we have received repeated requests for, or questions about, a curl rewrite in rust. Often as a joke, but also seriously. In this modern world of AIs, we have only been waiting for someone to prove it possible and now it seems we don’t have...
via daniel.haxx.se November 16, 2026Generated by openring