Merge lp:~dobey/ubuntuone-control-panel/update-4-0 into lp:ubuntuone-control-panel/stable-4-0

[dobey]

[Mike McCracken]

    - Use qt4reactor on Darwin. (LP: #1013820)
    - Make run-tests script work on Darwin. (LP: #1010211)

[Roberto Alsina]

    - Enable folder list sorting (Fixes LP:1006385).

[Diego Sarmentero]

    - Using suggested_path to server path comparisons (LP: #1004603).

[Mike McCracken (mikemc)]

Looks OK to me.

review: Approve

[lp:~dobey/ubuntuone-control-panel/update-4-0]

328. By Diego Sarmentero on 2012-06-20

[Mike McCracken]

    - Use qt4reactor on Darwin. (LP: #1013820)
    - Make run-tests script work on Darwin. (LP: #1010211)

[Roberto Alsina]

    - Enable folder list sorting (Fixes LP:1006385).

[Diego Sarmentero]

    - Using suggested_path to server path comparisons (LP: #1004603).

=== modified file 'bin/ubuntuone-control-panel-qt'
--- bin/ubuntuone-control-panel-qt	2012-03-01 17:47:54 +0000
+++ bin/ubuntuone-control-panel-qt	2012-06-20 19:10:48 +0000
@@ -22,7 +22,7 @@
 import signal
 import sys
 
-if sys.platform == 'win32':
+if sys.platform in ('win32', 'darwin'):
     import qt4reactor
     qt4reactor.install()
 
 
=== added file 'data/audio-x-generic.png'
 Binary files data/audio-x-generic.png	1970-01-01 00:00:00 +0000 and data/audio-x-generic.png	2012-06-20 19:10:48 +0000 differ
=== modified file 'data/qt/images.qrc'
--- data/qt/images.qrc	2012-05-14 21:05:08 +0000
+++ data/qt/images.qrc	2012-06-20 19:10:48 +0000
@@ -1,5 +1,6 @@
 <RCC>
   <qresource prefix="/">
+    <file>../audio-x-generic.png</file>
     <file>../banner.png</file>
     <file>../computer.png</file>
     <file>../external_icon_dark_grey.png</file>
 
=== modified file 'run-tests'
--- run-tests	2012-04-25 13:35:35 +0000
+++ run-tests	2012-06-20 19:10:48 +0000
@@ -19,8 +19,9 @@
 QT_TESTS_PATH="ubuntuone/controlpanel/gui/qt/tests, ubuntuone/controlpanel/gui/qt/main/tests, ubuntuone/controlpanel/gui/qt/uniqueapp/tests"
 DBUS_TESTS_PATH=ubuntuone/controlpanel/dbustests
 WINDOWS_TESTS=test_windows.py
+LINUX_TESTS=test_linux.py
+DARWIN_TESTS=test_darwin.py
 
-set -e
 
 if [ $# -ne 0 ]; then
     # run specific module given by the caller
@@ -31,7 +32,7 @@
 fi
 
 style_check() {
-    u1lint --ignore ubuntuone/controlpanel/gui/qt/ui
+    $u1lint --ignore ubuntuone/controlpanel/gui/qt/ui
     if [ -x `which pep8` ]; then
         pep8 --exclude '.svn,CVS,.bzr,.hg,.git,*_ui.py,*_rc.py' --repeat . bin/*
     else
@@ -45,15 +46,39 @@
     XVFB_CMDLINE="$XVFB -a"
 fi
 
+# now fail on errors, after we tried to find xvfb:
+set -e
+
+SYSNAME=`uname -s`
+
+if [ "$SYSNAME" == "Darwin" ]; then
+    u1trial="python $u1trial"
+    u1lint="python $u1lint"
+    IGNORE_FILES="$WINDOWS_TESTS, $LINUX_TESTS"
+    IGNORE_DBUS="-p $DBUS_TESTS_PATH"
+    echo "*** Skipping DBus test suite ***"
+    REACTOR=qt4
+    PYTHONPATH=$PYTHONPATH:../ubuntu-sso-client:../ubuntuone-client:../ubuntuone-storage-protocol:.
+else
+    # Linux:
+    if [ "x$XVFB_CMDLINE" == "x" ]; then
+	echo "WARNING: Could not find xvfb-run, prepare for visual spam."
+    fi
+    u1trial=u1trial
+    u1lint=u1lint
+    IGNORE_FILES="$WINDOWS_TESTS, $DARWIN_TESTS"
+    IGNORE_DBUS=""
+    echo "*** Running DBus test suite ***"
+    $u1trial --reactor=glib "$DBUS_TESTS_PATH"
+    REACTOR=gi
+fi
+
 echo "*** Running test suite for ""$MODULE"" ***"
-u1trial --reactor=gi -p "$DBUS_TESTS_PATH, $QT_TESTS_PATH" -i "$WINDOWS_TESTS" "$MODULE"
-
-echo "*** Running DBus test suite ***"
-u1trial --reactor=glib "$DBUS_TESTS_PATH"
+$u1trial --reactor=$REACTOR -p "$DBUS_TESTS_PATH, $QT_TESTS_PATH" -i "$IGNORE_FILES" "$MODULE"
 
 echo "*** Running QT test suite for ""$MODULE"" ***"
 ./setup.py build
-$XVFB_CMDLINE u1trial -i "$WINDOWS_TESTS" --reactor=qt4 --gui "$MODULE"
+$XVFB_CMDLINE $u1trial $IGNORE_DBUS -i "$IGNORE_FILES" --reactor=qt4 --gui "$MODULE"
 rm -rf _trial_temp
 rm -rf build
 
 
=== modified file 'ubuntuone/controlpanel/gui/qt/folders.py'
--- ubuntuone/controlpanel/gui/qt/folders.py	2012-05-14 18:50:12 +0000
+++ ubuntuone/controlpanel/gui/qt/folders.py	2012-06-20 19:10:48 +0000
@@ -80,10 +80,15 @@
 
 def _process_name(name):
     """Tweak 'name' with a translatable music folder name."""
-    if name == MUSIC_REAL_PATH:
+    if name.startswith('~/'):
+        suggested = name[2:]
+    else:
+        suggested = name
+
+    if suggested == MUSIC_REAL_PATH:
         result = MUSIC_DISPLAY_NAME
     else:
-        result = name
+        result = suggested
     return result
 
 
@@ -132,6 +137,9 @@
         headers.setResizeMode(SUBSCRIPTION_COL, headers.ResizeToContents)
         headers.setResizeMode(EXPLORE_COL, headers.ResizeToContents)
 
+        self.ui.folders.setSortingEnabled(True)
+        self.ui.folders.sortByColumn(FOLDER_NAME_COL, QtCore.Qt.AscendingOrder)
+
         self.ui.share_publish_button.setText(FOLDERS_MANAGE_LABEL)
         self.ui.share_publish_button.uri = MANAGE_FILES_LINK
         QtGui.QApplication.instance().focusChanged.connect(self.focus_changed)
@@ -203,7 +211,8 @@
                     child.volume_path = volume['path']
                 child.volume_id = volume['volume_id']
 
-                name = _process_name(volume[u'display_name'])
+                name = _process_name(volume.get(u'suggested_path',
+                    volume[u'display_name']))
                 child.setText(FOLDER_NAME_COL, name)
                 child.setToolTip(FOLDER_NAME_COL, name)
                 child.setToolTip(EXPLORE_COL, FOLDERS_COLUMN_EXPLORE)
@@ -505,21 +514,25 @@
                 for volume in volumes:
                     if (volume[u'type'] == self.backend.FOLDER_TYPE and
                         bool(volume['subscribed'])):
-                        folders.append((volume['path'], volume['volume_id']))
+                        suggested = volume.get(u'suggested_path',
+                            volume[u'display_name'])
+                        folders.append((volume['path'], volume['volume_id'],
+                                        suggested))
 
             # add local folders only if they are valid
             for folder in default_folders(user_home=self.user_home):
                 is_valid = yield self.backend.validate_path_for_folder(folder)
                 if is_valid:
-                    folders.append((folder, None))
+                    folders.append((folder, None, None))
 
             # always clear the items dict first, since clearing the folders
             # list will trigger "underlying C/C++ object has been deleted"
             self.items.clear()
             self.ui.folders.clear()
 
-            for path, volume_id in folders:
-                self.add_folder(folder_path=path, volume_id=volume_id)
+            for path, volume_id, suggested in folders:
+                self.add_folder(folder_path=path, volume_id=volume_id,
+                    suggested=suggested)
 
             if folders and not self.timer.isActive():
                 self.timer.start(2000)
@@ -552,20 +565,23 @@
         self.changesApplied.emit()
 
     @handle_errors(logger=logger)
-    def add_folder(self, folder_path, volume_id=None):
+    def add_folder(self, folder_path, volume_id=None, suggested=None):
         """Add a folder to the list."""
         if folder_path in self.items:
             logger.warning('LocalFoldersPanel: already have an item for %r.',
                            folder_path)
             return
 
-        if self.user_home is None:
+        if suggested is None:
             logger.warning('LocalFoldersPanel: user home is None! '
                            'paths will not be pretty.')
-            display_name = folder_path
-        else:
-            user_home = self.user_home + os.path.sep
+            if self.user_home is None:
+                user_home = ''
+            else:
+                user_home = self.user_home + os.path.sep
             display_name = _process_name(folder_path.replace(user_home, ''))
+        else:
+            display_name = _process_name(suggested)
 
         item = FolderItem([display_name, ""], path=folder_path,
                           queue=self.queue, volume_id=volume_id)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/main/__init__.py'
--- ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-05-14 22:27:07 +0000
+++ ubuntuone/controlpanel/gui/qt/main/__init__.py	2012-06-20 19:10:48 +0000
@@ -29,12 +29,12 @@
 from ubuntuone.controlpanel.gui.qt.uniqueapp import UniqueApplication
 
 # Invalid name "source", pylint: disable=C0103
-if sys.platform == 'win32':
-    from ubuntuone.controlpanel.gui.qt.main import windows
-    source = windows
+if sys.platform in ('win32', 'darwin'):
+    from ubuntuone.controlpanel.gui.qt.main import twisted_main
+    source = twisted_main
 else:
-    from ubuntuone.controlpanel.gui.qt.main import linux
-    source = linux
+    from ubuntuone.controlpanel.gui.qt.main import dbus_main
+    source = dbus_main
 # pylint: enable=C0103
 
 
 
=== renamed file 'ubuntuone/controlpanel/gui/qt/main/linux.py' => 'ubuntuone/controlpanel/gui/qt/main/dbus_main.py'
=== renamed file 'ubuntuone/controlpanel/gui/qt/main/windows.py' => 'ubuntuone/controlpanel/gui/qt/main/twisted_main.py'
--- ubuntuone/controlpanel/gui/qt/main/windows.py	2012-04-05 14:52:55 +0000
+++ ubuntuone/controlpanel/gui/qt/main/twisted_main.py	2012-06-20 19:10:48 +0000
@@ -14,7 +14,7 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Main method to be used on windows."""
+"""Main method to be used on platforms without dbus."""
 
 from PyQt4 import QtGui
 
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_folders.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-05-14 18:50:12 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-06-20 19:10:48 +0000
@@ -24,7 +24,7 @@
 import shutil
 import sys
 
-from PyQt4 import QtGui
+from PyQt4 import QtCore, QtGui
 from twisted.internet import defer
 from ubuntuone.devtools.handlers import MementoHandler
 from ubuntuone.devtools.testcases import skipIfOS
@@ -37,6 +37,7 @@
     FAKE_VOLUMES_ONLY_ROOT_INFO,
     MUSIC_FOLDER, MUSIC_PATH, ROOT, USER_HOME,
 )
+from ubuntuone.controlpanel.gui import MUSIC_REAL_PATH
 from ubuntuone.controlpanel.gui.qt import folders as gui
 from ubuntuone.controlpanel.gui.qt.tests import (
     BaseTestCase,
@@ -243,28 +244,21 @@
 
     def test_process_info(self):
         """The volumes info is processed when ready."""
+        folders = self.ui.ui.folders
         self.ui.process_info(FAKE_VOLUMES_INFO)
-        folders = self.ui.ui.folders
-
         root = folders.invisibleRootItem()
         self.assertEqual(len(FAKE_VOLUMES_INFO), root.childCount())
 
-        treeiter = gui.QtGui.QTreeWidgetItemIterator(folders)
         for name, _, volumes in FAKE_VOLUMES_INFO:
             name = _build_name(name)
-
-            # get first child, matching "My Folders"
-            item = treeiter.value()
-            self.assertFalse(item.is_empty)
-
+            items = folders.findItems(name, QtCore.Qt.MatchFixedString
+                | QtCore.Qt.MatchCaseSensitive | QtCore.Qt.MatchRecursive,
+                gui.FOLDER_NAME_COL)
+            self.assertEqual(1, len(items))
+            item = items[0]
             self.assert_folder_group_header_correct(item, name)
-
             self.assertEqual(len(volumes), item.childCount())
-            sorted_vols = sorted(volumes, key=operator.itemgetter('path'))
-            for volume in sorted_vols:
-                treeiter += 1
-                item = treeiter.value()  # get child folder
-                self.assertTrue(item is not None)
+            for volume in volumes:
 
                 name = volume['path'].replace(USER_HOME + os.path.sep, '')
                 expected_path = volume['path']
@@ -277,12 +271,14 @@
                 else:
                     icon_name = gui.SHARE_ICON_NAME
 
+                items = folders.findItems(name, QtCore.Qt.MatchFixedString |
+                    QtCore.Qt.MatchCaseSensitive | QtCore.Qt.MatchRecursive,
+                    gui.FOLDER_NAME_COL)
+                self.assertEqual(1, len(items))
+                item = items[0]
                 self.assert_folder_row_correct(item, name, icon_name, volume,
                                                tweaked_path=expected_path)
 
-            treeiter += 1
-            item = treeiter.value()
-
     def test_process_info_clears_the_list(self):
         """The old volumes info is cleared before updated."""
         self.ui.process_info(FAKE_VOLUMES_INFO)
@@ -304,9 +300,10 @@
 
         child_index = 0
         root = self.ui.ui.folders.invisibleRootItem()
-        for name, _, _ in FAKE_VOLUMES_NO_FREE_SPACE_INFO:
-            name = _build_name(name)
-
+        names = [_build_name(name) for name, _, _ in
+            FAKE_VOLUMES_NO_FREE_SPACE_INFO]
+        names.sort(key=lambda x: x.lower())
+        for name in names:
             item = root.child(child_index)
             self.assertFalse(item.is_empty)
             self.assert_folder_group_header_correct(item, name)
@@ -413,34 +410,23 @@
         """Ensure that the inner widgets are in the correct tab order."""
         self.ui.process_info(FAKE_VOLUMES_INFO)
         folders = self.ui.ui.folders
-
         widget = self.ui.ui.folders.nextInFocusChain()
         treeiter = gui.QtGui.QTreeWidgetItemIterator(folders)
-        for name, _, volumes in FAKE_VOLUMES_INFO:
-            item = treeiter.value()
-            sorted_vols = sorted(volumes, key=operator.itemgetter('path'))
-            for volume in sorted_vols:
+        while treeiter.value():
+            if treeiter.value().parent() is None:  # Top-levels
                 treeiter += 1
-                item = treeiter.value()  # get child folder
-
-                name = volume['path'].replace(USER_HOME + os.path.sep, '')
-                if volume['type'] == self.ui.backend.SHARE_TYPE:
-                    name = volume['name']
-                self.assertEqual(unicode(item.text(gui.FOLDER_NAME_COL)), name)
-
-                actual_name = unicode(self.ui.widget_items[widget].text(0))
-                if volume['type'] != self.ui.backend.ROOT_TYPE:
-                    self.assertIsInstance(widget, QtGui.QCheckBox)
-                    self.assertEqual(actual_name, name)
-                    widget = widget.nextInFocusChain()
-
-                if not self.ui.remote_folders:
-                    self.assertIsInstance(widget, QtGui.QPushButton)
-                    self.assertEqual(actual_name, name)
-                    widget = widget.nextInFocusChain()
-
+                continue
+            if self.ui.remote_folders:
+                self.assertIsInstance(widget, QtGui.QCheckBox)
+            # ROOT volume has no checkbox
+            elif treeiter.value().text(1) or self.ui.remote_folders:
+                self.assertIsInstance(widget, QtGui.QPushButton)
+            else:
+                self.assertIsInstance(widget, QtGui.QCheckBox)
+                widget = widget.nextInFocusChain()
+                self.assertIsInstance(widget, QtGui.QPushButton)
+            widget = widget.nextInFocusChain()
             treeiter += 1
-            item = treeiter.value()
 
     def test_widget_dict(self):
         """Ensure the widget_items dictionary is full."""
@@ -994,13 +980,17 @@
     def assert_folder_added(self, path, volume_id=None, item=None):
         """A entry for 'path' was added to the folder list."""
         folders = self.ui.ui.folders
-        if item is None:  # grab the last one added
-            item = folders.topLevelItem(folders.topLevelItemCount() - 1)
 
         if path == MUSIC_PATH:
             display_name = gui.MUSIC_DISPLAY_NAME
         else:
             display_name = path.replace(USER_HOME + os.path.sep, '')
+        if item is None:  # search for it
+            items = folders.findItems(display_name,
+                QtCore.Qt.MatchFixedString | QtCore.Qt.MatchCaseSensitive,
+                gui.FOLDER_NAME_COL)
+            self.assertEqual(len(items), 1)
+            item = items[0]
         self.assertEqual(display_name,
                          unicode(item.text(gui.LOCAL_SUBSCRIPTION_COL)))
 
@@ -1093,10 +1083,6 @@
         # the following will execute update_sizes once
         # will fill in all the path sizes for the already added folders
         self.timer.timeout.emit()
-
-        folders = self.ui.ui.folders
-        treeiter = gui.QtGui.QTreeWidgetItemIterator(folders)
-
         volumes = []
         for _, _, vols in volumes_info:
             volumes.extend(vols)
@@ -1107,28 +1093,14 @@
                 not bool(volume['subscribed'])):
                 # non-folders or unsubscribed should not appear in the tree
                 continue
-
-            item = treeiter.value()
-            self.assertTrue(item is not None)
             self.assert_folder_added(volume['path'],
-                                     volume_id=volume['volume_id'], item=item)
-
-            treeiter += 1
-            item = treeiter.value()
-
+                                     volume_id=volume['volume_id'])
         for folder in gui.default_folders(USER_HOME):
             valid = yield self.validate_path(folder)
             if not valid:
                 continue  # invalid folders should not appear in the tree
-
-            item = treeiter.value()
-            self.assertTrue(item is not None)
-            self.assert_folder_added(folder, volume_id=None, item=item)
-
-            treeiter += 1
-            item = treeiter.value()
-
-        self.assertTrue(item is None)
+            self.assert_folder_added(folder, volume_id=None, item=None)
+
         self.assert_space_header_correct(ACCOUNT_INFO['quota_used'])
 
     @defer.inlineCallbacks
@@ -1219,13 +1191,13 @@
 class LocalFoldersPanelAddFolderTestCase(BaseLocalFoldersPanelTestCase):
     """Test suite for the add_folder method from LocalFoldersPanel."""
 
-    def test_folder_is_added(self, folder_path=None):
+    def test_folder_is_added(self, folder_path=None, suggested=None):
         """Adding a folder adds it to the folder list."""
         former_count = self.ui.ui.folders.topLevelItemCount()
 
         if folder_path is None:
             folder_path = self.path
-        self.ui.add_folder(folder_path)
+        self.ui.add_folder(folder_path, suggested=suggested)
 
         new_count = self.ui.ui.folders.topLevelItemCount()
         self.assertEqual(new_count, former_count + 1)
@@ -1233,7 +1205,14 @@
 
     def test_add_music_folder_adds_the_folder(self):
         """Adding the purchased music folder adds it to the folder list."""
-        self.test_folder_is_added(folder_path=MUSIC_PATH)
+        self.test_folder_is_added(folder_path=MUSIC_PATH,
+            suggested=MUSIC_REAL_PATH)
+
+    def test_add_music_folder_adds_the_folder_with_suggested_path(self):
+        """Adding the purchased music folder adds it to the folder list."""
+        suggested_path = '~/' + MUSIC_REAL_PATH
+        self.test_folder_is_added(folder_path=MUSIC_PATH,
+            suggested=suggested_path)
 
     def test_do_not_add_twice(self):
         """The same folder will not be added twice."""