Merge lp:~townsend/unity/fix-ap-mouse-infinite-loop into lp:unity

[Christopher Townsend]

Make the mouse movement infinite while loop into a for loop and only iterate 10 times w/ a 0.5 second delay between movements. Raise an error if the correct icon is not found when the loop terminates.
Consolidate the autoscroll_to_icon() function into the move_mouse_to_icon() function and change move_mouse_to_icon() to handle autoscrolling offsets.

= Issue =
Some AP tests will move the mouse to a specific icon. The function to handle moving the mouse to the icon contained an infinite loop to move the mouse. The infinite loop was to make sure the Launcher would scroll since the icon could be off the screen. However, certain conditions can cause the Launcher to not scroll which led to a very long delay in the AP test of 7200 seconds! This also led to no movie of the failure to be created.

= Fix =
Instead of using an infinite while loop, now instead use a for loop and only iterate 10 times with a 0.5 second delay between movements. If the icon is not found after the loop terminates, raise an error which will fail the test and we should have a movie of what was causing the Launcher to not scroll.

I also consolidated the autoscroll_to_icon(0 function into the move_mouse_to_icon() function and added support to the move_mouse_to_icon() function to handle autscrolling offsets.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3512
http://jenkins.qa.ubuntu.com/job/unity-ci/365/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-saucy-amd64-ci/254/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-saucy-armhf-ci/252/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-saucy-i386-ci/253/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-ci/365/rebuild

review: Needs Fixing (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-autolanding/284/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/generic-cleanup-mbs/2271
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-saucy-amd64-autolanding/240
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-saucy-armhf-autolanding/240/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-saucy-i386-autolanding/240

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'tests/autopilot/unity/emulators/launcher.py'
--- tests/autopilot/unity/emulators/launcher.py	2013-09-12 15:56:41 +0000
+++ tests/autopilot/unity/emulators/launcher.py	2013-09-17 15:16:51 +0000
@@ -121,16 +121,28 @@
         logger.debug("Moving mouse to center of launcher.")
         self._mouse.move(target_x, target_y)
 
-    def move_mouse_to_icon(self, icon):
-        # The icon may be off the bottom of screen, so we do this in a loop:
-        while 1:
-            target_x = icon.center_x + self.x
-            target_y = icon.center_y
+    def move_mouse_to_icon(self, icon, autoscroll_offset=0):
+        """Move the mouse to a specific icon."""
+        (x, y, w, h) = self.geometry
+        found = False
+
+        # Only try 10 times (5 secs.) before giving up.
+        for i in xrange(0, 10):
+            mouse_x = target_x = icon.center_x + self.x
+            mouse_y = target_y = icon.center_y
+            if target_y > h:
+                mouse_y = h + y - autoscroll_offset
+            elif target_y < 0:
+                mouse_y = y + autoscroll_offset
             if self._mouse.x == target_x and self._mouse.y == target_y:
+                found = True
                 break
-            self._mouse.move(target_x, target_y)
+            self._mouse.move(mouse_x, mouse_y)
             sleep(0.5)
 
+        if not found:
+            raise RuntimeError("Could not move mouse to the icon")
+
     def mouse_reveal_launcher(self):
         """Reveal this launcher with the mouse.
 
@@ -309,17 +321,11 @@
 
         logger.debug("Clicking launcher icon %r on monitor %d with mouse button %d",
             icon, self.monitor, button)
+
         self.mouse_reveal_launcher()
-
-        # The icon may be off the screen, so we do this in a loop:
-        while 1:
-            target_x = icon.center_x + self.x
-            target_y = icon.center_y
-            if self._mouse.x == target_x and self._mouse.y == target_y:
-                break
-            self._mouse.move(target_x, target_y )
-            sleep(1)
+        self.move_mouse_to_icon(icon)
         self._mouse.click(button)
+
         if (move_mouse_after):
           self.move_mouse_to_right_of_launcher()
 
@@ -422,27 +428,6 @@
         pin_item = quicklist.get_quicklist_item_by_text('Unlock from Launcher')
         quicklist.click_item(pin_item)
 
-    def autoscroll_to_icon(self, icon, autoscroll_offset=0):
-        """Moves the mouse to the autoscroll zone to scroll the Launcher to the icon
-           in question.
-
-           autoscroll_offet is the offset, in number of pixels, from the end of the
-           autoscroll zone where is the autoscroll zone is currently 24 pixels high.
-        """
-        (x, y, w, h) = self.geometry
-
-        while 1:
-            mouse_x = target_x = icon.center_x + self.x
-            mouse_y = target_y = icon.center_y
-            if target_y > h:
-                mouse_y = h + y - autoscroll_offset
-            elif target_y < 0:
-                mouse_y = y + autoscroll_offset
-            if self._mouse.x == target_x and self._mouse.y == target_y:
-                break
-            self._mouse.move(mouse_x, mouse_y)
-            sleep(0.5)
-
     @property
     def geometry(self):
         """Returns a tuple of (x,y,w,h) for the current launcher."""
 
=== modified file 'tests/autopilot/unity/tests/launcher/test_scroll.py'
--- tests/autopilot/unity/tests/launcher/test_scroll.py	2013-05-20 10:36:31 +0000
+++ tests/autopilot/unity/tests/launcher/test_scroll.py	2013-09-17 15:16:51 +0000
@@ -58,7 +58,7 @@
         self.assertThat(last_icon.center_y, Eventually(GreaterThan(h)))
 
         # Autoscroll to the last icon
-        launcher_instance.autoscroll_to_icon(last_icon, autoscroll_offset)
+        launcher_instance.move_mouse_to_icon(last_icon, autoscroll_offset)
         
         (x_fin, y_fin) = self.mouse.position()
 
@@ -90,7 +90,7 @@
         self.assertThat(first_icon.center_y, Eventually(LessThan(y)))
         
         # Autoscroll to the first icon
-        launcher_instance.autoscroll_to_icon(first_icon, autoscroll_offset)
+        launcher_instance.move_mouse_to_icon(first_icon, autoscroll_offset)
 
         (x_fin, y_fin) = self.mouse.position()