Merge lp:~james-w/pkgme-service/base64-icon-data into lp:pkgme-service

[James Westby]

base64 the icon data so that it can be safely transmitted as json.

Hi,

Current the icon data, if any, is put raw in to the json string. It's safer
to encode it for transmission as base64.

Thanks,

James

[Martin Albisetti (beuno)]

review: Approve

[lp:~james-w/pkgme-service/base64-icon-data]

156. By James Westby on 2014-01-29

Add a comment about why we base64. Thanks Martin.

=== modified file 'src/djpkgme/tasks.py'
--- src/djpkgme/tasks.py	2014-01-15 15:27:18 +0000
+++ src/djpkgme/tasks.py	2014-01-29 18:34:40 +0000
@@ -1,3 +1,4 @@
+import base64
 import json
 import os
 import shutil
@@ -344,7 +345,8 @@
         icon_data = None
         try:
             full_path = os.path.join(package, icon_path)
-            icon_data = open(full_path, 'rb').read()
+            # base64 icon data, as it is binary to be sent in json
+            icon_data = base64.b64encode(open(full_path, 'rb').read())
         except:
             # gracefully handle not being able to read icon data
             logger.warning(

=== modified file 'src/djpkgme/tests/test_tasks.py'
--- src/djpkgme/tests/test_tasks.py	2014-01-15 15:27:18 +0000
+++ src/djpkgme/tests/test_tasks.py	2014-01-29 18:34:40 +0000
@@ -1,6 +1,7 @@
 # Run tasks eagerly for tests.  Taken from
 # http://ask.github.com/celery/cookbook/unit-testing.html
 
+import base64
 import json
 import logging
 import os
@@ -816,7 +817,8 @@
 
     @patch('__builtin__.open')
     def test_get_package_icon_ok(self, mock_open):
-        mock_data = mock_open.return_value.read.return_value
+        mock_icon_data = 'some icon'
+        mock_open.return_value.read.return_value = mock_icon_data
         mock_logger = Mock()
         job = ClickPackageInfoJob()
         info = job.get_package_icon('/unpacked/',
@@ -827,7 +829,7 @@
         self.assertEqual(info, {
             'path': 'path/to/icon.png',
             'filename': 'icon.png',
-            'data': mock_data,
+            'data': base64.b64encode(mock_icon_data),
         })
 
     @patch('__builtin__.open')