Merge pull request #4288 from rmol/ft-vnc

Extract VNC changes from Tor Browser functional test branch

devops/scripts/vnc-docker-connect.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+# shellcheck disable=SC2086
+#
+#
+# Connect to a docker test instance's VNC session
+
+set -e
+
+# Bomb out if container not running
+docker inspect securedrop-dev >/dev/null 2>&1 || (echo "ERROR: SD container not running."; exit 1)
+
+# Maybe we are running macOS
+if [ "$(uname -s)" == "Darwin" ]; then
+    open "vnc://${USER}:[email protected]:5901" &
+    exit 0
+fi
+
+# Find our securedrop docker ip
+SD_DOCKER_IP="$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' securedrop-dev)"
+
+# Quit if the VNC port not found
+nc -w5 -z "$SD_DOCKER_IP" 5901 || (echo "ERROR: VNC server not found"; exit 1)
+
+if [ ! "$(which remote-viewer)" ]
+then
+    printf "\nError: We use the remote-viewer utility to reach Docker via VNC,\n"
+    printf "and it is not installed. On Debian or Ubuntu, install it with\n"
+    printf "'sudo apt install virt-viewer', or if you use another VNC client,\n"
+    printf "consider adding it to this script:\n"
+    printf "\n%s\n\n" "$(realpath $0)"
+    printf "and submitting a pull request.\n\n"
+    exit 1
+fi
+
+rv_config="${TMPDIR:-/tmp}/func-vnc.ini"
+echo -e "[virt-viewer]\ntype=vnc\nhost=${SD_DOCKER_IP}\nport=5901\npassword=freedom" > "${rv_config}"
+remote-viewer "${rv_config}" 2>/dev/null &

securedrop/Makefile

@@ -57,6 +57,10 @@ translate: ## Update POT translation files from sources
 	./bin/dev-shell ./i18n_tool.py translate-messages --extract-update
 	./bin/dev-shell ./i18n_tool.py translate-desktop --extract-update
 
+.PHONY: func-vnc
+func-vnc: ## Open up a VNC connection to a running docker instance
+	../devops/scripts/vnc-docker-connect.sh
+
 # For an explanation of this shell magic, see the Makefile in the root of the repository
 .PHONY: help
 help: ## Print this message and exit.

securedrop/bin/dev-deps

@@ -3,15 +3,27 @@
 export DISPLAY=:1
 
 function run_xvfb() {
-    setsid Xvfb :1 -screen 0 1024x768x24 -ac +extension GLX +render -noreset >& /tmp/xvfb.out || cat /tmp/xvfb.out
+    (setsid Xvfb :1 -screen 0 1024x768x24 -ac +extension GLX +render -noreset >& /tmp/xvfb.out || cat /tmp/xvfb.out) &
+
+    # give it time to start
+    for _ in {1..10}
+    do
+        xdpyinfo -display :1 >/dev/null 2>&1 && return 0
+        sleep 1
+    done
+    xdpyinfo -display :1 >/dev/null 2>&1 || (echo "Xvfb is not available"; exit 1)
 }
 
 function run_redis() {
     setsid redis-server >& /tmp/redis.out || cat /tmp/redis.out
 }
 
