test(*): Add end to end tests

Author: julienloizelet

.github/workflows/test-suite.yml

@@ -24,12 +24,14 @@ jobs:
           repository: julienloizelet/ddev-php
 
       - name: Install DDEV
+        env:
+          DDEV_VERSION: v1.18.2
         run: |
           # @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
           sudo apt-get -qq update
           sudo apt-get -qq -y install libnss3-tools
           curl -LO https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh
-          bash install_ddev.sh
+          bash install_ddev.sh ${{env.DDEV_VERSION}}
           ddev config global --instrumentation-opt-in=false --omit-containers=dba,ddev-ssh-agent
           rm install_ddev.sh
 
@@ -44,13 +46,16 @@ jobs:
         run: |
           cp .ddev/config_overrides/config.${{ env.PHP_VERSION_CODE }}.yaml .ddev/config.${{ env.PHP_VERSION_CODE }}.yaml
           cp .ddev/additional_docker_compose/docker-compose.crowdsec.yaml .ddev/docker-compose.crowdsec.yaml
+          cp .ddev/additional_docker_compose/docker-compose.playwright.yaml .ddev/docker-compose.playwright.yaml
           ddev start
+          ddev --version
           ddev exec php -v
           
 
-      - name: Set BOUNCER_KEY env
+      - name: Set BOUNCER_KEY and PROXY_IP env
         run: |
-          echo "BOUNCER_KEY=$(ddev create-bouncer)" >> $GITHUB_ENV    
+          echo "BOUNCER_KEY=$(ddev create-bouncer)" >> $GITHUB_ENV
+          echo "PROXY_IP=$(ddev find-ip ddev-router)" >> $GITHUB_ENV
 
 
       - name: Clone PHP lib Crowdsec files
@@ -63,10 +68,29 @@ jobs:
           ddev composer update --working-dir ./my-own-modules/crowdsec-php-lib
 
 
-      - name: PHP UNIT
+      - name: Run PHP UNIT tests
         run: |
           ddev create-watcher PhpUnitTestMachine PhpUnitTestMachinePassword
           ddev exec BOUNCER_KEY=${{ env.BOUNCER_KEY }} LAPI_URL=http://crowdsec:8080 MEMCACHED_DSN=memcached://memcached:11211 REDIS_DSN=redis://redis:6379 /usr/bin/php ./my-own-modules/crowdsec-php-lib/vendor/bin/phpunit --testdox --colors --exclude-group ignore ./my-own-modules/crowdsec-php-lib/tests/IpVerificationTest.php
 
-
+      - name: Prepare END TO END tests
+        run: |
+          ddev create-watcher
+          cd ${{ github.workspace }}/.ddev
+          ddev crowdsec-prepend-nginx
+          cd ${{ github.workspace }}
+          cp .ddev/custom_files/crowdsec-lib-settings.php crowdsec-lib-settings.php
+          sed -i -e 's/REPLACE_API_KEY/${{ env.BOUNCER_KEY }}/g' crowdsec-lib-settings.php
+          sed -i -e 's/REPLACE_PROXY_IP/${{ env.PROXY_IP }}/g' crowdsec-lib-settings.php
+          mv crowdsec-lib-settings.php my-own-modules/crowdsec-php-lib/examples/auto-prepend/settings.php
+          cd ${{ github.workspace }}/my-own-modules/crowdsec-php-lib/tests/end-to-end/__scripts__
+          chmod +x test-init.sh
+          ./test-init.sh
+          chmod +x run-tests.sh
+            
+      - name: Run End to end test
+        run: |
+          cd ${{ github.workspace }}/my-own-modules/crowdsec-php-lib/tests/end-to-end/__scripts__
+          ./run-tests.sh ci "./__tests__/1-live-mode.js"
+      
 

docs/ddev.md

