Merge lp:~ralsina/ubuntuone-control-panel/fix-959447 into lp:ubuntuone-control-panel

[Roberto Alsina]

 - Made CalculateSize use bytes when calling os.walk (Fixes LP:959447).

Make CalculateSize use bytes for its path instead of unicode, so os.walk doesn't choke on invalid unicode paths.

[Diego Sarmentero (diegosarmentero)]

[FAIL]
Traceback (most recent call last):
  File "X:\ubuntuone-control-panel-ralsina2\ubuntuone\controlpanel\gui\qt\tests\
test_folders.py", line 1236, in test_add_music_folder_adds_the_folder
    self.test_folder_is_added(folder_path=MUSIC_PATH)
  File "X:\ubuntuone-control-panel-ralsina2\ubuntuone\controlpanel\gui\qt\tests\
test_folders.py", line 1232, in test_folder_is_added
    self.assert_folder_added(folder_path)
  File "X:\ubuntuone-control-panel-ralsina2\ubuntuone\controlpanel\gui\qt\tests\
test_folders.py", line 1005, in assert_folder_added
    unicode(item.text(gui.LOCAL_SUBSCRIPTION_COL)))
twisted.trial.unittest.FailTest: not equal:
a = u'Purchased Music'
b = u'.ubuntuone\\Purchased from Ubuntu One'

ubuntuone.controlpanel.gui.qt.tests.test_folders.LocalFoldersPanelAddFolderTestC
ase.test_add_music_folder_adds_the_folder

review: Needs Fixing

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Brian Curtin (brian.curtin)]

Looks good.

review: Approve

=== modified file 'ubuntuone/controlpanel/gui/qt/folders.py'
--- ubuntuone/controlpanel/gui/qt/folders.py	2012-04-05 21:51:49 +0000
+++ ubuntuone/controlpanel/gui/qt/folders.py	2012-05-14 18:57:22 +0000
@@ -20,6 +20,7 @@
 
 import os
 import Queue
+import sys
 import threading
 
 from PyQt4 import QtGui, QtCore
@@ -347,9 +348,17 @@
     """A thread that calculates, in the background, the size of a folder."""
 
     def __init__(self, path_name, queue):
-        self.path_name = path_name
         self.queue = queue
         self._stop = False
+        # This makes os.walk use the "bytes" version, which doesn't
+        # break with invalid unicode paths.
+        # This will only work for unicode locales (ex: LANG=es_ES.UTF-8)
+        # and will falback to as before for C and non-unicode locales.
+        try:
+            self.path_name = path_name.encode(sys.getfilesystemencoding())
+        except (UnicodeEncodeError, UnicodeDecodeError):
+            # Should never happen (haha)
+            self.path_name = path_name
 
         super(CalculateSize, self).__init__()
 

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_folders.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-04-11 11:48:07 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-05-14 18:57:22 +0000
@@ -22,6 +22,7 @@
 import os
 import Queue
 import shutil
+import sys
 
 from PyQt4 import QtGui
 from twisted.internet import defer
@@ -726,7 +727,7 @@
 
     @defer.inlineCallbacks
     def setUp(self):
-        self.path = 'not-existing-dir'
+        self.path = u'not-existing-dir'
         self.expected_size = self.build_test_dir(self.path)
         self.queue = Queue.Queue()
         self.kwargs['queue'] = self.queue
@@ -742,7 +743,8 @@
         assert not os.path.exists(dir_path)
 
         os.makedirs(dir_path)
-        self.addCleanup(shutil.rmtree, dir_path)
+        self.addCleanup(shutil.rmtree,
+            dir_path.encode(sys.getfilesystemencoding()))
 
         total_size = 0
 
@@ -823,6 +825,31 @@
         return total_size
 
 
+class CalculateSizeWithInvalidPath(CalculateSizeTestCase):
+    """Test suite for the CalculateSize thread implementation."""
+
+    def build_test_dir(self, dir_path):
+        """Build a testing directory hierarchy."""
+        total_size = super(CalculateSizeWithInvalidPath,
+                           self).build_test_dir(dir_path)
+        # Have to crete as bytes because it's an invalid path
+        a_file = os.path.join(dir_path.encode(sys.getfilesystemencoding()),
+            '\xe7\xa7')
+        with open(a_file, 'wb') as f:
+            f.write('y' * 5000)
+        total_size += os.path.getsize(a_file)
+        return total_size
+
+    def test_run(self):
+        """The run() method calculates the size for the given path."""
+        self.ui.run()
+
+        path, size = self.queue.get(block=True, timeout=0.5)
+
+        self.assertEqual(path, self.path)
+        self.assertEqual(size, self.expected_size)
+
+
 class FolderItemTestCase(BaseLocalFoldersTestCase):
     """Test suite for the FolderItem widget."""