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

[Leo Arias]

Added the Tabs autopilot emulator.

[Nicholas Skaggs (nskaggs)]

Looks nice Leo! Thanks again.

[lp:~elopio/ubuntu-ui-toolkit/tabs_emulator]

582. By Leo Arias on 2013-06-28

Moar tests and wait for the animation to finish.

583. By Leo Arias on 2013-06-28

Fixed pep8.

Unmerged revisions

583. By Leo Arias on 2013-06-28

Fixed pep8.

582. By Leo Arias on 2013-06-28

Moar tests and wait for the animation to finish.

581. By Leo Arias on 2013-06-28

Fixed pep8.

580. By Leo Arias on 2013-06-28

Added switch_to_previous_tab and throw an error when switching to an index out of range.

579. By Leo Arias on 2013-06-28

Added the switch_to_tab_by_index method.

578. By Leo Arias on 2013-06-28

Added a shortcut to switch a tab from the main view.

577. By Leo Arias on 2013-06-28

Removed the unused pointer from the tabs emulator.

576. By Leo Arias on 2013-06-28

Throw an error when trying to switch to a tab when there are no tabs.

575. By Leo Arias on 2013-06-28

Added a Tabs emulator and methods to get the current tab and switch to the next tab.

=== modified file 'debian/control'
--- debian/control	2013-06-27 02:42:26 +0000
+++ debian/control	2013-06-28 21:01:28 +0000
@@ -105,6 +105,7 @@
          libqt5test5,
          libqt5widgets5,
          python-autopilot (>= 1.3),
+         python-mock,
          ubuntu-ui-toolkit-examples (>= ${source:Version}),
 Description: Test package for Ubuntu UI Toolkit
  Autopilot tests for the ubuntu-ui-toolkit package

=== modified file 'tests/autopilot/UbuntuUiToolkit/emulators.py'
--- tests/autopilot/UbuntuUiToolkit/emulators.py	2013-06-27 02:31:46 +0000
+++ tests/autopilot/UbuntuUiToolkit/emulators.py	2013-06-28 21:01:28 +0000
@@ -14,9 +14,27 @@
 # 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/>.
 
+from autopilot import input, platform
 from autopilot.introspection import dbus
 
 
+_NO_TABS_ERROR = 'The MainView has no Tabs.'
+
+
+def get_pointing_device():
+    """Get the pointing device depending on the platform.
+
+    If the platform is `Desktop`, the pointing device will be a `Mouse`.
+    If not, the pointing device will be `Touch`.
+
+    """
+    if platform.model == 'Desktop':
+        input_device_class = input.Mouse
+    else:
+        input_device_class = input.Touch
+    return input.Pointer(input_device_class.create())
+
+
 class UbuntuUIToolkitEmulatorBase(dbus.CustomEmulatorBase):
     """A base class for all the Ubuntu UI Toolkit emulators."""
 
@@ -24,6 +42,149 @@
 class MainView(UbuntuUIToolkitEmulatorBase):
     """MainView Autopilot emulator."""
 
+    def __init__(self, *args):
+        super(MainView, self).__init__(*args)
+        self.pointing_device = get_pointing_device()
+
     def get_header(self):
