Merge lp:~elopio/ubuntu-ui-toolkit/fake_app_fixture into lp:ubuntu-ui-toolkit

[Leo Arias]

Refactor the fake application used by the autopilot emulator tests to make a fixture that can be reused by other projects.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:936
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1711/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3153
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2838
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/659
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/659
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/659/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2771
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3155
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3155/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2840
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2840/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5248
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3863

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

review: Approve (continuous-integration)

[Richard Huddie (rhuddie)]

I ran the tests on desktop and touch OK. Clean for pep8 and pyflakes. New code looks good to me.

review: Approve

[Cris Dywan (kalikiana)]

Would it make sense to verify the fields in the .desktop file? The shell isn't typically very talkative in case something's wrong.

[Javier Collado (javier.collado)]

I've looked into the code and run it in a desktop and works fine.

My only comment, is that I don't like the "assert_desktop_file_contents"
method. Instead of generating a long regular expression for the desktop file
and check that there's a match for every key value pair in the expected
contents dictionary, I'd parse the desktop file as a dictionary and run an
assertion on both the dictionaries:

        contents_dict = dict(
            [line.split('=')
             for line in desktop_file_contents.splitlines()[1:]])

        self.assertDictEqual(expected_contents_dict, contents_dict)

[lp:~elopio/ubuntu-ui-toolkit/fake_app_fixture]

937. By Leo Arias on 2014-02-12

Cleaned the assert_desktop_file_contents as suggested by javier.

[Leo Arias (elopio)]

> My only comment, is that I don't like the "assert_desktop_file_contents"
> method. Instead of generating a long regular expression for the desktop file
> and check that there's a match for every key value pair in the expected
> contents dictionary, I'd parse the desktop file as a dictionary and run an
> assertion on both the dictionaries:

Right you are! It looks much better now.

[Leo Arias (elopio)]

> Would it make sense to verify the fields in the .desktop file? The shell isn't
> typically very talkative in case something's wrong.

kalikiana, I had reported a bug about that. I see now that it's a duplicate of:
https://bugs.launchpad.net/ubuntu/+source/qtubuntu/+bug/1204595
And it seems to have some work. I'll ask tomorrow.

It wouldn't hurt to add an extra check here. What are the fields that we should require?

If that's ok to you, I'll do it in a separate branch.

[lp:~elopio/ubuntu-ui-toolkit/fake_app_fixture]

938. By Leo Arias on 2014-02-12

Removed extra line.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:937
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1718/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3173
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2857
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/666
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/666
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/666/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2790
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3175
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3175/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2859
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2859/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5267
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3885

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:938
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1719/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3175
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2859
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/667
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/667
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/667/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2792
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3177
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3177/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2861
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2861/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5269
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3887

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

review: Approve (continuous-integration)

[Leo Arias (elopio)]

<greyback> elopio: required entries are Name, Comment, Icon, Exec, Path, StageHint, others are optional

[Cris Dywan (kalikiana)]

> It wouldn't hurt to add an extra check here. What are the fields that we
> should require?
>
> If that's ok to you, I'll do it in a separate branch.

Ack.

Nice stuff.

review: Approve

[Leo Arias (elopio)]

Reported bug https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1279901 to do the desktop fields check.

=== modified file 'debian/control'
--- debian/control	2014-01-30 13:37:10 +0000
+++ debian/control	2014-02-12 18:41:59 +0000
@@ -40,8 +40,8 @@
                locales,
 Standards-Version: 3.9.4
 Homepage: https://launchpad.net/ubuntu-ui-toolkit
-# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging 
-# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code 
+# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging
+# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code
 # again.
 Vcs-Bzr: https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/trunk
 
@@ -131,6 +131,7 @@
          libqt5test5,
          libqt5widgets5,
          python-autopilot (>= 1.4),
+         python-fixtures,
          python-mock,
          ubuntu-ui-toolkit-examples (>= ${source:Version}),
 Description: Test package for Ubuntu UI Toolkit

