Merge into landing_28-05 : fix1324556-get_top_container : Code : Ubuntu UI Toolkit

Status:

Superseded

Proposed branch:

lp:~elopio/ubuntu-ui-toolkit/fix1324556-get_top_container

Merge into:

lp:~bzoltan/ubuntu-ui-toolkit/landing_28-05

Diff against target:

354 lines (+210/-27)

9 files modified

modules/Ubuntu/Components/PageStack.qml (+1/-0)
tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py (+16/-0)
tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py (+0/-17)
tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py (+2/-9)
tests/autopilot/ubuntuuitoolkit/fixture_setup.py (+45/-0)
tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/CustomMainView.qml (+23/-0)
tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml (+24/-0)
tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py (+27/-0)
tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py (+72/-1)

To merge this branch:

bzr merge lp:~elopio/ubuntu-ui-toolkit/fix1324556-get_top_container

Undecided

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration	2014-05-30	Pending
Ubuntu SDK team		2014-05-30	Pending
Review via email: mp+221491@code.launchpad.net

This proposal supersedes a proposal from 2014-05-29.

This proposal has been superseded by a proposal from 2014-05-30.

Commit message

On the autopilot Header helper, do not assume that the top container will be a MainView.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-05-29: Posted in a previous version of this proposal

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-05-29: Posted in a previous version of this proposal

#

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-05-30: Posted in a previous version of this proposal

#

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

review: Needs Fixing (continuous-integration)

Ubuntu UI Toolkit

Merge lp:~elopio/ubuntu-ui-toolkit/fix1324556-get_top_container into lp:~bzoltan/ubuntu-ui-toolkit/landing_28-05

Commit message

Description of the change

Unmerged revisions

Preview Diff

Subscribers

 === modified file 'modules/Ubuntu/Components/PageStack.qml'
 --- modules/Ubuntu/Components/PageStack.qml	2014-05-13 09:09:35 +0000
 +++ modules/Ubuntu/Components/PageStack.qml	2014-05-30 07:40:10 +0000
@@ -192,6 +192,7 @@
       */
      default property alias data: inactiveNode.data
      PageTreeNode {
++        anchors.fill: parent
          id: inactiveNode
          active: false
+     }
 === modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py'
 --- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2014-04-29 23:03:58 +0000
 +++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_common.py	2014-05-30 07:40:10 +0000
@@ -111,3 +111,19 @@
          raise ToolkitException(
              "The element is not contained in a Flickable so it can't be "
              "swiped into view.")
++
++    def _get_top_container(self):
++        """Return the top-most container with a globalRect."""
++        root = self.get_root_instance()
++        parent = self.get_parent()
++        top_container = None
++        while parent.id != root.id:
++            if hasattr(parent, 'globalRect'):
++                top_container = parent
++
++            parent = parent.get_parent()
++
++        if top_container is None:
++            raise ToolkitException('Could not find the top-most container.')
++        else:
++            return top_container
 === modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py'
 --- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-05-20 07:31:55 +0000
 +++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_flickable.py	2014-05-30 07:40:10 +0000
@@ -51,23 +51,6 @@
          containers = [self._get_top_container(), self]
          return containers
