Merge lp:~elopio/ubuntu-ui-toolkit/slider-autopilot_helper into lp:ubuntu-ui-toolkit/staging

[Leo Arias]

Added the autopilot helper for Sliders.

[Brendan Donegan (brendan-donegan)]

Don't leave todo's in the code

review: Needs Fixing

[Leo Arias (elopio)]

> Don't leave todo's in the code

Right, I forgot about it. Thanks.

[Chris Gagnon (chris.gagnon)]

This is redundant and should be combined/renamed to save the time it takes to run the tests

298 + ('positive value', {'value': 5}),
299 + ('negative value', {'value': -5}),
300 + ('minimum value', {'value': -10}),
301 + ('maximum value', {'value': 10}),

[Chris Gagnon (chris.gagnon)]

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1099
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/355/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/727
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/671
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/187
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/187
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/187/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/187
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1156
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1368
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1368/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8185
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic/598
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/810
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/810/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/355/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

Interesting, mako selects almost all the correct values. Back to the workshop.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1101
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/356/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/733
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/677
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/188
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/188
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/188/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/188
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1163
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1377
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/1377/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8193
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic/604
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/816
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/816/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/356/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1103
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/469/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1208/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/1075/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/301/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/301/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/301/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2086/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/1218/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/469/rebuild

review: Needs Fixing (continuous-integration)

[lp:~elopio/ubuntu-ui-toolkit/slider-autopilot_helper]

1104. By Leo Arias on 2014-06-26

Merged with staging.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1104
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/472/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/1223
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic/1088
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/304
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/304
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/304/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/304
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/1551
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2104
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/2104/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/8867
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic/902
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/1231
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/1231/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/472/rebuild

review: Needs Fixing (continuous-integration)

[lp:~elopio/ubuntu-ui-toolkit/slider-autopilot_helper]

1105. By Leo Arias on 2014-07-15

Merged with staging.

1106. By Leo Arias on 2014-07-16

Use the device simulation scenarios to reproduce slider problems.

Unmerged revisions

1106. By Leo Arias on 2014-07-16

Use the device simulation scenarios to reproduce slider problems.

1105. By Leo Arias on 2014-07-15

Merged with staging.

1104. By Leo Arias on 2014-06-26

Merged with staging.

1103. By Leo Arias on 2014-06-25

Changed the way we check for values not selectable, first try to select them.

1102. By Leo Arias on 2014-06-25

Merged with staging.

1101. By Leo Arias on 2014-06-06

Added a test for a negative float.

1100. By Leo Arias on 2014-06-06

Removed the TODOs.

1099. By Leo Arias on 2014-06-06

Added the docstring and logging.

1098. By Leo Arias on 2014-06-06

Added the last part of tests and checks to the slider helper.

1097. By Leo Arias on 2014-06-06

Fixed pep8.

