Merge into trunk : open_scope : Code : Unity 8

Status:	Superseded
Proposed branch:	lp:~elopio/unity8/open_scope
Merge into:	lp:unity8
Diff against target:	363 lines (+242/-23) 6 files modified debian/control (+1/-0) tests/autopilot/unity8/shell/emulators/__init__.py (+13/-6) tests/autopilot/unity8/shell/emulators/dash.py (+106/-12) tests/autopilot/unity8/shell/emulators/greeter.py (+2/-5) tests/autopilot/unity8/shell/tests/__init__.py (+1/-0) tests/autopilot/unity8/shell/tests/test_emulators.py (+119/-0)
To merge this branch:	bzr merge lp:~elopio/unity8/open_scope
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot (community)	continuous-integration		Needs Fixing on 2014-01-09
Albert Astals Cid (community)		2014-01-07	Approve on 2014-01-09
Richard Huddie (community)			Approve on 2014-01-06
Unity Team		2014-01-03	Pending
Review via email: mp+200426@code.launchpad.net

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-03:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-04:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-04:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Richard Huddie (rhuddie) wrote on 2014-01-06:

#

Regarding the last 2 tests, test_open_generic_scope and test_open_applications_scope should there also be some assertion/action to make sure that the target scope is not already opened? Otherwise if the tests are run out of sequence or if the device is left with that scope already open, the test may not actually do anything other than check it is already opened.

Revision history for this message

Leo Arias (elopio) wrote on 2014-01-06:

#

What I wanted to test in those two is just that the returned scope is of the right type. If it's open or not didn't seem relevant for me, as the opening is tested in the other tests.

Revision history for this message

Richard Huddie (rhuddie) wrote on 2014-01-06:

#

Agreed, just wanted to clarify the scope of the test.

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-06:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-06:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Leo Arias (elopio) wrote on 2014-01-08:

#

back to work in progress because now there is no bottom bar, and the header has the toolkit tabs.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Leo Arias (elopio) wrote on 2014-01-08:

#

Back to work in progress. Now I won't use indexes.

lp:~elopio/unity8/open_scope updated on 2014-01-08

621. By Leo Arias on 2014-01-08: Typo.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-08:

#

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

review: Needs Fixing (continuous-integration)

lp:~elopio/unity8/open_scope updated on 2014-01-09

622. By Leo Arias on 2014-01-09: added the missing x.
623. By Leo Arias on 2014-01-09: Merged with trunk.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-09:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-09:

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Albert Astals Cid (aacid) wrote on 2014-01-09:

#

Looks good to me, tests pass in my machine, wonder why not in CI :_/

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-09:

#

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

review: Needs Fixing (continuous-integration)

lp:~elopio/unity8/open_scope updated on 2014-01-09

624. By Leo Arias on 2014-01-09: Use the emulator pointing device on the Greeter.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-01-09:

#

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

review: Needs Fixing (continuous-integration)

lp:~elopio/unity8/open_scope updated on 2014-01-09

625. By Leo Arias on 2014-01-09: Merged with prerequisite.
626. By Leo Arias on 2014-01-09: Unlock using the process helper, to get retries.

Unity 8

Merge lp:~elopio/unity8/open_scope into lp:unity8

Commit message

Description of the change

Unmerged revisions

Preview Diff

Subscribers

 === modified file 'debian/control'
 --- debian/control	2013-12-20 15:37:27 +0000
 +++ debian/control	2014-01-09 21:28:09 +0000
@@ -104,6 +104,7 @@
           libqt5widgets5,
           python-evdev,
           python-gi,
++         python-mock,
           unity8 (>= ${source:Version}),
           unity8-fake-env (>= ${source:Version}),
           ${misc:Depends},
 === modified file 'tests/autopilot/unity8/shell/emulators/__init__.py'
 --- tests/autopilot/unity8/shell/emulators/__init__.py	2013-10-02 09:01:12 +0000
 +++ tests/autopilot/unity8/shell/emulators/__init__.py	2014-01-09 21:28:09 +0000
