Dockerfile completed

Author: FedericoMulas

.dockerignore

@@ -1 +1,18 @@
+# hidden unused files
 .git
+.vscode
+.gitignore
+.travis.yml
+
+# unused folders
+docs
+test
+
+# unused script and files
+alive.bat
+browsers.ini.sample
+centos_install.sh
+ios_install.sh
+ubuntu_install.sh
+windows_install.ps1
+windows_post_reboot.ps1

Dockerfile

@@ -1,68 +1,51 @@
-### IMPORTANT DOCKER COMMANDS ###
+FROM ubuntu as production
 
-###     docker images                               - List images available
-###     docker build <GITHUB-REPO-LINK> -t TAGNAME  - Builds the Dockerfile from the github repo
-###     docker ps                                   - List running images
-###     docker stop <IMAGE ID || IMAGE NAME>        - Stops running image with either --name <IMAGE NAME> || IMAGE ID>
-###     docker run -it -d TAGNAME /bin/bash         - Runs bash
-###     docker exec -it <IMAGE ID> /bin/bash        - Connects to bash for terminal execution (Needs to be running first)
+# since we don't really need a stable base we can also upgrade
+RUN apt update && apt upgrade -y
 
-### EXAMPLE DOCKER COMMANDS FOR RUNNING SERVER & AGENT
-
-###     docker run -d -p 4000:80 <IMAGE ID || <IMAGE TAG>
-###     docker run -d -p 4001:80 --network="host" -e "SERVER_URL=http://localhost:4000/work/" -e "LOCATION=Test" -e "-v" <IMAGE ID || <IMAGE TAG>
-
-### INSTALLING METHOD ###
-
-###     Recommend to install with "docker build <GITHUB-REPO-LINK> -t TAGNAME",
-###     grabs the latest copy of WPT and build time on average takes 10 minutes. 
-
-FROM ubuntu
-
-### PREVENTs INTERACTIVE PROMPTS WHILE INSTALLING ###
-ARG DEBIAN_FRONTEND=noninteractive
-
-### COPYING ENTIRE DIR TO LOCAL DOCKER /wptagent
+# Get files
+# see .dockerignore for filterd out folders
 COPY / /wptagent
-RUN apt-get update
 
-# Git Clone Install
-# RUN apt-get install -y git
-# RUN git clone -b dockerfile https://github.com/sammeboy635/wptagent.git
+# dependencies
 
-### UPDATE ###
-RUN apt-get update 
+## apt dependencies (took them from https://github.com/WPO-Foundation/wptagent/blob/master/.github/workflows/wptagent_test.yml#L31)
+# split into 2 parts to show dependency gathered from docs and found during upgrade of the docker image
+# set UTC as default timezone before end to avoid user interaction for tzdata package
+RUN ln -fs /usr/share/zoneinfo/UTC /etc/localtime && \
+    DEBIAN_FRONTEND=noninteractive apt install -y pylint apt-transport-https xserver-xorg-video-dummy xvfb gnupg2 python3-ujson imagemagick \
+    dbus-x11 traceroute software-properties-common psmisc libnss3-tools iproute2 net-tools openvpn libtiff5-dev \
+    libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.6-dev tk8.6-dev python3-tk python3-dev \
+    libavutil-dev libmp3lame-dev libx264-dev yasm autoconf automake build-essential libass-dev libfreetype6-dev \
+    libtheora-dev libtool libvorbis-dev pkg-config texi2html libtext-unidecode-perl python3-numpy python3-scipy \
+    perl adb ethtool nodejs cmake libsdl2-dev libva-dev libvdpau-dev libxcb1-dev libxcb-shm0-dev libxcb-xfixes0-dev \
+    texinfo wget ttf-mscorefonts-installer fonts-noto fonts-roboto fonts-open-sans
+RUN apt install -y python3 python3-pip curl npm sudo
 
-### INSTALL APT-GET LIBS ###
-RUN xargs -a /wptagent/.github/workflows/docker-apt-get.txt apt-get install --no-install-recommends --yes; exit 0
 
-### UPGRADING PIP AND INSTALLING REQUIRED PACKAGES ###
-RUN python3 -m pip install --upgrade --user pip && \
-    python3 -m pip install --user -r /wptagent/.github/workflows/requirements.txt 
+## python dependencies
+# FIXME split requirements into dev requirements and release requirements
+RUN pip install -r /wptagent/.github/workflows/requirements.txt && rm -rf /wptagent/.github/
 
-### INSTALLING LIGHTHOUSE FROM NPM ###
+## npm dependencies
 RUN npm install -g lighthouse
 
