Merge lp:~elopio/ubuntu-ui-toolkit/fix_tab_switch into lp:ubuntu-ui-toolkit

[Leo Arias]

Fixed the tab switch on autopilot emulators that used to rely on the order of the tree.

There where two places where the autopilot emulators relied on the order of the tree. Now, instead of that, they rely on the index property of the elements.
For this, I had to merge zsombi's branch that added the index property to the Tabs.
Here I'm also adding debug information to the log while switching tabs, hoping that it will help to diagnose other failures that happen sometimes on Jenkins. This logs are temporary. Once we can update to autopilot 1.4 we will have a much more elegant way to log all the user actions simulated by autopilot.

[I Ahmad (iahmad)]

This line import pdb; pdb.set_trace() below will stop the execution if this is picked up by ci. Any reason you are leaving this in your merge proposal?

[Leo Arias (elopio)]

> This line import pdb; pdb.set_trace() below will stop the execution if this
> is picked up by ci. Any reason you are leaving this in your merge proposal?

No, thanks for catching it.

Unmerged revisions

=== modified file 'CHANGES'
--- CHANGES	2013-09-24 19:47:54 +0000
+++ CHANGES	2013-10-02 07:01:34 +0000
@@ -9,6 +9,7 @@
 
 API Changes
 ***********
+* ADDED IN: Tab: readonly property int index
 * ADDED IN: ListItem.Empty: property bool confirmRemoval
 * ADDED IN: OptionSelectorDelegate: property bool constrainImage
 * ADDED IN: Empty: property alias divider

=== modified file 'components.api'
--- components.api	2013-09-30 12:00:41 +0000
+++ components.api	2013-10-02 07:01:34 +0000
@@ -197,6 +197,8 @@
     property string title
     property url iconSource
     property Item page
+    readonly property int index
+    property internal __protected
 modules/Ubuntu/Components/TabBar.qml
 StyledItem
     property Item tabsItem

=== modified file 'modules/Ubuntu/Components/Tab.qml'
--- modules/Ubuntu/Components/Tab.qml	2013-05-22 10:04:59 +0000
+++ modules/Ubuntu/Components/Tab.qml	2013-10-02 07:01:34 +0000
@@ -49,6 +49,13 @@
     property Item page: null
 
     /*!
+      \qmlproperty int index
+      \readonly
+      The property holds the index of the tab within the Tabs.
+      */
+    readonly property alias index: internal.index
+
+    /*!
       When page is updated, set its parent to be tab.
      */
     onPageChanged: if (page) page.parent = tab
@@ -73,4 +80,13 @@
             }
         }
     }
+
+    /*!
+      \internal
+      */
+    property alias __protected: internal
+    QtObject {
+        id: internal
+        property int index: -1
+    }
 }

