pax_global_header00006660000000000000000000000064130666224660014525gustar00rootroot0000000000000052 comment=4130a8b7d7f965afe31cc350227780d69a4f840c aiohttp-cors-0.5.0/000077500000000000000000000000001306662246600141435ustar00rootroot00000000000000aiohttp-cors-0.5.0/CHANGES.rst000066400000000000000000000032501306662246600157450ustar00rootroot00000000000000CHANGES ======= 0.5.0 (2016-11-18) ------------------ - Fix compatibility with aiohttp 1.1 0.4.0 (2016-04-04) ------------------ - Fixed support with new Resources objects introduced in ``aiohttp`` 0.21.0. Minimum supported version of ``aiohttp`` is 0.21.4 now. - New Resources objects are supported. You can specify default configuration for a Resource and use ``allow_methods`` to explicitly list allowed methods (or ``*`` for all HTTP methods): .. code-block:: python # Allow POST and PUT requests from "http://client.example.org" origin. hello_resource = cors.add(app.router.add_resource("/hello"), { "http://client.example.org": aiohttp_cors.ResourceOptions( allow_methods=["POST", "PUT"]), }) # No need to add POST and PUT routes into CORS configuration object. hello_resource.add_route("POST", handler_post) hello_resource.add_route("PUT", handler_put) # Still you can add additional methods to CORS configuration object: cors.add(hello_resource.add_route("DELETE", handler_delete)) - ``AbstractRouterAdapter`` was completely rewritten to be more Router agnostic. 0.3.0 (2016-02-06) ------------------ - Rename ``UrlDistatcherRouterAdapter`` to ``UrlDispatcherRouterAdapter``. - Set maximum supported ``aiohttp`` version to ``0.20.2``, see bug #30 for details. 0.2.0 (2015-11-30) ------------------ - Move ABCs from ``aiohttp_cors.router_adapter`` to ``aiohttp_cors.abc``. - Rename ``RouterAdapter`` to ``AbstractRouterAdapter``. - Fix bug with configuring CORS for named routes. 0.1.0 (2015-11-05) ------------------ * Initial release. aiohttp-cors-0.5.0/LICENSE000066400000000000000000000261361306662246600151600ustar00rootroot00000000000000 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. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. aiohttp-cors-0.5.0/MANIFEST.in000066400000000000000000000001751306662246600157040ustar00rootroot00000000000000include LICENSE include CHANGES.rst include README.rst recursive-include tests *.py include tests/integration/test_page.html aiohttp-cors-0.5.0/PKG-INFO000066400000000000000000000535431306662246600152520ustar00rootroot00000000000000Metadata-Version: 1.1 Name: aiohttp-cors Version: 0.5.0 Summary: CORS support for aiohttp Home-page: https://github.com/aio-libs/aiohttp-cors Author: Vladimir Rutsky Author-email: vladimir@rutsky.org License: Apache License, Version 2.0 Description: CORS support for aiohttp ======================== ``aiohttp_cors`` library implements `Cross Origin Resource Sharing (CORS) `__ support for `aiohttp `__ asyncio-powered asynchronous HTTP server. Jump directly to `Usage`_ part to see how to use ``aiohttp_cors``. Same-origin policy ================== Web security model is tightly connected to `Same-origin policy (SOP) `__. In short: web pages cannot *Read* resources which origin doesn't match origin of requested page, but can *Embed* (or *Execute*) resources and have limited ability to *Write* resources. Origin of a page is defined in the `Standard `__ as tuple ``(schema, host, port)`` (there is a notable exception with Internet Explorer: it doesn't use port to define origin, but uses it's own `Security Zones `__). Can *Embed* means that resource from other origin can be embedded into the page, e.g. by using `` aiohttp-cors-0.5.0/tests/integration/test_real_browser.py000066400000000000000000000264171306662246600237410ustar00rootroot00000000000000# Copyright 2015 Vladimir Rutsky # # 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. """System test using real browser. """ import os import json import asyncio import socket import unittest import pathlib import logging import webbrowser from aiohttp import web, hdrs import selenium.common.exceptions from selenium import webdriver from selenium.webdriver.support.ui import WebDriverWait from selenium.webdriver.common.keys import Keys from selenium.webdriver.common.by import By from selenium.webdriver.support import expected_conditions as EC from aiohttp_cors import setup, ResourceOptions from ..aio_test_base import create_server, AioTestBase, asynctest class _ServerDescr: """Auxiliary class for storing server info""" def __init__(self): self.app = None self.cors = None self.handler = None self.server = None self.url = None class IntegrationServers: """Integration servers starting/stopping manager""" def __init__(self, use_resources, *, loop=None): self.servers = {} self.loop = loop if self.loop is None: self.loop = asyncio.get_event_loop() self.use_resources = use_resources self._logger = logging.getLogger("IntegrationServers") @property def origin_server_url(self): return self.servers["origin"].url @asyncio.coroutine def start_servers(self): test_page_path = pathlib.Path(__file__).with_name("test_page.html") @asyncio.coroutine def handle_test_page(request: web.Request) -> web.StreamResponse: with test_page_path.open("r", encoding="utf-8") as f: return web.Response( text=f.read(), headers={hdrs.CONTENT_TYPE: "text/html"}) @asyncio.coroutine def handle_no_cors(request: web.Request) -> web.StreamResponse: return web.Response( text="""{"type": "no_cors.json"}""", headers={hdrs.CONTENT_TYPE: "application/json"}) @asyncio.coroutine def handle_resource(request: web.Request) -> web.StreamResponse: return web.Response( text="""{"type": "resource"}""", headers={hdrs.CONTENT_TYPE: "application/json"}) @asyncio.coroutine def handle_servers_addresses( request: web.Request) -> web.StreamResponse: servers_addresses = \ {name: descr.url for name, descr in self.servers.items()} return web.Response( text=json.dumps(servers_addresses)) # For most resources: # "origin" server has no CORS configuration. # "allowing" server explicitly allows CORS requests to "origin" server. # "denying" server explicitly disallows CORS requests to "origin" # server. # "free_for_all" server allows CORS requests for all origins server. # "no_cors" server has no CORS configuration. cors_server_names = ["allowing", "denying", "free_for_all"] server_names = cors_server_names + ["origin", "no_cors"] for server_name in server_names: assert server_name not in self.servers self.servers[server_name] = _ServerDescr() server_sockets = {} # Create applications and sockets. for server_name, server_descr in self.servers.items(): server_descr.app = web.Application() sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) sock.bind(("127.0.0.1", 0)) sock.listen(10) server_sockets[server_name] = sock hostaddr, port = sock.getsockname() server_descr.url = "http://{host}:{port}".format( host=hostaddr, port=port) # Server test page from origin server. self.servers["origin"].app.router.add_route( "GET", "/", handle_test_page) self.servers["origin"].app.router.add_route( "GET", "/servers_addresses", handle_servers_addresses) # Add routes to all servers. for server_name in server_names: app = self.servers[server_name].app app.router.add_route("GET", "/no_cors.json", handle_no_cors) app.router.add_route("GET", "/cors_resource", handle_resource, name="cors_resource") cors_default_configs = { "allowing": { self.servers["origin"].url: ResourceOptions( allow_credentials=True, expose_headers="*", allow_headers="*") }, "denying": { # Allow requests to other than "origin" server. self.servers["allowing"].url: ResourceOptions( allow_credentials=True, expose_headers="*", allow_headers="*") }, "free_for_all": { "*": ResourceOptions( allow_credentials=True, expose_headers="*", allow_headers="*") }, } # Configure CORS. for server_name, server_descr in self.servers.items(): default_config = cors_default_configs.get(server_name) if default_config is None: continue server_descr.cors = setup( server_descr.app, defaults=default_config) # Add CORS routes. for server_name in cors_server_names: server_descr = self.servers[server_name] # TODO: Starting from aiohttp 0.21.0 name-based access returns # Resource, not Route. Manually get route while aiohttp_cors # doesn't support configuring for Resources. resource = server_descr.app.router["cors_resource"] route = next(iter(resource)) if self.use_resources: server_descr.cors.add(resource) server_descr.cors.add(route) else: server_descr.cors.add(route) # Start servers. for server_name, server_descr in self.servers.items(): handler = server_descr.app.make_handler() server = yield from create_server(handler, self.loop, sock=server_sockets[server_name]) server_descr.handler = handler server_descr.server = server self._logger.info("Started server '%s' at '%s'", server_name, server_descr.url) @asyncio.coroutine def stop_servers(self): for server_descr in self.servers.values(): server_descr.server.close() yield from server_descr.handler.finish_connections() yield from server_descr.server.wait_closed() yield from server_descr.app.finish() self.servers = {} def _get_chrome_driver(): driver_path_env = "WEBDRIVER_CHROMEDRIVER_PATH" if driver_path_env in os.environ: driver = webdriver.Chrome(executable_path=os.environ[driver_path_env]) else: driver = webdriver.Chrome() return driver class TestInBrowser(AioTestBase): @asyncio.coroutine def _test_in_webdriver(self, driver, use_resources): # TODO: Use pytest's fixtures to test use resources/not use resources. servers = IntegrationServers(use_resources) yield from servers.start_servers() def selenium_thread(): driver.get(servers.origin_server_url) assert "aiohttp_cors" in driver.title wait = WebDriverWait(driver, 10) run_button = wait.until(EC.element_to_be_clickable( (By.ID, "runTestsButton"))) # Start tests. run_button.send_keys(Keys.RETURN) # Wait while test will finish (until clear button is not # activated). wait.until(EC.element_to_be_clickable( (By.ID, "clearResultsButton"))) # Get results json results_area = driver.find_element_by_id("results") return json.loads(results_area.get_attribute("value")) try: results = yield from self.loop.run_in_executor( self.thread_pool_executor, selenium_thread) self.assertEqual(results["status"], "success") for test_name, test_data in results["data"].items(): with self.subTest(group_name=test_name): self.assertEqual(test_data["status"], "success", msg=(test_name, test_data)) finally: yield from servers.stop_servers() @asynctest @asyncio.coroutine def test_firefox(self): try: driver = webdriver.Firefox() except selenium.common.exceptions.WebDriverException: raise unittest.SkipTest try: yield from self._test_in_webdriver(driver, False) finally: driver.close() @asynctest @asyncio.coroutine def test_chromium(self): try: driver = _get_chrome_driver() except selenium.common.exceptions.WebDriverException: raise unittest.SkipTest try: yield from self._test_in_webdriver(driver, False) finally: driver.close() @asynctest @asyncio.coroutine def test_firefox_resource(self): try: driver = webdriver.Firefox() except selenium.common.exceptions.WebDriverException: raise unittest.SkipTest try: yield from self._test_in_webdriver(driver, True) finally: driver.close() @asynctest @asyncio.coroutine def test_chromium_resource(self): try: driver = _get_chrome_driver() except selenium.common.exceptions.WebDriverException: raise unittest.SkipTest try: yield from self._test_in_webdriver(driver, True) finally: driver.close() def _run_integration_server(): """Runs integration server for interactive debugging.""" logging.basicConfig(level=logging.INFO) logger = logging.getLogger("run_integration_server") loop = asyncio.get_event_loop() servers = IntegrationServers() logger.info("Starting integration servers...") loop.run_until_complete(servers.start_servers()) try: webbrowser.open(servers.origin_server_url) except webbrowser.Error: pass try: loop.run_forever() except KeyboardInterrupt: pass finally: logger.info("Stopping integration servers...") loop.run_until_complete(servers.stop_servers()) if __name__ == "__main__": # This module can be run in the following way: # $ python -m tests.integration.test_real_browser # from aiohttp_cors root directory. _run_integration_server() aiohttp-cors-0.5.0/tests/unit/000077500000000000000000000000001306662246600162645ustar00rootroot00000000000000aiohttp-cors-0.5.0/tests/unit/__init__.py000066400000000000000000000000001306662246600203630ustar00rootroot00000000000000aiohttp-cors-0.5.0/tests/unit/test___about__.py000066400000000000000000000017111306662246600216030ustar00rootroot00000000000000# Copyright 2015 Vladimir Rutsky # # 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. """Test aiohttp_cors package metainformation. """ import unittest from pkg_resources import parse_version import aiohttp_cors class TestMetaInformation(unittest.TestCase): """Test package metainformation""" # pylint: disable=no-self-use def test_version(self): """Test package version string""" parse_version(aiohttp_cors.__version__) aiohttp-cors-0.5.0/tests/unit/test_cors_config.py000066400000000000000000000063371306662246600222010ustar00rootroot00000000000000# Copyright 2015 Vladimir Rutsky # # 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. """aiohttp_cors.cors_config unit tests. """ import asyncio import unittest from aiohttp import web from aiohttp_cors import CorsConfig, ResourceOptions def _handler(request): return web.Response(text="Done") class TestCorsConfig(unittest.TestCase): """Unit tests for CorsConfig""" def setUp(self): self.loop = asyncio.new_event_loop() self.app = web.Application(loop=self.loop) self.cors = CorsConfig(self.app, defaults={ "*": ResourceOptions() }) self.get_route = self.app.router.add_route( "GET", "/get_path", _handler) self.options_route = self.app.router.add_route( "OPTIONS", "/options_path", _handler) def tearDown(self): self.loop.close() def test_add_options_route(self): """Test configuring OPTIONS route""" with self.assertRaises(RuntimeError): self.cors.add(self.options_route.resource) def test_plain_named_route(self): """Test adding plain named route.""" # Adding CORS routes should not introduce new named routes. self.assertEqual(len(self.app.router.keys()), 0) route = self.app.router.add_route( "GET", "/{name}", _handler, name="dynamic_named_route") self.assertEqual(len(self.app.router.keys()), 1) self.cors.add(route) self.assertEqual(len(self.app.router.keys()), 1) def test_dynamic_named_route(self): """Test adding dynamic named route.""" self.assertEqual(len(self.app.router.keys()), 0) route = self.app.router.add_route( "GET", "/{name}", _handler, name="dynamic_named_route") self.assertEqual(len(self.app.router.keys()), 1) self.cors.add(route) self.assertEqual(len(self.app.router.keys()), 1) def test_static_named_route(self): """Test adding dynamic named route.""" self.assertEqual(len(self.app.router.keys()), 0) route = self.app.router.add_static( "/file", "/", name="dynamic_named_route") self.assertEqual(len(self.app.router.keys()), 1) self.cors.add(route) self.assertEqual(len(self.app.router.keys()), 1) def test_static_resource(self): """Test adding static resource.""" self.assertEqual(len(self.app.router.keys()), 0) self.app.router.add_static( "/file", "/", name="dynamic_named_route") self.assertEqual(len(self.app.router.keys()), 1) for resource in list(self.app.router.resources()): if issubclass(resource, web.StaticResource): self.cors.add(resource) self.assertEqual(len(self.app.router.keys()), 1) aiohttp-cors-0.5.0/tests/unit/test_resource_options.py000066400000000000000000000041711306662246600233020ustar00rootroot00000000000000# Copyright 2015 Vladimir Rutsky # # 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. """aiohttp_cors.resource_options unit tests. """ import unittest from aiohttp_cors.resource_options import ResourceOptions class TestResourceOptions(unittest.TestCase): """Unit tests for ResourceOptions class""" def test_init_no_args(self): """Test construction without arguments""" opts = ResourceOptions() self.assertFalse(opts.allow_credentials) self.assertFalse(opts.expose_headers) self.assertFalse(opts.allow_headers) self.assertIsNone(opts.max_age) def test_comparison(self): self.assertTrue(ResourceOptions() == ResourceOptions()) self.assertFalse(ResourceOptions() != ResourceOptions()) self.assertFalse( ResourceOptions(allow_credentials=True) == ResourceOptions()) self.assertTrue( ResourceOptions(allow_credentials=True) != ResourceOptions()) def test_allow_methods(self): self.assertIsNone(ResourceOptions().allow_methods) self.assertEqual( ResourceOptions(allow_methods='*').allow_methods, '*') self.assertEqual( ResourceOptions(allow_methods=[]).allow_methods, frozenset()) self.assertEqual( ResourceOptions(allow_methods=['get']).allow_methods, frozenset(['GET'])) self.assertEqual( ResourceOptions(allow_methods=['get', 'Post']).allow_methods, {'GET', 'POST'}) with self.assertRaises(ValueError): ResourceOptions(allow_methods='GET') # TODO: test arguments parsing aiohttp-cors-0.5.0/tests/unit/test_urldispatcher_router_adapter.py000066400000000000000000000101521306662246600256450ustar00rootroot00000000000000# Copyright 2015 Vladimir Rutsky # # 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. """aiohttp_cors.urldispatcher_router_adapter unit tests. """ import asyncio import unittest from unittest import mock from aiohttp import web from aiohttp_cors.urldispatcher_router_adapter import \ ResourcesUrlDispatcherRouterAdapter from aiohttp_cors import ResourceOptions def _handler(request): return web.Response(text="Done") class TestResourcesUrlDispatcherRouterAdapter(unittest.TestCase): """Unit tests for CorsConfig""" def setUp(self): self.loop = asyncio.new_event_loop() self.app = web.Application(loop=self.loop) self.adapter = ResourcesUrlDispatcherRouterAdapter( self.app.router, defaults={ "*": ResourceOptions() }) self.get_route = self.app.router.add_route( "GET", "/get_path", _handler) self.options_route = self.app.router.add_route( "OPTIONS", "/options_path", _handler) def tearDown(self): self.loop.close() def test_add_get_route(self): """Test configuring GET route""" result = self.adapter.add_preflight_handler( self.get_route.resource, _handler) self.assertIsNone(result) self.assertEqual(len(self.adapter._resource_config), 0) self.assertEqual( len(self.adapter._resources_with_preflight_handlers), 1) self.assertEqual(len(self.adapter._preflight_routes), 1) def test_add_options_route(self): """Test configuring OPTIONS route""" with self.assertRaisesRegex( ValueError, "CORS must be enabled for route's resource first"): self.adapter.add_preflight_handler(self.options_route, _handler) self.assertFalse(self.adapter._resources_with_preflight_handlers) self.assertFalse(self.adapter._preflight_routes) def test_get_non_preflight_request_config(self): self.adapter.add_preflight_handler( self.get_route.resource, _handler) self.adapter.set_config_for_routing_entity( self.get_route.resource, { 'http://example.org': ResourceOptions(), }) self.adapter.add_preflight_handler( self.get_route, _handler) self.adapter.set_config_for_routing_entity( self.get_route, { 'http://test.example.org': ResourceOptions(), }) request = mock.Mock() with mock.patch('aiohttp_cors.urldispatcher_router_adapter.' 'ResourcesUrlDispatcherRouterAdapter.' 'is_cors_enabled_on_request' ) as is_cors_enabled_on_request, \ mock.patch('aiohttp_cors.urldispatcher_router_adapter.' 'ResourcesUrlDispatcherRouterAdapter.' '_request_resource' ) as _request_resource: is_cors_enabled_on_request.return_value = True _request_resource.return_value = self.get_route.resource self.assertEqual( self.adapter.get_non_preflight_request_config(request), { '*': ResourceOptions(), 'http://example.org': ResourceOptions(), }) request.method = 'GET' self.assertEqual( self.adapter.get_non_preflight_request_config(request), { '*': ResourceOptions(), 'http://example.org': ResourceOptions(), 'http://test.example.org': ResourceOptions(), })