Merge lp:~canonical-platform-qa/autopilot/fix1268782-press_duration into lp:autopilot

[Leo Arias]

Add the press duration argument to touch clicks.

[lp:~canonical-platform-qa/autopilot/fix1268782-press_duration]

515. By Leo Arias on 2014-08-21

    No need to mock the sleep again.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:515
http://jenkins.qa.ubuntu.com/job/autopilot-ci/849/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/124
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/124/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/123
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/123/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/123
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/123/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/3888
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-autopilot/285
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/3748
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/5135
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/5135/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/11887
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/325
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/3281
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/3281/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good, just had one question:
  difflines 110, 119: is there a reason you're doing it this way and not using make_fake_object method (from that same test file?)

review: Needs Information

[lp:~canonical-platform-qa/autopilot/fix1268782-press_duration]

516. By Leo Arias on 2014-08-26

Use make_fake_object.

517. By Leo Arias on 2014-08-26

Also update the other use of make_fake_object.

[Leo Arias (elopio)]

I didn't see that function. I've pushed a new version following your advice. I also updated other test that wasn't using it, that's where I copied the statement from.

Thanks veebers.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:517
http://jenkins.qa.ubuntu.com/job/autopilot-ci/850/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/125
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-amd64-ci/125/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/124
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-armhf-ci/124/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/124
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-utopic-i386-ci/124/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/4021
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-autopilot/286
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/3863
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/5273
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/5273/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/12091
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/326
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/3384
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/3384/artifact/work/output/*zip*/output.zip

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

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Awesome, cheers.

review: Approve

=== modified file 'autopilot/input/__init__.py'
--- autopilot/input/__init__.py	2014-03-25 14:42:25 +0000
+++ autopilot/input/__init__.py	2014-08-26 05:24:44 +0000
@@ -440,11 +440,11 @@
         """
         raise NotImplementedError("You cannot use this class directly.")
 
-    def tap(self, x, y):
+    def tap(self, x, y, press_duration=0.1):
         """Click (or 'tap') at given x,y coordinates."""
         raise NotImplementedError("You cannot use this class directly.")
 
-    def tap_object(self, object):
+    def tap_object(self, object, press_duration=0.1):
         """Tap the center point of a given object.
 
         It does this by looking for several attributes, in order. The first
@@ -610,7 +610,7 @@
             if button != 1:
                 raise ValueError(
                     "Touch devices do not have button %d" % (button))
-            self._device.tap(self._x, self._y)
+            self._device.tap(self._x, self._y, press_duration=press_duration)
 
     def move(self, x, y):
         """Moves the pointer to the specified coordinates.

=== modified file 'autopilot/input/_uinput.py'
--- autopilot/input/_uinput.py	2014-07-30 10:18:17 +0000
+++ autopilot/input/_uinput.py	2014-08-26 05:24:44 +0000
@@ -460,7 +460,7 @@
     def pressed(self):
         return self._device.pressed
 
-    def tap(self, x, y):
+    def tap(self, x, y, press_duration=0.1):
         """Click (or 'tap') at given x and y coordinates.
 
         :raises RuntimeError: if the finger is already pressed.
@@ -469,10 +469,10 @@
         """
         _logger.debug("Tapping at: %d,%d", x, y)
         self._device.finger_down(x, y)
-        sleep(0.1)
+        sleep(press_duration)
         self._device.finger_up()
 
-    def tap_object(self, object_):
+    def tap_object(self, object_, press_duration=0.1):
         """Click (or 'tap') a given object.
 
         :raises RuntimeError: if the finger is already pressed.
@@ -483,7 +483,7 @@
         """
         _logger.debug("Tapping object: %r", object)
         x, y = get_center_point(object_)
-        self.tap(x, y)
+        self.tap(x, y, press_duration=press_duration)
 
     def press(self, x, y):
         """Press and hold a given object or at the given coordinates.

