Merge lp:~jibel/autopilot/autopilot-sandbox-run into lp:autopilot

[Jean-Baptiste Lallement]

Added autopilot-sandbox-run to run autopilot tests in a 'fake' X server.
Xephyr and Xvfb are supported.

Added autopilot-sandbox-run to run autopilot tests in a 'fake' X server.
Xephyr and Xvfb are supported.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:325
http://jenkins.qa.ubuntu.com/job/autopilot-ci/217/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/145/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/145/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/217/rebuild

review: Needs Fixing (continuous-integration)

[Martin Pitt (pitti)]

JB, you need to add the new script to scripts=[...] in setup.py.

> 4 +XEPHYR_CMD="$(which Xephyr)"

This will fail if Xephyr isn't installed, as the script is set -e. You should ignore that error without -x (similarly with "which Xvfb"), as further down the script already gives a proper error message if it's not installed.

> SERVERNUM=$(shuf -n1 -i5-99)

This should loop until ! [ -e /tmp/.X${SERVERNUM}-lock ]

> sleep 1 # Waits from fake X to settle

I think this can be done more robustly with a loop which sleeps 0.1 until [ -e /tmp/.X${SERVERNUM}-lock ]

Merci beaucoup !

review: Needs Fixing

[Martin Pitt (pitti)]

Also, I don't immediately see anything which requires bash in the script, did I miss anything? It could be /bin/sh.

It's generally better to do

#!/bin/sh
set -eu

instead of "#!/bin/sh -eu"; with the latter, the -eu will be silently not happen if you run the script with e. g. "sh -x bin/autopilot-sandbox'run", but with the former the set -eu will always be considered.

[Jean-Baptiste Lallement (jibel)]

Thanks for your review.

I updated the MP with your comments and added 2 functions:
* find_free_servernum to find first free server number instead of picking a random server number
* wait_for_x to wait for the start of X server and timeout after 10S instead of a static sleep

review: Needs Resubmitting

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:326
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~jibel/autopilot/autopilot-sandbox-run/+merge/185506/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/autopilot-ci/218/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/146
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/146

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/218/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:326
http://jenkins.qa.ubuntu.com/job/autopilot-ci/219/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/147
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/147/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/219/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:326
http://jenkins.qa.ubuntu.com/job/autopilot-ci/220/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/148
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/148

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/220/rebuild

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

LGTM, would like pitti to review this before merging it.

review: Approve

[Martin Pitt (pitti)]

LGTM now, thanks for the fixes!

review: Approve

[Jean-Baptiste Lallement (jibel)]

approving my own MP :)

review: Approve

Unmerged revisions

