- Notifications
You must be signed in to change notification settings - Fork42
a socket mock framework - for all kinds of socket animals, web-clients included
License
mindflayer/python-mocket
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
for all kinds of socketanimals, web-clients included - with gevent/asyncio/SSL support
...and then MicroPython'surequests (mocket >= 3.9.1)
Mocket packages are available foropenSUSE,NixOS,ALT Linux,NetBSD, and of course fromPyPI.
Starting from3.7.0, Mocket major version will follow the same numbering pattern as Python's and therefore indicate the most recent Python version that is supported.
FYI: the last version compatible with Python 2.7 is3.9.4, bugfixing or backporting of features introduced after that release will only be available as commercial support.
Star the project on GitHub,Buy Me a Coffee clicking the button below or, even better, contribute with patches or documentation.
Read the following blog posts if you want to have a big picture of whatMocket is capable of:
- https://medium.com/p/mocket-is-alive-and-is-fighting-with-us-b2810d52597a
- https://hackernoon.com/make-development-great-again-faab769d264e
- https://hackernoon.com/httpretty-now-supports-asyncio-e310814704c6
- https://medium.com/@mindflayer/how-to-make-your-tests-fail-when-they-try-to-access-the-network-python-eb80090a6d24
- https://medium.com/@mindflayer/testing-in-an-asyncio-world-a9a0ad41b0c5
The starting point to understand how to useMocket to write a custom mock is the following example:
As next step, you are invited to have a look at the implementation of both the mocks it provides:
- HTTP mock (similar to HTTPretty) -https://github.com/mindflayer/python-mocket/blob/master/mocket/mocks/mockhttp.py
- Redis mock (basic implementation) -https://github.com/mindflayer/python-mocket/blob/master/mocket/mocks/mockredis.py
Please also have a look at the huge test suite:
Using pip:
$ pip install mocket
Mocket usesxxhash when available instead ofhashlib.md5 for creating hashes, you can install it as follows:
$ pip install mocket[speedups]
When opening anIssue, please add few lines of code as failing test, or -better- open its relativePull request adding this test to our test suite.
Let's create a new virtualenv with all we need:
$ python3 -m venv example$ source example/bin/activate$ pip install pytest requests mocket
As second step, we create an example.py file as the following one:
importjsonfrommocketimportmocketizefrommocket.mockhttpimportEntryimportrequestsimportpytest@pytest.fixturedefresponse():return {"integer":1,"string":"asd","boolean":False, }@mocketize# use its decoratordeftest_json(response):url_to_mock='https://testme.org/json'Entry.single_register(Entry.GET,url_to_mock,body=json.dumps(response),headers={'content-type':'application/json'} )mocked_response=requests.get(url_to_mock).json()assertresponse==mocked_response# OR use its context managerfrommocketimportMocketizerdeftest_json_with_context_manager(response):url_to_mock='https://testme.org/json'Entry.single_register(Entry.GET,url_to_mock,body=json.dumps(response),headers={'content-type':'application/json'} )withMocketizer():mocked_response=requests.get(url_to_mock).json()assertresponse==mocked_response
Let's fire our example test:
$ py.test example.py
NEW!!! Sometimes you just want your tests to fail when they attempt to use the network.
withMocketizer(strict_mode=True):withpytest.raises(StrictMocketException):requests.get("https://duckduckgo.com/")# OR@mocketize(strict_mode=True)deftest_get():withpytest.raises(StrictMocketException):requests.get("https://duckduckgo.com/")
You can specify exceptions as a list of hosts or host-port pairs.
withMocketizer(strict_mode=True,strict_mode_allowed=["localhost", ("intake.ourmetrics.net",443)]): ...# OR@mocketize(strict_mode=True,strict_mode_allowed=["localhost", ("intake.ourmetrics.net",443)])deftest_get(): ...
Add this instruction at the end of the test execution:
Mocket.assert_fail_if_entries_not_served()
It's very important that we test non-happy paths.
@mocketizedeftest_raise_exception(self):url="http://github.com/fluidicon.png"Entry.single_register(Entry.GET,url,exception=socket.error())withself.assertRaises(requests.exceptions.ConnectionError):requests.get(url)
You probably know whatVCRpy is capable of, that's themocket's way of achieving it:
@mocketize(truesocket_recording_dir=tempfile.mkdtemp())deftest_truesendall_with_recording_https():url='https://httpbin.org/ip'requests.get(url,headers={"Accept":"application/json"})resp=requests.get(url,headers={"Accept":"application/json"})assertresp.status_code==200dump_filename=os.path.join(Mocket.get_truesocket_recording_dir(),Mocket.get_namespace()+'.json', )withio.open(dump_filename)asf:response=json.load(f)assertlen(response['httpbin.org']['443'].keys())==1
Mocket HTTP mock can work asHTTPretty replacement for many different use cases. Two main features are missing:
- URL entries containing regular expressions;
- response body from functions (used mostly to fake errors,mocket doesn't need to do it this way).
Two features which are against the Zen of Python, at least imho (mindflayer), but of course I am open to call it into question.
Example:
importjsonimportaiohttpimportasynciofromunittestimportTestCasefrommocket.plugins.httprettyimporthttpretty,httprettifiedclassAioHttpEntryTestCase(TestCase):@httprettifieddeftest_https_session(self):url='https://httpbin.org/ip'httpretty.register_uri(httpretty.GET,url,body=json.dumps(dict(origin='127.0.0.1')), )asyncdefmain(l):asyncwithaiohttp.ClientSession(loop=l,timeout=aiohttp.ClientTimeout(total=3) )assession:asyncwithsession.get(url)asget_response:assertget_response.status==200assertawaitget_response.text()=='{"origin": "127.0.0.1"}'loop=asyncio.new_event_loop()loop.set_debug(True)loop.run_until_complete(main(loop))
UsingMocket with asyncio based clients:
$ pip install aiohttp
Example:
# `aiohttp` creates SSLContext instances at import-time# that's why Mocket would get stuck when dealing with HTTP# Importing the module while Mocket is in control (inside a# decorated test function or using its context manager would# be enough for making it work), the alternative is using a# custom TCPConnector which always return a FakeSSLContext# from Mocket like this example is showing.importaiohttpimportpytestfrommocketimportasync_mocketizefrommocket.mockhttpimportEntryfrommocket.plugins.aiohttp_connectorimportMocketTCPConnector@pytest.mark.asyncio@async_mocketizeasyncdeftest_aiohttp():""" The alternative to using the custom `connector` would be importing `aiohttp` when Mocket is already in control (inside the decorated test). """url="https://bar.foo/"data= {"message":"Hello"}Entry.single_register(Entry.GET,url,body=json.dumps(data),headers={"content-type":"application/json"}, )asyncwithaiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=3),connector=MocketTCPConnector() )assession,session.get(url)asresponse:response=awaitresponse.json()assertresponse==data
UsingMocket aspook engine:
$ pip install mocket[pook]
Example:
importpookfrommocket.plugins.pook_mock_engineimportMocketEnginepook.set_mock_engine(MocketEngine)pook.on()url='http://twitter.com/api/1/foobar'status=404response_json= {'error':'foo'}mock=pook.get(url,headers={'content-type':'application/json'},reply=status,response_json=response_json,)mock.persist()requests.get(url)assertmock.calls==1resp=requests.get(url)assertresp.status_code==statusassertresp.json()==response_jsonassertmock.calls==2
EuroPython 2013, Florence
About
a socket mock framework - for all kinds of socket animals, web-clients included