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

[Leo Arias]

Added the Toolbar Autopilot emulator.

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

571. By Leo Arias on 2013-06-27

Fixed pep8.

572. By Leo Arias on 2013-06-27

Typo.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:571
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/226/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/83/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/83/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/226/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:572
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/227/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/84/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/84/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/227/rebuild

review: Needs Fixing (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

LGTM

review: Approve

[Nicholas Skaggs (nskaggs)]

Check my +junk version again. If you don't force proper integers to click for say opening the toolbar it seems to fails when using gu units for window size.

So something like line_x = x + self.width * 0.50 I force to line_x = int(x + self.width * 0.50)

Otherwise this looks good!

[Leo Arias (elopio)]

Thanks for pointing that out Nicholas. With this change in autopilot, now we don't have to cast to int:
https://code.launchpad.net/~elopio/autopilot/fix1195499-move_non_int/+merge/171934

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:572
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/238/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/95/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/95/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/238/rebuild

review: Needs Fixing (continuous-integration)

[Juhapekka Piiroinen (juhapekka-piiroinen)]

> "Added the objectName property to ActionItem."

Could you justify the change to modules/Ubuntu/Components/ActionItem.qml. As in my opinion objectName should be set by the applications, not by the library. :)

review: Needs Information

[Leo Arias (elopio)]

Hi.

Do you mean that it should be defined on the test_qml?
If I just add it to the Action definition on the QML, it will not be present on the ActionItem object accessed by autopilot. I'm not close to be a QML expert thought, so I might be missing something.

I might have also misunderstood your question. I'm not close to be an english expert either :)

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

573. By Leo Arias on 2013-06-28

If we define the objectName on the ToolbarButton, we don't need to have the objectName property on the ActionItem.

574. By Leo Arias on 2013-06-28

Removed pdb.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:574
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/241/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/98
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/98
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/98/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins:8080/job/ubuntu-ui-toolkit-ci/241/rebuild

review: Approve (continuous-integration)

=== modified file 'debian/control'
--- debian/control	2013-06-27 02:42:26 +0000
+++ debian/control	2013-06-28 18:16:24 +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 18:16:24 +0000
@@ -14,9 +14,24 @@
 # 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
 
 
+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 +39,75 @@
 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')
+
+    def get_toolbar(self):
+        """Get 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 = self.globalRect[0]
+        y = self.globalRect[1]
+        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 = self.globalRect[0]
+        y = self.globalRect[1]
+        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)
+
+
+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)

=== 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 18:16:24 +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,114 @@
 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_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)
+
+
+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_get_header(self):
         header = self.main_view.get_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.')