#!/bin/bash # Copyright 2015-2016 Holger Levsen # released under the GPLv=2 DEBUG=false . /srv/jenkins/bin/common-functions.sh common_init "$@" set -e # dependencies used in the schroot are described in job-cfg/torbrowser-launcher.yaml, see how schroot-create.sh is called there. # additionally this script needs the following packages: xvfb, xvkbd, ffmpeg, gocr, imagemagick cleanup_all() { set +e # kill xvfb and ffmpeg kill $XPID $FFMPEGPID 2>/dev/null|| true # preserve screenshots and video cd $TMPDIR [ ! -f $VIDEO ] || mv $VIDEO $RESULTS/ cd $WORKSPACE [ ! -f screenshot.png ] || rm screenshot.png [ ! -f screenshot-thumb.png ] || rm screenshot-thumb.png [ ! -f screenshot_from_git.png ] || mv screenshot_from_git.png screenshot.png # shutdown and end session if it still exists STATUS=$(schroot -l --all-sessions | grep $SESSION || true) if [ -n "$STATUS" ] ; then echo "$(date -u ) - stopping dbus service." schroot --run-session -c $SESSION --directory /tmp -u root -- service dbus stop || true sleep 1 schroot --end-session -c $SESSION || true echo "$(date -u ) - schroot session $SESSION end." fi # delete main work dir cd rm $TMPDIR $TBL_LOGFILE -rf # end echo "$(date -u) - $TMPDIR deleted. Cleanup done." # $1 is empty when called via trap if [ "$1" = "quiet" ] ; then echo "$(date -u) - everything ran nicely, congrats." fi } cleanup_duplicate_screenshots() { cd $RESULTS echo "$(date -u) - removing duplicate and similar screenshots." # loop backwards through the screenshots and remove similar ones # this results in keeping the interesting ones :) MAXDIFF=2500 # pixels for i in $(ls -r1 *.png | xargs echo) ; do for j in $(ls -r1 *.png | xargs echo) ; do if [ "$j" = "$i" ] ; then break elif [ ! -f $j ] || [ ! -f $i ] ; then break fi # here we check the difference in pixels between the two images PIXELS=$(compare -metric AE $i $j /dev/null 2>&1 || true) # if it's an integer… if [[ "$PIXELS" =~ ^[0-9]+$ ]] && [ $PIXELS -le $MAXDIFF ] ; then echo "$(date -u ) - removing $j, $PIXELS pixels difference." rm $j fi done done cp $(ls -r1 *.png | head -1) final_state.png convert final_state.png -adaptive-resize 128x96 final_state-thumb.png } update_screenshot() { TIMESTAMP=$(date +%Y%m%d%H%M%S) # probably there is something more lightweight to grab a screenshot from xvfb… ffmpeg -y -f x11grab -s $SIZE -i :$SCREEN.0 -frames 1 screenshot.png > /dev/null 2>&1 convert screenshot.png -adaptive-resize 128x96 screenshot-thumb.png # for later publishing cp screenshot.png $RESULTS/screenshot_$TIMESTAMP.png # for the live screenshot plugin mv screenshot.png screenshot-thumb.png $WORKSPACE/ echo "screenshot_$TIMESTAMP.png taken." } begin_session() { # create schroot session schroot --begin-session --session-name=$SESSION -c jenkins-torbrowser-launcher-$SUITE echo "Starting schroot session, schroot --run-session -c $SESSION -- now availble." schroot --run-session -c $SESSION --directory /tmp -u root -- mkdir $HOME schroot --run-session -c $SESSION --directory /tmp -u root -- chown jenkins:jenkins $HOME } end_session() { # destroy schroot session schroot --end-session -c $SESSION echo "$(date -u ) - schroot session $SESSION end." sleep 1 } upgrade_to_newer_packaged_version_in() { local SUITE=$1 echo echo "$(date -u ) - upgrading to torbrowser-launcher from $SUITE." echo "deb $MIRROR $SUITE main contrib" | schroot --run-session -c $SESSION --directory /tmp -u root -- tee -a /etc/apt/sources.list schroot --run-session -c $SESSION --directory /tmp -u root -- apt-get update schroot --run-session -c $SESSION --directory /tmp -u root -- apt-get -y install -t $SUITE torbrowser-launcher echo "$(date -u ) - upgraded to torbrowser-launcher from $SUITE." } upgrade_to_package_build_from_git() { echo local BRANCH=$1 # GIT_URL is set by jenkins echo "$(date -u ) - building Debian package based on branch $BRANCH from $GIT_URL." # build package if [ "$BRANCH" = "debian/jessie" ] || [ "$BRANCH" = "debian/jessie-proposed" ] ; then local UPSTREAM_TREE=v0.1.9 elif [ "$BRANCH" = "upstream-master-plus-debian-packaging" ] ; then local UPSTREAM_TREE=origin/master else local UPSTREAM_TREE=origin/master fi # configure lintian to be pedantic echo "pedantic = yes" | schroot --run-session -c $SESSION --directory $TMPDIR -u root -- tee -a /etc/lintianrc # build the package schroot --run-session -c $SESSION --directory $TMPDIR/git -- gbp buildpackage --git-ignore-branch --git-upstream-tree=$UPSTREAM_TREE -uc -us local DEB=$(cd $TMPDIR ; ls torbrowser-launcher_*deb) local CHANGES=$(cd $TMPDIR ; ls torbrowser-launcher_*changes) # install it echo "$(date -u ) - $DEB will be installed." schroot --run-session -c $SESSION --directory $TMPDIR -u root -- dpkg -i $DEB # cleanup rm $TMPDIR/git -r cat $TMPDIR/$CHANGES schroot --run-session -c $SESSION --directory $TMPDIR -- dcmd rm -v $CHANGES || true echo "$(date -u ) - $DEB installed." } announce_failure_and_exit() { echo "$1" echo "'$1'" | xargs schroot --run-session -c $SESSION --preserve-environment -- notify-send -u critical update_screenshot cleanup_duplicate_screenshots exit 1 } announce_problem_and_abort_silently() { echo "$1" echo "'$1'" | xargs schroot --run-session -c $SESSION --preserve-environment -- notify-send -u critical update_screenshot cleanup_duplicate_screenshots cleanup_all exec /srv/jenkins/bin/abort.sh exit 0 } prepare_other_packages() { # once #805173 is fixed in all tested suites, ca-certificates doesn't have to be installed here anymore if [ "$SUITE" = "wheezy" ] || [ "$SUITE" = "jessie" ] ; then schroot --run-session -c $SESSION --directory $TMPDIR -u root -- apt-get install -y ca-certificates fi # tor is only a recommends and we don't install recommends by default… if $VIA_TOR ; then echo "$(date -u ) - installing tor as this test will download torbrowser via the system tor service." schroot --run-session -c $SESSION --directory $TMPDIR -u root -- apt-get install -y tor fi } prepare_lauchner_settings() { if $BROKEN_SETTINGS ; then echo "$(date -u ) - providing broken settings for torbrowser-launcher to test if it can deal with it." SETTINGS=$(mktemp -t tbl-tests-XXXXXXXX) cat >$SETTINGS <<-__END__ (dp0 S'accept_links' p1 I00 sS'modem_sound' p2 I00 sS'latest_version' p3 S'5.5a4-hardened' p4 sS'installed_version' p5 S'5.0.4' p6 sS'check_for_updates' p7 I00 sS'mirror' p8 S'https://dist.torproject.org/' p9 sS'tbl_version' p10 S'0.1.9-1' p11 sS'update_over_tor' p12 I01 sS'last_update_check_timestamp' p13 I1449534041 __END__ echo -n "s." >> $SETTINGS schroot --run-session -c $SESSION --preserve-environment -- mkdir -p $HOME/.config/torbrowser cat $SETTINGS | schroot --run-session -c $SESSION --preserve-environment -- tee $HOME/.config/torbrowser/settings rm $SETTINGS >/dev/null else echo "$(date -u ) - not providing any settings for torbrowser-launcher." fi } download_and_launch() { echo echo "$(date -u) - Test download_and_launch begins." schroot --run-session -c $SESSION --directory /tmp -- dpkg -l torbrowser-launcher || true echo "$(date -u ) - starting dbus service." # yes, torbrowser needs dbus schroot --run-session -c $SESSION --directory /tmp -u root -- service dbus start sleep 5 echo "$(date -u) - starting Xvfb on :$SCREEN.0 now." # start X on virtual framebuffer device Xvfb -ac -br -screen 0 ${SIZE}x24 :$SCREEN & XPID=$! sleep 3 # configure environment export DISPLAY=":$SCREEN.0" echo export DISPLAY=":$SCREEN.0" unset http_proxy unset https_proxy #export LANGUAGE="de" #export LANG="de_DE.UTF-8" #export LC_ALL="de_DE.UTF-8" echo "$(date -u) - starting awesome." timeout -k 30m 29m schroot --run-session -c $SESSION --preserve-environment -- awesome & sleep 5 # configure dbus session for this user's session DBUS_SESSION_FILE=$(mktemp -t torbrowser-launcher-XXXXXX) DBUS_SESSION_POINTER=$(schroot --run-session -c $SESSION --preserve-environment -- ls $HOME/.dbus/session-bus/ -t1 | head -1) schroot --run-session -c $SESSION --preserve-environment -- cat $HOME/.dbus/session-bus/$DBUS_SESSION_POINTER > $DBUS_SESSION_FILE . $DBUS_SESSION_FILE && export DBUS_SESSION_BUS_ADDRESS echo export DBUS_SESSION_BUS_ADDRESS=$DBUS_SESSION_BUS_ADDRESS rm $DBUS_SESSION_FILE # start ffmpeg to capture a video of the interesting bits of the test ffmpeg -f x11grab -s $SIZE -i :$SCREEN.0 $VIDEO > /dev/null 2>&1 & FFMPEGPID=$! sleep 2 echo "'$(date -u) - starting torbrowser tests'" | tee | xargs schroot --run-session -c $SESSION --preserve-environment -- notify-send update_screenshot echo "$(date -u) - starting torbrowser-launcher, opening settings dialog." # set PYTHONUNBUFFERED to get unbuffered output from python, so we can grep in it in real time export PYTHONUNBUFFERED=true prepare_lauchner_settings ( timeout -k 30m 29m schroot --run-session -c $SESSION --preserve-environment -- /usr/bin/torbrowser-launcher --settings 2>&1 |& tee $TBL_LOGFILE || true ) & sleep 23 update_screenshot if $VIA_TOR ; then # download via system tor echo "$(date -u) - pressing to select download via tor" xvkbd -text "\r" > /dev/null 2>&1 sleep 1 update_screenshot fi # else the default will be used, which is download via https… echo "$(date -u) - pressing " xvkbd -text "\t" > /dev/null 2>&1 sleep 1 TBL_VERSION=$(schroot --run-session -c $SESSION -- dpkg --status torbrowser-launcher |grep ^Version|cut -d " " -f2) if dpkg --compare-versions $TBL_VERSION lt 0.2.0-1~ && ! dpkg --compare-versions $TBL_VERSION gt 0.1.9-1+deb8u2~ ; then echo "$(date -u) - torbrowser-launcher version <0.2.0-1~ detected ($TBL_VERSION), pressing three times more." xvkbd -text "\t\t\t" > /dev/null 2>&1 sleep 1 elif dpkg --compare-versions $TBL_VERSION lt 0.2.2-1~ ; then echo "$(date -u) - torbrowser-launcher version <0.2.2-1~ detected ($TBL_VERSION), pressing twice more." xvkbd -text "\t\t" > /dev/null 2>&1 sleep 1 elif dpkg --compare-versions $TBL_VERSION gt 0.2.3-1~ ; then echo "$(date -u) - torbrowser-launcher version >0.2.3-1~ detected ($TBL_VERSION), pressing once more." xvkbd -text "\t" > /dev/null 2>&1 sleep 1 fi update_screenshot echo "$(date -u) - pressing " xvkbd -text "\r" > /dev/null 2>&1 sleep 5 update_screenshot SETTINGS_DONE=$(pgrep -f "$SESSION --preserve-environment -- torbrowser-launcher --settings" || true) if [ -n "$SETTINGS_DONE" ] ; then announce_failure_and_exit "$(date -u) - settings dialog still there, please investigate." fi if $VIA_TOR ; then MAX_LOOP=52 # allow the download to take up to ~31 minutes (1898 seconds) via tor else MAX_LOOP=42 # allow the download to take up to ~22 minutes (1323 seconds) via https fi # ( echo -n "0" ; for i in $(seq 1 42) ; do echo -n "+$i+10" ; done ; echo ) | bc # we watch the download directory and parse torbrowser-launchers stdout, so usually this loop won't run this long for i in $(seq 1 $MAX_LOOP) ; do sleep 10 ; sleep $i STATUS="$(grep '^Download error:' $TBL_LOGFILE || true)" if [ -n "$STATUS" ] ; then announce_failure_and_exit "$(date -u) - $STATUS" fi # download is finished once BROWSER_DIR_EN or BROWSER_DIR_DE exist # as these directories only exist once torbrower has been successfully installed # (and pattern matching doesnt work because of schroot…) local BROWSER_DIR_EN=$HOME/.local/share/torbrowser/tbb/x86_64/tor-browser_en-US/Browser local BROWSER_DIR_DE=$HOME/.local/share/torbrowser/tbb/x86_64/tor-browser_de/Browser STATUS="$(schroot --run-session -c $SESSION -- test ! -d $BROWSER_DIR_EN -a ! -d $BROWSER_DIR_DE || echo $(date -u ) - torbrowser downloaded and installed, configuring tor now. )" if [ -n "$STATUS" ] ; then update_screenshot break fi update_screenshot done if [ ! -n "$STATUS" ] ; then announce_failure_and_exit "$(date -u) - could not download torbrowser, please investigate." fi echo "$(date -u) - waiting for torbrowser to start the tor network settings dialogue." # allow up to 90 seconds for torbrowser to start the tor network settings dialogue for i in $(seq 1 9) ; do sleep 5 ; sleep $i # this directory only exists once torbrower has successfully started # (and pattern matching doesnt work because of schroot…) local BROWSER_PROFILE=TorBrowser/Data/Browser/profile.default STATUS="$(schroot --run-session -c $SESSION -- test ! -d $BROWSER_DIR_EN/$BROWSER_PROFILE -a ! -d $BROWSER_DIR_DE/$BROWSER_PROFILE || echo $(date -u ) - torbrowser running. )" if [ -n "$STATUS" ] ; then sleep 15 break fi done if [ ! -n "$STATUS" ] ; then announce_failure_and_exit "$(date -u) - could not start torbrowser, please investigate." fi echo "$(date -u) - pressing , to connect directly via tor." xvkbd -text "\r" > /dev/null 2>&1 sleep 3 update_screenshot # allow up to 165 seconds for torbrowser to start and to make the first connection through tor for i in $(seq 1 14) ; do sleep 5 ; sleep $i update_screenshot TOR_RUNNING=$(gocr $WORKSPACE/screenshot.png 2>/dev/null | egrep "(Search securely|Tor Is NOT all you need to browse|There are many ways you can help)" || true) if [ -n "$TOR_RUNNING" ] ; then echo "$(date -u) - torbrowser is working as it should, good." break fi done if [ -z "$TOR_RUNNING" ] ; then announce_problem_and_abort_silently "$(date -u) - could not connect via tor or could not run torbrowser at all. Aborting." fi BONUS_LEVEL_1="" URL="http://vwakviie2ienjx6t.onion/debian/" # see http://richardhartmann.de/blog/posts/2015/08/24-Tor-enabled_Debian_mirror/ echo "$(date -u) - pressing -l - about to enter $URL as URL." xvkbd -text "\Cl" > /dev/null 2>&1 sleep 3 xvkbd -text "$URL" > /dev/null 2>&1 sleep 1 xvkbd -text "\r" > /dev/null 2>&1 sleep 2 # allow up up to 76 seconds to load the url for i in $(seq 1 8) ; do sleep 5 ; sleep $i # ocr'ing README only sometimes works well and not so much with the new rendering URL_LOADED=$(gocr $WORKSPACE/screenshot.png 2>/dev/null | egrep -c '(README|RE_ADh1E|REnDmE)' || true) update_screenshot if [ $URL_LOADED -ge 4 ] ; then echo "$(date -u) - $URL loaded fine, very much an archive in there, great." BONUS_LEVEL_1="yes" break fi done # for debugging if [ $URL_LOADED -lt 4 ] ; then echo "$(date -u) - URL_LOADED = '$URL_LOADED' so probably that page didnt load properly." # extra debug, as rendering in sid has changed and thus gocr behaves differently… gocr $WORKSPACE/screenshot.png 2>/dev/null fi BONUS_LEVEL_2="" URL="https://www.debian.org" echo "$(date -u) - pressing -l - about to enter $URL as URL." xvkbd -text "\Cl" > /dev/null 2>&1 sleep 3 xvkbd -text "$URL" > /dev/null 2>&1 sleep 1 xvkbd -text "\r" > /dev/null 2>&1 sleep 2 # allow up up to 51 seconds to load the url for i in $(seq 1 6) ; do sleep 5 ; sleep $i URL_LOADED=$(gocr $WORKSPACE/screenshot.png 2>/dev/null | grep -c "Debian" || true) update_screenshot if [ $URL_LOADED -ge 6 ] ; then echo "$(date -u) - $URL loaded fine, very much Debian in there, great." BONUS_LEVEL_2="yes" break fi done # for debugging if [ $URL_LOADED -lt 6 ] ; then echo "$(date -u) - URL_LOADED = '$URL_LOADED'" fi if [ -n "$BONUS_LEVEL_1" ] && [ -n "$BONUS_LEVEL_2" ] ; then STATUS_MSG="Very well done." STATUS_COLORS="-bg green -fg black" elif [ -n "$BONUS_LEVEL_1" ] || [ -n "$BONUS_LEVEL_2" ] ; then STATUS_MSG="Well done." STATUS_COLORS="-bg lightgreen -fg black" else STATUS_MSG="" STATUS_COLORS="" fi # sleep is added here, so xterm + notification come up nicely schroot --run-session -c $SESSION --preserve-environment -- xterm -geometry 1024x230+0+520 $STATUS_COLORS -fa 'DejaVuSansMono' -fs 18 -hold -T '$(date +'%a %d %b')' -e "echo ; figlet -c -f banner -w 68 '$(date +'%a %d %b')'" 2>/dev/null || true & sleep 4 echo "'$(date -u) - torbrowser tests end. $STATUS_MSG'" | tee | xargs schroot --run-session -c $SESSION --preserve-environment -- notify-send sleep 0.5 update_screenshot echo "$(date -u) - telling awesome to quit." echo 'awesome.quit()' | schroot --run-session -c $SESSION --preserve-environment -- awesome-client sleep 0.5 schroot --run-session -c $SESSION --directory /tmp -u root -- service dbus stop sleep 1 echo "$(date -u ) - killing Xvfb and ffmpeg." kill $XPID $FFMPEGPID || true sleep 1 echo "$(date -u ) - Test ends." echo } merge_debian_branch() { local DEBIAN_GIT_URL="git://git.debian.org/pkg-privacy/packages/torbrowser-launcher.git" local DEBIAN_BRANCH="debian/$1" echo "$(date -u) - Merging branch $DEBIAN_BRANCH into $COMMIT_HASH now." echo git log -1 git checkout -b $BRANCH git remote add debian $DEBIAN_GIT_URL git fetch --no-tags debian git merge --no-stat --no-edit $DEBIAN_BRANCH local BUILD_VERSION="$(dpkg-parsechangelog |grep ^Version:|cut -d " " -f2).0~jenkins-test-$COMMIT_HASH" local COMMIT_MSG1="Automatically build by jenkins using the branch $DEBIAN_BRANCH (from $DEBIAN_GIT_URL) merged into $COMMIT_HASH." # GIT_URL AND GIT_BRANCH are set by jenkins local COMMIT_MSG2="$COMMIT_HASH is from branch $(echo $GIT_BRANCH|cut -d '/' -f2) from $GIT_URL." dch -R $COMMIT_MSG1 dch -v $BUILD_VERSION $COMMIT_MSG2 git commit -a -m "Automatically merged by jenkins." } prepare_git_workspace_copy() { echo "$(date -u) - preparing git workspace copy in $TMPDIR/git" git branch -av mkdir $TMPDIR/git cp -r .git* * $TMPDIR/git echo } revert_git_changes() { git reset --hard git checkout -f -q $COMMIT_HASH git branch -D $BRANCH } # # prepare # if [ -z "$1" ] ; then echo "call $0 with a suite as param." exit 1 elif [ "$1" = "broken_settings" ] ; then BROKEN_SETTINGS=true shift else BROKEN_SETTINGS=false fi if [ "$1" = "via_tor" ] ; then VIA_TOR=true shift else VIA_TOR=false fi SUITE=$1 UPGRADE_SUITE="" TMPDIR=$(mktemp -d -t torbrowser-launcher-XXXXXX) TBL_LOGFILE=$(mktemp -t torbrowser-launcher-XXXXXX) SESSION="tbb-launcher-$SUITE-$(basename $TMPDIR)" STARTTIME=$(date +%Y%m%d%H%M) VIDEO=test-torbrowser-${SUITE}_$STARTTIME.mpg SIZE=1024x768 SCREEN=$EXECUTOR_NUMBER if [ "$2" = "git" ] ; then if [ "$3" = "merge" ] ; then # merge debian branch into upstream master branch BRANCH=upstream-master-plus-debian-packaging COMMIT_HASH=$(git log -1 --oneline|cut -d " " -f1) merge_debian_branch $4 prepare_git_workspace_copy revert_git_changes else # just use this branch BRANCH=$3 prepare_git_workspace_copy fi elif [ "$SUITE" = "experimental" ] || [ "$2" = "experimental" ] ; then SUITE=unstable UPGRADE_SUITE=experimental elif [ "$2" = "unstable" ] ; then UPGRADE_SUITE=unstable elif [ "$2" = "stretch" ] ; then UPGRADE_SUITE=stretch elif [ "$2" = "backports" ] ; then UPGRADE_SUITE=$SUITE-backports fi WORKSPACE=$(pwd) RESULTS=$WORKSPACE/results rm -f $RESULTS/*.png $RESULTS/*.mpg [ ! -f screenshot.png ] || mv screenshot.png screenshot_from_git.png mkdir -p $RESULTS cd $TMPDIR # use trap to always clean up trap cleanup_all INT TERM EXIT # # main # echo "$(date -u) - testing torbrowser-launcher on $SUITE now." begin_session prepare_other_packages # the default is to test the packaged version from $SUITE # and there are two variations: if [ "$2" = "git" ] ; then upgrade_to_package_build_from_git $BRANCH elif [ -n "$UPGRADE_SUITE" ] ; then upgrade_to_newer_packaged_version_in $UPGRADE_SUITE fi download_and_launch end_session cleanup_duplicate_screenshots # the very end trap - INT TERM EXIT cleanup_all quiet echo "$(date -u) - the very end."