Merge lp:~elopio/autopilot/fix1266601-Pointer-pressed-move into lp:autopilot

[Leo Arias]

Do a touch move when the Pointer is pressed.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:409
http://jenkins.qa.ubuntu.com/job/autopilot-ci/376/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/102/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/102/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/102/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2019/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2019/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/376/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:409
http://jenkins.qa.ubuntu.com/job/autopilot-ci/383/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/109/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/109/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2135/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2137/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/383/rebuild

review: Needs Fixing (continuous-integration)

[lp:~elopio/autopilot/fix1266601-Pointer-pressed-move]

410. By Leo Arias on 2014-01-19

Merged with trunk.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:410
http://jenkins.qa.ubuntu.com/job/autopilot-ci/405/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/131/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/131/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2452/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2454/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/405/rebuild

review: Needs Fixing (continuous-integration)

[lp:~elopio/autopilot/fix1266601-Pointer-pressed-move]

411. By Leo Arias on 2014-01-19

Merged with prerequisite branch.

412. By Leo Arias on 2014-01-19

Merged with prerequisite branch.

413. By Leo Arias on 2014-01-19

Merged with prerequisite branch.

414. By Leo Arias on 2014-01-19

Merged with prerequisite branch.

415. By Leo Arias on 2014-01-19

Use the mock touch so now real mouse events are used.

416. By Leo Arias on 2014-02-11

Merged with prerequisite.

417. By Leo Arias on 2014-02-11

Cleaned up the tests.

418. By Leo Arias on 2014-02-11

Cleaned up the tests.

419. By Leo Arias on 2014-02-11

Merged with prerequisite.

420. By Leo Arias on 2014-02-11

Updated prerequisite.

421. By Leo Arias on 2014-02-21

Use the device pressed property.

422. By Leo Arias on 2014-02-21

Fixed the tests backend.

423. By Leo Arias on 2014-02-21

Cleanup.

424. By Leo Arias on 2014-02-21

Finger move with transition.

425. By Leo Arias on 2014-02-21

Be consistent on the use of attributes.

426. By Leo Arias on 2014-02-21

Fixed pep8.

Unmerged revisions

426. By Leo Arias on 2014-02-21

Fixed pep8.

425. By Leo Arias on 2014-02-21

Be consistent on the use of attributes.

424. By Leo Arias on 2014-02-21

Finger move with transition.

423. By Leo Arias on 2014-02-21

Cleanup.

422. By Leo Arias on 2014-02-21

Fixed the tests backend.

421. By Leo Arias on 2014-02-21

Use the device pressed property.

420. By Leo Arias on 2014-02-11

Updated prerequisite.

419. By Leo Arias on 2014-02-11

Merged with prerequisite.

418. By Leo Arias on 2014-02-11

Cleaned up the tests.

417. By Leo Arias on 2014-02-11

Cleaned up the tests.

=== modified file 'autopilot/input/_X11.py'
--- autopilot/input/_X11.py	2013-11-07 05:53:36 +0000
+++ autopilot/input/_X11.py	2014-01-19 01:47:17 +0000
@@ -1,7 +1,7 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
 # Autopilot Functional Test Tool
-# Copyright (C) 2012-2013 Canonical
+# Copyright (C) 2012, 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 as published by
@@ -455,7 +455,7 @@
         x, y = coord["root_x"], coord["root_y"]
         return x, y
 
-    def drag(self, x1, y1, x2, y2):
+    def drag(self, x1, y1, x2, y2, rate=10):
         """Performs a press, move and release.
 
         This is to keep a common API between Mouse and Finger as long as
@@ -464,7 +464,7 @@
         """
         self.move(x1, y1)
         self.press()
-        self.move(x2, y2)
+        self.move(x2, y2, rate=rate)
         self.release()
 
     @classmethod

=== modified file 'autopilot/input/__init__.py'
--- autopilot/input/__init__.py	2013-09-20 19:01:27 +0000
+++ autopilot/input/__init__.py	2014-01-19 01:47:17 +0000
@@ -369,7 +369,7 @@
         """
         raise NotImplementedError("You cannot use this class directly.")
 
-    def drag(self, x1, y1, x2, y2):
+    def drag(self, x1, y1, x2, y2, rate=10):
         """Performs a press, move and release.
 
         This is to keep a common API between Mouse and Finger as long as