=== added file 'tests/autopilot/ubuntuuitoolkit/fixture_setup.py'
--- tests/autopilot/ubuntuuitoolkit/fixture_setup.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/fixture_setup.py	2014-02-12 18:41:59 +0000
@@ -0,0 +1,97 @@
+# -*- 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 copy
+import os
+import tempfile
+
+import fixtures
+
+from ubuntuuitoolkit import base
+
+
+DEFAULT_QML_FILE_CONTENTS = ("""
+import QtQuick 2.0
+import Ubuntu.Components 0.1
+
+MainView {
+    width: units.gu(48)
+    height: units.gu(60)
+
+    Label {
+        objectName: 'testLabel'
+        text: 'Test application.'
+    }
+}
+""")
+DEFAULT_DESKTOP_FILE_DICT = {
+    'Type': 'Application',
+    'Name': 'test',
+    'Exec': '{qmlscene} {qml_file_path}',
+    'Icon': 'Not important'
+}
+
+
+class FakeApplication(fixtures.Fixture):
+
+    def __init__(
+            self, qml_file_contents=DEFAULT_QML_FILE_CONTENTS,
+            desktop_file_dict=None):
+        super(FakeApplication, self).__init__()
+        self._qml_file_contents = qml_file_contents
+        if desktop_file_dict is None:
+            self._desktop_file_dict = copy.deepcopy(DEFAULT_DESKTOP_FILE_DICT)
+        else:
+            self._desktop_file_dict = copy.deepcopy(desktop_file_dict)
+
+    def setUp(self):
+        super(FakeApplication, self).setUp()
+        self.qml_file_path, self.desktop_file_path = (
+            self._create_test_application())
+
+    def _create_test_application(self):
+        qml_file_path = self._write_test_qml_file()
+        self.addCleanup(os.remove, qml_file_path)
+        desktop_file_path = self._write_test_desktop_file(qml_file_path)
+        self.addCleanup(os.remove, desktop_file_path)
+        return qml_file_path, desktop_file_path
+
+    def _write_test_qml_file(self):
+        qml_file = tempfile.NamedTemporaryFile(
+            mode='w+t', suffix='.qml', delete=False)
+        qml_file.write(self._qml_file_contents)
+        qml_file.close()
+        return qml_file.name
+
+    def _write_test_desktop_file(self, qml_file_path):
+        desktop_file_dir = self._get_local_desktop_file_directory()
+        if not os.path.exists(desktop_file_dir):
+            os.makedirs(desktop_file_dir)
+        desktop_file = tempfile.NamedTemporaryFile(
+            mode='w+t', suffix='.desktop', dir=desktop_file_dir, delete=False)
+        self._desktop_file_dict['Exec'] = (
+            self._desktop_file_dict['Exec'].format(
+                qmlscene=base.get_qmlscene_launch_command(),
+                qml_file_path=qml_file_path))
+        desktop_file.write('[Desktop Entry]\n')
+        for key, value in self._desktop_file_dict.iteritems():
+            desktop_file.write('{key}={value}\n'.format(key=key, value=value))
+        desktop_file.close()
+        return desktop_file.name
+
+    def _get_local_desktop_file_directory(self):
+        return os.path.join(
+            os.environ.get('HOME'), '.local', 'share', 'applications')

=== modified file 'tests/autopilot/ubuntuuitoolkit/tests/__init__.py'
--- tests/autopilot/ubuntuuitoolkit/tests/__init__.py	2014-01-09 15:10:25 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/__init__.py	2014-02-12 18:41:59 +0000
@@ -23,7 +23,7 @@
 from autopilot.matchers import Eventually
 from testtools.matchers import Is, Not, Equals
 