=== modified file 'autopilot/tests/unit/test_input.py'
--- autopilot/tests/unit/test_input.py	2014-05-20 08:53:21 +0000
+++ autopilot/tests/unit/test_input.py	2014-08-26 05:24:44 +0000
@@ -652,24 +652,26 @@
 
     def get_touch_with_mocked_backend(self):
         touch = _uinput.Touch(device_class=Mock)
-        touch._device.mock_add_spec(
-            _uinput._UInputTouchDevice, spec_set=True)
+        touch._device.mock_add_spec(_uinput._UInputTouchDevice)
         return touch
 
-    def test_tap_must_put_finger_down_and_then_up(self):
+    def test_tap_must_put_finger_down_then_sleep_and_then_put_finger_up(self):
         expected_calls = [
             call.finger_down(0, 0),
+            call.sleep(ANY),
             call.finger_up()
         ]
 
         touch = self.get_touch_with_mocked_backend()
-        touch.tap(0, 0)
+        with patch('autopilot.input._uinput.sleep') as mock_sleep:
+            touch._device.attach_mock(mock_sleep, 'sleep')
+            touch.tap(0, 0)
         self.assertEqual(expected_calls, touch._device.mock_calls)
 
     def test_tap_object_must_put_finger_down_and_then_up_on_the_center(self):
-        object_ = type('Dummy', (object,), {'globalRect': (0, 0, 10, 10)})
+        object_ = make_fake_object(center=True)
         expected_calls = [
-            call.finger_down(5, 5),
+            call.finger_down(object_.center_x, object_.center_y),
             call.finger_up()
         ]
 
@@ -746,6 +748,40 @@
         touch.drag(0, 0, 0, 0)
         self.assertEqual(expected_calls, touch._device.mock_calls)
 
+    def test_tap_without_press_duration_must_sleep_default_time(self):
+        touch = self.get_touch_with_mocked_backend()
+
+        touch.tap(0, 0)
+
+        self.assertEqual(utilities.sleep.total_time_slept(), 0.1)
+
+    def test_tap_with_press_duration_must_sleep_specified_time(self):
+        touch = self.get_touch_with_mocked_backend()
+
+        touch.tap(0, 0, press_duration=10)
+
+        self.assertEqual(utilities.sleep.total_time_slept(), 10)
+
+    def test_tap_object_without_duration_must_call_tap_with_default_time(self):
+        object_ = make_fake_object(center=True)
+        touch = self.get_touch_with_mocked_backend()
+
+        with patch.object(touch, 'tap') as mock_tap:
+            touch.tap_object(object_)
+
+        mock_tap.assert_called_once_with(
+            object_.center_x, object_.center_y, press_duration=0.1)
+
+    def test_tap_object_with_duration_must_call_tap_with_specified_time(self):
+        object_ = make_fake_object(center=True)
+        touch = self.get_touch_with_mocked_backend()
+
+        with patch.object(touch, 'tap') as mock_tap:
+            touch.tap_object(object_, press_duration=10)
+
+        mock_tap.assert_called_once_with(
+            object_.center_x, object_.center_y, press_duration=10)
+
 
 class MultipleUInputTouchBackend(_uinput._UInputTouchDevice):
 
@@ -885,3 +921,17 @@
 
         mock_drag.assert_called_once_with(
             0, 0, 20, 20, rate=10, time_between_events=0.01)
+
+    def test_click_with_default_press_duration(self):
+        pointer = self.get_pointer_with_touch_backend_with_mock_device()
+        with patch.object(pointer._device, 'tap') as mock_tap:
+            pointer.click(1)
+
+        mock_tap.assert_called_once_with(0, 0, press_duration=0.1)
+
+    def test_press_with_specified_press_duration(self):
+        pointer = self.get_pointer_with_touch_backend_with_mock_device()
+        with patch.object(pointer._device, 'tap') as mock_tap:
+            pointer.click(1, press_duration=10)
+
+        mock_tap.assert_called_once_with(0, 0, press_duration=10)