@@ -1,7 +1,7 @@
  # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+ #
  # Unity Autopilot Test Suite
--# 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
@@ -17,9 +17,16 @@
  # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ #
--
--from autopilot.introspection import CustomEmulatorBase
--
--
--class UnityEmulatorBase(CustomEmulatorBase):
++from autopilot import input, introspection
++
++
++class UnityEmulatorBase(introspection.CustomEmulatorBase):
      """A base class for all unity emulators."""
++
++    def __init__(self, *args):
++        super(UnityEmulatorBase, self).__init__(*args)
++        self.pointing_device = input.Touch.create()
++
++
++class UnityEmulatorException(Exception):
++    """Exception raised when there is an error with the Unity emulators."""
 === modified file 'tests/autopilot/unity8/shell/emulators/dash.py'
 --- tests/autopilot/unity8/shell/emulators/dash.py	2013-11-01 13:59:50 +0000
 +++ tests/autopilot/unity8/shell/emulators/dash.py	2014-01-09 21:28:09 +0000
@@ -1,7 +1,7 @@
  # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+ #
  # Unity Autopilot Test Suite
--# 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
@@ -17,13 +17,25 @@
  # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ #
--from unity8.shell.emulators import UnityEmulatorBase
--
--
--class Dash(UnityEmulatorBase):
--
++import logging
++
++from unity8.shell import emulators
++
++from autopilot import logging as autopilot_logging
++from autopilot.introspection import dbus
++
++
++logger = logging.getLogger(__name__)
++
++
++class Dash(emulators.UnityEmulatorBase):
      """An emulator that understands the Dash."""
