Merge lp:~mterry/phablet-tools/unlock into lp:phablet-tools

[Michael Terry]

Unlock as part of a test run ourselves (instead of relying on user or ubuntu-test-case scripts to do it)

Unlock as part of a test run ourselves (instead of relying on user or ubuntu-test-case scripts to do it).

This also means we grab the powerd lock ourselves (since we trigger a reboot).

I added a new option -l to turn off this reboot&unlock. I chose l because it felt like "lock" (vs unlock) but am open to a better option. Especially since it doesn't mean that the script locks the phone. But really, such one-letter options can get pretty arbitrary so I didn't stress.

This branch goes hand-in-hand with https://code.launchpad.net/~mterry/ubuntu-test-cases/touch-unlock-device/+merge/215911

[lp:~mterry/phablet-tools/unlock]

270. By Michael Terry on 2014-04-29

Teardown even if killed

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:269
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/311/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/83
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/83
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/83

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/311/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:270
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/312/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/84
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/84
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/84

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/312/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

+ exec_with_adb sh -c "if ! dpkg -s unity8-autopilot >/dev/null 2>/dev/null; then echo 'Installing unity8-autopilot on device for unlock support'; DEBIAN_FRONTEND=noninteractive apt-get -y -q install unity8-autopilot; fi"

Ideally devices should be in read only state for app testing. What I do to get the autopilot modules in phablet-test-click-setup is to grab the installed unity8 versions of the package and grab it's source package (pull-lp-source). We should do something similar here.

[Sergio Schvezov (sergiusens)]

Seeding unity8-autopilot is fine as well. We are in definite need of a proper QA story here.

The rest looks fine btw! :-)

[Michael Terry (mterry)]

Sergio, I think seeding is best bet, since the unlock script uses some python methods installed by the package.

Which branch has the seed config that I need to change?

[Sergio Schvezov (sergiusens)]

On Tue, Apr 29, 2014 at 4:39 PM, Michael Terry
<email address hidden>wrote:

> Sergio, I think seeding is best bet, since the unlock script uses some
> python methods installed by the package.
>
> Which branch has the seed config that I need to change?
>

For seeding, that's just the regular seed branch:
lp:~ubuntu-core-dev/ubuntu-seeds/ubuntu-touch.utopic

What do you think of splitting the autopilot package into some smaller
bits?

I'm looping in rsalveti and ogra

[Michael Terry (mterry)]

Oh. I thought you meant some special seeding that the QA images use. No, I'm not a fan of seeding it on all the images...

We could change the unlock script to be more contained -- we could probably duplicate some of the necessary python code.

But doesn't the autopilot scripts do some magic around installing files to /home/phablet/autopilot?

[lp:~mterry/phablet-tools/unlock]

271. By Michael Terry on 2014-04-30

If we need to, download unity8-autopilot and unpack it manually

272. By Michael Terry on 2014-04-30

Only override PYTHONPATH if we need to

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:272
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/313/
Executed test runs:
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-trusty-amd64-ci/85
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-trusty-armhf-ci/85
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-trusty-i386-ci/85

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/313/rebuild

review: Approve (continuous-integration)

[Michael Terry (mterry)]

OK... I've updated the branch to download a copy of unity8 and use its files (storing the python module in /home/phablet/autopilot). But A) this needs a change on the unity8 side to be able to specify a PYTHONPATH for the unlock-device script. And B) we need to grab the dependencies for unity8-autopilot (like ubuntu-ui-toolkit-autopilot).

I don't want to reinvent the wheel here. Is there already a function somewhere else that nicely puts modules and their dependencies in /home/phablet/autopilot?

As an aside, this is becoming complicated. How does unlocking work today on a readonly device? You'd need the unity8 python module there too. So this must be a solved problem. (And if it isn't, can we not block this change on that feature?)

[Sergio Schvezov (sergiusens)]

