Fix static resource preflight route in preflight handler adding (#55)

* Fix setup of preflight route for StaticResource.
Because of set_options_route of StaticResource is return nothing, get the OPTIONS route directly from resource instance _routes

* Fix creation of servers for tests in real browser.
Sockets for each server is created before starting app to avoid freezing

* Add integration test for OPTIONS request to static resource route
(used test_page.html)

* Add CORS config test for static resource

Author: vovanbo

aiohttp_cors/urldispatcher_router_adapter.py

@@ -152,7 +152,8 @@ def add_preflight_handler(
                 # Preflight handler already added for this resource.
                 return
 
-            preflight_route = resource.set_options_route(handler)
+            resource.set_options_route(handler)
+            preflight_route = resource._routes[hdrs.METH_OPTIONS]
             self._preflight_routes.add(preflight_route)
             self._resources_with_preflight_handlers.add(resource)
 

tests/aio_test_base.py

@@ -23,12 +23,13 @@
 
 
 @asyncio.coroutine
-def create_server(protocol_factory, loop=None):
+def create_server(protocol_factory, loop=None, sock=None):
     """Create server listening on random port"""
 
-    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
-    sock.bind(("127.0.0.1", 0))
-    sock.listen(10)
+    if sock is None:
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        sock.bind(("127.0.0.1", 0))
+        sock.listen(10)
 
     if loop is None:
         loop = asyncio.get_event_loop()

tests/integration/test_main.py

@@ -16,6 +16,9 @@
 """
 
 import asyncio
+import pathlib
+
+from yarl import URL
 
 from tests.aio_test_base import AioTestBase, create_server, asynctest
 
@@ -802,6 +805,38 @@ def test_preflight_request_headers(self):
             "headers are not allowed: TEST",
             (yield from response.text()))
 
+    @asynctest
+    @asyncio.coroutine
+    def test_static_route(self):
+        """Test a static route with CORS."""
+        app = web.Application()
+        cors = setup(app, defaults={
+            "*": ResourceOptions(
+                allow_credentials=True,
+                expose_headers="*",
+                allow_methods="*",
+                allow_headers=("Content-Type", "X-Header"),
+            )
+        })
+
+        test_static_path = pathlib.Path(__file__).parent
+        cors.add(app.router.add_static("/static", test_static_path, name='static'))
+
+        yield from self.create_server(app)
+
+        response = yield from aiohttp.request(
+            "OPTIONS", URL(self.server_url) / "static/test_page.html",
+            headers={
+                hdrs.ORIGIN: "http://example.org",
+                hdrs.ACCESS_CONTROL_REQUEST_METHOD: "OPTIONS",
+                hdrs.ACCESS_CONTROL_REQUEST_HEADERS: "content-type",
+            }
+        )
+        data = yield from response.text()
+        self.assertEqual(response.status, 200)
+        self.assertEqual(data, '')
+
+
 # TODO: test requesting resources with not configured CORS.
 # TODO: test wildcard origin in default config.
 # TODO: test different combinations of ResourceOptions options.

tests/integration/test_real_browser.py

@@ -18,6 +18,7 @@
 import os
 import json
 import asyncio
+import socket
 import unittest
 import pathlib
 import logging
@@ -111,10 +112,21 @@ def handle_servers_addresses(
             assert server_name not in self.servers
             self.servers[server_name] = _ServerDescr()
 
-        # Create applications.
-        for server_descr in self.servers.values():
+        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)
@@ -128,20 +140,6 @@ def handle_servers_addresses(
             app.router.add_route("GET", "/cors_resource", handle_resource,
                                  name="cors_resource")
 
-        # 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)
-            server_descr.handler = handler
-            server_descr.server = server
-
-            hostaddr, port = server.sockets[0].getsockname()
-            server_descr.url = "http://{host}:{port}".format(
-                host=hostaddr, port=port)
-
-            self._logger.info("Started server '%s' at '%s'",
-                              server_name, server_descr.url)
-
         cors_default_configs = {
             "allowing": {
                 self.servers["origin"].url:
@@ -187,6 +185,17 @@ def handle_servers_addresses(
             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():

tests/unit/test_cors_config.py

@@ -77,3 +77,14 @@ def test_static_named_route(self):
         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)