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
- 2024
- Reinstalling Windows at 1am
- SQLite DB Migrations with PRAGMA user_version
- My Custom Miniflux CSS Theme
- How to Disable Wayland in Debian Testing
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- Give Your Spouse the Gift of a Couple's Email Domain from mtlynch.io
- Have smart glasses finally hit an inflection point? from The Torment Nexus
- The McPhee method from the jsomers.net blog
- Pluralistic: LLMs are slot-machines (16 Aug 2025) from Pluralistic: Daily links from Cory Doctorow
- Pluralistic: Bluesky creates the world's weirdest, hardest-to-understand binding arbitration clause (15 Aug 2025) from Pluralistic: Daily links from Cory Doctorow
- Just a Little More Context Bro, I Promise, and It’ll Fix Everything from Jim Nielsen’s Blog
- The Futzing Fraction from Deciphering Glyph
- Sit On Your Ass Web Development from Jim Nielsen’s Blog
Articles from blogs I follow around the net
Issue 91 – GDP on the blockchain
The regulator set to take on primary crypto oversight is down to a single Commissioner, and new pro-crypto PACs focus on installing more Republicans in the midterms
via Citation Needed August 27, 2025V&A East Storehouse and Operation Mincemeat in London
We were back in London for a few days and yesterday had a day of culture. First up: the brand new V&A East Storehouse museum in the Queen Elizabeth Olympic Park near Stratford, which opened on May 31st this year. This is a delightful new format for a mu…
via Simon Willison's Weblog: Entries August 27, 2025Generated by openring