Merge pull request #32419 from woocommerce/e2e/db-healthcheck

Only start PHP containers after a successful healthcheck against DB
2022-04-04 04:09:24 -05:00 · 2022-04-04 04:09:24 -05:00 · 8812feedaa
parent feba6a8dcd 3253b1222f
commit 8812feedaa
7 changed files with 58 additions and 295 deletions
--- a/.github/workflows/pr-build-and-e2e-tests.yml
+++ b/.github/workflows/pr-build-and-e2e-tests.yml
@ -45,16 +45,6 @@ jobs:
              with:
                  path: package/woocommerce

-            - name: Install PNPM and install dependencies
-              working-directory: package/woocommerce
-              run: |
-                  npm install -g pnpm
-                  pnpm install
-
-            - name: Load docker images and start containers.
-              working-directory: package/woocommerce/plugins/woocommerce
-              run: pnpx wc-e2e docker:up
-
            - name: Move current directory to code. We will install zip file in this dir later.
              run: mv ./package/woocommerce/plugins/woocommerce/* ./code/woocommerce

@ -70,12 +60,16 @@ jobs:
                  unzip woocommerce.zip -d woocommerce
                  mv woocommerce/woocommerce/* ../package/woocommerce/plugins/woocommerce/

-            - name: Install dependencies again
+            - name: Install dependencies
              working-directory: package/woocommerce
              run: |
                  npm install -g pnpm
                  pnpm install

+            - name: Load docker images and start containers.
+              working-directory: package/woocommerce/plugins/woocommerce
+              run: pnpx wc-e2e docker:up
+
            - name: Run tests command.
              working-directory: package/woocommerce/plugins/woocommerce
              env:
@ -110,16 +104,6 @@ jobs:
              with:
                  path: package/woocommerce

-            - name: Install PNPM and install dependencies
-              working-directory: package/woocommerce
-              run: |
-                  npm install -g pnpm
-                  pnpm install
-
-            - name: Load docker images and start containers.
-              working-directory: package/woocommerce/plugins/woocommerce
-              run: pnpx wc-e2e docker:up
-
            - name: Move current directory to code. We will install zip file in this dir later.
              run: mv ./package/woocommerce/plugins/woocommerce/* ./code/woocommerce

@ -135,12 +119,16 @@ jobs:
                  unzip woocommerce.zip -d woocommerce
                  mv woocommerce/woocommerce/* ../package/woocommerce/plugins/woocommerce/

-            - name: Install dependencies again
+            - name: Install dependencies
              working-directory: package/woocommerce
              run: |
                  npm install -g pnpm
                  pnpm install

+            - name: Load docker images and start containers.
+              working-directory: package/woocommerce/plugins/woocommerce
+              run: pnpx wc-e2e docker:up
+
            - name: Run tests command.
              working-directory: package/woocommerce/plugins/woocommerce
              env:
@ -174,21 +162,6 @@ jobs:
              with:
                  path: package/woocommerce

-            - name: Install PNPM and install dependencies
-              working-directory: package/woocommerce
-              run: |
-                  npm install -g pnpm
-                  pnpm install
-
-            - name: Workaround to use initialization file with prepopulated data.
-              working-directory: package/woocommerce/plugins/woocommerce/tests/e2e/docker
-              run: |
-                  cp init-sample-products.sh initialize.sh
-
-            - name: Load docker images and start containers.
-              working-directory: package/woocommerce/plugins/woocommerce
-              run: pnpx wc-e2e docker:up
-
            - name: Move current directory to code. We will install zip file in this dir later.
              run: mv ./package/woocommerce/plugins/woocommerce/* ./code/woocommerce

@ -204,15 +177,20 @@ jobs:
                  unzip woocommerce.zip -d woocommerce
                  mv woocommerce/woocommerce/* ../package/woocommerce/plugins/woocommerce/

-            - name: Install dependencies again
+            - name: Install dependencies
              working-directory: package/woocommerce
              run: |
                  npm install -g pnpm
                  pnpm install
-
-            - name: Wait for the Docker container to be built
+            
+            - name: Workaround to use initialization file with prepopulated data.
+              working-directory: package/woocommerce/plugins/woocommerce/tests/e2e/docker
+              run: |
+                  cp init-sample-products.sh initialize.sh
+            
+            - name: Load docker images and start containers.
              working-directory: package/woocommerce/plugins/woocommerce
-              run: pnpx wc-e2e docker:wait
+              run: pnpx wc-e2e docker:up

            - name: Install k6
              run: |
--- a/packages/js/e2e-environment/CHANGELOG.md
+++ b/packages/js/e2e-environment/CHANGELOG.md
@ -1,5 +1,10 @@
 # Unreleased

+## Fixed
+- Removed the restart policy from e2e containers
+- Makes sure that the php containers are only spun up when the db containers is healthy and ready to accept connections
+- Wait for WordPress itself to be "healthy and ready" when running `pnpm docker:up`
+
 ## Changed
 - Updated `resolveSingleE2EPath` 
  - it resolves the full path if the filePath is valid
--- a/packages/js/e2e-environment/bin/wc-e2e.sh
+++ b/packages/js/e2e-environment/bin/wc-e2e.sh
@ -49,7 +49,7 @@ fi
 # Run scripts
 case $1 in
 	'docker:up')
-		./bin/docker-compose.sh up $2
+		./bin/docker-compose.sh up $2 && ./bin/wait-for-build.sh
 		;;
 	'docker:wait')
 		./bin/wait-for-build.sh
--- a/packages/js/e2e-environment/docker-compose.yaml
+++ b/packages/js/e2e-environment/docker-compose.yaml
@ -1,11 +1,10 @@
-version: '3.3'
+version: '3.8'

 services:

  db:
    container_name: "${APP_NAME}_db"
    image: mariadb:${DC_MARIADB_VERSION}
-    restart: on-failure
    environment:
      MYSQL_DATABASE: ${WORDPRESS_DB_NAME}
      MYSQL_USER: ${WORDPRESS_DB_USER}
@ -13,19 +12,26 @@ services:
      MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
    volumes:
      - db:/var/lib/mysql
+    healthcheck:
+        test: ["CMD-SHELL", "mysqladmin ping -P 3306 --user=${WORDPRESS_DB_USER} --password=${WORDPRESS_DB_PASSWORD} | grep 'mysqld is alive' || exit 1"]
+        interval: 2s
+        retries: 30

  php:
    container_name: "${APP_NAME}_php"
    image: php:${DC_PHP_VERSION}
+    depends_on:
+        db:
+            condition: service_healthy

  wordpress-www:
    container_name: "${APP_NAME}_wordpress-www"
    depends_on:
-      - db
+        db:
+            condition: service_healthy
    image: wordpress:${WORDPRESS_VERSION}
    ports:
      - ${WORDPRESS_PORT}:80
-    restart: on-failure
    environment:
      WORDPRESS_DB_HOST: ${WORDPRESS_DB_HOST}
      WORDPRESS_DB_NAME: ${WORDPRESS_DB_NAME}
@ -41,11 +47,9 @@ services:
  wordpress-cli:
    container_name: "${APP_NAME}_wordpress-cli"
    depends_on:
-      - db
-      - wordpress-www
+        - wordpress-www
    build:
        context: ./docker/wp-cli
-    restart: on-failure
    environment:
        WORDPRESS_PORT: ${WORDPRESS_PORT}
        WORDPRESS_HOST: wordpress-www:80
--- a/packages/js/e2e-environment/docker/wp-cli/Dockerfile
+++ b/packages/js/e2e-environment/docker/wp-cli/Dockerfile
@ -2,10 +2,6 @@ FROM wordpress:cli-2.5.0

 USER root

-COPY wait-for-it.sh /usr/local/bin/wait-for-it
-RUN chown xfs:xfs /usr/local/bin/wait-for-it && \
-    chmod +x /usr/local/bin/wait-for-it
-
 COPY entrypoint.sh /usr/local/bin/entrypoint.sh
 RUN chown xfs:xfs /usr/local/bin/entrypoint.sh && \
    chmod +x /usr/local/bin/entrypoint.sh
--- a/packages/js/e2e-environment/docker/wp-cli/entrypoint.sh
+++ b/packages/js/e2e-environment/docker/wp-cli/entrypoint.sh
@ -1,14 +1,13 @@
 #!/usr/bin/env bash
 set -eu

-declare -p WORDPRESS_HOST
-wait-for-it ${WORDPRESS_HOST} -t 120
-
-## if file exists then exit early because initialization already happened.
-if [ -f /var/www/html/.initialized ];
+# If WordPress is installed and the page "ready" exists, we bail the initialization.
+if [ $(wp --allow-root core is-installed) ] && [ $(wp --allow-root post exists $(wp --allow-root post list --format=ids --post_name=ready)) ];
 then
   echo "The environment has already been initialized."
   exit 0
+else
+	echo "Initializing the environment..."
 fi

 chown xfs:xfs /var/www/html/wp-content
@ -29,23 +28,18 @@ declare -p WORDPRESS_PORT
 URL="http://localhost" || \
 URL="http://localhost:${WORDPRESS_PORT}"

-if $(wp core is-installed);
-then
-    echo "WordPress is already installed..."
-else
-    declare -p WORDPRESS_TITLE >/dev/null
-    declare -p WORDPRESS_LOGIN >/dev/null
-    declare -p WORDPRESS_PASSWORD >/dev/null
-    declare -p WORDPRESS_EMAIL >/dev/null
-    echo "Installing WordPress..."
-    wp core install \
-        --url=${URL} \
-        --title="$WORDPRESS_TITLE" \
-        --admin_user=${WORDPRESS_LOGIN} \
-        --admin_password=${WORDPRESS_PASSWORD} \
-        --admin_email=${WORDPRESS_EMAIL} \
-        --skip-email
-fi
+declare -p WORDPRESS_TITLE >/dev/null
+declare -p WORDPRESS_LOGIN >/dev/null
+declare -p WORDPRESS_PASSWORD >/dev/null
+declare -p WORDPRESS_EMAIL >/dev/null
+echo "Installing WordPress..."
+wp core install \
+	--url=${URL} \
+	--title="$WORDPRESS_TITLE" \
+	--admin_user=${WORDPRESS_LOGIN} \
+	--admin_password=${WORDPRESS_PASSWORD} \
+	--admin_email=${WORDPRESS_EMAIL} \
+	--skip-email

 ## Check for an initialization script.
 declare -r INIT_SCRIPT=$(command -v initialize.sh)
@ -61,17 +55,11 @@ if ! [[ ${CURRENT_DOMAIN} == ${URL} ]]; then
    wp search-replace ${CURRENT_DOMAIN} ${URL}
 fi

-if $(wp post list --post_type=page --name=ready);
-then
-    echo "Ready page already exists..."
-else
-    wp post create \
-        --url=${URL} \
-        --post_type=page \
-        --post_status=publish \
-        --post_title='Ready' \
-        --post_content='E2E-tests.'
-fi
+wp post create \
+	--url=${URL} \
+	--post_type=page \
+	--post_status=publish \
+	--post_title='Ready' \
+	--post_content='E2E-tests.'

 echo "Visit $(wp option get siteurl)"
-touch /var/www/html/.initialized
--- a/packages/js/e2e-environment/docker/wp-cli/wait-for-it.sh
+++ b/packages/js/e2e-environment/docker/wp-cli/wait-for-it.sh
@ -1,208 +0,0 @@
-#!/usr/bin/env bash
-#source https://github.com/vishnubob/wait-for-it/pull/81
-#The MIT License (MIT)
-#
-#Original work Copyright (c) 2016 Giles Hall: wait-for-it.sh
-#Modified work Copyright (c) 2019 iturgeon: wait-for-it.sh
-#
-#Permission is hereby granted, free of charge, to any person obtaining a copy of
-#this software and associated documentation files (the "Software"), to deal in
-#the Software without restriction, including without limitation the rights to
-#use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-#of the Software, and to permit persons to whom the Software is furnished to do
-#so, subject to the following conditions:
-#
-#The above copyright notice and this permission notice shall be included in all
-#copies or substantial portions of the Software.
-#
-#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-#SOFTWARE.
-
-#   Use this script to test if a given TCP host/port are available
-
-WAITFORIT_cmdname=${0##*/}
-
-echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
-
-usage()
-{
-    cat << USAGE >&2
-Usage:
-    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
-    -h HOST | --host=HOST       Host or IP under test
-    -p PORT | --port=PORT       TCP port under test
-                                Alternatively, you specify the host and port as host:port
-    -s | --strict               Only execute subcommand if the test succeeds
-    -q | --quiet                Don't output any status messages
-    -t TIMEOUT | --timeout=TIMEOUT
-                                Timeout in seconds, zero for no timeout
-    -- COMMAND ARGS             Execute command with args after the test finishes
-USAGE
-    exit 1
-}
-
-wait_for()
-{
-    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
-        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
-    else
-        echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
-    fi
-    WAITFORIT_start_ts=$(date +%s)
-    while :
-    do
-        if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
-            nc -z $WAITFORIT_HOST $WAITFORIT_PORT
-            WAITFORIT_result=$?
-        else
-            (echo > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
-            WAITFORIT_result=$?
-        fi
-        if [[ $WAITFORIT_result -eq 0 ]]; then
-            WAITFORIT_end_ts=$(date +%s)
-            echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
-            break
-        fi
-        sleep 1
-    done
-    return $WAITFORIT_result
-}
-
-wait_for_wrapper()
-{
-    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
-    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
-        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
-    else
-        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
-    fi
-    WAITFORIT_PID=$!
-    trap "kill -INT -$WAITFORIT_PID" INT
-    wait $WAITFORIT_PID
-    WAITFORIT_RESULT=$?
-    if [[ $WAITFORIT_RESULT -ne 0 ]]; then
-        echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
-    fi
-    return $WAITFORIT_RESULT
-}
-
-# process arguments
-while [[ $# -gt 0 ]]
-do
-    case "$1" in
-        *:* )
-        WAITFORIT_hostport=(${1//:/ })
-        WAITFORIT_HOST=${WAITFORIT_hostport[0]}
-        WAITFORIT_PORT=${WAITFORIT_hostport[1]}
-        shift 1
-        ;;
-        --child)
-        WAITFORIT_CHILD=1
-        shift 1
-        ;;
-        -q | --quiet)
-        WAITFORIT_QUIET=1
-        shift 1
-        ;;
-        -s | --strict)
-        WAITFORIT_STRICT=1
-        shift 1
-        ;;
-        -h)
-        WAITFORIT_HOST="$2"
-        if [[ $WAITFORIT_HOST == "" ]]; then break; fi
-        shift 2
-        ;;
-        --host=*)
-        WAITFORIT_HOST="${1#*=}"
-        shift 1
-        ;;
-        -p)
-        WAITFORIT_PORT="$2"
-        if [[ $WAITFORIT_PORT == "" ]]; then break; fi
-        shift 2
-        ;;
-        --port=*)
-        WAITFORIT_PORT="${1#*=}"
-        shift 1
-        ;;
-        -t)
-        WAITFORIT_TIMEOUT="$2"
-        if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
-        shift 2
-        ;;
-        --timeout=*)
-        WAITFORIT_TIMEOUT="${1#*=}"
-        shift 1
-        ;;
-        --)
-        shift
-        WAITFORIT_CLI=("$@")
-        break
-        ;;
-        --help)
-        usage
-        ;;
-        *)
-        echoerr "Unknown argument: $1"
-        usage
-        ;;
-    esac
-done
-
-if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
-    echoerr "Error: you need to provide a host and port to test."
-    usage
-fi
-
-WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
-WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
-WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
-WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
-WAITFORIT_ISBUSY=0
-WAITFORIT_BUSYTIMEFLAG=""
-WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
-WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
-
-# check to see if we're using busybox?
-if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
-    WAITFORIT_ISBUSY=1
-fi
-
-# see if timeout.c args have been updated in busybox v1.30.0 or newer
-# note: this requires the use of bash on Alpine
-if [[ $WAITFORIT_ISBUSY && $(busybox | head -1) =~ ^.*v([[:digit:]]+)\.([[:digit:]]+)\..+$ ]]; then
-    if [[ ${BASH_REMATCH[1]} -le 1 && ${BASH_REMATCH[2]} -lt 30 ]]; then
-        # using pre 1.30.0 version with `-t SEC` arg
-        WAITFORIT_BUSYTIMEFLAG="-t"
-    fi
-fi
-
-if [[ $WAITFORIT_CHILD -gt 0 ]]; then
-    wait_for
-    WAITFORIT_RESULT=$?
-    exit $WAITFORIT_RESULT
-else
-    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
-        wait_for_wrapper
-        WAITFORIT_RESULT=$?
-    else
-        wait_for
-        WAITFORIT_RESULT=$?
-    fi
-fi
-
-if [[ $WAITFORIT_CLI != "" ]]; then
-    if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
-        echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
-        exit $WAITFORIT_RESULT
-    fi
-    exec "${WAITFORIT_CLI[@]}"
-else
-    exit $WAITFORIT_RESULT
-fi