+function setup_vncauth {
+    x11vnc -storepasswd freedom /tmp/vncpasswd
+}
+
 function run_x11vnc() {
-    setsid x11vnc -display :1 -autoport 5901 -shared >& /tmp/x11vnc.out || cat /tmp/x11vnc.out
+    setsid x11vnc -display :1 -geometry 1024x768 -rfbauth /tmp/vncpasswd -rfbport 5901 -shared >& /tmp/x11vnc.out || cat /tmp/x11vnc.out
 }
 
 function urandom() {

securedrop/bin/dev-shell

@@ -28,8 +28,8 @@ function docker_image() {
 
     docker build \
            ${DOCKER_BUILD_ARGUMENTS:-} \
-	   --build-arg=USER_ID="$(id -u)" \
-	   --build-arg=USER_NAME="${USER:-root}" \
+       --build-arg=USER_ID="$(id -u)" \
+       --build-arg=USER_NAME="${USER:-root}" \
            -t "securedrop-test-${1}" \
        --file "${TOPLEVEL}/securedrop/dockerfiles/${1}/Dockerfile" \
        "${TOPLEVEL}/securedrop"
@@ -40,12 +40,14 @@ function docker_run() {
 
     find . \( -name '*.pyc' -o -name __pycache__ \) -delete
     docker run \
-	   --rm \
+       -p 127.0.0.1:5901:5901 \
+       --rm \
        -e NUM_SOURCES \
-	   --user "${USER:-root}" \
-	   --volume "${TOPLEVEL}:${TOPLEVEL}" \
-	   --workdir "${TOPLEVEL}/securedrop" \
-	   -ti ${DOCKER_RUN_ARGUMENTS:-} "securedrop-test-${1}" "${@:2}"
+       --user "${USER:-root}" \
+       --volume "${TOPLEVEL}:${TOPLEVEL}" \
+       --workdir "${TOPLEVEL}/securedrop" \
+       --name securedrop-dev \
+       -ti ${DOCKER_RUN_ARGUMENTS:-} "securedrop-test-${1}" "${@:2}"
 }
 
 if test -n "${CIRCLE_SHA1:-}" ; then

securedrop/bin/run

@@ -7,7 +7,6 @@ source "${BASH_SOURCE%/*}/dev-deps"
 
 run_xvfb &
 run_redis &
-run_x11vnc &
 urandom
 run_sass --watch &
 maybe_create_config_py

securedrop/bin/run-test

@@ -5,8 +5,10 @@ set -euo pipefail
 
 source "${BASH_SOURCE%/*}/dev-deps"
 
-run_xvfb &
+run_xvfb
 run_redis &
+setup_vncauth
+run_x11vnc &
 urandom
 run_sass --force --update
 maybe_create_config_py

securedrop/dockerfiles/trusty/Dockerfile

@@ -1,5 +1,5 @@
-# ubuntu:14.04 as of 2019-01-22
-FROM ubuntu@sha256:cac55e5d97fad634d954d00a5c2a56d80576a08dcc01036011f26b88263f1578
+# ubuntu 14.04 image from 2019-03-12
+FROM ubuntu@sha256:6612de24437f6f01d6a2988ed9a36b3603df06e8d2c0493678f3ee696bc4bb2d
 ARG USER_NAME
 ENV USER_NAME ${USER_NAME:-root}
 ARG USER_ID

securedrop/dockerfiles/xenial/Dockerfile

@@ -1,5 +1,5 @@
-# ubuntu 16.04 image - 2019-01-22
-FROM ubuntu@sha256:e4a134999bea4abb4a27bc437e6118fdddfb172e1b9d683129b74d254af51675
+# ubuntu 16.04 image from 2019-03-12
+FROM ubuntu@sha256:58d0da8bc2f434983c6ca4713b08be00ff5586eb5cdff47bcde4b2e88fd40f88
 ARG USER_NAME
 ENV USER_NAME ${USER_NAME:-root}
 ARG USER_ID
@@ -14,7 +14,8 @@ RUN apt-get update && \
 RUN apt-get install -y devscripts vim \
                        python-pip libpython2.7-dev libssl-dev secure-delete \
                        gnupg2 ruby redis-server firefox git xvfb haveged curl \
-                       gettext paxctl x11vnc enchant libffi-dev sqlite3 gettext sudo
+                       gettext paxctl x11vnc enchant libffi-dev sqlite3 gettext sudo \
+                       libgtk2.0
 
 ENV FIREFOX_CHECKSUM=88d25053306d33658580973b063cd459a56e3596a3a298c1fb8ab1d52171d860
 RUN curl -LO https://launchpad.net/~ubuntu-mozilla-security/+archive/ubuntu/ppa/+build/9727836/+files/firefox_46.0.1+build1-0ubuntu0.14.04.3_amd64.deb && \