From 9de0862eed803f564003b8137dd717bb2d1d201a Mon Sep 17 00:00:00 2001 From: Jamie Lennox Date: Thu, 10 Apr 2014 13:13:07 +1000 Subject: [PATCH] Initial commit Simple framework with basic testing. --- .gitignore | 43 +++++++ .travis.yml | 15 +++ LICENSE | 180 ++++++++++++++++++++++++++++ MANIFEST.in | 1 + requests_mock/__init__.py | 18 +++ requests_mock/adapter.py | 99 +++++++++++++++ requests_mock/exceptions.py | 22 ++++ requests_mock/mock.py | 48 ++++++++ requests_mock/tests/__init__.py | 0 requests_mock/tests/base.py | 17 +++ requests_mock/tests/test_mocking.py | 37 ++++++ requirements.txt | 3 + setup.cfg | 2 + setup.py | 50 ++++++++ test-requirements.txt | 1 + tox.ini | 10 ++ 16 files changed, 546 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100755 requests_mock/__init__.py create mode 100644 requests_mock/adapter.py create mode 100644 requests_mock/exceptions.py create mode 100755 requests_mock/mock.py create mode 100755 requests_mock/tests/__init__.py create mode 100644 requests_mock/tests/base.py create mode 100644 requests_mock/tests/test_mocking.py create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100755 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..07ee706 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml +htmlcov + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Complexity +output/*.html +output/*/index.html + +# Sphinx +docs/_build \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7dd5cf4 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +# Config file for automatic testing at travis-ci.org + +language: python + +python: + - "3.3" + - "2.7" + - "2.6" + - "pypy" + +# command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors +install: pip install -r requirements.txt + +# command to run tests, e.g. python setup.py test +script: python setup.py test \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c88a073 --- /dev/null +++ b/LICENSE @@ -0,0 +1,180 @@ +Copyright (c) 2014, Jamie Lennox +All rights reserved. + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..1aba38f --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include LICENSE diff --git a/requests_mock/__init__.py b/requests_mock/__init__.py new file mode 100755 index 0000000..5b63d37 --- /dev/null +++ b/requests_mock/__init__.py @@ -0,0 +1,18 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +from requests_mock.mock import Mock +from requests_mock.adapter import Adapter +from requests_mock.exceptions import MockException, NoMockAddress + + +__all__ = ['Mock', 'Adapter', 'MockException', 'NoMockAddress'] diff --git a/requests_mock/adapter.py b/requests_mock/adapter.py new file mode 100644 index 0000000..6cb4b08 --- /dev/null +++ b/requests_mock/adapter.py @@ -0,0 +1,99 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import requests +from requests import adapters + +try: + import urlparse +except ImportError: + import urllib.parse as urlparse + +from requests_mock import exceptions + + +class Matcher(object): + + def __init__(self, url, method, status_code, body, headers): + self.url = urlparse.urlsplit(url.lower()) + self.method = method + self.status_code = status_code + self.body = body.encode('utf-8') + self.headers = headers + + def create_response(self, request): + response = requests.Response() + response.status_code = self.status_code + response.request = request + response._content = self.body + + if self.headers: + response.headers.update(self.headers) + + return response + + +def match(request, matcher): + if request.method.lower() != matcher.method.lower(): + return False + + url = urlparse.urlsplit(request.url.lower()) + + if matcher.url.scheme and url.scheme != matcher.url.scheme: + return False + + if matcher.url.netloc and url.netloc != matcher.url.netloc: + return False + + if matcher.url.path and url.path != matcher.url.path: + return False + + return True + + +class Adapter(adapters.BaseAdapter): + + def __init__(self): + self._matchers = [] + self._request_history = [] + + def send(self, request, **kwargs): + self._request_history.append(request) + + for matcher in self._matchers: + if match(request, matcher): + return matcher.create_response(request) + + raise exceptions.NoMockAddress(request) + + def close(self): + pass + + def register_uri(self, method, url, + status_code=200, + body='', + headers=None): + self._matchers.append(Matcher(url, + method, + status_code, + body, + headers)) + + def latest_request(self): + """Retrieve the latest request sent""" + try: + return self._request_history[-1] + except IndexError: + return None + + +__all__ = ['Adapter'] diff --git a/requests_mock/exceptions.py b/requests_mock/exceptions.py new file mode 100644 index 0000000..24148b9 --- /dev/null +++ b/requests_mock/exceptions.py @@ -0,0 +1,22 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + + +class MockException(Exception): + """Base Exception for library""" + + +class NoMockAddress(MockException): + """The requested URL was not mocked""" + + def __init__(self, request): + self.request = request diff --git a/requests_mock/mock.py b/requests_mock/mock.py new file mode 100755 index 0000000..dc0e226 --- /dev/null +++ b/requests_mock/mock.py @@ -0,0 +1,48 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import fixtures +import requests + +from requests_mock import adapter + + +class Mock(fixtures.Fixture): + + def __init__(self): + super(Mock, self).__init__() + self.adapter = adapter.Adapter() + self._original_get_adapter = None + + def _cleanup(self): + if not self._original_get_adapter: + return + + requests.Session.get_adapter = self._original_get_adapter + self._original_get_adapter = None + + def _get_adapter(self, url): + return self.adapter + + def setUp(self): + super(Mock, self).setUp() + + self._original_get_adapter = requests.Session.get_adapter + requests.Session.get_adapter = self._get_adapter + + self.addCleanup(self._cleanup) + + def register_uri(self, *args, **kwargs): + return self.adapter.register_uri(*args, **kwargs) + + def latest_request(self): + return self.adapter.latest_request() diff --git a/requests_mock/tests/__init__.py b/requests_mock/tests/__init__.py new file mode 100755 index 0000000..e69de29 diff --git a/requests_mock/tests/base.py b/requests_mock/tests/base.py new file mode 100644 index 0000000..9f33054 --- /dev/null +++ b/requests_mock/tests/base.py @@ -0,0 +1,17 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import testtools + + +class TestCase(testtools.TestCase): + pass diff --git a/requests_mock/tests/test_mocking.py b/requests_mock/tests/test_mocking.py new file mode 100644 index 0000000..9919021 --- /dev/null +++ b/requests_mock/tests/test_mocking.py @@ -0,0 +1,37 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import requests +import requests_mock +from requests_mock.tests import base + + +class MockingTests(base.TestCase): + + def setUp(self): + super(MockingTests, self).setUp() + self.mocker = self.useFixture(requests_mock.Mock()) + + def test_basic_install(self): + pass + + def test_failure(self): + self.assertRaises(requests_mock.NoMockAddress, + requests.get, 'http://www.google.com') + + def test_mock(self): + test_url = 'http://www.google.com/' + self.mocker.register_uri('GET', test_url, body='response') + + resp = requests.get(test_url) + self.assertEqual('response', resp.text) + self.assertEqual(test_url, self.mocker.latest_request().url) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..df48d9b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +wheel==0.22.0 +requests +fixtures diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..0a8df87 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[wheel] +universal = 1 \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..3ee74b8 --- /dev/null +++ b/setup.py @@ -0,0 +1,50 @@ +#!/usr/bin/env python + +import os +import sys + + +try: + from setuptools import setup +except ImportError: + from distutils.core import setup + +if sys.argv[-1] == 'publish': + os.system('python setup.py sdist upload') + sys.exit() + +setup( + name='requests-mock', + version='0.1.0-dev', + description='Mock out the requests package', + author='Jamie Lennox', + author_email='jamielennox@gmail.com', + url='https://github.com/jamielennox/requests-mock', + packages=[ + 'requests_mock', + ], + package_dir={'requests_mock': 'requests_mock'}, + include_package_data=True, + install_requires=[ + 'requests', + 'fixtures', + ], + test_requires=[ + 'testtools' + ], + license="BSD", + zip_safe=False, + keywords='requests mock', + classifiers=[ + 'Development Status :: 2 - Pre-Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: Apache Software License' + 'Natural Language :: English', + "Programming Language :: Python :: 2", + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + ], + test_suite='requests_mock.tests', +) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..04da15e --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +testtools diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..1f4acbe --- /dev/null +++ b/tox.ini @@ -0,0 +1,10 @@ +[tox] +envlist = py26, py27, py33 + +[testenv] +setenv = + PYTHONPATH = {toxinidir}:{toxinidir}/requests-mock +commands = python setup.py test +deps = + -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt