Merge lp:~pedronis/u1db/u1db-serve-w-cors into lp:u1db

[Samuele Pedroni]

add support for serving CORS headers to u1db-serve

add support for serving CORS headers to u1db-serve

[Stuart Langridge (sil)]

Seems to be adding headers properly. It might be worth mentioning in the help that you need to quote a "*" otherwise it gets interpreted by the shell ;)

review: Approve

[lp:~pedronis/u1db/u1db-serve-w-cors]

428. By Samuele Pedroni on 2012-10-12

clarify help

=== modified file 'u1db-serve'
--- u1db-serve	2011-12-21 19:33:35 +0000
+++ u1db-serve	2012-10-12 10:25:22 +0000
@@ -37,9 +37,16 @@
         help='Bind to this port when serving.')
     p.add_argument('--working-dir', default='.', metavar='WORKING_DIR',
                    help='Directory where the databases live.')
+    p.add_argument('--accept-cors-connections', default=None,
+                   metavar="ACCEPTED_ORIGINS",
+                   help='Comma separated accepted origins or "*"')
 
     args = p.parse_args(args)
-    server = serve.make_server(args.host, args.port, args.working_dir)
+    accept_cors_connections = args.accept_cors_connections
+    if accept_cors_connections is not None:
+        accept_cors_connections = accept_cors_connections.split(',')
+    server = serve.make_server(args.host, args.port, args.working_dir,
+                               accept_cors_connections)
     sys.stdout.write('listening on: %s:%s\n' % server.server_address)
     sys.stdout.flush()
     server.serve_forever()

=== modified file 'u1db/commandline/serve.py'
--- u1db/commandline/serve.py	2011-12-21 19:33:35 +0000
+++ u1db/commandline/serve.py	2012-10-12 10:25:22 +0000
@@ -21,14 +21,18 @@
 from u1db.remote import (
     http_app,
     server_state,
+    cors_middleware
     )
 
 
-def make_server(host, port, working_dir):
+def make_server(host, port, working_dir, accept_cors_connections=None):
     """Make a server on host and port exposing dbs living in working_dir."""
     state = server_state.ServerState()
     state.set_workingdir(working_dir)
     application = http_app.HTTPApp(state)
+    if accept_cors_connections:
+        application = cors_middleware.CORSMiddleware(application,
+                                                     accept_cors_connections)
     server = httpserver.WSGIServer(application, (host, port),
                                    httpserver.WSGIHandler)
     return server

=== modified file 'u1db/tests/commandline/test_serve.py'
--- u1db/tests/commandline/test_serve.py	2012-04-20 14:57:30 +0000
+++ u1db/tests/commandline/test_serve.py	2012-10-12 10:25:22 +0000
@@ -53,16 +53,21 @@
         self.assertEqual(0, p.returncode)
         self.assertIn('Run the U1DB server', stdout)
 
+    def _get_port(self, p, starts='listening on:'):
+        x = p.stdout.readline().strip()
+        self.assertTrue(x.startswith(starts))
+        return int(x[len(starts):].split(":")[1])
+
+    def _request(self, port, path):
+        url = "http://127.0.0.1:%s%s" % (port, path)
+        c = http_client.HTTPClientBase(url)
+        self.addCleanup(c.close)
+        return c._request_json('GET', [])
+
     def test_bind_to_port(self):
         p = self.startU1DBServe([])
-        starts = 'listening on:'
-        x = p.stdout.readline()
-        self.assertTrue(x.startswith(starts))
-        port = int(x[len(starts):].split(":")[1])
-        url = "http://127.0.0.1:%s/" % port
-        c = http_client.HTTPClientBase(url)
-        self.addCleanup(c.close)
-        res, _ = c._request_json('GET', [])
+        port = self._get_port(p)
+        res, _ = self._request(port, '/')
         self.assertEqual({'version': _u1db_version}, res)
 
     def test_supply_port(self):
@@ -71,12 +76,9 @@
         host, port = s.getsockname()
         s.close()
         p = self.startU1DBServe(['--port', str(port)])
-        x = p.stdout.readline().strip()
-        self.assertEqual('listening on: 127.0.0.1:%s' % (port,), x)
-        url = "http://127.0.0.1:%s/" % port
-        c = http_client.HTTPClientBase(url)
-        self.addCleanup(c.close)
-        res, _ = c._request_json('GET', [])
+        eff_port = self._get_port(p, 'listening on: 127.0.0.1')
+        self.assertEqual(port, eff_port)
+        res, _ = self._request(port, '/')
         self.assertEqual({'version': _u1db_version}, res)
 
     def test_bind_to_host(self):
@@ -85,17 +87,28 @@
         x = p.stdout.readline()
         self.assertTrue(x.startswith(starts))
 
-    def test_supply_working_dir(self):
+    def _landmark_db(self, name):
         tmp_dir = self.createTempDir('u1db-serve-test')
-        db = u1db_open(os.path.join(tmp_dir, 'landmark.db'), create=True)
+        db = u1db_open(os.path.join(tmp_dir, name), create=True)
         db.close()
+        return tmp_dir
+
+    def test_supply_working_dir(self):
+        tmp_dir = self._landmark_db('landmark.db')
         p = self.startU1DBServe(['--working-dir', tmp_dir])
-        starts = 'listening on:'
-        x = p.stdout.readline()
-        self.assertTrue(x.startswith(starts))
-        port = int(x[len(starts):].split(":")[1])
-        url = "http://127.0.0.1:%s/landmark.db" % port
-        c = http_client.HTTPClientBase(url)
-        self.addCleanup(c.close)
-        res, _ = c._request_json('GET', [])
+        port = self._get_port(p)
+        res, _ = self._request(port, '/landmark.db')
         self.assertEqual({}, res)
+
+    def test_accept_cors_connections(self):
+        tmp_dir = self._landmark_db('landmark2.db')
+        origins = ['http://bar.example', 'http://foo.example']
+        p = self.startU1DBServe(['--working-dir', tmp_dir,
+                                 '--accept-cors-connections',
+                                 ','.join(origins)])
+        port = self._get_port(p)
+        res, headers = self._request(port, '/landmark2.db')
+        self.assertEqual({}, res)  # sanity
+        self.assertIn('access-control-allow-origin', headers)
+        self.assertEqual(' '.join(origins),
+                         headers['access-control-allow-origin'])