--    def _get_top_container(self):
--        """Return the top-most container with a globalRect."""
--        root = self.get_root_instance()
--        parent = self.get_parent()
--        top_container = None
--        while parent.id != root.id:
--            if hasattr(parent, 'globalRect'):
--                top_container = parent
--
--            parent = parent.get_parent()
--
--        if top_container is None:
--            raise _common.ToolkitException(
--                "Couldn't find the top-most container.")
--        else:
--            return top_container
--
      def _is_child_visible(self, child, containers):
          """Check if the center of the child is visible.
 === modified file 'tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py'
 --- tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-05-13 12:43:31 +0000
 +++ tests/autopilot/ubuntuuitoolkit/_custom_proxy_objects/_header.py	2014-05-30 07:40:10 +0000
@@ -21,7 +21,6 @@
  from ubuntuuitoolkit._custom_proxy_objects import (
      _common,
--    _mainview,
      _tabbar
+ )
@@ -35,13 +34,6 @@
  class Header(_common.UbuntuUIToolkitCustomProxyObjectBase):
      """Header Autopilot emulator."""
--    def __init__(self, *args):
--        super(Header, self).__init__(*args)
--        # XXX we need a better way to keep reference to the main view.
--        # --elopio - 2014-02-26
--        self.main_view = self.get_root_instance().select_single(
--            _mainview.MainView)
--
      def _show_if_not_visible(self):
          if not self._is_visible():
              self._show()
@@ -53,8 +45,9 @@
          # FIXME This will fail if the header is not linked to a flickable that
          # fills the main view. The header has a flickable property but it
          # can't be read by autopilot. See bug http://pad.lv/1318829
++        top_container = self._get_top_container()
          start_x = stop_x = (self.globalRect.x + self.globalRect.width) // 2
--        start_y = self.main_view.globalRect.y + 5
++        start_y = top_container.globalRect.y + 5
          stop_y = start_y + self.globalRect.height
          self.pointing_device.drag(start_x, start_y, stop_x, stop_y)
          self.y.wait_for(0)
 === modified file 'tests/autopilot/ubuntuuitoolkit/fixture_setup.py'
 --- tests/autopilot/ubuntuuitoolkit/fixture_setup.py	2014-04-23 08:50:20 +0000
 +++ tests/autopilot/ubuntuuitoolkit/fixture_setup.py	2014-05-30 07:40:10 +0000
@@ -16,6 +16,7 @@
  import copy
  import os
++import shutil
  import tempfile
  import fixtures
@@ -118,3 +119,47 @@
                  original_value)
          else:
              self.addCleanup(environment.unset_initctl_env_var, variable)
++
++
++class FakeHome(fixtures.Fixture):
++
++    # We copy the Xauthority file to allow executions using XVFB. If it is not
++    # on the user's HOME directory, nothing will happen.
++    should_copy_xauthority_file = True
++
++    def __init__(self, directory=None):
++        super(FakeHome, self).__init__()
++        self.directory = directory
++
++    def setUp(self):
++        super(FakeHome, self).setUp()
++        self.directory = self._make_directory_if_not_specified()
++        if self.should_copy_xauthority_file:
++            self._copy_xauthority_file(self.directory)
++        # We patch both environment variables so it works on the desktop and on
++        # the phone.
++        self.useFixture(
++            InitctlEnvironmentVariable(HOME=self.directory))
++        self.useFixture(
++            fixtures.EnvironmentVariable('HOME', newvalue=self.directory))
++
++    def _make_directory_if_not_specified(self):
++        if self.directory is None:
++            parent_directory = os.path.join(
++                os.environ.get('HOME'), 'autopilot', 'fakeenv')
++            if not os.path.exists(parent_directory):
++                os.makedirs(parent_directory)
++            temp_dir_fixture = fixtures.TempDir(parent_directory)
++            self.useFixture(temp_dir_fixture)
++            return temp_dir_fixture.path
++        else:
++            return self.directory
++
++    def _copy_xauthority_file(self, directory):
++        """Copy the .Xauthority file if it exists in the user's home."""
++        xauthority_file_path = os.path.join(
++            os.environ.get('HOME'), '.Xauthority')
++        if os.path.isfile(xauthority_file_path):
++            shutil.copyfile(
++                xauthority_file_path,
++                os.path.join(directory, '.Xauthority'))
 === added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/CustomMainView.qml'
 --- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/CustomMainView.qml	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/CustomMainView.qml	2014-05-30 07:40:10 +0000