@@ -267,13 +267,6 @@ Before using the bouncer in a standalone mode (i.e. with an auto-prepend directi
 `examples/auto-prepend/settings.example.php` file to a `examples/auto-prepend/settings.php` and edit it depending on 
 your needs.
 
-And you need also to have functional php website sources under your `php-project-sources` folder. For a quick test, 
-you could just create a `php-project-sources/index.php` with the following content;
-```php
-<?php
-
-echo "This is HOMEPAGE";
-```
 
 Then, to configure the Nginx service in order that it uses an auto-prepend directive pointing to the 
 `examples/auto-prepend/scripts/bounce-via-auto-prepend.php` script, please run the 
@@ -286,4 +279,46 @@ ddev crowdsec-prepend-nginx
 
 
 With that done, every access to your ddev url (i.e. `https://phpXX.ddev.site` where `XX` is your php version) will 
-be bounce
+be bounce.
+
+For example, you should try to browse the following url:
+
+```
+https://phpXX.ddev.site/my-own-modules/crowdsec-php-lib/examples/auto-prepend/public/protected-page.php
+```
+
+#### End to end tests
+
+In auto-prepend mode, you can run some end to end tests. 
+
+We are using a Jest/Playwright Node.js stack to launch a suite of end-to-end tests.
+
+Tests code is in the `tests/end-to-end` folder. You should have to `chmod +x` the scripts you will find in  
+`tests/end-to-end/__scripts__`.
+
+
+Then you can use the `run-test.sh` script to run the tests:
+
+- the first parameter specifies if you want to run the test on your machine (`host`) or in the
+  docker containers (`docker`). You can also use `ci` if you want to have the same behavior as in Github action.
+- the second parameter list the test files you want to execute. If empty, all the test suite will be launched.
+
+For example:
+
+    ./run-tests.sh host "./__tests__/1-live-mode.js"
+    ./run-tests.sh docker "./__tests__/1-live-mode.js" 
+    ./run-tests.sh host
+
+Before testing with the `docker` or `ci` parameter, you have to install all the required dependencies
+in the playwright container with this command :
+
+    ./test-init.sh
+
+If you want to test with the `host` parameter, you will have to install manually all the required dependencies:
+
+```
+yarn --cwd ./tests/end-to-end --force
+yarn global add cross-env
+```
+ 
+

examples/auto-prepend/public/protected-page.php

@@ -1,2 +1,16 @@
-<h1>The way is clear!</h1>
-<p>In this example page, if you can see this text, the bouncer considers your IP as clean.</p>
+<?php
+
+echo '
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8"/>
+    <title>Home page</title>
+</head>
+
+<body>
+    <h1>The way is clear!</h1>
+    <p>In this example page, if you can see this text, the bouncer considers your IP as clean.</p>
+</body>
+</html>
+';

tests/end-to-end/.eslintignore

@@ -0,0 +1 @@
+node_modules

tests/end-to-end/.eslintrc

@@ -0,0 +1,20 @@
+{
+    "parserOptions": {
+        // Required for certain syntax usages
+        "ecmaVersion": 2018
+    },
+    "extends": [
+        "eslint:recommended",
+        "airbnb-base",
+        "plugin:prettier/recommended"
+    ],
+    "rules": {
+        "no-unused-vars": 1,
+        "no-underscore-dangle": 0,
+        "import/no-dynamic-require": 0,
+        "no-console": [1, { "allow": ["warn", "error", "debug"] }]
+    },
+    "env": {
+        "jest": true
+    }
+}

tests/end-to-end/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+.cookies.json
+.test-results-*.json
+*.lock
+*.log
+*.jpg

tests/end-to-end/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "semi": true,
+    "trailingComma": "all",
+    "printWidth": 80,
+    "tabWidth": 4
+}

tests/end-to-end/CustomEnvironment.js

@@ -0,0 +1,30 @@
+const PlaywrightEnvironment =
+    require("jest-playwright-preset/lib/PlaywrightEnvironment").default;
+
+class CustomEnvironment extends PlaywrightEnvironment {
+    async handleTestEvent(event) {
+        if (process.env.FAIL_FAST) {
+            if (
+                event.name === "hook_failure" ||
+                event.name === "test_fn_failure"
+            ) {
+                this.failedTest = true;
+                const buffer = await this.global.page.screenshot({
+                    path: "screenshot.jpg",
+                    type: "jpeg",
+                    quality: 20,
+                });
+                console.debug("Screenshot:", buffer.toString("base64"));
+            } else if (this.failedTest && event.name === "test_start") {
+                // eslint-disable-next-line no-param-reassign
+                event.test.mode = "skip";
+            }
+        }
+
+        if (super.handleTestEvent) {
+            await super.handleTestEvent(event);
+        }
+    }
+}
+
+module.exports = CustomEnvironment;

tests/end-to-end/__scripts__/run-tests.sh