-from ubuntuuitoolkit import base, emulators
+from ubuntuuitoolkit import base, emulators, fixture_setup
 
 
 _DESKTOP_FILE_CONTENTS = ("""[Desktop Entry]
@@ -79,27 +79,22 @@
         self.launch_application()
 
     def launch_application(self):
-        qml_file_path = self._write_test_qml_file()
-        self.addCleanup(os.remove, qml_file_path)
-        desktop_file_path = _write_test_desktop_file()
-        self.addCleanup(os.remove, desktop_file_path)
+        fake_application = fixture_setup.FakeApplication(
+            qml_file_contents=self.test_qml)
+        self.useFixture(fake_application)
+
         self.app = self.launch_test_application(
             base.get_qmlscene_launch_command(),
             '-I' + _get_module_include_path(),
-            qml_file_path,
-            '--desktop_file_hint={0}'.format(desktop_file_path),
+            fake_application.qml_file_path,
+            '--desktop_file_hint={0}'.format(
+                fake_application.desktop_file_path),
             emulator_base=emulators.UbuntuUIToolkitEmulatorBase,
             app_type='qt')
 
         self.assertThat(
             self.main_view.visible, Eventually(Equals(True)))
 
-    def _write_test_qml_file(self):
-        qml_file = tempfile.NamedTemporaryFile(suffix='.qml', delete=False)
-        qml_file.write(self.test_qml.encode('utf-8'))
-        qml_file.close()
-        return qml_file.name
-
     @property
     def main_view(self):
         return self.app.select_single(emulators.MainView)

=== added file 'tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py'
--- tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/ubuntuuitoolkit/tests/test_fixture_setup.py	2014-02-12 18:41:59 +0000
@@ -0,0 +1,163 @@
+# -*- 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
+
+import mock
+import testtools
+from autopilot import testcase as autopilot_testcase
+from testtools.matchers import Contains, Not, FileExists
+
+from ubuntuuitoolkit import base, fixture_setup
+
+
+class FakeApplicationTestCase(testtools.TestCase):
+
+    def assert_desktop_file_contents(
+            self, desktop_file_contents, expected_contents_dict):
+        desktop_file_lines = desktop_file_contents.splitlines()
+        self.assertEqual('[Desktop Entry]', desktop_file_lines[0])
+
+        contents_dict = dict(
+            [line.split('=') for line in desktop_file_lines[1:]])
+        self.assertDictEqual(expected_contents_dict, contents_dict)
+
+    def test_qml_file_must_be_created_with_specified_contents(self):
+        fake_application = fixture_setup.FakeApplication(
+            qml_file_contents='Test')
+        self.useFixture(fake_application)
+
+        with open(fake_application.qml_file_path, 'r+t') as qml_file:
+            qml_file_contents = qml_file.read()
+
+        self.assertEqual('Test', qml_file_contents)
+
+    def test_qml_file_with_default_contents(self):
+        fake_application = fixture_setup.FakeApplication()
+        self.useFixture(fake_application)
+
+        with open(fake_application.qml_file_path, 'r+t') as qml_file:
+            qml_file_contents = qml_file.read()
+
+        self.assertEqual(
+            fixture_setup.DEFAULT_QML_FILE_CONTENTS, qml_file_contents)
+
+    def test_desktop_file_must_be_created_with_specified_values(self):
+        test_desktop_file_dict = {
+            'test key 1': 'test value 1',
+            'test key 2': 'test value 2',
+            'Exec': 'test',
+        }
+        fake_application = fixture_setup.FakeApplication(
+            desktop_file_dict=test_desktop_file_dict)
+        self.useFixture(fake_application)
+
+        with open(fake_application.desktop_file_path, 'r+t') as desktop_file:
+            desktop_file_contents = desktop_file.read()
+
+        self.assert_desktop_file_contents(
+            desktop_file_contents, test_desktop_file_dict)
+
+    def test_desktop_file_with_qmlscene_launch_command(self):
+        test_desktop_file_dict = {'Exec': '{qmlscene} application'}
+
+        qmlscene = 'ubuntuuitoolkit.base.get_qmlscene_launch_command'
+        with mock.patch(qmlscene) as mock_qmlscene:
+            mock_qmlscene.return_value = 'test_qmlscene_command'
+            fake_application = fixture_setup.FakeApplication(
+                desktop_file_dict=test_desktop_file_dict)
+            self.useFixture(fake_application)
+
+        with open(fake_application.desktop_file_path, 'r+t') as desktop_file:
+            desktop_file_contents = desktop_file.read()
+
+        self.assertThat(
+            desktop_file_contents,
+            Contains('Exec=test_qmlscene_command application'))
+
+    def test_desktop_file_with_qml_file_path(self):
+        test_desktop_file_dict = {'Exec': 'qmlscene {qml_file_path}'}
+
+        fake_application = fixture_setup.FakeApplication(
+            desktop_file_dict=test_desktop_file_dict)
+        self.useFixture(fake_application)
+
+        with open(fake_application.desktop_file_path, 'r+t') as desktop_file:
+            desktop_file_contents = desktop_file.read()
+
+        self.assertThat(
+            desktop_file_contents,
+            Contains(
+                'Exec=qmlscene {}'.format(fake_application.qml_file_path)))
+
+    def test_desktop_file_with_default_contents(self):
+        qmlscene = 'ubuntuuitoolkit.base.get_qmlscene_launch_command'
+        with mock.patch(qmlscene) as mock_qmlscene:
+            mock_qmlscene.return_value = 'qmlscene'
+            fake_application = fixture_setup.FakeApplication()
+            self.useFixture(fake_application)
+
+        with open(fake_application.desktop_file_path, 'r+t') as desktop_file:
+            desktop_file_contents = desktop_file.read()
+
+        expected_desktop_file_dict = {
+            'Type': 'Application',
+            'Name': 'test',
+            'Icon': 'Not important',
+            'Exec': 'qmlscene {}'.format(fake_application.qml_file_path),
+        }
+        self.assert_desktop_file_contents(
+            desktop_file_contents, expected_desktop_file_dict)
+
+    def test_desktop_file_must_be_created_in_local_directory(self):
+        fake_application = fixture_setup.FakeApplication()
+        self.useFixture(fake_application)
+
+        expected_desktop_file_directory = os.path.join(
+            os.environ.get('HOME'), '.local', 'share', 'applications')
+        self.assertEqual(
+            expected_desktop_file_directory,
+            os.path.dirname(fake_application.desktop_file_path))
+
+    def test_fake_application_files_must_be_removed_after_test(self):
+        fake_application = fixture_setup.FakeApplication()
+
+        def inner_test():
+            class TestWithFakeApplication(testtools.TestCase):
+                def test_it(self):
+                    self.useFixture(fake_application)
+            return TestWithFakeApplication('test_it')
+
+        inner_test().run()
+        self.assertThat(fake_application.qml_file_path, Not(FileExists()))
+        self.assertThat(fake_application.desktop_file_path, Not(FileExists()))
+
+
+class LaunchFakeApplicationTestCase(autopilot_testcase.AutopilotTestCase):
+
+    def test_launch_fake_application_with_qmlscene(self):
+        fake_application = fixture_setup.FakeApplication()
+        self.useFixture(fake_application)
+
+        self.application = self.launch_test_application(
+            base.get_qmlscene_launch_command(),
+            fake_application.qml_file_path,
+            '--desktop_file_hint={0}'.format(
+                fake_application.desktop_file_path),
+            app_type='qt')
+
+        # We can select a component from the application.
+        self.application.select_single('Label', objectName='testLabel')