47 echo "Usage: $NAME [OPTION]... [--] [CUCUMBER_ARGS]...
48 Sets up an appropriate environment and invokes cucumber. Note that this script
49 must be run from the Tails source directory root.
51 Options for '@product' features:
52 --artifacts-base-uri URI
53 Pretend that the artifact is located at URI when printing
54 its location during a scenario failure. This is useful if
55 you intend to serve the artifacts via the web, for
57 --capture Captures failed scenarios into videos stored in the
58 temporary directory (see --tmpdir below) using x264
59 encoding. Requires x264.
60 --capture-all Keep videos for all scenarios, including those that
61 succeed (implies --capture).
62 --pause-on-fail On failure, pause test suite until pressing Enter. This is
63 useful for investigating the state of the VM guest to see
64 exactly why a test failed.
65 --keep-snapshots Don't ever delete any snapshots (including ones marked as
66 temporary). This can be a big time saver when debugging new
68 --retry-find Print a warning whenever Sikuli fails to find an image
69 and allow *one* retry after pressing ENTER. This is useful
70 for updating outdated images.
71 --tmpdir Directory where various temporary files are written
72 during a test, e.g. VM snapshots and memory dumps,
73 failure screenshots, pcap files and disk images
74 (default is TMPDIR in the environment, and if unset,
76 --view Shows the test session in a windows. Requires x11vnc
78 --vnc-server-only Starts a VNC server for the test session. Requires x11vnc.
79 --iso IMAGE Test '@product' features using IMAGE.
80 --old-iso IMAGE For some '@product' features (e.g. usb_install) we need
81 an older version of Tails, which this options sets to
82 IMAGE. If none is given, it defaults to the same IMAGE
83 given by --iso, which will be good enough for most testing
86 Note that '@source' features has no relevant options.
88 CUCUMBER_ARGS can be used to specify which features to be run, but also any
89 cucumber option, although then you must pass \`--\` first to let this wrapper
90 script know that we're done with *its* options. For debugging purposes, a
91 'debug' formatter has been added so pretty debugging can be enabled with
92 \`--format debug\`. You could even combine the default (pretty) formatter with
93 pretty debugging printed to a file with \`--format pretty --format debug
99 echo "${NAME}: error: ${*}" >&2
104 package_installed
() {
107 if dpkg
-s "${1}" 2>/dev
/null |
grep -q "^Status:.*installed"; then
116 check_dependencies
() {
117 while [ -n "${1:-}" ]; do
118 if ! which "${1}" >/dev
/null
&& ! package_installed
"${1}" ; then
119 error
"'${1}' is missing, please install it and run again."
126 [ -e "/tmp/.X${1#:}-lock" ] ||
[ -e "/tmp/.X11-unix/X${1#:}" ]
129 next_free_display
() {
131 while display_in_use
":${display_nr}"; do
132 display_nr
=$
((display_nr
+1))
134 echo ":${display_nr}"
137 test_suite_cleanup
() {
138 (kill -0 ${XVFB_PID} 2>/dev
/null
&& kill ${XVFB_PID}) ||
/bin
/true
142 Xvfb
$TARGET_DISPLAY -screen 0 1024x768x24
+32 >/dev
/null
2>&1 &
144 # Wait for Xvfb to run on TARGET_DISPLAY
145 until display_in_use
$TARGET_DISPLAY; do
148 echo "Virtual X framebuffer started on display ${TARGET_DISPLAY}"
149 # Hide the mouse cursor so it won't mess up Sikuli's screen scanning
150 unclutter
-display $TARGET_DISPLAY -root -idle 0 >/dev
/null
2>&1 &
154 check_dependencies x11vnc
155 VNC_SERVER_PORT
="$(x11vnc -listen localhost -display ${TARGET_DISPLAY} \
156 -bg -nopw -forever 2>&1 | \
157 grep -m 1 "^PORT
=[0-9]\
+" | sed 's/^PORT=//')"
158 echo "VNC server running on: localhost:${VNC_SERVER_PORT}"
162 check_dependencies xtightvncviewer
163 xtightvncviewer
-viewonly localhost
:${VNC_SERVER_PORT} 1>/dev
/null
2>&1 &
167 check_dependencies libvpx1
168 echo "Capturing guest display into ${CAPTURE_FILE}"
169 avconv
-f x11grab
-s 1024x768
-r 15 -i ${TARGET_DISPLAY}.0 -an \
170 -vcodec libvpx
-y "${CAPTURE_FILE}" >/dev
/null
2>&1 &
175 # Unset all environment variables used by this script to pass options
176 # to cucumber, except TMPDIR since we explicitly want to support
177 # setting it that way.
186 SIKULI_RETRY_FINDFAILED
=
190 LONGOPTS
="artifacts-base-uri:,view,vnc-server-only,capture,capture-all,help,tmpdir:,keep-snapshots,retry-find,iso:,old-iso:,pause-on-fail"
191 OPTS
=$
(getopt
-o "" --longoptions $LONGOPTS -n "${NAME}" -- "$@")
193 while [ $# -gt 0 ]; do
195 --artifacts-base-uri)
197 export ARTIFACTS_BASE_URI
="${1}"
208 check_dependencies x264
212 check_dependencies x264
214 export CAPTURE_ALL
="yes"
217 export PAUSE_ON_FAIL
="yes"
220 export KEEP_SNAPSHOTS
="yes"
223 export SIKULI_RETRY_FINDFAILED
="yes"
227 export TMPDIR
="$(readlink -f $1)"
231 export TAILS_ISO
="$(readlink -f $1)"
235 export OLD_TAILS_ISO
="$(readlink -f $1)"
249 trap "test_suite_cleanup" EXIT HUP INT QUIT TERM
251 check_dependencies
${GENERAL_DEPENDENCIES}
253 TARGET_DISPLAY
=$
(next_free_display
)
257 if [ -n "${VNC_SERVER:-}" ]; then
260 if [ -n "${VNC_VIEWER:-}" ]; then
264 export SIKULI_HOME
="/usr/share/java"
265 export DISPLAY
=${TARGET_DISPLAY}