Merge lp:~stevanr/linaro-license-protection/bug-1085007 into lp:~linaro-automation/linaro-license-protection/trunk

[Stevan Radaković]

Additional fix for bug 1085007.
When certificates for www.linaro.org are fixed, this code will become obsolete and may be removed.

[Данило Шеган (danilo)]

Hi Stevan,

Thanks for working on this. It's very close to being ready to land :)

У уто, 26. 02 2013. у 19:43 +0000, Stevan Radaković пише:
> === modified file 'license_protected_downloads/views.py'

> @@ -479,3 +480,13 @@
> path = result[1]
>
> return HttpResponse(json.dumps(RenderTextFiles.find_and_render(path)))
> +
> +
> +def get_remote_static(request):
> +

Please provide a docstring explaining what this does. And replace this blank line with it.

> + name = request.GET.get("name")
> + if name not in settings.SUPPORTED_REMOTE_STATIC_FILES:
> + raise Http404

Please add a message to this exception: it's always a good practice to
do that.

> +
> + data = urllib2.urlopen(settings.SUPPORTED_REMOTE_STATIC_FILES[name])
> + return HttpResponse(data)
>
> === modified file 'settings.py'
> --- settings.py 2012-11-29 09:36:04 +0000
> +++ settings.py 2013-02-26 19:42:24 +0000
> @@ -191,3 +191,9 @@
> 'Building From Source',
> 'Firmware Update',
> 'RTSM']
> +
> +SUPPORTED_REMOTE_STATIC_FILES = {
> + "linarofamily.js": "http://www.linaro.org/remote/js/linarofamily.js",
> + "init.css": "http://www.linaro.org/remote/css/init.css",
> + "remote.css": "http://www.linaro.org/remote/css/remote.css",
> + }
>
> === modified file 'templates/header.html'
> --- templates/header.html 2013-02-21 08:48:00 +0000
> +++ templates/header.html 2013-02-26 19:42:24 +0000
> @@ -5,9 +5,9 @@
> {% endif %}
> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
> <title>Linaro Snapshots</title>
> - <link href="//www.linaro.org/remote/css/init.css" rel="stylesheet" type="text/css" >
> - <link href="//www.linaro.org/remote/css/remote.css" rel="stylesheet" type="text/css" >
> - <script language="javascript" type="text/javascript" src="//www.linaro.org/remote/js/linarofamily.js"></script>
> + <link href="/get-remote-static?name=init.css" rel="stylesheet" type="text/css" >
> + <link href="/get-remote-static?name=remote.css" rel="stylesheet" type="text/css" >
> + <script language="javascript" type="text/javascript" src="/get-remote-static?name=linarofamily.js"></script>

This seems to break the line length limit: please fix this by breaking
into multiple lines where needed to meet our 79-character maximum line
length.