=== added file 'bin/autopilot-sandbox-run'
--- bin/autopilot-sandbox-run	1970-01-01 00:00:00 +0000
+++ bin/autopilot-sandbox-run	2013-09-13 15:24:06 +0000
@@ -0,0 +1,178 @@
+#!/bin/sh
+
+#
+# Runner to execute autopilot locally
+#
+# This scripts run autopilot in a "fake" X server, either headless with xvfb
+# or nested with Xephyr
+#
+
+# Copyright (C) 2013 Canonical
+#
+# Authors: Jean-Baptiste Lallement <[e-mail]>
+#
+# 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; 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 General Public License for more # details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+set -eu
+
+# General Settings
+RC=0  # Main return code
+BINDIR=$(dirname $(readlink -f $0))
+XEPHYR=0
+XEPHYR_CMD="$(which Xephyr||true)"
+XEPHYR_OPT="-ac -br -noreset"
+
+XVFB_CMD="$(which Xvfb||true)"
+XVFB_OPT=""
+
+AP_CMD="$(which autopilot)"
+AP_OPT=""
+
+SERVERNUM=5
+SCREEN="1024x768x24"
+
+DBUS_SESSION_BUS_PID=""
+X_PID=""
+
+usage() {
+    # Display usage and exit with error
+    cat<<EOF
+Usage: $(basename $0) [OPTIONS...] TEST [TEST...]
+Runs autopilot tests in a 'fake' Xserver with Xvfb or Xephyr. autopilot runs
+in Xvfb by default.
+    
+    TEST: autopilot tests to run
+
+Options:
+    -h, --help           This help
+    -d, --debug          Enable debug mode
+    -a, --autopilot ARG  Pass arguments ARG to 'autopilot run'
+    -X, --xephyr         Run in nested mode with Xephyr
+    -s, --screen WxHxD   Sets screen width, height, and depth to W, H, and D
+                         respectively (default: $SCREEN)
+
+EOF
+    RC=1
+    exit
+}
+
+find_free_servernum() {
+    # Find a free server number by looking at .X*-lock files in /tmp.
+    # Inspired from xvfb-run
+    #
+    # Args:
+    #   None
+    # Returns:
+    #   First free server number
+    #
+    snum=$SERVERNUM
+    while [ -f /tmp/.X$snum-lock ]; do
+        snum=$(($snum + 1))
+    done
+    echo $snum
+}
+
+wait_for_x() {
+    # Waits for start of fake X server and exit on timeout
+    #
+    # Args:
+    #   $1: Server number
+    # Returns
+    #   None
+    if [ $# -ne 1 ]; then
+        echo "E: wait_for_x: Missing argument servernum"
+        RC=1
+        exit
+    fi
+    loops=100
+    delay=.1
+    snum=$1
+    while [ ! -e /tmp/.X$snum-lock ]; do
+        sleep $delay
+        loops=$((loops - 1))
+        if [ $loops -le 0 ]; then
+            echo "E: X Server :$snum failed to come up.  Aborting!"
+            RC=1
+            exit
+        fi
+    done
+}
+
+on_exit() {
+    # Exit handler
+    for pid in "$DBUS_SESSION_BUS_PID" "$X_PID"; do
+        [ -n "$pid" ] && kill $pid >/dev/null 2>&1 || true
+    done
+
+    exit $RC
+}
+
+trap on_exit EXIT INT QUIT ABRT PIPE TERM
+
+SHORTOPTS="hda:s:X"
+LONGOPTS="help,debug,autopilot:,screen:,xephyr"
+
+TEMP=$(getopt -o $SHORTOPTS --long $LONGOPTS -- "$@")
+eval set -- "$TEMP"
+
+exec 2>&1
+
+while true ; do
+    case "$1" in
+        -h|--help)
+            usage;;
+        -d|--debug)
+            set -x
+            shift;;
+        -a|--autopilot)
+            AP_OPT=$2
+            shift 2;;
+        -s|-screen)
+            SCREEN=$2
+            shift 2;;
+        -X|--xephyr)
+            XEPHYR=1
+            [ ! -x "$XEPHYR_CMD" ] && \
+                echo "E: Xephyr executable not found. Please install Xephyr" &&\
+                RC=1 && exit 1
+            shift;;
+        --) shift;
+            break;;
+        *) usage;;
+    esac
+done
+
+[ $# -eq 0 ] && usage
+if [ $XEPHYR -eq 0 -a ! -x "$XVFB_CMD" ]; then
+    echo "E: Xvfb executable not found. Please install xvfb"
+    RC=1
+    exit 
+fi
+
+TESTLIST="$@"
+echo "I: Running tests $TESTLIST"
+
+SERVERNUM=$(find_free_servernum)
+XCMD="$XVFB_CMD :$SERVERNUM $XVFB_OPT -screen 0 $SCREEN"
+[ $XEPHYR -eq 1 ] && XCMD="$XEPHYR_CMD :$SERVERNUM $XEPHYR_OPT -screen $SCREEN"
+
+echo "I: Starting X Server: $XCMD"
+$XCMD >/dev/null 2>&1 &
+X_PID=$!
+export DISPLAY=:${SERVERNUM}.0
+
+export XAUTHORITY=/dev/null
+wait_for_x $SERVERNUM
+echo "I: Starting autopilot"
+dbus-launch --exit-with-session autopilot run $AP_OPT $TESTLIST
+echo "I: autopilot tests done"
+RC=$?

=== modified file 'debian/python-autopilot.install'
--- debian/python-autopilot.install	2013-05-04 01:01:06 +0000
+++ debian/python-autopilot.install	2013-09-13 15:24:06 +0000
@@ -1,2 +1,3 @@
 usr/bin/autopilot /usr/bin/
+usr/bin/autopilot-sandbox-run /usr/bin/
 debian/61-autopilot-uinput.rules /lib/udev/rules.d

=== modified file 'setup.py'
--- setup.py	2013-07-24 05:56:06 +0000
+++ setup.py	2013-09-13 15:24:06 +0000
@@ -47,6 +47,6 @@
     license='GPLv3',
     packages=find_packages(),
     test_suite='autopilot.tests',
-    scripts=['bin/autopilot'],
+    scripts=['bin/autopilot', 'bin/autopilot-sandbox-run'],
     ext_modules=[autopilot_tracepoint],
 )