=== modified file 'modules/Ubuntu/Components/Themes/Ambiance/SliderStyle.qml'
--- modules/Ubuntu/Components/Themes/Ambiance/SliderStyle.qml	2014-04-23 08:50:20 +0000
+++ modules/Ubuntu/Components/Themes/Ambiance/SliderStyle.qml	2014-07-16 05:06:34 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 Canonical Ltd.
+ * Copyright 2013, 2014 Canonical Ltd.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -35,6 +35,8 @@
 
     UbuntuShape {
         id: background
+        objectName: 'sliderBar'
+
         anchors {
             verticalCenter: parent.verticalCenter
             right: parent.right
@@ -56,6 +58,7 @@
 
     UbuntuShape {
         id: thumb
+        objectName: 'sliderThumb'
 
         anchors {
             verticalCenter: parent.verticalCenter

=== modified file 'tests/autopilot/ubuntuuitoolkit/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/__init__.py	2014-07-07 14:43:52 +0000
+++ tests/autopilot/ubuntuuitoolkit/__init__.py	2014-07-16 05:06:34 +0000
@@ -35,6 +35,7 @@
     'popups',
     'QQuickFlickable',
     'QQuickListView',
+    'Slider',
     'TabBar',
     'Tabs',
     'tests',
@@ -69,6 +70,7 @@
     popups,
     QQuickFlickable,
     QQuickListView,
+    Slider,
     TabBar,
     Tabs,
     TextField,

=== modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py	2014-06-30 10:49:51 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/__init__.py	2014-07-16 05:06:34 +0000
@@ -31,6 +31,7 @@
     'popups',
     'QQuickFlickable',
     'QQuickListView',
+    'Slider',
     'TabBar',
     'Tabs',
     'TextField',
@@ -63,6 +64,7 @@
 from ubuntuuitoolkit._custom_proxy_objects._qquicklistview import (
     QQuickListView
 )
+from ubuntuuitoolkit._custom_proxy_objects._slider import Slider
 from ubuntuuitoolkit._custom_proxy_objects._tabbar import TabBar
 from ubuntuuitoolkit._custom_proxy_objects._tabs import Tabs
 from ubuntuuitoolkit._custom_proxy_objects._textfield import TextField

=== added file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_slider.py'
--- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_slider.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_slider.py	2014-07-16 05:06:34 +0000
@@ -0,0 +1,81 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# 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 logging
+
+import autopilot.logging
+
+from ubuntuuitoolkit._custom_proxy_objects import _common
+
+
+logger = logging.getLogger(__name__)
+
+
+class Slider(_common.UbuntuUIToolkitCustomProxyObjectBase):
+    """Autopilot helper for the Slider."""
+
+    @autopilot.logging.log_action(logger.info)
+    def select_value(self, value):
+        """Select a value from the slider.
+
+        :param value: The value to select.
+        :raises ubuntuuitoolkit.ToolkitException: if the value is below the
+           minimum or above the minimum, and if the value is not selectable.
+
+        """
+        if value < self.minimumValue:
+            raise _common.ToolkitException(
+                'The value is lower than the minimum permitted by the slider.')
+        elif value > self.maximumValue:
+            raise _common.ToolkitException(
+                'The value is higher than the maximum permitted by the '
+                'slider.')
+        else:
+            self._set_valid_value(value)
+
+    def _set_valid_value(self, value):
+        x, y = self._get_value_point_in_bar(value)
+        self.pointing_device.move(round(x), round(y))
+        self.pointing_device.click()
+        if self.value != value:
+            raise _common.ToolkitException(
+                'The value is not selectable on the slider.')
+
+    def _get_value_point_in_bar(self, value):
+        bar_start, bar_end = self._get_bar_start_and_end()
+        # We have two points: (min, bar_start) and (max, bar_end).
+        # With that we can use linear interpolation to get the x coordinate to
+        # click.
+        p_x_from_slider = (
+            bar_start +
+            (bar_end - bar_start) *
+            (value - self.minimumValue) /
+            (self.maximumValue - self.minimumValue))
+        p_x = p_x_from_slider + self.globalRect.x
+        # The point to click on the y coordinate is the center of the slider.
+        p_y = self.globalRect.y + self.globalRect.height // 2
+        return p_x, p_y
+
+    def _get_bar_start_and_end(self):
+        # We subtract from the bar width the width of the thumb because the
+        # center of the thumb never reaches the start or the end of the bar,
+        # so we have to scale down the range of values that we can select.
+        thumb = self.select_single(objectName='sliderThumb')
+        half_thumb_width = thumb.globalRect.width / 2
+        bar = self.select_single(objectName='sliderBar')
+        bar_start = half_thumb_width
+        bar_end = bar.globalRect.width - half_thumb_width
+        return bar_start, bar_end

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.SliderTestCase.qml'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.SliderTestCase.qml	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.SliderTestCase.qml	2014-07-16 05:06:34 +0000
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * 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 QtQuick 2.0
+import Ubuntu.Components 1.1
+
+MainView {
+
+    width: units.gu(48)
+    height: units.gu(60)
+
+    Slider {
+        objectName: 'testSlider'
+
+        minimumValue: -10
+        maximumValue: 10
+        value: 0.0
+    }
+}

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.py'
--- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_slider.py	2014-07-16 05:06:34 +0000
@@ -0,0 +1,161 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# 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 os
+
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
+import testscenarios
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals
+
+import ubuntuuitoolkit
+from ubuntuuitoolkit import fixture_setup, ubuntu_scenarios
+
+
+class BaseSliderTestCase(ubuntuuitoolkit.tests.QMLFileAppTestCase):
+
+    path = os.path.abspath(__file__)
+    dir_path = os.path.dirname(path)
+    test_qml_file_path = os.path.join(
+        dir_path, 'test_slider.SliderTestCase.qml')
+
+    def setUp(self):
+        super(BaseSliderTestCase, self).setUp()
+        # The test slider has a minimum value = -10, maximum value = 10 and
+        # starts with value = 0.
+        self.slider = self.main_view.select_single(
+            ubuntuuitoolkit.Slider, objectName='testSlider')
+
+
+class SliderCustomProxyObjectTestCase(BaseSliderTestCase):
+
+    def test_get_slider_must_return_custom_proxy_object(self):
+        """Test the type of the returned object after selecting the slider.
+
+        It must be the custom proxy object for the Slider.
+
+        """
+        self.assertIsInstance(self.slider, ubuntuuitoolkit.Slider)
+
+    def test_select_value_below_minimum_must_raise_exception(self):
+        """Test to select a value that is below the slider minimum.
+
+        It must raise a ToolkitException.
+
+        """
+        error = self.assertRaises(
+            ubuntuuitoolkit.ToolkitException, self.slider.select_value, -15)
+        self.assertEqual(
+            'The value is lower than the minimum permitted by the slider.',
+            str(error))
+
+    def test_select_value_above_maximum_must_raise_exception(self):
+        """Test to select a value that is above the slider maximum.
+
+        It must raise a ToolkitException.
+
+        """
+        error = self.assertRaises(
+            ubuntuuitoolkit.ToolkitException, self.slider.select_value, 15)
+        self.assertEqual(
+            'The value is higher than the maximum permitted by the slider.',
+            str(error))
+
+    def test_select_current_value_must_do_nothing(self):
+        """Test selecting the current value on the slider.
+
+        The value must be kept the same and the slider should not be touched.
+
+        """
+        with mock.patch.object(self.slider, 'pointing_device') as mock_device:
+            self.slider.select_value(0)
+
+        self.assertFalse(mock_device.called)
+        self.assertEqual(self.slider.value, 0)
+
+    def test_select_value_not_selectable_must_raise_exception(self):
+        """Test selecting a value that's not selectable with the thumb.
+
+        It must raise a ubuntuuitoolkit.ToolkitException.
+
+        """
+        error = self.assertRaises(
+            ubuntuuitoolkit.ToolkitException, self.slider.select_value, 2.2222)
+        self.assertEqual(
+            'The value is not selectable on the slider.', str(error))
+
+
+class SelectSliderValueTestCase(BaseSliderTestCase):
+
+    value_scenarios = [
+        ('positive value', {'value': 5}),
+        ('negative value', {'value': -5}),
+        ('minimum value', {'value': -10}),
+        ('maximum value', {'value': 10}),
+        ('positive float value', {'value': 2.152777777777777}),
+        ('negative float value', {'value': -1.1805555555555554}),
+    ]
+    scenarios = testscenarios.multiply_scenarios(
+        ubuntu_scenarios.get_device_simulation_scenarios(),
+        value_scenarios)
+
+    def setUp(self):
+        if self.should_simulate_device():
+            # Hide the Unity7 launcher because it takes space that might be
+            # needed by the app with the simulated size.
+            self.useFixture(fixture_setup.HideUnity7Launcher())
+            # This sets the grid units, so it should be called before launching
+            # the app.
+            self.simulate_device()
+        super(SelectSliderValueTestCase, self).setUp()
+
+        if self.should_simulate_device():
+            # XXX Currently we have no way to launch the application with a
+            # specific size, so we must resize it after it's launched.
+            # --elopio - 2014-06-25
+            self.resize_window()
+
+    def should_simulate_device(self):
+        return (hasattr(self, 'app_width') and hasattr(self, 'app_height') and
+                hasattr(self, 'grid_unit_px'))
+
+    def simulate_device(self):
+        simulate_device_fixture = self.useFixture(fixture_setup.SimulateDevice(
+            self.app_width, self.app_height, self.grid_unit_px))
+        self.app_width = simulate_device_fixture.app_width
+        self.app_height = simulate_device_fixture.app_height
+
+    def resize_window(self):
+        application = self.process_manager.get_running_applications()[0]
+        window = application.get_windows()[0]
+        window.resize(self.app_width, self.app_height)
+
+        def get_window_size():
+            _, _, window_width, window_height = window.geometry
+            return window_width, window_height
+
+        self.assertThat(
+            get_window_size,
+            Eventually(Equals((self.app_width, self.app_height))))
+
+    def test_select_valid_value_must_update_slider_value(self):
+        """Test that selecting a valid value on the slider must update it."""
+        self.slider.select_value(self.value)
+        self.assertEqual(self.slider.value, self.value)