>
> <script type="text/javascript" src="/js/jquery-1.7.2.js"></script>
>
> === modified file 'urls.py'
> --- urls.py 2012-10-22 12:48:48 +0000
> +++ urls.py 2013-02-26 19:42:24 +0000
> @@ -22,6 +22,10 @@
> url(r'^css/(?P<path>.*)$', 'django.views.static.serve',
> {'document_root': settings.CSS_PATH}),
>
> + url(r'^get-remote-static',
> + 'license_protected_downloads.views.get_remote_static',
> + name='get_remote_static'),
> +
> # The license page...
> url(r'^license$',
> 'license_protected_downloads.views.show_license',

Btw, any reason there're no tests for this? Seems pretty simple to test
the get_remote_static() view (you might want to override settings in a
test though). It would be good to test the "negative" case as well: the
fact that it throws a 404 wh...

review: Needs Fixing

[lp:~stevanr/linaro-license-protection/bug-1085007]

171. By Stevan Radaković on 2013-02-26

Add tests, docstrings and fix pep8 in html.

172. By Stevan Radaković on 2013-02-28

Add test server for urllib testing.

173. By Stevan Radaković on 2013-02-28

Add test server helper from danilos branch.

174. By Stevan Radaković on 2013-02-28

Add test for non-existing file. Add exception handling for HTTPError.

[Данило Шеган (danilo)]

Thanks for the improvements. Please extend the comment in get_remote_static to say how we should switch the error to Http404 once we start sending the email to infrastructure-errors.

review: Approve

[lp:~stevanr/linaro-license-protection/bug-1085007]

175. By Stevan Radaković on 2013-02-28

Add additional comment for re-raising error.

=== modified file 'license_protected_downloads/tests/helpers.py'
--- license_protected_downloads/tests/helpers.py	2012-11-29 09:36:04 +0000
+++ license_protected_downloads/tests/helpers.py	2013-02-28 10:08:20 +0000
@@ -4,6 +4,9 @@
 import os
 import shutil
 import tempfile
+import threading
+import BaseHTTPServer
+import SocketServer
 
 
 class temporary_directory(object):
@@ -39,3 +42,43 @@
             target.write(data)
             target.close()
             return full_path
+
+
+class HttpHandler(BaseHTTPServer.BaseHTTPRequestHandler):
+    def do_GET(self):
+        if self.path in self.urls:
+            self.send_response(200, "OK")
+            self.end_headers()
+            self.request.sendall(self.urls[self.path])
+        else:
+            self.send_error(404, 'URL %s not found' % self.path)
+            self.end_headers()
+
+
+class ThreadedHTTPServer(SocketServer.ThreadingMixIn,
+                         BaseHTTPServer.HTTPServer):
+    pass
+
+
+class TestHttpServer(object):
+    """Creates a context manager for a temporary directory."""
+
+    def __init__(self, urls):
+        self.handler = HttpHandler
+        self.handler.urls = urls
+
+    def __enter__(self):
+        self.server = ThreadedHTTPServer(
+            ("localhost", 0), self.handler)
+        self.ip, self.port = self.server.server_address
+        self.thread = threading.Thread(target=self.server.serve_forever)
+        self.thread.daemon = True
+        self.thread.start()
+        return self
+
+    def __exit__(self, *args):
+        self.server.shutdown()
+
+    @property
+    def base_url(self):
+        return "http://%s:%s" % (self.ip, self.port)

=== modified file 'license_protected_downloads/tests/test_views.py'
--- license_protected_downloads/tests/test_views.py	2013-02-26 08:38:32 +0000
+++ license_protected_downloads/tests/test_views.py	2013-02-28 10:08:20 +0000
@@ -6,18 +6,19 @@
 import os
 import tempfile
 import unittest
+import urllib2
 import urlparse
 
 from license_protected_downloads import bzr_version
 from license_protected_downloads.buildinfo import BuildInfo
 from license_protected_downloads.config import INTERNAL_HOSTS
 from license_protected_downloads.tests.helpers import temporary_directory
+from license_protected_downloads.tests.helpers import TestHttpServer
 from license_protected_downloads.views import _insert_license_into_db
 from license_protected_downloads.views import _process_include_tags
 from license_protected_downloads.views import _sizeof_fmt
 from license_protected_downloads.views import is_same_parent_dir
 
-
 THIS_DIRECTORY = os.path.dirname(os.path.abspath(__file__))
 TESTSERVER_ROOT = os.path.join(THIS_DIRECTORY, "testserver_root")
 
@@ -664,6 +665,33 @@
         fname = os.path.join(TESTSERVER_ROOT, "../file")
         self.assertFalse(is_same_parent_dir(TESTSERVER_ROOT, fname))
 
+    def test_get_remote_static_unsupported_file(self):
+        response = self.client.get('/get-remote-static?name=unsupported.css')
+        self.assertEqual(response.status_code, 404)
+
+    def test_get_remote_static_nonexisting_file(self):
+        pages = {"/": "index"}
+
+        with TestHttpServer(pages) as http_server:
+            css_url = '%s/init.css' % http_server.base_url
+            settings.SUPPORTED_REMOTE_STATIC_FILES = {
+                'init.css': css_url}
+
+            self.assertRaises(urllib2.HTTPError, self.client.get,
+                              '/get-remote-static?name=init.css')
+
+    def test_get_remote_static(self):
+        pages = {"/": "index", "/init.css": "test CSS"}
+
+        with TestHttpServer(pages) as http_server:
+            css_url = '%s/init.css' % http_server.base_url
+            settings.SUPPORTED_REMOTE_STATIC_FILES = {
+                'init.css': css_url}
+
+            response = self.client.get('/get-remote-static?name=init.css')
+            self.assertEqual(response.status_code, 200)
+            self.assertContains(response, 'test CSS')
+
 
 class HowtoViewTests(BaseServeViewTest):
     def test_no_howtos(self):

=== modified file 'license_protected_downloads/views.py'
--- license_protected_downloads/views.py	2013-02-21 12:09:12 +0000
+++ license_protected_downloads/views.py	2013-02-28 10:08:20 +0000
@@ -4,6 +4,7 @@
 import mimetypes
 import os
 import re
+import urllib2
 from mimetypes import guess_type
 from datetime import datetime
 
@@ -479,3 +480,19 @@
     path = result[1]
 
     return HttpResponse(json.dumps(RenderTextFiles.find_and_render(path)))
+
+
+def get_remote_static(request):
+    """Fetches remote static files based on the dict map in settings.py."""
+    name = request.GET.get("name")
+    if name not in settings.SUPPORTED_REMOTE_STATIC_FILES:
+        raise Http404("File name not supported.")
+
+    try:
+        data = urllib2.urlopen(settings.SUPPORTED_REMOTE_STATIC_FILES[name])
+    except urllib2.HTTPError:
+        # TODO: send an email to infrastructure-errors list,
+        # then implement raising of Http404 instead of HTTPError
+        raise
+
+    return HttpResponse(data)

=== modified file 'settings.py'
--- settings.py	2012-11-29 09:36:04 +0000
+++ settings.py	2013-02-28 10:08:20 +0000
@@ -191,3 +191,9 @@
                 'Building From Source',
                 'Firmware Update',
                 'RTSM']
