Merge lp:~veebers/unity8/adding_unlock_emulator into lp:unity8

[Christopher Lee]

Adds an easy to consume function that attempts to unlock the unity greeter.

Adds an easy to consume function that attempts to unlock the unity greeter.

[Thomi Richards (thomir-deactivatedaccount)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:471
http://jenkins.qa.ubuntu.com/job/unity8-ci/1418/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/5039
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/2976
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-saucy/2285
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-amd64-ci/441
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-armhf-ci/1418
        deb: http://jenkins.qa.ubuntu.com/job/unity8-saucy-armhf-ci/1418/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-i386-ci/1417
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-saucy/1209
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-amd64/914
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-amd64/914/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/2978
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/2978/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2484
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2528

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity8-ci/1418/rebuild

review: Needs Fixing (continuous-integration)

[Michał Sawicz (saviq)]

Hey, unity8 tests should be using this, to make sure we know ASAP that things break and fix it for ourselves. WDYT?

review: Needs Information

[Christopher Lee (veebers)]

Sounds like a good idea.

I want get this merged now so that in the interim it can be consumed by the CI/testing scripts and I'll start work on updating the unity tests etc.

review: Approve

[Michał Sawicz (saviq)]

Looks good - and works.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:471
http://jenkins.qa.ubuntu.com/job/unity8-ci/1465/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/5123
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-touch/3130/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-saucy/2337
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-amd64-ci/488
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-armhf-ci/1469
        deb: http://jenkins.qa.ubuntu.com/job/unity8-saucy-armhf-ci/1469/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-saucy-i386-ci/1464
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-saucy/1287
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-amd64/998
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-amd64/998/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3132
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy-armhf/3132/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2611/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2662/console
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/253
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/252

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity8-ci/1465/rebuild

review: Needs Fixing (continuous-integration)

[Christopher Lee (veebers)]

The CI is currently failing due to this bug: https://bugs.launchpad.net/ubuntu/+source/lxc-android-config/+bug/1243432

Once this bug is fixed the CI should pass with flying colours and this should be merged.

[Christopher Lee (veebers)]

Get CI running.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:471
http://jenkins.qa.ubuntu.com/job/unity8-ci/1513/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/145
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/139/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-trusty/40
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-amd64-ci/37
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/37
        deb: http://jenkins.qa.ubuntu.com/job/unity8-trusty-armhf-ci/37/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-trusty-i386-ci/37
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/136
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/145
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/145/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/139
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/139/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-maguro/2766/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/2817/console
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/571
    SUCCESS: http://10.97.0.26:8080/job/touch-flash-device/572

Click here to trigger a rebuild:
http://10.97.0.26:8080/job/unity8-ci/1513/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== added file 'tests/autopilot/unity8/process_helpers.py'
--- tests/autopilot/unity8/process_helpers.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/unity8/process_helpers.py	2013-10-16 04:09:14 +0000
@@ -0,0 +1,116 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Unity Autopilot Utilities
+# Copyright (C) 2013 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/>.
+#
+
+from autopilot.introspection import (
+    get_proxy_object_for_existing_process,
+    ProcessSearchError,
+)
+import subprocess
+from unity8.shell.emulators import UnityEmulatorBase
+from unity8.shell.emulators.main_window import MainWindow
+
+
+class CannotAccessUnity(Exception):
+    pass
+
+
+def unlock_unity():
+    """Helper function that attempts to unlock the unity greeter.
+
+    :raises RuntimeError: if the greeter attempts and fails to be unlocked.
+
+    :raises RuntimeWarning: when the greeter cannot be found because it is
+      already unlocked.
+    :raises CannotAccessUnity: if unity is not introspectable or cannot be
+      found on dbus.
+    :raises CannotAccessUnity: if unity's upstart status is not "start" or the
+      upstart job cannot be found at all.
+
+    """
+    pid = _get_unity_pid()
+    try:
+        unity = get_proxy_object_for_existing_process(
+            pid=pid,
+            emulator_base=UnityEmulatorBase,
+        )
+        main_window = MainWindow(unity)
+
+        greeter = main_window.get_greeter()
+        if greeter is None:
+            raise RuntimeWarning("Greeter appears to be already unlocked.")
+        greeter.swipe()
+    except ProcessSearchError as e:
+        raise CannotAccessUnity(
+            "Cannot introspect unity, make sure that it has been started "
+            "with testability. Perhaps use the function "
+            "'restart_unity_with_testability' this module provides."
+            "(%s)"
+            % str(e)
+        )
+
+
+def restart_unity_with_testability():
+    """Restarts (or just starts) unity8 with the testability driver loaded
+
+    :raises subprocess.CalledProcessError: if unable to stop or start the
+      unity8 upstart job.
+
+    """
+    status = _get_unity_status()
+    if "start/" in status:
+        try:
+            print("Stopping unity.")
+            subprocess.check_call([
+                'initctl',
+                'stop',
+                'unity8',
+            ])
+        except subprocess.CalledProcessError as e:
+            e.args += ("Failed to stop running instance of unity8", )
+            raise
+
+    try:
+        print("Starting unity with testability.")
+        subprocess.check_call([
+            'initctl',
+            'start',
+            'unity8',
+            'QT_LOAD_TESTABILITY=1',
+        ])
+    except subprocess.CalledProcessError as e:
+        e.args += ("Failed to start unity8 with testability ", )
+        raise
+
+
+def _get_unity_status():
+    try:
+        return subprocess.check_output([
+            'initctl',
+            'status',
+            'unity8'
+        ])
+    except subprocess.CalledProcessError as e:
+        raise CannotAccessUnity("Unable to get unity's status: %s" % str(e))
+
+
+def _get_unity_pid():
+    status = _get_unity_status()
+    if not "start/" in status:
+        raise CannotAccessUnity("Unity is not in the running state.")
+    return int(status.split()[-1])