@@ -466,7 +466,7 @@
         """Release a previously pressed finger"""
         raise NotImplementedError("You cannot use this class directly.")
 
-    def drag(self, x1, y1, x2, y2):
+    def drag(self, x1, y1, x2, y2, rate=10):
         """Perform a drag gesture from (x1,y1) to (x2,y2)"""
         raise NotImplementedError("You cannot use this class directly.")
 
@@ -502,6 +502,7 @@
         self._device = device
         self._x = 0
         self._y = 0
+        self._pressed = False
 
     @property
     def x(self):
@@ -544,6 +545,7 @@
                 raise ValueError(
                     "Touch devices do not have button %d" % (button))
             self._device.press(self._x, self._y)
+        self._pressed = True
 
     def release(self, button=1):
         """Releases the pointer at it's current location.
@@ -560,6 +562,7 @@
                 raise ValueError(
                     "Touch devices do not have button %d" % (button))
             self._device.release()
+        self._pressed = False
 
     def click(self, button=1, press_duration=0.10):
         """Press and release at the current pointer location.
@@ -589,6 +592,8 @@
         if isinstance(self._device, Mouse):
             self._device.move(x, y)
         else:
+            if self._pressed:
+                self._device.move(x, y)
             self._x = x
             self._y = y
 
@@ -641,9 +646,9 @@
         else:
             return (self._x, self._y)
 
-    def drag(self, x1, y1, x2, y2):
+    def drag(self, x1, y1, x2, y2, rate=10):
         """Performs a press, move and release."""
-        self._device.drag(x1, y1, x2, y2)
+        self._device.drag(x1, y1, x2, y2, rate=rate)
         if isinstance(self._device, Touch):
             self._x = x2
             self._y = y2

=== modified file 'autopilot/input/_uinput.py'
--- autopilot/input/_uinput.py	2013-11-07 05:53:36 +0000
+++ autopilot/input/_uinput.py	2014-01-19 01:47:17 +0000
@@ -1,7 +1,7 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
 # Autopilot Functional Test Tool
-# Copyright (C) 2012-2013 Canonical
+# Copyright (C) 2012, 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 as published by
@@ -361,23 +361,33 @@
             raise RuntimeError("Attempting to move without finger being down.")
         self._finger_move(x, y)
 
-    def drag(self, x1, y1, x2, y2):
+    def drag(self, x1, y1, x2, y2, rate=10):
         """Perform a drag gesture from (x1,y1) to (x2,y2)"""
         logger.debug("Dragging from %d,%d to %d,%d", x1, y1, x2, y2)
         self._finger_down(x1, y1)
 
-        # Let's drag in 100 steps for now...
-        dx = 1.0 * (x2 - x1) / 100
-        dy = 1.0 * (y2 - y1) / 100
-        cur_x = x1 + dx
-        cur_y = y1 + dy
-        for i in range(0, 100):
-            self._finger_move(int(cur_x), int(cur_y))
+        current_x, current_y = x1, y1
+        while current_x != x2 or current_y != y2:
+            dx = abs(x2 - current_x)
+            dy = abs(y2 - current_y)
+
+            intx = float(dx) / max(dx, dy)
+            inty = float(dy) / max(dx, dy)
+
+            step_x = min(rate * intx, dx)
+            step_y = min(rate * inty, dy)
+
+            if x2 < current_x:
+                step_x *= -1
+            if y2 < current_y:
+                step_y *= -1
+
+            current_x += step_x
+            current_y += step_y
+            self._finger_move(current_x, current_y)
+
             sleep(0.002)
-            cur_x += dx
-            cur_y += dy
-        # Make sure we actually end up at target
-        self._finger_move(x2, y2)
+
         self._finger_up()
 
     def _finger_down(self, x, y):

=== modified file 'autopilot/tests/unit/test_input.py'
--- autopilot/tests/unit/test_input.py	2013-12-10 03:10:11 +0000
+++ autopilot/tests/unit/test_input.py	2014-01-19 01:47:17 +0000
@@ -1,7 +1,7 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
 #
 # Autopilot Functional Test Tool
-# Copyright (C) 2013 Canonical
+# Copyright (C) 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 as published by
@@ -17,10 +17,14 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from mock import patch
+import testscenarios
+
+from mock import call, Mock, patch
 from testtools import TestCase
 from testtools.matchers import raises
 
+import autopilot.input
+from autopilot.input import _uinput, _X11
 from autopilot.input._common import get_center_point
 
 