-### INSTALLING CHROME BROWSER ###
-###     Fails to Find all libs needed to run
-# RUN wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && \
-#     dpkg -i google-chrome-stable_current_amd64.deb; exit 0 && \
-#     apt -f install -y && \
-#     apt-get install google-chrome-stable
+# install chrome, simplified version
+RUN curl -o google-chrome-stable_current_amd64.deb  https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb && \
+    apt install -y /google-chrome-stable_current_amd64.deb && rm /google-chrome-stable_current_amd64.deb
 
-### BETTER INSTALLING CHROME BROWSER METHOD ###
-###     Better Installing method but would like to change this to something less complex.
-RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
-    && echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list
-RUN apt-get update && apt-get -y install google-chrome-stable ; exit 0
-RUN apt-get update --fix-missing -y
-RUN apt-get install -f -y
+WORKDIR /wptagent
 
-### CLEAN UP ###
-#       We could add some clean up here but in testing it was negotiable
+ENTRYPOINT ["/bin/sh", "/wptagent/docker/linux-headless/entrypoint.sh"]
 
+# Create debug build that waits for a debugger to attach
+FROM production as debug
 
-WORKDIR /wptagent
+RUN pip install debugpy
+
+RUN mv wptagent.py wptagent_starter.py
+
+COPY wptagent_debug.py wptagent.py
 
-### /bin/bash LOCATION OF COMMAND EXECUTION ###
-CMD ["/bin/bash", "/wptagent/docker/linux-headless/entrypoint.sh"]
+# set production build as default
+FROM production

README.md

@@ -141,6 +141,33 @@ The test result is written as JSON to `stdout`. If a server, location, and key a
 - `--testruns`: Number of runs to test. Defaults to 1.
 - `--testrv`: Include repeat view (defaults to only testing first view)
 
+### Running the container
+
+The `Dokerfile`` has multi-stage definition:
+* **production**: Default stage, produce a image without debug features;
+* **debug**: When running the produced image the wptagent script will wait for a debug to.attach
+
+To build the production container
+```sh
+docker build --tag wptagent .
+```
+To build the debug container
+```sh
+docker build --target debug --tag wptagent -debug .
+```
+
+The entrypoint is `docker\linux-headless\entrypoint.sh` that has some of the above parameters as default: `--xvfb`, `--dockerized`.
+Mandatory parameters are required via environment variables:
+* **SERVER_URL**: corresponding to `--server` parameter;
+* **LOCATION**: corresponding to `--location` parameter.
+
+Additional parameters can be passed. A typical run in debug mode looks like this
+
+```sh
+docker run -e SERVER_URL=http://127.0.0.1:80/work/ -e LOCATION=Test wptagent-debug -vvvv --key 123456789
+```
+
+where `-vvvv` and `--key` are optional parameters passed to the wptagent script.
 ## Supported features
 
 The following [Script Commands](https://docs.webpagetest.org/scripting/) are supported on Windows, Linux, Mac, and Android:

docker/linux-headless/entrypoint.sh

@@ -1,6 +1,4 @@
 #!/bin/bash
-set -e
-
 if [ -z "$SERVER_URL" ]; then
   echo >&2 'SERVER_URL not set'
   exit 1
@@ -11,22 +9,6 @@ if [ -z "$LOCATION" ]; then
   exit 1
 fi
 
-if [ -z "$EXTRA_ARGS" ]; then
-  EXTRA_ARGS=""
-fi
-
-if [ -n "$NAME" ]; then
-  EXTRA_ARGS="$EXTRA_ARGS --name $NAME"
-fi
-
-if [ -n "$KEY" ]; then
-  EXTRA_ARGS="$EXTRA_ARGS --key $KEY"
-fi
-
-if [ -n "$SHAPER" ]; then
-  EXTRA_ARGS="$EXTRA_ARGS --shaper $SHAPER"
-fi
-
 # exec replaces the shell process by the python process and is required to
 # propagate signals (i.e. SIGTERM)
-exec python3 /wptagent/wptagent.py --server "${SERVER_URL}" --location "${LOCATION}" ${EXTRA_ARGS} --xvfb --dockerized -vvvv
+exec python3 /wptagent/wptagent.py --server "${SERVER_URL}" --location "${LOCATION}" --xvfb --dockerized "$@"

wptagent_debug.py

@@ -0,0 +1,16 @@
+import debugpy
+import os
+# first try to import with the original name
+try:
+   from wptagent import main
+except ImportError:
+    # then import as the contianer require
+    from wptagent_starter import main
+
+if __name__ == '__main__':
+    print("Waiting for debug")
+    debugpy.listen(("0.0.0.0", 50000))
+    debugpy.wait_for_client()
+    main()
+    # Force a hard exit so unclean threads can't hang the agent
+    os._exit(0)