Add GUI tests

Author: GuillaumeGomez

.github/workflows/ci.yml

@@ -123,6 +123,9 @@ jobs:
             $f || exit 1
           done
 
+      - name: Run GUI tests
+        run: ./dockerfiles/run-gui-tests.sh
+
       - name: Clean up the database
         run: docker-compose down --volumes
 

README.md

@@ -100,6 +100,15 @@ Note that you will need docker installed no matter what, since it's used for Rus
 cargo test
 ```
 
+To run GUI tests:
+
+```
+./dockerfiles/run-gui-tests.sh
+```
+
+They use the [browser-ui-test](https://github.com/GuillaumeGomez/browser-UI-test/) framework. You
+can take a look at its documentation [here](https://github.com/GuillaumeGomez/browser-UI-test/blob/master/goml-script.md).
+
 ### Pure docker-compose
 
 If you have trouble with the above commands, consider using `docker-compose up --build`,

docker-compose.yml

@@ -90,6 +90,16 @@ services:
             timeout: 5s
             retries: 10
 
+    gui_tests:
+        build:
+            context: .
+            dockerfile: ./dockerfiles/Dockerfile-gui-tests
+        network_mode: "host"
+        extra_hosts:
+            - "host.docker.internal:host-gateway"
+        volumes:
+            - "${PWD}:/build/out"
+
 volumes:
     postgres-data: {}
     minio-data: {}

dockerfiles/Dockerfile-gui-tests

@@ -0,0 +1,87 @@
+FROM ubuntu:22.04 AS build
+
+# Install packaged dependencies
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    build-essential git curl cmake gcc g++ pkg-config libmagic-dev \
+    libssl-dev zlib1g-dev ca-certificates
+
+# Install the stable toolchain with rustup
+RUN curl https://sh.rustup.rs >/tmp/rustup-init && \
+    chmod +x /tmp/rustup-init && \
+    /tmp/rustup-init -y --no-modify-path --default-toolchain stable --profile minimal
+ENV PATH=/root/.cargo/bin:$PATH
+
+RUN apt-get update && apt-get install -y \
+  ca-certificates \
+  curl \
+  docker.io \
+  gcc \
+  git \
+  libssl-dev \
+  pkg-config \
+  xz-utils
+
+# Install dependencies for chromium browser
+RUN apt-get install -y \
+  gconf-service \
+  libasound2 \
+  libatk1.0-0 \
+  libatk-bridge2.0-0 \
+  libc6 \
+  libcairo2 \
+  libcups2 \
+  libdbus-1-3 \
+  libexpat1 \
+  libfontconfig1 \
+  libgbm-dev \
+  libgcc1 \
+  libgconf-2-4 \
+  libgdk-pixbuf2.0-0 \
+  libglib2.0-0 \
+  libgtk-3-0 \
+  libnspr4 \
+  libpango-1.0-0 \
+  libpangocairo-1.0-0 \
+  libstdc++6 \
+  libx11-6 \
+  libx11-xcb1 \
+  libxcb1 \
+  libxcomposite1 \
+  libxcursor1 \
+  libxdamage1 \
+  libxext6 \
+  libxfixes3 \
+  libxi6 \
+  libxrandr2 \
+  libxrender1 \
+  libxss1 \
+  libxtst6 \
+  fonts-liberation \
+  libappindicator1 \
+  libnss3 \
+  lsb-release \
+  xdg-utils \
+  wget
+
+# Install rust
+RUN curl https://sh.rustup.rs -sSf | bash -s -- -y --default-toolchain nightly --no-modify-path --profile minimal
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+RUN curl -sL https://nodejs.org/dist/v14.4.0/node-v14.4.0-linux-x64.tar.xz | tar -xJ
+ENV PATH="/node-v14.4.0-linux-x64/bin:${PATH}"
+ENV NODE_PATH="/node-v14.4.0-linux-x64/lib/node_modules/"
+
+WORKDIR /build
+
+RUN mkdir out
+
+# For now, we need to use `--unsafe-perm=true` to go around an issue when npm tries
+# to create a new folder. For reference:
+# https://github.com/puppeteer/puppeteer/issues/375
+#
+# We also specify the version in case we need to update it to go around cache limitations.
+RUN npm install -g [email protected] --unsafe-perm=true
+
+EXPOSE 3000
+
+CMD ["node", "/build/out/gui-tests/tester.js"]

dockerfiles/run-gui-tests.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+# Just in case it's running, we stop the web server.
+docker-compose stop web
+
+docker-compose up -d db s3
+
+# We add the information we need.
+cargo run -- database migrate
+docker-compose run web build crate sysinfo 0.23.4
+docker-compose run web build crate sysinfo 0.23.5
+docker-compose run web build add-essential-files
+docker-compose build web
+
+# In case we don't have a `.env`, we create one.
+if [ ! -f .env ]
+then
+cp .env.sample .env
+source .env
+fi
+
+docker-compose up -d web
+
+cargo run -- start-web-server &
+SERVER_PID=$!
+
+docker build . -f dockerfiles/Dockerfile-gui-tests -t gui_tests
+
+echo "Sleeping a bit to be sure the web server will be started..."
+sleep 5
+
+# status="docker run . -v `pwd`:/build/out:ro gui_tests"
+docker-compose run gui_tests
+status=$?
+kill -9 $SERVER_PID
+exit $status

gui-tests/404.goml

@@ -0,0 +1,3 @@
+// Checks the content of the 404 page.
+goto: |DOC_PATH|/non-existing-crate
+assert-text: ("#crate-title", "The requested crate does not exist")

gui-tests/basic.goml

@@ -0,0 +1,12 @@
+// Checks that the "latest" URL leads us to the last version of the `sysinfo` crate.
+goto: |DOC_PATH|/sysinfo
+// We first check if the redirection worked as expected:
+assert-document-property: ({"URL": "/sysinfo/latest/sysinfo/"}, ENDS_WITH)
+assert: "//*[@class='title' and text()='sysinfo-0.23.5']"
+// And we also confirm we're on a rustdoc page.
+assert: "#rustdoc_body_wrapper"
+
+// Let's go to the docs.rs page of the crate.
+goto: |DOC_PATH|/crate/sysinfo/latest
+assert-false: "#rustdoc_body_wrapper"
+assert-text: ("#crate-title", "sysinfo 0.23.5", CONTAINS)