-        """Get the Header emulator of the MainView."""
-        return self.select_single('Header')
+        """Return the Header emulator of the MainView."""
+        return self.select_single(Header)
+
+    def get_toolbar(self):
+        """Return the Toolbar emulator of the MainView."""
+        return self.select_single(Toolbar)
+
+    def open_toolbar(self):
+        """Open the toolbar if it's not already opened.
+
+        :return: The toolbar.
+
+        """
+        toolbar = self.get_toolbar()
+        if not toolbar.opened:
+            self._drag_to_open_toolbar()
+            toolbar.opened.wait_for(True)
+
+        return toolbar
+
+    def _drag_to_open_toolbar(self):
+        x, y, _, _ = self.globalRect
+        line_x = x + self.width * 0.50
+        start_y = y + self.height - 1
+        stop_y = y + self.height * 0.95
+
+        self.pointing_device.drag(line_x, start_y, line_x, stop_y)
+
+    def close_toolbar(self):
+        """Close the toolbar if it's opened."""
+        toolbar = self.get_toolbar()
+        if toolbar.opened:
+            self._drag_to_close_toolbar()
+            toolbar.opened.wait_for(False)
+
+    def _drag_to_close_toolbar(self):
+        x, y, _, _ = self.globalRect
+        line_x = x + self.width * 0.50
+        start_y = y + self.height * 0.95
+        stop_y = y + self.height - 1
+
+        self.pointing_device.drag(line_x, start_y, line_x, stop_y)
+
+    def get_tabs(self):
+        """Return the Tabs emulator of the MainView."""
+        tabs = self.select_single(Tabs)
+        assert tabs is not None, _NO_TABS_ERROR
+        return tabs
+
+    def switch_to_next_tab(self):
+        """Open the next tab.
+
+        :return: the newly opened tab.
+
+        """
+        self.get_header().switch_to_next_tab()
+        return self.get_tabs().get_current_tab()
+
+    def switch_to_tab_by_index(self, index):
+        """Open a tab.
+
+        :parameter index: The index of the tab to open.
+        :return: The newly opened tab.
+
+        """
+        tabs = self.get_tabs()
+        if index >= tabs.get_number_of_tabs():
+            raise IndexError('Tab index out of range.')
+        while not tabs.selectedTabIndex == index:
+            self.switch_to_next_tab()
+        return tabs.get_current_tab()
+
+    def switch_to_previous_tab(self):
+        """Open the previous tab.
+
+        :return: the newly opened tab.
+
+        """
+        tabs = self.get_tabs()
+        if tabs.selectedTabIndex == 0:
+            previous_tab_index = tabs.get_number_of_tabs() - 1
+        else:
+            previous_tab_index = tabs.selectedTabIndex - 1
+        return self.switch_to_tab_by_index(previous_tab_index)
+
+
+class Header(UbuntuUIToolkitEmulatorBase):
+    """Header Autopilot emulator."""
+
+    def __init__(self, *args):
+        super(Header, self).__init__(*args)
+        self.pointing_device = get_pointing_device()
+
+    def switch_to_next_tab(self):
+        """Open the next tab."""
+        tab_bar = self.select_single('NewTabBar')
+        assert tab_bar is not None, _NO_TABS_ERROR
+        tab_bar_x, tab_bar_y, _, _ = tab_bar.globalRect
+        line_y = tab_bar_y + tab_bar.height * 0.5
+        current_tab_x = tab_bar_x + tab_bar.width * 0.35
+        next_tab_x = tab_bar_x + tab_bar.width * 0.65
+
+        self.pointing_device.move(current_tab_x, line_y)
+        self.pointing_device.click()
+        self.pointing_device.move(next_tab_x, line_y)
+        self.pointing_device.click()
+
+
+class Toolbar(UbuntuUIToolkitEmulatorBase):
+    """Toolbar Autopilot emulator."""
+
+    def __init__(self, *args):
+        super(Toolbar, self).__init__(*args)
+        self.pointing_device = get_pointing_device()
+
+    def click_button(self, object_name):
+        """Click a button of the toolbar.
+
+        :param object_name: The QML objectName property of the button.
+
+        """
+        button = self._get_button(object_name)
+        not_found_error = 'Button with objectName "{0}" not found.'.format(
+            object_name)
+        assert button is not None, not_found_error
+        self.pointing_device.click_object(button)
+
+    def _get_button(self, object_name):
+        return self.select_single('ActionItem', objectName=object_name)
+
+
+class Tabs(UbuntuUIToolkitEmulatorBase):
+    """Tabs Autopilot emulator."""
+
+    def get_current_tab(self):
+        """Return the currently selected tab."""
+        return self.select_many('Tab')[self.selectedTabIndex]
+
+    def get_number_of_tabs(self):
+        """Return the number of tabs."""
+        return len(self.select_many('Tab'))

=== modified file 'tests/autopilot/UbuntuUiToolkit/tests/test_emulators.py'
--- tests/autopilot/UbuntuUiToolkit/tests/test_emulators.py	2013-06-27 02:29:35 +0000
+++ tests/autopilot/UbuntuUiToolkit/tests/test_emulators.py	2013-06-28 21:01:28 +0000
@@ -14,6 +14,7 @@
 # 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 mock
 
 from UbuntuUiToolkit import tests
 from UbuntuUiToolkit import emulators