@@ -0,0 +1,23 @@
++/*
++ * 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 0.1
++
++MainView {
++    objectName: "overview"
++    property string test
++}
 === added file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml'
 --- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.HeaderInCustomMainViewTestCase.qml	2014-05-30 07:40:10 +0000
@@ -0,0 +1,24 @@
++/*
++ * 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
++
++CustomMainView {
++
++    objectName: 'mainView'
++
++}
 === modified file 'tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py'
 --- tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-05-20 08:56:28 +0000
 +++ tests/autopilot/ubuntuuitoolkit/tests/custom_proxy_objects/test_header.py	2014-05-30 07:40:10 +0000
@@ -14,6 +14,8 @@
  # 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
++
  import ubuntuuitoolkit
  from ubuntuuitoolkit import tests
@@ -157,3 +159,28 @@
          # only three actions are visible
          self.assertEqual(overflow_button.visible, False)
++
++
++class CustomMainView(ubuntuuitoolkit.MainView):
++    """Autopilot helper for a custom main view."""
++
++
++class HeaderInCustomMainViewTestCase(tests.QMLFileAppTestCase):
++
++    path = os.path.abspath(__file__)
++    dir_path = os.path.dirname(path)
++    test_qml_file_path = os.path.join(
++        dir_path, 'test_header.HeaderInCustomMainViewTestCase.qml')
++
++    @property
++    def main_view(self):
++        return self.app.select_single(CustomMainView)
++
++    def test_get_header_from_custom_main_view(self):
++        """Test that we can get the header from a custom main view.
++
++        This prevents a regression of http://pad.lv/1324556.
++
++        """
++        header = self.main_view.get_header()
++        self.assertIsInstance(header, ubuntuuitoolkit.Header)
 === modified file 'tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py'
 --- tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	2014-03-10 16:51:01 +0000
 +++ tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	2014-05-30 07:40:10 +0000
@@ -15,6 +15,7 @@
  # along with this program. If not, see <http://www.gnu.org/licenses/>.
  import os
++import tempfile
  try:
      # Python 3.
@@ -24,7 +25,7 @@
      import mock
  import testtools
  from autopilot import testcase as autopilot_testcase
--from testtools.matchers import Contains, Not, FileExists
++from testtools.matchers import Contains, FileExists, Not
  from ubuntuuitoolkit import base, environment, fixture_setup
@@ -233,3 +234,73 @@
          self.assertEqual(
              'original test value',
              environment.get_initctl_env_var('testenvvarforfixture'))
++
++
++class FakeHomeTestCase(testtools.TestCase):
++
++    def test_fake_home_fixture_patches_initctl_env_var(self):
++        original_home = environment.get_initctl_env_var('HOME')
++        fake_home = original_home + 'fake'
++        result = testtools.TestResult()
++
++        def inner_test():
++            class TestWithFakeHome(testtools.TestCase):
++                def test_it(self):
++                    fake_home_fixture = fixture_setup.FakeHome(fake_home)
++                    fake_home_fixture.should_copy_xauthority_file = False
++                    self.useFixture(fake_home_fixture)
++                    self.assertEqual(
++                        fake_home, environment.get_initctl_env_var('HOME'))
++            return TestWithFakeHome('test_it')
++
++        inner_test().run(result)
++
++        self.assertTrue(
++            result.wasSuccessful(),
++            'Failed to fake the home: {}'.format(result.errors))
++        self.assertEqual(
++            original_home,
++            environment.get_initctl_env_var('HOME'))
++
++    def test_fake_home_fixture_patches_env_var(self):
++        original_home = os.environ.get('HOME')
++        fake_home = tempfile.gettempdir()
++        result = testtools.TestResult()
++
++        def inner_test():
++            class TestWithFakeHome(testtools.TestCase):
++                def test_it(self):
++                    fake_home_fixture = fixture_setup.FakeHome(fake_home)
++                    fake_home_fixture.should_copy_xauthority_file = False
++                    self.useFixture(fake_home_fixture)
++                    self.assertEqual(
++                        fake_home, os.environ.get('HOME'))
++            return TestWithFakeHome('test_it')
++
++        inner_test().run(result)
++
++        self.assertTrue(
++            result.wasSuccessful(),
++            'Failed to fake the home: {}'.format(result.failures))
++        self.assertEqual(original_home, os.environ.get('HOME'))
++
++    def test_fake_home_fixture_must_create_default_directory(self):
++        original_home = os.environ.get('HOME')
++        self.useFixture(fixture_setup.FakeHome())
++
++        home_parent_directory, _ = os.path.split(os.environ.get('HOME'))
++        self.assertEqual(
++            home_parent_directory,
++            os.path.join(original_home, 'autopilot', 'fakeenv'))
++
++    def test_fake_home_fixture_must_copy_xauthority(self):
++        # Fake the home first so we don't write the xauthority on the real
++        # home.
++        self.useFixture(fixture_setup.FakeHome())
++
++        open(os.path.join(os.environ.get('HOME'), '.Xauthority')).close()
++
++        self.useFixture(fixture_setup.FakeHome())
++        self.assertTrue(
++            os.path.exists(
++                os.path.join(os.environ.get('HOME'), '.Xauthority')))