.. image:: https://circleci.com/gh/novafloss/mock-services.svg?style=shield :target: https://circleci.com/gh/novafloss/mock-services :alt: We are under CI!!
Aims to provide an easy way to mock an entire service API based on
requests-mock_ and a simple dict definition of a service. The idea is to mock
everything at start according given rules. Then mock-services_ allows to
start/stop http mock locally.
During our session we can:
Note: rules urls must be regex. They always will be compiled before updating
the main requests-mock_ urls registry.
Let's mock our favorite search engine::
>>> def fake_duckduckgo_cb(request):
... return 200, {}, 'Coincoin!'
>>> rules = [
... {
... 'text': fake_duckduckgo_cb,
... 'headers': {'Content-Type': 'text/html'},
... 'method': 'GET',
... 'url': r'^https://duckduckgo.com/\?q='
... },
... ]
>>> from mock_services import update_http_rules
>>> update_http_rules(rules)
>>> import requests
>>> requests.get('https://duckduckgo.com/?q=mock-services').content[:15]
'<!DOCTYPE html>'
>>> from mock_services import start_http_mock
>>> start_http_mock()
>>> requests.get('https://duckduckgo.com/?q=mock-services').content
'Coincoin!'
When the http_mock is started if you try to call an external url, it should fail::
>>> requests.get('https://www.google.com/#q=mock-services')
...
ConnectionError: Connection refused: GET https://www.google.com/#q=mock-services
Then you can allow external calls if needed::
>>> from mock_services import http_mock
>>> http_mock.set_allow_external(True)
>>> requests.get('https://www.google.com/#q=mock-services').content[:15]
'<!doctype html>'
At anytime you can stop the mocking as follow::
>>> from mock_services import stop_http_mock
>>> stop_http_mock()
>>> requests.get('https://duckduckgo.com/?q=mock-services').content[:15]
'<!DOCTYPE html>'
Or stop mocking during a function call::
>>> start_http_mock()
>>> @no_http_mock
... def please_do_not_mock_me():
... return requests.get('https://duckduckgo.com/?q=mock-services').content[:15] == '<!DOCTYPE html>', 'mocked!'
>>> please_do_not_mock_me
Or start mocking for another function call::
>>> stop_http_mock()
>>> @with_http_mock
... def please_mock_me():
... assert requests.get('https://duckduckgo.com/?q=mock-services').content == 'Coincoin', 'no mock!'
>>> please_mock_me
You can add REST rules with an explicit method. It will add rules as above and automatically bind callbacks to fake a REST service.
Note: resource and id regex options are mandatory in the rules urls.
Additionally, mock_services_ include attrs_ library. It can be use for
field validation as follow.
This service mock will create, get, update and delete resources for you::
>>> import attr
>>> rest_rules = [
... {
... 'method': 'LIST',
... 'url': r'^http://my_fake_service/(?P<resource>api)$'
... },
... {
... 'method': 'GET',
... 'url': r'^http://my_fake_service/(?P<resource>api)/(?P<id>\d+)$',
... },
... {
... 'method': 'GET',
... 'url': r'^http://my_fake_service/(?P<resource>api)/(?P<id>\d+)/(?P<action>download)$',
... },
... {
... 'method': 'POST',
... 'url': r'^http://my_fake_service/(?P<resource>api)$',
... 'id_name': 'id',
... 'id_factory': int,
... 'attrs': {
... 'bar': attr.ib(),
... 'foo':attr.ib(default=True)
... }
... },
... {
... 'method': 'PATCH',
... 'url': r'^http://my_fake_service/(?P<resource>api)/(?P<id>\d+)$',
... },
... {
... 'method': 'DELETE',
... 'url': r'^http://my_fake_service/(?P<resource>api)/(?P<id>\d+)$'
... },
... ]
>>> from mock_services import update_rest_rules
>>> update_rest_rules(rest_rules)
>>> from mock_services import start_http_mock
>>> start_http_mock()
>>> response = requests.get('http://my_fake_service/api')
>>> response.status_code
200
>>> response.json()
[]
>>> response = requests.get('http://my_fake_service/api/1')
>>> response.status_code
404
>>> import json
>>> response = requests.post('http://my_fake_service/api',
... data=json.dumps({}),
... headers={'content-type': 'application/json'})
>>> response.status_code
400
>>> response = requests.post('http://my_fake_service/api',
... data=json.dumps({'bar': 'Python will save the world'}),
... headers={'content-type': 'application/json'})
>>> response.status_code
201
>>> response.json()
{
'id': 1,
'foo'; True,
'bar'; 'Python will save the world.'
}
>>> response = requests.patch('http://my_fake_service/api/1',
... data=json.dumps({'bar': "Python will save the world. I don't know how. But it will."}),
... headers={'content-type': 'application/json'})
>>> response.status_code
200
>>> response = requests.get('http://my_fake_service/api/1')
>>> response.status_code
200
>>> response.json()
{
'id': 1,
'foo'; True,
'bar'; "Python will save the world. I don't know how. But it will."
}
>>> response = requests.delete('http://my_fake_service/api/1')
>>> response.status_code
204
Is some cases you need to validate a resource against another. Then you can add global validators per endpoint as follow::
>>> from mock_services import storage
>>> from mock_services.service import ResourceContext
>>> from mock_services.exceptions import Http409
>>> def duplicate_foo(request):
... data = json.loads(request.body)
... ctx = ResourceContext(hostname='my_fake_service', resource='api')
... if data['foo'] in [o['foo'] for o in storage.list(ctx)]:
... raise Http409
>>> rest_rules_with_validators = [
... {
... 'method': 'POST',
... 'url': r'^http://my_fake_service/(?P<resource>api)$',
... 'validators': [
... duplicate_foo,
... ],
... },
... ]
>>> response = requests.post('http://my_fake_service/api',
... data=json.dumps({'foo': 'bar'}),
... headers={'content-type': 'application/json'})
>>> response.status_code
201
>>> response = requests.post('http://my_fake_service/api',
... data=json.dumps({'foo': 'bar'}),
... headers={'content-type': 'application/json'})
>>> response.status_code
409
Have fun in testing external APIs ;)
.. _attrs: https://github.com/hynek/attrs
.. _requests-mock: https://github.com/openstack/requests-mock
.. _mock-services: https://github.com/novafloss/mock-services
FAQs
Mock services.
We found that mock-services demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.