@@ -28,16 +29,195 @@
 MainView {
     width: units.gu(48)
     height: units.gu(60)
-
-    Page {
-        title: "Test title"
-    }
 }
 """)
 
     def test_main_view_custom_emulator(self):
         self.assertIsInstance(self.main_view, emulators.MainView)
 
-    def test_get_header(self):
-        header = self.main_view.get_header()
+    def test_get_header_without_header(self):
+        header = self.main_view.get_header()
+        self.assertFalse(header.visible)
+
+    def test_toolbar_custom_emulator(self):
+        toolbar = self.main_view.get_toolbar()
+        self.assertIsInstance(toolbar, emulators.Toolbar)
+        self.assertFalse(toolbar.opened)
+
+    def test_get_tabs_without_tabs(self):
+        error = self.assertRaises(
+            AssertionError, self.main_view.get_tabs)
+        self.assertEqual(
+            error.message, 'The MainView has no Tabs.')
+
+    def test_switch_to_next_tab_without_tabs(self):
+        header = self.main_view.get_header()
+        error = self.assertRaises(
+            AssertionError, header.switch_to_next_tab)
+        self.assertEqual(
+            error.message, 'The MainView has no Tabs.')
+
+
+class PageTestCase(tests.UbuntuUiToolkitTestCase):
+
+    test_qml = ("""
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+
+MainView {
+    width: units.gu(48)
+    height: units.gu(60)
+
+    Page {
+        title: "Test title"
+    }
+}
+""")
+
+    def test_header_custom_emulator(self):
+        header = self.main_view.get_header()
+        self.assertIsInstance(header, emulators.Header)
+        self.assertTrue(header.visible)
         self.assertEqual(header.title, "Test title")
+
+
+class ToolbarTestCase(tests.UbuntuUiToolkitTestCase):
+
+    test_qml = ("""
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+
+MainView {
+    width: units.gu(50)
+    height: units.gu(50)
+
+    Page {
+
+        Label {
+            id: "label"
+            objectName: "clicked_label"
+            anchors.centerIn: parent
+            text: "Button not clicked."
+        }
+
+        tools: ToolbarItems {
+            ToolbarButton {
+                objectName: "buttonName"
+                action: Action {
+                    text: "buttonText"
+                    onTriggered: label.text = "Button clicked."
+                }
+            }
+            locked: false
+            opened: false
+        }
+    }
+}
+""")
+
+    def test_open_toolbar(self):
+        toolbar = self.main_view.open_toolbar()
+        self.assertTrue(toolbar.opened)
+
+    def test_opened_toolbar_is_not_opened_again(self):
+        toolbar = self.main_view.open_toolbar()
+        with mock.patch.object(
+                self.main_view.pointing_device, 'drag') as mock_drag:
+            self.main_view.open_toolbar()
+
+        self.assertFalse(mock_drag.called)
+        self.assertTrue(toolbar.opened)
+
+    def test_close_toolbar(self):
+        toolbar = self.main_view.open_toolbar()
+        self.main_view.close_toolbar()
+        self.assertFalse(toolbar.opened)
+
+    def test_closed_toolbar_is_not_closed_again(self):
+        with mock.patch.object(
+                self.main_view.pointing_device, 'drag') as mock_drag:
+            self.main_view.close_toolbar()
+
+        self.assertFalse(mock_drag.called)
+        self.assertFalse(self.main_view.get_toolbar().opened)
+
+    def test_click_toolbar_button(self):
+        label = self.app.select_single('Label', objectName='clicked_label')
+        self.assertNotEqual(label.text, 'Button clicked.')
+        toolbar = self.main_view.open_toolbar()
+        toolbar.click_button('buttonName')
+        self.assertEqual(label.text, 'Button clicked.')
+
+    def test_click_unexisting_button(self):
+        toolbar = self.main_view.open_toolbar()
+        error = self.assertRaises(
+            AssertionError, toolbar.click_button, 'unexisting')
+        self.assertEqual(
+            error.message, 'Button with objectName "unexisting" not found.')
+
+
+class TabsTestCase(tests.UbuntuUiToolkitTestCase):
+
+    test_qml = ("""
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+import Ubuntu.Components.ListItems 0.1 as ListItem
+
+MainView {
+    width: units.gu(48)
+    height: units.gu(60)
+
+    Tabs {
+        id: tabs
+        Tab {
+            objectName: "tab1"
+            title: "Test tab 1"
+        }
+        Tab {
+            objectName: "tab2"
+            title: "Test tab 2"
+        }
+    }
+}
+""")
+
+    def test_tabs_custom_emulator(self):
+        self.assertIsInstance(self.main_view.get_tabs(), emulators.Tabs)
+
+    def test_get_current_tab(self):
+        tabs = self.main_view.get_tabs()
+        self.assertEqual(tabs.get_current_tab().title, 'Test tab 1')
+
+    def test_switch_to_next_tab_from_header(self):
+        header = self.main_view.get_header()
+        header.switch_to_next_tab()
+        current_tab = self.main_view.get_tabs().get_current_tab()
+        self.assertEqual(current_tab.title, 'Test tab 2')
+
+    def test_switch_to_next_tab_from_main_view(self):
+        current_tab = self.main_view.switch_to_next_tab()
+        self.assertEqual(current_tab.title, 'Test tab 2')
+
+    def test_switch_to_tab_by_index(self):
+        current_tab = self.main_view.switch_to_tab_by_index(1)
+        self.assertEqual(current_tab.title, 'Test tab 2')
+        current_tab = self.main_view.switch_to_tab_by_index(0)
+        self.assertEqual(current_tab.title, 'Test tab 1')
+
+    def test_get_number_of_tabs(self):
+        tabs = self.main_view.get_tabs()
+        self.assertEqual(tabs.get_number_of_tabs(), 2)
+
+    def test_swith_to_tab_by_index_out_of_range(self):
+        error = self.assertRaises(
+            IndexError, self.main_view.switch_to_tab_by_index, 2)
+        self.assertEqual(error.message, 'Tab index out of range.')
+
+    def test_switch_to_previous_tab_from_first(self):
+        current_tab = self.main_view.switch_to_previous_tab()
+        self.assertEqual(current_tab.title, 'Test tab 2')
+
+    def test_switch_to_previous_tab_not_from_first(self):
+        self.main_view.switch_to_next_tab()
+        current_tab = self.main_view.switch_to_previous_tab()
+        self.assertEqual(current_tab.title, 'Test tab 1')