=== modified file 'modules/Ubuntu/Components/Tabs.qml'
--- modules/Ubuntu/Components/Tabs.qml	2013-08-22 17:15:35 +0000
+++ modules/Ubuntu/Components/Tabs.qml	2013-10-02 07:01:34 +0000
@@ -212,8 +212,12 @@
 
         function updateTabList() {
             var list = [];
+            var index = 0;
             for (var i=0; i < children.length; i++) {
-                if (isTab(tabsModel.children[i])) list.push(tabsModel.children[i]);
+                if (isTab(tabsModel.children[i])) {
+                    tabsModel.children[i].__protected.index = index++;
+                    list.push(tabsModel.children[i]);
+                }
             }
             tabList = list;
             tabs.modelChanged();

=== modified file 'tests/autopilot/ubuntuuitoolkit/emulators.py'
--- tests/autopilot/ubuntuuitoolkit/emulators.py	2013-09-21 19:08:50 +0000
+++ tests/autopilot/ubuntuuitoolkit/emulators.py	2013-10-02 07:01:34 +0000
@@ -14,11 +14,15 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
+import logging
+
 from autopilot import input, platform
 from autopilot.introspection import dbus
 
 _NO_TABS_ERROR = 'The MainView has no Tabs.'
 
+logger = logging.getLogger(__name__)
+
 
 class ToolkitEmulatorException(Exception):
     """Exception raised when there is an error with the emulator."""
@@ -111,6 +115,7 @@
         :return: The newly opened tab.
 
         """
+        logger.debug('Switch to next tab.')
         self.get_header().switch_to_next_tab()
         current_tab = self.get_tabs().get_current_tab()
         current_tab.visible.wait_for(True)
@@ -123,6 +128,7 @@
         :return: The newly opened tab.
 
         """
+        logger.debug('Switch to tab with index {0}.'.format(index))
         tabs = self.get_tabs()
         number_of_tabs = tabs.get_number_of_tabs()
         if index >= number_of_tabs:
@@ -130,6 +136,8 @@
         current_tab = tabs.get_current_tab()
         number_of_switches = 0
         while not tabs.selectedTabIndex == index:
+            logger.debug(
+                'Current tab index: {0}.'.format(tabs.selectedTabIndex))
             if number_of_switches >= number_of_tabs - 1:
                 # This prevents a loop. But if this error is ever raised, it's
                 # likely there's a bug on the emulator or on the QML Tab.
@@ -162,7 +170,7 @@
         tabs = self.get_tabs()
         for index, tab in enumerate(tabs.select_many('Tab')):
             if tab.objectName == object_name:
-                return self.switch_to_tab_by_index(index)
+                return self.switch_to_tab_by_index(tab.index)
         raise ValueError(
             'Tab with objectName "{0}" not found.'.format(object_name))
 
@@ -221,11 +229,23 @@
 
     def get_current_tab(self):
         """Return the currently selected tab."""
-        return self.select_many('Tab')[self.selectedTabIndex]
+        return self._get_tab(self.selectedTabIndex)
+
+    def _get_tab(self, index):
+        tabs = self._get_tabs()
+        for tab in tabs:
+            if tab.index == index:
+                return tab
+        else:
+            raise ToolkitEmulatorException(
+                'There is no tab with index {0}.'.format(index))
+
+    def _get_tabs(self):
+        return self.select_many('Tab')
 
     def get_number_of_tabs(self):
         """Return the number of tabs."""
-        return len(self.select_many('Tab'))
+        return len(self._get_tabs())
 
 
 class TabBar(UbuntuUIToolkitEmulatorBase):
@@ -234,16 +254,19 @@
     def switch_to_next_tab(self):
         """Open the next tab."""
         # Click the tab bar to switch to selection mode.
+        logger.debug('Click the tab bar to enable selection mode.')
         self.pointing_device.click_object(self)
         if not self.selectionMode:
+            logger.debug('Selection mode not enabled, try again.')
             # in case someone stole the click, like the open toolbar
             self.pointing_device.click_object(self)
+        logger.debug('Click the next tab bar button.')
         self.pointing_device.click_object(self._get_next_tab_button())
 
     def _get_next_tab_button(self):
         current_index = self._get_selected_button_index()
         next_index = (current_index + 1) % self._get_number_of_tab_buttons()
-        return self._get_tab_buttons()[next_index]
+        return self._get_tab_button(next_index)
 
     def _get_selected_button_index(self):
         return self.select_single('QQuickPathView').selectedButtonIndex
@@ -254,6 +277,15 @@
     def _get_tab_buttons(self):
         return self.select_many('AbstractButton')
 
+    def _get_tab_button(self, index):
+        buttons = self._get_tab_buttons()
+        for button in buttons:
+            if button.buttonIndex == index:
+                return button
+        else:
+            raise ToolkitEmulatorException(
+                'There is no tab button with index {0}.'.format(index))
+
 
 class ActionSelectionPopover(UbuntuUIToolkitEmulatorBase):
     """ActionSelectionPopover Autopilot emulator."""

=== modified file 'tests/unit/tst_components/tst_tab.qml'
--- tests/unit/tst_components/tst_tab.qml	2013-05-06 13:11:21 +0000
+++ tests/unit/tst_components/tst_tab.qml	2013-10-02 07:01:34 +0000
@@ -39,6 +39,10 @@
          compare(tab.title,newTitle,"can set/get")
      }
 
+     function test_index() {
+         compare(tab.index, -1, "is -1 by default")
+     }
+
      Tab {
          id: tab
      }

=== modified file 'tests/unit/tst_components/tst_tabs.qml'
--- tests/unit/tst_components/tst_tabs.qml	2013-07-29 10:05:05 +0000
+++ tests/unit/tst_components/tst_tabs.qml	2013-10-02 07:01:34 +0000
@@ -76,6 +76,15 @@
         tabs.selectedTabIndex = 0;
     }
 
+    function test_index() {
+        compare(tab1.index, 0, "tab1 is at 0");
+        compare(tab2.index, 1, "tab2 is at 1");
+        compare(tab3.index, 2, "tab3 is at 2");
+        compare(tabFlick1.index, 3, "tabFlick1 is at 3");
+        compare(tabFlick2.index, 4, "tabFlick2 is at 4");
+        compare(tabFlickLoader.index, 5, "tabFlickLoader is at 5");
+    }
+
     Tabs {
         id: emptyTabs
     }