@@ -0,0 +1,114 @@
+#!/bin/bash
+# Run test suite
+# Usage: ./run-tests.sh  <type>  <file-list>
+# type : host, docker or ci (default: host)
+# file-list : a list of test files (default: empty so it will run all the tests)
+# Example: ./run-tests.sh docker "./__tests__/1-live-mode.js"
+
+YELLOW='\033[33m'
+RESET='\033[0m'
+if ! ddev --version >/dev/null 2>&1; then
+    printf "${YELLOW}Ddev is required for this script. Please see docs/ddev.md.${RESET}\n"
+    exit 1
+fi
+
+
+TYPE=${1:-host}
+FILE_LIST=${2:-""}
+
+
+case $TYPE in
+  "host")
+    echo "Running with host stack"
+    ;;
+
+  "docker")
+    echo "Running with ddev docker stack"
+    ;;
+
+
+  "ci")
+    echo "Running in CI context"
+    ;;
+
+  *)
+    echo "Unknown param '${TYPE}'"
+    echo "Usage: ./run-tests.sh  <type>  <file-list>"
+    exit 1
+    ;;
+esac
+
+
+HOSTNAME=$(ddev exec printenv DDEV_HOSTNAME | sed 's/\r//g')
+PHPVERSION=$(ddev exec printenv DDEV_PROJECT | sed 's/\r//g')
+PHP_URL=https://$HOSTNAME
+PROXY_IP=$(ddev find-ip ddev-router)
+BOUNCER_KEY=$(ddev exec grep "'api_key'" /var/www/html/my-own-modules/crowdsec-php-lib/examples/auto-prepend/settings.php | sed 's/api_key//g' | sed -e 's|[=>,"'\'']||g'  | sed s/'\s'//g)
+JEST_PARAMS="--bail=true  --runInBand --verbose"
+# If FAIL_FAST, will exit on first individual test fail
+# @see CustomEnvironment.js
+FAIL_FAST=true
+
+
+case $TYPE in
+  "host")
+    cd "../"
+    DEBUG_STRING="PWDEBUG=1"
+    YARN_PATH="./"
+    COMMAND="yarn --cwd ${YARN_PATH} cross-env"
+    LAPI_URL_FROM_PLAYWRIGHT=http://$HOSTNAME:8080
+    CURRENT_IP=$(ddev find-ip host)
+    TIMEOUT=31000
+    HEADLESS=false
+    SLOWMO=150
+    ;;
+
+  "docker")
+    DEBUG_STRING=""
+    YARN_PATH="./var/www/html/my-own-modules/crowdsec-php-lib/tests/end-to-end"
+    COMMAND="ddev exec -s playwright yarn --cwd ${YARN_PATH} cross-env"
+    LAPI_URL_FROM_PLAYWRIGHT=http://crowdsec:8080
+    CURRENT_IP=$(ddev find-ip playwright)
+    TIMEOUT=31000
+    HEADLESS=true
+    SLOWMO=0
+    ;;
+
+  "ci")
+    DEBUG_STRING="DEBUG=pw:api"
+    YARN_PATH="./var/www/html/my-own-modules/crowdsec-php-lib/tests/end-to-end"
+    COMMAND="ddev exec -s playwright xvfb-run --auto-servernum -- yarn --cwd ${YARN_PATH} cross-env"
+    LAPI_URL_FROM_PLAYWRIGHT=http://crowdsec:8080
+    CURRENT_IP=$(ddev find-ip playwright)
+    TIMEOUT=60000
+    HEADLESS=true
+    SLOWMO=0
+    ;;
+
+  *)
+    echo "Unknown param '${TYPE}'"
+    echo "Usage: ./run-tests.sh  <type>  <file-list>"
+    exit 1
+    ;;
+esac
+
+
+
+# Run command
+
+$COMMAND \
+PHP_URL=$PHP_URL \
+$DEBUG_STRING \
+BOUNCER_KEY=$BOUNCER_KEY \
+PROXY_IP=$PROXY_IP  \
+LAPI_URL_FROM_PLAYWRIGHT=$LAPI_URL_FROM_PLAYWRIGHT \
+CURRENT_IP=$CURRENT_IP \
+TIMEOUT=$TIMEOUT \
+HEADLESS=$HEADLESS \
+FAIL_FAST=$FAIL_FAST \
+SLOWMO=$SLOWMO \
+yarn --cwd $YARN_PATH test \
+    $JEST_PARAMS \
+    --json \
+    --outputFile=./.test-results-$PHPVERSION.json \
+    $FILE_LIST

tests/end-to-end/__scripts__/test-init.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+# Prepare Playwright container before testing
+# Usage : ./test-init.sh
+
+YELLOW='\033[33m'
+RESET='\033[0m'
+if ! ddev --version >/dev/null 2>&1; then
+    printf "${YELLOW}Ddev is required for this script. Please see docs/ddev.md.${RESET}\n"
+    exit 1
+fi
+
+ddev exec -s playwright yarn --cwd ./var/www/html/my-own-modules/crowdsec-php-lib/tests/end-to-end --force && \
+ddev exec -s playwright yarn global add cross-env