@@ -151,3 +155,232 @@
 
         self.assertEqual(123, x)
         self.assertEqual(345, y)
+
+
+class PartialMock(object):
+    """Mock some of the methods of an object, and record their calls."""
+
+    def __init__(self, real_object, *args):
+        super(PartialMock, self).__init__()
+        self._mock_manager = Mock()
+        self._real_object = real_object
+        self.patched_attributes = args
+
+    def __getattr__(self, name):
+        """Forward all the calls to the real object."""
+        return self._real_object.__getattribute__(name)
+
+    @property
+    def mock_calls(self):
+        """Return the calls recorded for the mocked attributes."""
+        return self._mock_manager.mock_calls
+
+    def __enter__(self):
+        self._start_patchers()
+        return self
+
+    def _start_patchers(self):
+        self._patchers = []
+        for attribute in self.patched_attributes:
+            patcher = patch.object(self._real_object, attribute)
+            self._patchers.append(patcher)
+
+            self._mock_manager.attach_mock(patcher.start(), attribute)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self._stop_patchers()
+
+    def _stop_patchers(self):
+        for patcher in self._patchers:
+            patcher.stop()
+
+
+class MockX11Mouse(PartialMock):
+    """Mock for the X11 Mouse Touch.
+
+    It records the calls to press, release and move, but doesn't perform them.
+
+    """
+
+    def __init__(self):
+        super(MockX11Mouse, self).__init__(
+            _X11.Mouse(), 'press', 'release', 'move')
+
+    def get_move_call_args_list(self):
+        return self._mock_manager.move.call_args_list
+
+
+class X11MouseTestCase(TestCase):
+
+    def test_drag_should_call_move_with_rate(self):
+        expected_first_move_call = call(0, 0)
+        expected_second_move_call = call(100, 100, rate=1)
+        with MockX11Mouse() as mock_mouse:
+            mock_mouse.drag(0, 0, 100, 100, rate=1)
+
+        self.assertEqual(
+            [expected_first_move_call, expected_second_move_call],
+            mock_mouse.get_move_call_args_list())
+
+    def test_drag_with_default_rate(self):
+        expected_first_move_call = call(0, 0)
+        expected_second_move_call = call(100, 100, rate=10)
+        with MockX11Mouse() as mock_mouse:
+            mock_mouse.drag(0, 0, 100, 100)
+
+        self.assertEqual(
+            [expected_first_move_call, expected_second_move_call],
+            mock_mouse.get_move_call_args_list())
+
+
+class MockUinputTouch(PartialMock):
+    """Mock for the uinput Touch.
+
+    It records the calls to _finger_down, _finger_up and _finger_move, but
+    doesn't perform them.
+
+    """
+
+    def __init__(self):
+        super(MockUinputTouch, self).__init__(
+            _uinput.Touch(), '_finger_down', '_finger_up', '_finger_move')
+
+    def get_finger_move_call_args_list(self):
+        return self._mock_manager._finger_move.call_args_list
+
+
+class UinputTouchTestCase(TestCase):
+
+    def test_drag_finger_actions(self):
+        expected_finger_calls = [
+            call._finger_down(0, 0),
+            call._finger_move(10, 10),
+            call._finger_up()
+        ]
+        with MockUinputTouch() as mock_touch:
+            mock_touch.drag(0, 0, 10, 10)
+        self.assertEqual(mock_touch.mock_calls, expected_finger_calls)
+
+    def test_drag_should_call_move_with_rate(self):
+        expected_move_calls = [call(5, 5), call(10, 10), call(15, 15)]
+        with MockUinputTouch() as mock_touch:
+            mock_touch.drag(0, 0, 15, 15, rate=5)
+
+        self.assertEqual(
+            expected_move_calls, mock_touch.get_finger_move_call_args_list())
+
+    def test_drag_with_default_rate(self):
+        expected_move_calls = [call(10, 10), call(20, 20)]
+        with MockUinputTouch() as mock_touch:
+            mock_touch.drag(0, 0, 20, 20)
+
+        self.assertEqual(
+            expected_move_calls, mock_touch.get_finger_move_call_args_list())
+
+    def test_drag_to_same_place_should_not_move(self):
+        expected_finger_calls = [
+            call._finger_down(0, 0),
+            call._finger_up()
+        ]
+        with MockUinputTouch() as mock_touch:
+            mock_touch.drag(0, 0, 0, 0)
+        self.assertEqual(mock_touch.mock_calls, expected_finger_calls)
+
+
+class DragUinputTouchTestCase(testscenarios.TestWithScenarios, TestCase):
+
+    scenarios = [
+        ('drag to top', dict(
+            start_x=50, start_y=50, stop_x=50, stop_y=30,
+            expected_moves=[call(50, 40), call(50, 30)])),
+        ('drag to bottom', dict(
+            start_x=50, start_y=50, stop_x=50, stop_y=70,
+            expected_moves=[call(50, 60), call(50, 70)])),
+        ('drag to left', dict(
+            start_x=50, start_y=50, stop_x=30, stop_y=50,
+            expected_moves=[call(40, 50), call(30, 50)])),
+        ('drag to right', dict(
+            start_x=50, start_y=50, stop_x=70, stop_y=50,
+            expected_moves=[call(60, 50), call(70, 50)])),
+
+        ('drag to top-left', dict(
+            start_x=50, start_y=50, stop_x=30, stop_y=30,
+            expected_moves=[call(40, 40), call(30, 30)])),
+        ('drag to top-right', dict(
+            start_x=50, start_y=50, stop_x=70, stop_y=30,
+            expected_moves=[call(60, 40), call(70, 30)])),
+        ('drag to bottom-left', dict(
+            start_x=50, start_y=50, stop_x=30, stop_y=70,
+            expected_moves=[call(40, 60), call(30, 70)])),
+        ('drag to bottom-right', dict(
+            start_x=50, start_y=50, stop_x=70, stop_y=70,
+            expected_moves=[call(60, 60), call(70, 70)])),
+
+        ('drag less than rate', dict(
+            start_x=50, start_y=50, stop_x=55, stop_y=55,
+            expected_moves=[call(55, 55)])),
+
+        ('drag with last move less than rate', dict(
+            start_x=50, start_y=50, stop_x=65, stop_y=65,
+            expected_moves=[call(60, 60), call(65, 65)])),
+    ]
+
+    def test_drag_moves(self):
+        with MockUinputTouch() as mock_touch:
+            mock_touch.drag(
+                self.start_x, self.start_y, self.stop_x, self.stop_y)
+
+        self.assertEqual(
+            self.expected_moves, mock_touch.get_finger_move_call_args_list())
+
+
+class PointerTestCase(TestCase):
+
+    def setUp(self):
+        super(PointerTestCase, self).setUp()
+        self.pointer = autopilot.input.Pointer(autopilot.input.Mouse.create())
+
+    def test_drag_with_rate(self):
+        with patch.object(self.pointer._device, 'drag') as mock_drag:
+            self.pointer.drag(0, 0, 20, 20, rate=5)
+
+        mock_drag.assert_called_once_with(0, 0, 20, 20, rate=5)
+
+    def test_drag_with_default_rate(self):
+        with patch.object(self.pointer._device, 'drag') as mock_drag:
+            self.pointer.drag(0, 0, 20, 20)
+
+        mock_drag.assert_called_once_with(0, 0, 20, 20, rate=10)
+
+
+class PointerWithTouchBackendTestCase(TestCase):
+
+    def setUp(self):
+        super(PointerWithTouchBackendTestCase, self).setUp()
+        self.pointer = autopilot.input.Pointer(autopilot.input.Touch.create())
+
+    def test_not_pressed_move_should_not_move_pointing_finger(self):
+        with patch.object(_uinput.Touch, 'move') as mock_move:
+            self.pointer.move(1, 1)
+
+        self.assertFalse(mock_move.called)
+
+    def test_pressed_move_should_move_pointing_finger(self):
+        with MockUinputTouch() as mock_touch:
+            self.pointer._device = mock_touch
+            with patch.object(_uinput.Touch, 'move') as mock_move:
+                self.pointer.press()
+                self.pointer.move(1, 1)
+
+        mock_move.assert_called_once_with(1, 1)
+
+    def test_released_move_should_not_move_pointing_finger(self):
+        with MockUinputTouch() as mock_touch:
+            self.pointer._device = mock_touch
+            with patch.object(_uinput.Touch, 'move') as mock_move:
+                self.pointer.press()
+                self.pointer.release()
+
+                self.pointer.move(1, 1)
+
+        self.assertFalse(mock_move.called)