Merge lp:~elopio/ubuntu-ui-toolkit/fix1220346-pointing_device into lp:ubuntu-ui-toolkit

[Leo Arias]

Do not duplicate the pointer instantiation on the autopilot emulators.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:742
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/606/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/2949/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/463/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/463/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2955/console

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

review: Needs Fixing (continuous-integration)

[lp:~elopio/ubuntu-ui-toolkit/fix1220346-pointing_device]

743. By Leo Arias on 2013-09-03

Fixed pep8 error.

[Nicholas Skaggs (nskaggs)]

+1 on the fact it would be nice to have access to the screen on touch devices.

Overall, this makes sense to leave in the base class and not duplicate.

[Leo Arias (elopio)]

<balloons> elopio, problems with this do you think? mock_model.return_value = 'not desktop'
<elopio> balloons: I didn't like it, but it seems each phone returns something different.
<balloons> I spoke with thomi at one point about getting actual device names returned via the platform model call
<elopio> balloons: hum, my nexus4 returns 'nexus4'.
<elopio> 'Nexus 4'
<balloons> it's just a test I suppose :-)
<elopio> balloons: it's just testing the two workflows we have: 1 on the desktop, 1 other.
<elopio> maybe later it would make more sense make a switch statement with all the available devices.
<balloons> right.. It's not an issue for us to solve, as we don't currently define anything beyond that
<balloons> we as in, autopilot I mean to say
<elopio> but I see more problems on that, because we are going to be always outdated.
<elopio> maybe, what we are missing is an api method that tells us if the platform has a touch interface.
<balloons> well, I mean something perhaps that says this is a tablet or phone.. or at least this device supports multitouch, osk, etc, etc
<elopio> there are desktop monitors that can be touched, and there are phones that can't.
<balloons> indeed
<elopio> yes, we are definetly missing something.
<balloons> perhaps thomi will solve that when he adds the accelerometer stuff
<elopio> yes, all those things are related. Selenium has something called capabilities
<elopio> to check if a browser can do javascript, and things like that.
<elopio> and then they have drivers for each browser.
<elopio> it might make sense to group some capabilities on device drivers, and select which tests to run based on that. Or which devices to use, like on-screen keyboard vrs external keyboard.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:743
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/608/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/2957/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/465
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/465
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/465/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2963/console

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

review: Needs Fixing (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

<thomi> elopio: I don't think you need so many mocks in your tests
<thomi> elopio: in fact, you can do it with 0 mocks :)
<thomi> first you need to add @skipIf(model() != 'Desktop') and the inverse above each test
<thomi> then just create your emulator, and assert that the pointing device is an instance of Pointer

review: Needs Fixing

[lp:~elopio/ubuntu-ui-toolkit/fix1220346-pointing_device]

744. By Leo Arias on 2013-09-03

Put the return value on the decorator, as suggested by thomi.

745. By Leo Arias on 2013-09-03

Remove the model mock and skip the test if we are on the wrong device, as suggested by thomi.

[Leo Arias (elopio)]

<elopio> thomi: but then all the tests will never be run. And if jenkins executes on desktop, the touch case will never be executed.
<thomi> elopio: this is true, but we're supposed to be running our tests on *all the platforms* :)
<thomi> in that case, at least change your patch descriptor to something like:
<thomi> @patch('autopilot.model.platform', new=lambda: "Desktop")
<thomi> so you don't need to pass it in
<elopio> thomi: ok, I changed that.
<elopio> I could get rid of the pointer mock, but I would have to assert the _device attribute.
<elopio> as it starts with _, I found that a bad idea.
<thomi> elopio: also, you can't create a mouse on the touch
<thomi> so you *have* to mock it
<elopio> really?
<thomi> or fake it, either way
<thomi> yeah
<thomi> Mouse is X11
<thomi> no X11 on the device :-/
<thomi> until we get bindings to the mir input stack, our hands are tied there I'm afraid
<elopio> ok, then it doesn't make a lot of sense to run all the tests. I'll add the skips.
<elopio> thomi: pushed.
<elopio> thomi: would you prefer if I check the type of pointer._device instead of using the mock and checking the type of the argument?
<thomi> elopio: I'm cool either way :)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:745
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/609/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/2962
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-amd64-ci/466
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/466
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-saucy-armhf-ci/466/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2968
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-i386/2968/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/2520

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

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve

=== modified file 'tests/autopilot/ubuntuuitoolkit/emulators.py'
--- tests/autopilot/ubuntuuitoolkit/emulators.py	2013-09-03 10:38:06 +0000
+++ tests/autopilot/ubuntuuitoolkit/emulators.py	2013-09-03 20:31:27 +0000
@@ -35,20 +35,22 @@
         input_device_class = input.Mouse
     else:
         input_device_class = input.Touch
-    return input.Pointer(input_device_class.create())
+    return input.Pointer(device=input_device_class.create())
 
 
 class UbuntuUIToolkitEmulatorBase(dbus.CustomEmulatorBase):
     """A base class for all the Ubuntu UI Toolkit emulators."""
 
+    def __init__(self, *args):
+        super(UbuntuUIToolkitEmulatorBase, self).__init__(*args)
+        self.pointing_device = get_pointing_device()
+        # TODO it would be nice to have access to the screen keyboard if we are
+        # on the touch UI -- elopio - 2013-09-04
+
 
 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):
         """Return the Header emulator of the MainView."""
         return self.select_single('Header', objectName='MainView_Header')
@@ -198,10 +200,6 @@
 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.
 
@@ -233,10 +231,6 @@
 class TabBar(UbuntuUIToolkitEmulatorBase):
     """TabBar Autopilot emulator."""
 
-    def __init__(self, *args):
-        super(TabBar, self).__init__(*args)
-        self.pointing_device = get_pointing_device()
-
     def switch_to_next_tab(self):
         """Open the next tab."""
         # Click the tab bar to switch to selection mode.
@@ -264,10 +258,6 @@
 class ActionSelectionPopover(UbuntuUIToolkitEmulatorBase):
     """ActionSelectionPopover Autopilot emulator."""
 
-    def __init__(self, *args):
-        super(ActionSelectionPopover, self).__init__(*args)
-        self.pointing_device = get_pointing_device()
-
     def click_button_by_text(self, text):
         """Click a button on the popover.
 

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py'
--- tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py	2013-09-03 10:19:24 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/test_emulators.py	2013-09-03 20:31:27 +0000
@@ -14,11 +14,38 @@
 # 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 unittest
+
 import mock
+import testtools
+from autopilot import input, platform
 
 from ubuntuuitoolkit import emulators, tests
 
 
+class UbuntuUIToolkitEmulatorBaseTestCase(testtools.TestCase):
+
+    def test_pointing_device(self):
+        emulator = emulators.UbuntuUIToolkitEmulatorBase({}, 'dummy_path')
+        self.assertIsInstance(emulator.pointing_device, input.Pointer)
+
+    @mock.patch('autopilot.input.Pointer')
+    @unittest.skipIf(platform.model() != 'Desktop', 'Desktop only')
+    def test_pointing_device_in_desktop(self, mock_pointer):
+        emulators.UbuntuUIToolkitEmulatorBase({}, 'dummy_path')
+        mock_pointer.assert_called_once_with(device=mock.ANY)
+        _, _, keyword_args = mock_pointer.mock_calls[0]
+        self.assertIsInstance(keyword_args['device'], input.Mouse)
+
+    @mock.patch('autopilot.input.Pointer')
+    @unittest.skipIf(platform.model() == 'Desktop', 'Phablet only')
+    def test_pointing_device_in_phablet(self, mock_pointer):
+        emulators.UbuntuUIToolkitEmulatorBase({}, 'dummy_path')
+        mock_pointer.assert_called_once_with(device=mock.ANY)
+        _, _, keyword_args = mock_pointer.mock_calls[0]
+        self.assertIsInstance(keyword_args['device'], input.Touch)
+
+
 class MainViewTestCase(tests.UbuntuUiToolkitTestCase):
 
     test_qml = ("""