On Wed, Apr 30, 2014 at 5:19 PM, Michael Terry
<email address hidden>wrote:

> OK... I've updated the branch to download a copy of unity8 and use its
> files (storing the python module in /home/phablet/autopilot). But A) this
> needs a change on the unity8 side to be able to specify a PYTHONPATH for
> the unlock-device script. And B) we need to grab the dependencies for
> unity8-autopilot (like ubuntu-ui-toolkit-autopilot).
>
> I don't want to reinvent the wheel here. Is there already a function
> somewhere else that nicely puts modules and their dependencies in
> /home/phablet/autopilot?
>

phablet-click-test-setup does this; that's one of the reasons you can test
click packages on read only images.

>
> As an aside, this is becoming complicated. How does unlocking work today
> on a readonly device? You'd need the unity8 python module there too. So
> this must be a solved problem. (And if it isn't, can we not block this
> change on that feature?)
>

Read only devices don't have unlocking; if you add the TODO, it's fine; I
think it's kind of a failure that we can't have a testing story for a
consumer device though.

[lp:~mterry/phablet-tools/unlock]

273. By Michael Terry on 2014-05-01

Go back to just assuming readwrite image

274. By Michael Terry on 2014-05-01

Add TODO note about wanting to support readonly images

[Michael Terry (mterry)]

OK, I've reverted this branch to the assume-readwrite-image version. I'd really prefer not to bundle all these features together. This change is blocking landing the split greeter, so I'd like to make this as targeted as possible (this set of merges is already taking on another of your wish list items to move the logic out of ubuntu-test-cases into phablet-tools).

I've added a TODO about readonly support. Ready for review.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:274
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/314/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/86
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/86
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/86

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/314/rebuild

review: Approve (continuous-integration)

[lp:~mterry/phablet-tools/unlock]

275. By Michael Terry on 2014-05-01

Merge in some changes from Andy Doan that add support for passing on the wait command to unlock-device

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:275
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/315/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/87
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/87
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/87

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/315/rebuild

review: Approve (continuous-integration)

Unmerged revisions

275. By Michael Terry on 2014-05-01

Merge in some changes from Andy Doan that add support for passing on the wait command to unlock-device

274. By Michael Terry on 2014-05-01

Add TODO note about wanting to support readonly images

273. By Michael Terry on 2014-05-01

Go back to just assuming readwrite image

272. By Michael Terry on 2014-04-30

Only override PYTHONPATH if we need to

271. By Michael Terry on 2014-04-30

If we need to, download unity8-autopilot and unpack it manually

270. By Michael Terry on 2014-04-29

Teardown even if killed

269. By Michael Terry on 2014-04-29

Add unlock support to phablet-test-run

=== modified file 'phablet-test-run'
--- phablet-test-run	2014-04-01 01:36:31 +0000
+++ phablet-test-run	2014-05-01 19:30:14 +0000
@@ -21,17 +21,20 @@
 ARTIFACTS=""
 APFORMAT="xml"
 APEXTRA=""
+LOCALTMP=""
+PIDS=""
 
 EXECUTE_COMMAND=0
 USER=phablet
 ADBOPTS=""