+
+SUPPORTED_REMOTE_STATIC_FILES = {
+    "linarofamily.js": "http://www.linaro.org/remote/js/linarofamily.js",
+    "init.css": "http://www.linaro.org/remote/css/init.css",
+    "remote.css": "http://www.linaro.org/remote/css/remote.css",
+    }

=== modified file 'templates/header.html'
--- templates/header.html	2013-02-21 08:48:00 +0000
+++ templates/header.html	2013-02-28 10:08:20 +0000
@@ -5,9 +5,12 @@
   {% endif %}
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   <title>Linaro Snapshots</title>
-  <link href="//www.linaro.org/remote/css/init.css" rel="stylesheet" type="text/css" >
-  <link href="//www.linaro.org/remote/css/remote.css" rel="stylesheet" type="text/css" >
-  <script language="javascript" type="text/javascript" src="//www.linaro.org/remote/js/linarofamily.js"></script>
+  <link href="/get-remote-static?name=init.css"
+        rel="stylesheet" type="text/css" >
+  <link href="/get-remote-static?name=remote.css"
+        rel="stylesheet" type="text/css" >
+  <script language="javascript" type="text/javascript"
+          src="/get-remote-static?name=linarofamily.js"></script>
 
 
   <script type="text/javascript" src="/js/jquery-1.7.2.js"></script>

=== modified file 'urls.py'
--- urls.py	2012-10-22 12:48:48 +0000
+++ urls.py	2013-02-28 10:08:20 +0000
@@ -22,6 +22,10 @@
     url(r'^css/(?P<path>.*)$', 'django.views.static.serve',
         {'document_root': settings.CSS_PATH}),
 
+    url(r'^get-remote-static',
+        'license_protected_downloads.views.get_remote_static',
+        name='get_remote_static'),
+
     # The license page...
     url(r'^license$',
         'license_protected_downloads.views.show_license',