50 echo "Usage: $NAME [OPTION]... [--] [CUCUMBER_ARGS]...
51 Sets up an appropriate environment and invokes cucumber. Note that this script
52 must be run from the Tails source directory root.
54 Options for '@product' features:
55 --artifacts-base-uri URI
56 Pretend that the artifact is located at URI when printing
57 its location during a scenario failure. This is useful if
58 you intend to serve the artifacts via the web, for
60 --capture Captures failed scenarios into videos stored in the
61 temporary directory (see --tmpdir below) using x264
62 encoding. Requires x264.
63 --capture-all Keep videos for all scenarios, including those that
64 succeed (implies --capture).
65 --interactive-debugging
66 On failure, pause test suite until pressing Enter. Also
67 offer the option to open an interactive Ruby shell (pry)
68 in the Cucumber world's context.
69 --keep-snapshots Don't ever delete any snapshots (including ones marked as
70 temporary). This can be a big time saver when debugging new
72 --retry-find Print a warning whenever Sikuli fails to find an image
73 and allow *one* retry after pressing ENTER. This is useful
74 for updating outdated images.
75 --fuzzy-image-matching
76 When Sikuli fails to find an image, let it retry with more
77 fuzziness (or \"lower similarity factor\" in Sikuli terms).
78 --tmpdir Directory where various temporary files are written
79 during a test, e.g. VM snapshots and memory dumps,
80 failure screenshots, pcap files and disk images
81 (default is TMPDIR in the environment, and if unset,
83 --view Shows the test session in a windows. Requires x11vnc
85 --vnc-server-only Starts a VNC server for the test session. Requires x11vnc.
86 --iso IMAGE Test '@product' features using IMAGE.
87 --old-iso IMAGE For some '@product' features (e.g. usb_install) we need
88 an older version of Tails, which this options sets to
89 IMAGE. If none is given, it defaults to the same IMAGE
90 given by --iso, which will be good enough for most testing
93 Note that '@source' features has no relevant options.
95 CUCUMBER_ARGS can be used to specify which features to be run, but also any
96 cucumber option, although then you must pass \`--\` first to let this wrapper
97 script know that we're done with *its* options. For debugging purposes, a
98 'debug' formatter has been added so pretty debugging can be enabled with
99 \`--format debug\`. You could even combine the default (pretty) formatter with
100 pretty debugging printed to a file with \`--format pretty --format debug
106 echo "${NAME}: error: ${*}" >&2
111 package_installed
() {
114 if dpkg
-s "${1}" 2>/dev
/null |
grep -q "^Status:.*installed"; then
123 check_dependencies
() {
124 while [ -n "${1:-}" ]; do
125 if ! which "${1}" >/dev
/null
&& ! package_installed
"${1}" ; then
126 error
"'${1}' is missing, please install it and run again."
133 [ -e "/tmp/.X${1#:}-lock" ] ||
[ -e "/tmp/.X11-unix/X${1#:}" ]
136 next_free_display
() {
138 while display_in_use
":${display_nr}"; do
139 display_nr
=$
((display_nr
+1))
141 echo ":${display_nr}"
144 test_suite_cleanup
() {
145 (kill -0 ${XVFB_PID} 2>/dev
/null
&& kill ${XVFB_PID}) ||
/bin
/true
149 Xvfb
$TARGET_DISPLAY -screen 0 1024x768x24
+32 >/dev
/null
2>&1 &
151 # Wait for Xvfb to run on TARGET_DISPLAY
152 until display_in_use
$TARGET_DISPLAY; do
155 echo "Virtual X framebuffer started on display ${TARGET_DISPLAY}"
156 # Hide the mouse cursor so it won't mess up Sikuli's screen scanning
157 unclutter
-display $TARGET_DISPLAY -root -idle 0.1 >/dev
/null
2>&1 &
161 check_dependencies x11vnc
162 VNC_SERVER_PORT
="$(x11vnc -listen localhost -display ${TARGET_DISPLAY} \
163 -bg -nopw -forever 2>&1 | \
164 grep -m 1 "^PORT
=[0-9]\
+" | sed 's/^PORT=//')"
165 echo "VNC server running on: localhost:${VNC_SERVER_PORT}"
169 check_dependencies tigervnc-viewer
170 xtigervncviewer
-nojpeg -viewonly localhost
:${VNC_SERVER_PORT} 1>/dev
/null
2>&1 &
174 check_dependencies libvpx1
175 echo "Capturing guest display into ${CAPTURE_FILE}"
176 avconv
-f x11grab
-s 1024x768
-r 15 -i ${TARGET_DISPLAY}.0 -an \
177 -vcodec libvpx
-y "${CAPTURE_FILE}" >/dev
/null
2>&1 &
182 # Unset all environment variables used by this script to pass options
183 # to cucumber, except TMPDIR since we explicitly want to support
184 # setting it that way.
191 INTERACTIVE_DEBUGGING
=
193 SIKULI_RETRY_FINDFAILED
=
194 SIKULI_FUZZY_IMAGE_MATCHING
=
198 LONGOPTS
="artifacts-base-uri:,view,vnc-server-only,capture,capture-all,help,tmpdir:,keep-snapshots,retry-find,fuzzy-image-matching,iso:,old-iso:,interactive-debugging"
199 OPTS
=$
(getopt
-o "" --longoptions $LONGOPTS -n "${NAME}" -- "$@")
201 while [ $# -gt 0 ]; do
203 --artifacts-base-uri)
205 export ARTIFACTS_BASE_URI
="${1}"
216 check_dependencies x264
220 check_dependencies x264
222 export CAPTURE_ALL
="yes"
224 --interactive-debugging)
225 export INTERACTIVE_DEBUGGING
="yes"
228 export KEEP_SNAPSHOTS
="yes"
231 export SIKULI_RETRY_FINDFAILED
="yes"
233 --fuzzy-image-matching)
234 export SIKULI_FUZZY_IMAGE_MATCHING
="yes"
238 export TMPDIR
="$(readlink -f $1)"
242 export TAILS_ISO
="$(readlink -f $1)"
246 export OLD_TAILS_ISO
="$(readlink -f $1)"
260 trap "test_suite_cleanup" EXIT HUP INT QUIT TERM
262 check_dependencies
${GENERAL_DEPENDENCIES}
264 TARGET_DISPLAY
=$
(next_free_display
)
268 if [ -n "${VNC_SERVER:-}" ]; then
271 if [ -n "${VNC_VIEWER:-}" ]; then
275 export SIKULI_HOME
="/usr/share/java"
276 export DISPLAY
=${TARGET_DISPLAY}