+NOUNLOCK=0
 NOSHELL=0
 RETVAL=0
 VERBOSE=""
 
 print_usage() {
     cat << EOF
-usage: $0 [-s SERIAL] [-s] [-n] [-x] [-v] [-p PACKAGENAME] [-c PACKAGE] [-o DIR] [-a ARTIFACT] [-f xml|subunit|text] [-A args] testsuite
+usage: $0 [-s SERIAL] [-s] [-n] [-x] [-v] [-p PACKAGENAME] [-c PACKAGE] [-o DIR] [-a ARTIFACT] [-f xml|subunit|text] [-W WAIT_COMMAND] [-A args] testsuite
 
   Run the specified testsuite on the device
 
@@ -47,13 +50,16 @@
   -A               Extra arguments to pass to autopilot.
   -a ARTIFACT      Artifact to fetch after the test, may be used multiple times
                    (requires -o)
+  -l               Don't unlock screen on device (and thus don't reboot)
+  -W WAIT_COMMAND  By default the unlock script will sleep for 20 seconds.
+                   This allows using a custom script to do something else.
   -x               Execute command line, will not use autopilot by default
   -v               Run autopilot with -v option for more verbose output
 EOF
 }
 
 wait_for_device() {
-    adb $ADBOPTS wait-for-device
+    adb $ADBOPTS "wait-for-device"
 }
 
 exec_with_adb() {
@@ -70,6 +76,16 @@
         exec_with_adb DEBIAN_FRONTEND=noninteractive apt-get -y -q install $TESTPACKAGES
     fi
 
+    if [ $NOUNLOCK -eq 0 ]; then
+        # Need to install unity8-autopilot so we can grab its unlock script.
+        # We don't want the version of the script that may be on our host, because
+        # the user may have different unity8 on device.  And we do this here before
+        # we push local packages in case user is pushing a custom unity8-autopilot.
+        # TODO: It would be nice to allow doing this in a readonly image, by
+        # installing this and its dependencies into /home/phablet/autopilot.
+        exec_with_adb sh -c "if ! dpkg -s unity8-autopilot >/dev/null 2>/dev/null; then echo 'Installing unity8-autopilot on device for unlock support'; DEBIAN_FRONTEND=noninteractive apt-get -y -q install unity8-autopilot; fi"
+    fi
+
     if test -n "$LOCALPACKAGES"; then
         exec_with_adb mkdir -p /tmp/phablet-run-test/
         exec_with_adb rm -rf /tmp/phablet-run-test/*
@@ -85,6 +101,34 @@
     fi
 }
 
+setup_session() {
+    LOCALTMP=$(mktemp -d)
+
+    if [ $NOUNLOCK -eq 0 ]; then
+        echo "Rebooting and unlocking screen..."
+        adb pull /usr/share/unity8/unlock-device "$LOCALTMP" 2>/dev/null
+        chmod +x "$LOCALTMP/unlock-device"
+        # will reboot device and leave us inside user session
+        "$LOCALTMP/unlock-device" $WAIT_COMMAND
+    fi
+
+    # Call these directly rather than through exec_with_adb because we want to
+    # grab the adb PID, not the PID of a backgrounded bash function.
+    adb $ADBOPTS shell /usr/bin/powerd-cli active >/dev/null &
+    PIDS="$PIDS $!"
+    adb $ADBOPTS shell /usr/bin/powerd-cli display on bright >/dev/null &
+    PIDS="$PIDS $!"
+}
+
+teardown_session() {
+    if [ -n "$PIDS" ]; then
+        kill $PIDS
+        PIDS=""
+    fi
+
+    rm -rf "$LOCALTMP"
+}
+
 disable_shell() {
     exec_with_adb_user initctl stop unity8
 }
@@ -168,7 +212,7 @@
     fi
 }
 
-while getopts A:a:c:f:hnxo:p:s:v opt; do
+while getopts A:a:c:f:hW:lnxo:p:s:v opt; do
     case $opt in
     A)
         APEXTRA=$OPTARG
@@ -186,6 +230,12 @@
         print_usage
         exit 0
         ;;
+    l)
+        NOUNLOCK=1
+        ;;
+    W)
+        WAIT_COMMAND="-w $OPTARG"
+        ;;
     n)
         NOSHELL=1
         ;;
@@ -215,8 +265,14 @@
     exit 0
 fi
 
+trap teardown_session TERM INT EXIT
+
 install_packages
 
+# Must do this after install_packages, since we may end up using installed
+# packages to set up the session.
+setup_session
+
 if [ $NOSHELL -eq 1 ]; then
     echo "Disabling shell"
     disable_shell