++    def __init__(self, *args):
++        super(Dash, self).__init__(*args)
++        self.dash_content_list = self.wait_select_single(
++            'QQuickListView', objectName='dashContentList')
++
      def get_home_applications_grid(self):
          get_grid = self.get_scope('home').wait_select_single(
              "GenericFilterGrid",
@@ -43,9 +55,91 @@
          return resp_grid.select_single('Tile', text=text)
      def get_scope(self, scope_name='home'):
--        dash_content = self.wait_select_single(
--            'QQuickListView',
--            objectName='dashContentList'
--        )
--        scope_id = "%s.scope" % scope_name
--        return dash_content.select_single('QQuickLoader', scopeId=scope_id)
++        scope_id = "%s.scope" % scope_name
++        return self.dash_content_list.select_single(
++            'QQuickLoader', scopeId=scope_id)
++
++    @autopilot_logging.log_action(logger.info)
++    def open_scope(self, scope_name):
++        """Open a dash scope.
++
++        :parameter scope_name: The name of the scope.
++        :return: The scope.
++
++        """
++        scope_id = "%s.scope" % scope_name
++        scope_loader = self._get_scope_loader(scope_id)
++        if scope_loader.isCurrent:
++            logger.info('The scope is already open.')
++            return self._get_scope_from_loader(scope_loader)
++        else:
++            return self._open_scope_scrolling(scope_loader)
++
++    def _get_scope_loader(self, scope_id):
++        try:
++            return self.dash_content_list.select_single(
++                'QQuickLoader', scopeId=scope_id)
++        except dbus.StateNotFoundError:
++            raise emulators.UnityEmulatorException(
++                'No scope found with id {0}'.format(scope_id))
++
++    def _get_scope_from_loader(self, loader):
++        if loader.scopeId == 'applications.scope':
++            return loader.select_single(DashApps)
++        else:
++            return loader.select_single(GenericScopeView)
++
++    def _open_scope_scrolling(self, scope_loader):
++        scroll = self._get_scroll_direction(scope_loader)
++
++        while not scope_loader.isCurrent:
++            scroll()
++
++        scope = self._get_scope_from_loader(scope_loader)
++        scope.moving.wait_for(False)
++        scope.isCurrent.wait_for(True)
++        return scope
++
++    def _get_scroll_direction(self, scope_loader):
++        current_scope_loader = self.dash_content_list.select_single(
++            'QQuickLoader', isCurrent=True)
++        if scope_loader.globalRect.x < current_scope_loader.globalRect.x:
++            return self._scroll_to_left_scope
++        elif scope_loader.globalRect.x > current_scope_loader.globalRect.x:
++            return self._scroll_to_right_scope
++        else:
++            raise emulators.UnityEmulatorException('The scope is already open')
++
++    @autopilot_logging.log_action(logger.info)
++    def _scroll_to_left_scope(self):
++        original_index = self.dash_content_list.currentIndex
++        # Scroll on the border of the page header, because some scopes have
++        # contents that can be scrolled horizontally.
++        page_header = self.select_single('PageHeader')
++        border = page_header.select_single('QQuickBorderImage')
++        start_x = border.width / 3
++        stop_x = border.width / 3 * 2
++        start_y = stop_y = border.globalRect.y + border.height / 2
++        self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
++        self.dash_content_list.currentIndex.wait_for(original_index - 1)
++
++    @autopilot_logging.log_action(logger.info)
++    def _scroll_to_right_scope(self):
++        original_index = self.dash_content_list.currentIndex
++        # Scroll on the border of the page header, because some scopes have
++        # contents that can be scrolled horizontally.
++        page_header = self.select_single('PageHeader')
++        border = page_header.select_single('QQuickBorderImage')
++        start_x = border.width / 3 * 2
++        stop_x = border.width / 3
++        start_y = stop_y = border.globalRect.y + border.height / 2
++        self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
++        self.dash_content_list.currentIndex.wait_for(original_index + 1)
++
++
++class GenericScopeView(emulators.UnityEmulatorBase):
++    """Autopilot emulators for generic scopes."""
++
++
++class DashApps(emulators.UnityEmulatorBase):
++    """Autopilot emulators for the applications scope."""
 === modified file 'tests/autopilot/unity8/shell/emulators/greeter.py'
 --- tests/autopilot/unity8/shell/emulators/greeter.py	2013-11-01 13:59:50 +0000
 +++ tests/autopilot/unity8/shell/emulators/greeter.py	2014-01-09 21:28:09 +0000
@@ -1,7 +1,7 @@
  # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+ #
  # Unity Autopilot Test Suite
--# 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
@@ -18,24 +18,21 @@
+ #
  from unity8.shell.emulators import UnityEmulatorBase
--from autopilot.input import Touch
  class Greeter(UnityEmulatorBase):
--
      """An emulator that understands the greeter screen."""
      def swipe(self):
          """Swipe the greeter screen away."""
          self.created.wait_for(True)
--        touch = Touch.create()
          rect = self.globalRect
          start_x = rect[0] + rect[2] - 3
          start_y = int(rect[1] + rect[3] / 2)
          stop_x = int(rect[0] + rect[2] * 0.2)
          stop_y = start_y
--        touch.drag(start_x, start_y, stop_x, stop_y)
++        self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
          self.created.wait_for(False)
 === modified file 'tests/autopilot/unity8/shell/tests/__init__.py'
 --- tests/autopilot/unity8/shell/tests/__init__.py	2013-11-14 03:36:01 +0000
 +++ tests/autopilot/unity8/shell/tests/__init__.py	2014-01-09 21:28:09 +0000
@@ -147,6 +147,7 @@
          if model() != "Desktop":
              from autopilot.input import _uinput
              _uinput._touch_device = _uinput.create_touch_device()
++            self.addCleanup(_uinput._touch_device.close)
          ####
          self.touch = Touch.create()
 === added file 'tests/autopilot/unity8/shell/tests/test_emulators.py'
 --- tests/autopilot/unity8/shell/tests/test_emulators.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/unity8/shell/tests/test_emulators.py	2014-01-09 21:28:09 +0000
@@ -0,0 +1,119 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++#
++# Unity Autopilot Test Suite
++# Copyright (C) 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
++# the Free Software Foundation, either version 3 of the License, or
++# (at your option) any later version.
++#
++# 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 General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++#
++
++import mock
++
++from unity8.shell import emulators, tests
++from unity8.shell.emulators import dash as dash_emulators
++
++
++class DashEmulatorTestCase(tests.UnityTestCase):
++
++    scenarios = tests._get_device_emulation_scenarios()
++
++    def setUp(self):
++        super(DashEmulatorTestCase, self).setUp()
++        self.launch_unity()
++        self.main_window.get_greeter().swipe()
++        self.dash = self.main_window.get_dash()
++
++    def test_open_unexisting_scope(self):
++        scope_name = 'unexisting'
++        with mock.patch.object(self.dash, 'pointing_device') as mock_pointer:
++            exception = self.assertRaises(
++                emulators.UnityEmulatorException,
++                self.dash.open_scope, scope_name)
++
++        self.assertEqual(
++            'No scope found with id unexisting.scope', str(exception))
++        self.assertFalse(mock_pointer.called)
++
++    def test_open_already_opened_scope(self):
++        scope_id = self._get_current_scope_id()
++        with mock.patch.object(self.dash, 'pointing_device') as mock_pointer:
++            scope = self.dash.open_scope(self._get_scope_name_from_id(
++                scope_id))
++
++        self.assertFalse(mock_pointer.called)
++        self._assert_scope_is_opened(scope, scope_id)
++
++    def _assert_scope_is_opened(self, scope, scope_id):
++        self.assertTrue(scope.isCurrent)
++        scope_loader = scope.get_parent()
++        self.assertEqual(scope_loader.scopeId, scope_id)
++
++    def _get_current_scope_id(self):
++        scope = self.dash.dash_content_list.select_single(
++            'QQuickLoader', isCurrent=True)
++        return scope.scopeId
++
++    def test_open_scope_to_the_right(self):
++        leftmost_scope = self._get_scope_name_from_id(
++            self._get_leftmost_scope_id())
++        self.dash.open_scope(leftmost_scope)
++
++        scope_id = self._get_rightmost_scope_id()
++        scope = self.dash.open_scope(self._get_scope_name_from_id(scope_id))
++        self._assert_scope_is_opened(scope, scope_id)
++
++    def _get_leftmost_scope_id(self):
++        scope_loaders = self._get_scope_loaders()
++        leftmost_scope_loader = scope_loaders[0]
++        for loader in scope_loaders[1:]:
++            if loader.globalRect.x < leftmost_scope_loader.globalRect.x:
++                leftmost_scope_loader = loader
++        return leftmost_scope_loader.scopeId
++
++    def _get_scope_loaders(self):
++        item = self.dash.dash_content_list.get_children_by_type(
++            'QQuickItem')[0]
++        return item.get_children_by_type('QQuickLoader')
++
++    def _get_scope_name_from_id(self, scope_id):
++        if scope_id.endswith('.scope'):
++            return scope_id[:-6]
++
++    def _get_rightmost_scope_id(self):
++        scope_loaders = self._get_scope_loaders()
++        rightmost_scope_loader = scope_loaders[0]
++        for loader in scope_loaders[1:]:
++            if loader.globalRect.x > rightmost_scope_loader.globalRect.x:
++                rightmost_scope_loader = loader
++        return rightmost_scope_loader.scopeId
++
++    def test_open_scope_to_the_left(self):
++        rightmost_scope = self._get_scope_name_from_id(
++            self._get_rightmost_scope_id())
++        self.dash.open_scope(rightmost_scope)
++
++        scope_id = self._get_leftmost_scope_id()
++        scope = self.dash.open_scope(self._get_scope_name_from_id(scope_id))
++        self._assert_scope_is_opened(scope, scope_id)
++
++    def test_open_generic_scope(self):
++        scope_id = 'home.scope'
++        scope = self.dash.open_scope(self._get_scope_name_from_id(scope_id))
++        self._assert_scope_is_opened(scope, scope_id)
++        self.assertIsInstance(scope, dash_emulators.GenericScopeView)
++
++    def test_open_applications_scope(self):
++        scope_id = 'applications.scope'
++        scope = self.dash.open_scope(self._get_scope_name_from_id(scope_id))
++        self._assert_scope_is_opened(scope, scope_id)
++        self.assertIsInstance(scope, dash_emulators.DashApps)