Merge lp:~elopio/gallery-app/workaround1302706-fix1302706-click_toolbar_button_failure into lp:gallery-app

[Leo Arias]

    On the autopilot helpers to click a toolbar button, check that the toolbar is opened first.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:943
http://jenkins.qa.ubuntu.com/job/gallery-app-ci/765/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-amd64-ci/190
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/191
        deb: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/191/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-i386-ci/190
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-trusty-touch/31
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4530
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-runner-mako/56
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-click-builder-trusty-armhf/41
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5635
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3913
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4642
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4642/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/gallery-app-ci/765/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:943
http://jenkins.qa.ubuntu.com/job/gallery-app-ci/772/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-amd64-ci/197
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/198
        deb: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/198/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-i386-ci/197
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-trusty-touch/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4550
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-runner-mako/63
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-click-builder-trusty-armhf/48
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5678
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3929
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4668
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4668/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/gallery-app-ci/772/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:943
http://jenkins.qa.ubuntu.com/job/gallery-app-ci/773/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-amd64-ci/198
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/199
        deb: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-armhf-ci/199/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gallery-app-trusty-i386-ci/198
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-trusty-touch/39
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/4577
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-click-autopilot-runner-mako/65
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-click-builder-trusty-armhf/49
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/5703
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/3943
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4695
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4695/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/gallery-app-ci/773/rebuild

review: Needs Fixing (continuous-integration)

[Bill Filler (bfiller)]

approved

review: Approve

=== modified file 'tests/autopilot/gallery_app/emulators/toolbar.py'
--- tests/autopilot/gallery_app/emulators/toolbar.py	2013-11-03 22:47:55 +0000
+++ tests/autopilot/gallery_app/emulators/toolbar.py	2014-04-04 16:55:41 +0000
@@ -1,5 +1,5 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-# Copyright 2013 Canonical
+# Copyright 2013, 2014 Canonical
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -15,6 +15,38 @@
 class Toolbar(toolkit_emulators.Toolbar):
     """An emulator class that makes it easy to interact with the tool bar"""
 
+    def click_button(self, object_name):
+        """Click a button of the toolbar.
+
+        The toolbar should be opened before clicking the button, or an
+        exception will be raised. If the toolbar is closed for some reason
+        (e.g., timer finishes) after moving the mouse cursor and before
+        clicking the button, it is re-opened automatically by this function.
+
+        Overriden from the toolkit because of bug http://pad.lv/1302706
+        TODO remove this method once that bug is fixed on the toolkit.
+        --elopio - 2014-04-04
+
+        :parameter object_name: The QML objectName property of the button.
+        :raise ToolkitEmulatorException: If there is no button with that object
+            name.
+
+        """
+        # ensure the toolbar is open
+        if not self.opened:
+            raise toolkit_emulators.ToolkitEmulatorException(
+                'Toolbar must be opened before calling click_button().')
+        try:
+            button = self._get_button(object_name)
+        except StateNotFoundError:
+            raise toolkit_emulators.ToolkitEmulatorException(
+                'Button with objectName "{0}" not found.'.format(object_name))
+        self.pointing_device.move_to_object(button)
+        # ensure the toolbar is still open (may have closed due to timeout)
+        self.open()
+        # click the button
+        self.pointing_device.click_object(button)
+
     def click_custom_button(self, object_name):
         try:
             button = self.select_single('Button', objectName=object_name)