From 68be3a6bcd7458193d0fde04d82f796d0730450f Mon Sep 17 00:00:00 2001 From: mvitale1989 Date: Tue, 30 May 2023 17:34:15 +0200 Subject: [PATCH] Prepare: run E2E smoketests with GitHub actions (#23301) - Port E2E testing scripts from cypress-ui-automation - Move server to docker-compose, move E2E images to ecrpublic * Integrate General channel renaming, fixes - Add local automation-dashboard - Add readme - Add E2E smoketests - Bump postgres to 12 --------- Co-authored-by: Mattermost Build Co-authored-by: Saturnino Abril Co-authored-by: Antonis Stamatiou --- .github/workflows/e2e-tests-ci.yml | 72 +++++++++++-- e2e-tests/.ci/.e2erc | 75 ++++++++++++++ e2e-tests/.ci/.env.cypress | 1 + e2e-tests/.ci/.env.dashboard | 1 + e2e-tests/.ci/.env.server | 1 + e2e-tests/.ci/.gitignore | 5 + e2e-tests/.ci/dashboard.entrypoint.sh | 21 ++++ e2e-tests/.ci/dashboard.override.yml | 24 +++++ e2e-tests/.ci/dashboard.start.sh | 29 ++++++ e2e-tests/.ci/dashboard.stop.sh | 6 ++ e2e-tests/.ci/server.override.yml | 121 ++++++++++++++++++++++ e2e-tests/.ci/server.prepare.sh | 49 +++++++++ e2e-tests/.ci/server.run_cypress.sh | 46 ++++++++ e2e-tests/.ci/server.start.sh | 45 ++++++++ e2e-tests/.ci/server.stop.sh | 7 ++ e2e-tests/.gitignore | 3 + e2e-tests/Makefile | 28 +++++ e2e-tests/README.md | 33 ++++++ e2e-tests/cypress/package-lock.json | 2 +- e2e-tests/cypress/tests/support/index.js | 3 + server/build/gitlab-dc.common.yml | 57 ++++++++-- server/build/gitlab-dc.mysql.yml | 9 +- server/build/gitlab-dc.postgres.yml | 16 +-- server/build/gitlab-dc.schemamysql.yml | 9 +- server/build/gitlab-dc.schemapostgres.yml | 9 +- 25 files changed, 623 insertions(+), 49 deletions(-) create mode 100644 e2e-tests/.ci/.e2erc create mode 100644 e2e-tests/.ci/.env.cypress create mode 100644 e2e-tests/.ci/.env.dashboard create mode 100644 e2e-tests/.ci/.env.server create mode 100644 e2e-tests/.ci/.gitignore create mode 100755 e2e-tests/.ci/dashboard.entrypoint.sh create mode 100644 e2e-tests/.ci/dashboard.override.yml create mode 100755 e2e-tests/.ci/dashboard.start.sh create mode 100755 e2e-tests/.ci/dashboard.stop.sh create mode 100644 e2e-tests/.ci/server.override.yml create mode 100755 e2e-tests/.ci/server.prepare.sh create mode 100755 e2e-tests/.ci/server.run_cypress.sh create mode 100755 e2e-tests/.ci/server.start.sh create mode 100755 e2e-tests/.ci/server.stop.sh create mode 100644 e2e-tests/Makefile create mode 100644 e2e-tests/README.md diff --git a/.github/workflows/e2e-tests-ci.yml b/.github/workflows/e2e-tests-ci.yml index e526b8a79c..7f7ce78022 100644 --- a/.github/workflows/e2e-tests-ci.yml +++ b/.github/workflows/e2e-tests-ci.yml @@ -1,17 +1,35 @@ -name: mattermost-e2e-tests +name: E2E Tests on: - pull_request: - push: - branches: - - master - - mono-repo* + # For PRs, this workflow gets triggered from the Argo Events platform. + # Check the following repo for details: https://github.com/mattermost/delivery-platform + workflow_dispatch: + inputs: + commit_sha: + type: string + required: false defaults: run: shell: bash + jobs: + update-initial-status: + runs-on: ubuntu-22.04 + steps: + - uses: mattermost/actions/delivery/update-commit-status@main + env: + GITHUB_TOKEN: ${{ github.token }} + with: + repository_full_name: ${{ github.repository }} + commit_sha: ${{ inputs.commit_sha || github.sha }} + context: ci/e2e-tests + description: E2E tests for mattermost server app + status: pending + cypress-check: runs-on: ubuntu-22.04 + needs: + - update-initial-status defaults: run: working-directory: e2e-tests/cypress @@ -24,15 +42,18 @@ jobs: with: node-version-file: ".nvmrc" cache: npm - cache-dependency-path: 'e2e-tests/cypress/package-lock.json' + cache-dependency-path: "e2e-tests/cypress/package-lock.json" - name: ci/cypress/npm-install run: | npm ci - name: ci/cypress/npm-check run: | npm run check + playwright-check: runs-on: ubuntu-22.04 + needs: + - update-initial-status defaults: run: working-directory: e2e-tests/playwright @@ -45,7 +66,7 @@ jobs: with: node-version-file: ".nvmrc" cache: npm - cache-dependency-path: 'e2e-tests/playwright/package-lock.json' + cache-dependency-path: "e2e-tests/playwright/package-lock.json" - name: ci/get-webapp-node-modules working-directory: webapp # requires build of client and types @@ -57,3 +78,38 @@ jobs: - name: ci/playwright/npm-check run: | npm run check + + smoketests: + runs-on: ubuntu-22.04 + needs: + - cypress-check + - playwright-check + defaults: + run: + working-directory: e2e-tests + steps: + - name: ci/checkout-repo + uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 + - name: ci/e2e-smoketests + run: | + make + # Assert that the run contained 0 failures + CYPRESS_FAILURES=$(find cypress/results -name '*.json' | xargs -l jq -r '.stats.failures' | jq -s add) + echo "Cypress run completed with $CYPRESS_FAILURES failures" + [ "$CYPRESS_FAILURES" = "0" ] + + update-final-status: + runs-on: ubuntu-22.04 + if: always() + needs: + - smoketests + steps: + - uses: mattermost/actions/delivery/update-commit-status@main + env: + GITHUB_TOKEN: ${{ github.token }} + with: + repository_full_name: ${{ github.repository }} + commit_sha: ${{ inputs.commit_sha || github.sha }} + context: ci/e2e-tests + description: E2E tests for mattermost server app + status: ${{ job.status }} diff --git a/e2e-tests/.ci/.e2erc b/e2e-tests/.ci/.e2erc new file mode 100644 index 0000000000..e663f0ac08 --- /dev/null +++ b/e2e-tests/.ci/.e2erc @@ -0,0 +1,75 @@ +# Utility variables +# NB: these assume you `source` them from the directory this file is in +export MME2E_DC_SERVER="docker-compose -p mmserver -f $(readlink -e ../../server/build/gitlab-dc.postgres.yml) -f $(readlink -e ./server.override.yml)" +export MME2E_DC_DASHBOARD="docker-compose -p mmdashboard -f $(readlink -e ./dashboard/docker/docker-compose.yml) -f $(readlink -e ./dashboard.override.yml)" +export MME2E_UID=$(id -u) + +# Default the optional variables that are used in the docker-compose file +export SERVER_IMAGE_DEFAULT="mattermostdevelopment/mm-ee-test:$(git rev-parse --short=7 HEAD)" +export SERVER_IMAGE=${SERVER_IMAGE:-$SERVER_IMAGE_DEFAULT} + +# Function definitions +mme2e_log () { echo "[$(date -Is)]" "$@"; } +mme2e_get_current_shopt_arg () { + # This function lets you get the current value of shell options, e.g. pipefail or allexport, in the form + # of arguments to pass to the 'set' shell function, in order to restore its value later + SHOPT_ARG=${1:?} + case $(set -o | sed -n -E "s/^${SHOPT_ARG}[[:space:]]+(o..?)$/\1/p") in + on) echo -n "-o ${SHOPT_ARG}";; + off) echo -n "+o ${SHOPT_ARG}";; + *) exit 1;; + esac +} +mme2e_load_env_file () { + # This loads the ./env file. Variables are automatically exported + [ -f ./env ] || return 0 + MME2E_PREVIOUS_ALLEXPORT=$(mme2e_get_current_shopt_arg allexport) + set -o allexport + mme2e_log "Loading env file" + . ./env + set ${MME2E_PREVIOUS_ALLEXPORT} +} +mme2e_generate_envfile_from_var_names () { + # Read var names from stdin, one per line + while read VARIABLE; do + [ -z "${!VARIABLE:-}" ] || echo "${VARIABLE}=${!VARIABLE}"; + done +} +mme2e_wait_command_success () { + COMMAND=${1?} + RETRY_MESSAGE=${2?} + RETRIES_LEFT=${3:-1} + RETRIES_INTERVAL=${4:-10} + MME2E_PREVIOUS_PIPEFAIL=$(mme2e_get_current_shopt_arg pipefail) + set -o pipefail + until bash -c "${COMMAND}"; do + RETRIES_LEFT=$((RETRIES_LEFT - 1)) + [ "$RETRIES_LEFT" -le "0" ] && break + mme2e_log "${RETRY_MESSAGE} ($RETRIES_LEFT retries left, sleeping $RETRIES_INTERVAL seconds)" + sleep $RETRIES_INTERVAL + done + set ${MME2E_PREVIOUS_PIPEFAIL} + if [ "$RETRIES_LEFT" = "0" ]; then + exit 1 + fi +} +mme2e_wait_service_healthy () { + SERVICE_NAME=${1?} + RETRIES_LEFT=${2:-1} + RETRIES_INTERVAL=${3:-10} + mme2e_wait_command_success "${MME2E_DC_SERVER} ps ${SERVICE_NAME} | grep -q '\(healthy\)'" "Waiting for ${SERVICE_NAME} container to be healthy" "$RETRIES_LEFT" "$RETRIES_INTERVAL" +} +mme2e_wait_image () { + IMAGE_NAME=${1?} + RETRIES_LEFT=${2:-1} + RETRIES_INTERVAL=${3:-10} + mme2e_wait_command_success "docker pull $IMAGE_NAME" "Waiting for docker image ${IMAGE_NAME} to be available" "$RETRIES_LEFT" "$RETRIES_INTERVAL" +} + +# Utility alias, for interactive shell usage. Can be reversed with 'unalias docker-compose' in your shell +# NB: this won't work in the script +alias docker-compose-mmserver="${MME2E_DC_SERVER}" +alias docker-compose-mmdashboard="${MME2E_DC_DASHBOARD}" + +# Call prerequisite utility functions +mme2e_load_env_file diff --git a/e2e-tests/.ci/.env.cypress b/e2e-tests/.ci/.env.cypress new file mode 100644 index 0000000000..64c0275276 --- /dev/null +++ b/e2e-tests/.ci/.env.cypress @@ -0,0 +1 @@ +# NB: this file is just a placeholder required by docker-compose. It's supposed to be modified by the CI pipeline and should remain empty in git diff --git a/e2e-tests/.ci/.env.dashboard b/e2e-tests/.ci/.env.dashboard new file mode 100644 index 0000000000..64c0275276 --- /dev/null +++ b/e2e-tests/.ci/.env.dashboard @@ -0,0 +1 @@ +# NB: this file is just a placeholder required by docker-compose. It's supposed to be modified by the CI pipeline and should remain empty in git diff --git a/e2e-tests/.ci/.env.server b/e2e-tests/.ci/.env.server new file mode 100644 index 0000000000..64c0275276 --- /dev/null +++ b/e2e-tests/.ci/.env.server @@ -0,0 +1 @@ +# NB: this file is just a placeholder required by docker-compose. It's supposed to be modified by the CI pipeline and should remain empty in git diff --git a/e2e-tests/.ci/.gitignore b/e2e-tests/.ci/.gitignore new file mode 100644 index 0000000000..cc1baff8fd --- /dev/null +++ b/e2e-tests/.ci/.gitignore @@ -0,0 +1,5 @@ +dashboard +env +!.env.cypress +!.env.server +!.env.dashboard diff --git a/e2e-tests/.ci/dashboard.entrypoint.sh b/e2e-tests/.ci/dashboard.entrypoint.sh new file mode 100755 index 0000000000..49ccfe40a9 --- /dev/null +++ b/e2e-tests/.ci/dashboard.entrypoint.sh @@ -0,0 +1,21 @@ +#!/bin/bash +set -e -u -o pipefail + +npm install + +# Run migrations. This is also a way to wait for the database to be up +MIGRATION_ATTEMPTS_LEFT=10 +MIGRATION_ATTEMPTS_INTERVAL=10 +until npm run migrate:latest; do + MIGRATION_ATTEMPTS_LEFT=$((MIGRATION_ATTEMPTS_LEFT - 1)) + [ "$MIGRATION_ATTEMPTS_LEFT" -gt 0 ] || break + echo "Migration script failed, sleeping $MIGRATION_ATTEMPTS_INTERVAL" + sleep $MIGRATION_ATTEMPTS_INTERVAL +done +[ "$MIGRATION_ATTEMPTS_LEFT" -gt 0 ] || { + echo "Migration script failed, exhausted attempts. Giving up." + exit 1 +} + +# Launch the dashboard +exec npm run dev diff --git a/e2e-tests/.ci/dashboard.override.yml b/e2e-tests/.ci/dashboard.override.yml new file mode 100644 index 0000000000..a444a7be71 --- /dev/null +++ b/e2e-tests/.ci/dashboard.override.yml @@ -0,0 +1,24 @@ +--- +version: '3.1' + +services: + dashboard: + image: node:16.17.0 + environment: + PG_URI: postgres://mmuser:mostest@db:5432/automation_dashboard_db + JWT_SECRET: s8gGBA3ujKRohSw1L8HLOY7Jjnu2ZYv8 # Generated with e.g. `dd if=/dev/urandom count=24 bs=1 2>/dev/null | base64 -w0` + JWT_USER: cypress-test + JWT_ROLE: integration + JWT_ALG: HS256 + JWT_EXPIRES_IN: 365d + ALLOWED_USER: cypress-test + ALLOWED_ROLE: integration + user: "${MME2E_UID}" + volumes: + - "../:/app" + - "../../dashboard.entrypoint.sh:/usr/local/bin/dashboard.entrypoint.sh:ro" + - "../../.env.dashboard:/var/local/.env.dashboard:rw" + working_dir: /app + entrypoint: /usr/local/bin/dashboard.entrypoint.sh + ports: + - 4000:4000 diff --git a/e2e-tests/.ci/dashboard.start.sh b/e2e-tests/.ci/dashboard.start.sh new file mode 100755 index 0000000000..89feb25513 --- /dev/null +++ b/e2e-tests/.ci/dashboard.start.sh @@ -0,0 +1,29 @@ +#!/bin/bash +set -e -u -o pipefail +cd $(dirname $0) +. .e2erc + +MME2E_DASHBOARD_REF_DEFAULT="origin/main" +MME2E_DASHBOARD_REF=${MME2E_DASHBOARD_REF:-$MME2E_DASHBOARD_REF_DEFAULT} + +mme2e_log "Cloning the automation-dashboard project" +[ -d dashboard ] || git clone https://github.com/saturninoabril/automation-dashboard.git dashboard +git -C dashboard fetch +git -C dashboard checkout $MME2E_DASHBOARD_REF + +mme2e_log "Starting the dashboard" +${MME2E_DC_DASHBOARD} up -d db dashboard + +mme2e_log "Generating the dashboard's local URL" +MME2E_DC_DASHBOARD_NETWORK=$(${MME2E_DC_DASHBOARD} ps -q dashboard | xargs -l docker inspect | jq -r '.[0].NetworkSettings.Networks | (keys|.[0])') +MME2E_DC_DASHBOARD_GATEWAY=$(docker network inspect $MME2E_DC_DASHBOARD_NETWORK | jq -r '.[0].IPAM.Config[0].Gateway') +AUTOMATION_DASHBOARD_URL="http://${MME2E_DC_DASHBOARD_GATEWAY}:4000/api" + +mme2e_log "Generating a signed JWT token for accessing the dashboard" +AUTOMATION_DASHBOARD_TOKEN=$(${MME2E_DC_DASHBOARD} exec -T -u $MME2E_UID dashboard node script/sign.js | awk '{ print $2; }') # The token secret is specified in the dashboard.override.yml file + +mme2e_log "Generating the .env.dashboard file, to point Cypress to the dashboard URL" +mme2e_generate_envfile_from_var_names >.env.dashboard </dev/null +${MME2E_DC_SERVER} exec -T -- server curl -L --silent https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.9.0/com.mattermost.demo-plugin-0.9.0.tar.gz | ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress tee tests/fixtures/com.mattermost.demo-plugin-0.9.0.tar.gz >/dev/null +${MME2E_DC_SERVER} exec -T -- server curl -L --silent https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.8.0/com.mattermost.demo-plugin-0.8.0.tar.gz | ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress tee tests/fixtures/com.mattermost.demo-plugin-0.8.0.tar.gz >/dev/null +${MME2E_DC_SERVER} exec -T -- server curl -L --silent https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.8.0/com.mattermost.demo-plugin-0.8.0.tar.gz | ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress tee tests/fixtures/com.mattermost.demo-plugin-0.8.0.tar.gz >/dev/null +${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress tee tests/fixtures/keycloak.crt >/dev/null <../../server/build/docker/keycloak/keycloak.crt + +# Generate the test mattermosts-server config, and restart its container +mme2e_log "Prepare Server: patching the mattermost-server config" +${MME2E_DC_SERVER} exec -T -e "OUTPUT_CONFIG=/tmp/config_generated.json" -w /opt/mattermost-server/server -- utils go run scripts/config_generator/main.go +${MME2E_DC_SERVER} exec -T -- utils bash </tmp/config_patched.json +EOF +# TODO double check: could there be race conditions, if the server tries to write back to the file? Afaiu, nobody touching the UI -> no changes to the config file +${MME2E_DC_SERVER} exec -T -- utils cat /tmp/config_patched.json | ${MME2E_DC_SERVER} exec -T -- server tee config/config.json >/dev/null +${MME2E_DC_SERVER} restart server +if ! mme2e_wait_service_healthy server 60 10; then + mme2e_log "Mattermost container not healthy, retry attempts exhausted. Giving up." >&2 + exit 1 +fi +mme2e_log "Mattermost container is running and healthy" + +# Inject test data, prepare for E2E tests +mme2e_log "Prepare Server: injecting E2E test data" +${MME2E_DC_SERVER} exec -T -- server mmctl config set TeamSettings.MaxUsersPerTeam 100 --local +${MME2E_DC_SERVER} exec -T -- server mmctl sampledata -u 60 --local +${MME2E_DC_SERVER} exec -T -- openldap bash -c 'ldapadd -x -D "cn=admin,dc=mm,dc=test,dc=com" -w mostest' <../../server/tests/test-data.ldif +${MME2E_DC_SERVER} exec -T -- minio sh -c 'mkdir -p /data/mattermost-test' +mme2e_log "Mattermost is running and ready for E2E testing" +mme2e_log "You can use the test data credentials for logging in (username=sysadmin password=Sys@dmin-sample1)" diff --git a/e2e-tests/.ci/server.run_cypress.sh b/e2e-tests/.ci/server.run_cypress.sh new file mode 100755 index 0000000000..5ab4eb9c66 --- /dev/null +++ b/e2e-tests/.ci/server.run_cypress.sh @@ -0,0 +1,46 @@ +#!/bin/bash +set -e -u -o pipefail +cd $(dirname $0) +. .e2erc + +# Set required variables +TEST_FILTER_DEFAULT='--stage=@prod --group=@smoke' +TEST_FILTER=${TEST_FILTER:-$TEST_FILTER_DEFAULT} + +# Print run information +mme2e_log "Printing Cypress container informations" +${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress node -p 'module.paths' +${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress bash <<"EOF" +cat <' > results/junit/empty.xml +EOF + +# Run cypress test +# No need to collect its exit status: if it's nonzero, this script will terminate since we use '-e' +if ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress bash -c '[ -n "${AUTOMATION_DASHBOARD_URL}" ]'; then + mme2e_log "AUTOMATION_DASHBOARD_URL is set. Using run_test_cycle.js for the cypress run" + ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress node --trace-warnings generate_test_cycle.js ${TEST_FILTER} + ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress node run_test_cycle.js | tee ../cypress/logs/cypress.log +else + mme2e_log "AUTOMATION_DASHBOARD_URL is unset. Using run_tests.js for the cypress run" + ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress node run_tests.js ${TEST_FILTER} | tee ../cypress/logs/cypress.log +fi + +# Collect server logs +${MME2E_DC_SERVER} exec -T -- server cat /mattermost/logs/mattermost.log >../cypress/logs/mattermost.log diff --git a/e2e-tests/.ci/server.start.sh b/e2e-tests/.ci/server.start.sh new file mode 100755 index 0000000000..4e99ae8df7 --- /dev/null +++ b/e2e-tests/.ci/server.start.sh @@ -0,0 +1,45 @@ +#!/bin/bash +set -e -u -o pipefail +cd $(dirname $0) +. .e2erc + +export BRANCH_DEFAULT=$(git branch --show-current) +export BRANCH=${BRANCH:-$BRANCH_DEFAULT} +export BUILD_ID_DEFAULT=$(date +%s) +export BUILD_ID=${BUILD_ID:-$BUILD_ID_DEFAULT} +export CI_BASE_URL="${CI_BASE_URL:-localhost}" + +# Cleanup old containers, if any +mme2e_log "Stopping leftover E2E containers, if any are running" +${MME2E_DC_SERVER} down -v + +# Generate .env.server +mme2e_log "Generating .env.server" +mme2e_generate_envfile_from_var_names >.env.server <> .env.server +done + +# Generate .env.cypress +mme2e_log "Generating .env.cypress" +mme2e_generate_envfile_from_var_names >.env.cypress <&2 + exit 1 +fi +mme2e_log "Mattermost container is running and healthy" diff --git a/e2e-tests/.ci/server.stop.sh b/e2e-tests/.ci/server.stop.sh new file mode 100755 index 0000000000..cd7d7f83e1 --- /dev/null +++ b/e2e-tests/.ci/server.stop.sh @@ -0,0 +1,7 @@ +#!/bin/bash +set -e -u -o pipefail +cd $(dirname $0) +. .e2erc + +mme2e_log "Stopping E2E containers" +${MME2E_DC_SERVER} down -v diff --git a/e2e-tests/.gitignore b/e2e-tests/.gitignore index 710358c8d0..ff56c51f94 100644 --- a/e2e-tests/.gitignore +++ b/e2e-tests/.gitignore @@ -6,3 +6,6 @@ # Plugin *.tar.gz + +# node +*.lock diff --git a/e2e-tests/Makefile b/e2e-tests/Makefile new file mode 100644 index 0000000000..babae1a73b --- /dev/null +++ b/e2e-tests/Makefile @@ -0,0 +1,28 @@ +.PHONY: all run stop +all: run +run: start-server prepare-server run-cypress +stop: stop-server stop-dashboard clean-env-placeholders + +.PHONY: start-server prepare-server run-cypress stop-server restart-server +start-server: + ./.ci/server.start.sh +prepare-server: + ./.ci/server.prepare.sh +run-cypress: + ./.ci/server.run_cypress.sh +stop-server: + ./.ci/server.stop.sh +restart-server: stop-server start-server + +.PHONY: start-dashboard stop-dashboard +start-dashboard: + ./.ci/dashboard.start.sh +stop-dashboard: + ./.ci/dashboard.stop.sh + +.PHONY: print-env-placeholders clean-env-placeholders +print-env-placeholders: + find .ci -maxdepth 1 -name '.env.*' | xargs --verbose -l cat +clean-env-placeholders: + git reset .ci/.env.* + git checkout .ci/.env.* diff --git a/e2e-tests/README.md b/e2e-tests/README.md new file mode 100644 index 0000000000..dac80d245e --- /dev/null +++ b/e2e-tests/README.md @@ -0,0 +1,33 @@ +# E2E testing for the Mattermost web client + +This directory contains the E2E testing code for the Mattermost web client. + +### How to run locally + +The E2E testing scripts depend on the following tools being installed on your system: `docker`, `docker-compose`, `make`, `git`, `jq`, and some common utilities (`coreutils`, `findutils`, `bash`, `awk`, `sed`, `grep`) + +Instructions, tl;dr: create a local branch with your E2E test changes, then open a PR to the `mattermost-server` repo targeting the `master` branch (so that CI will produce the image that docker-compose needs), then run `make` in this directory. + +Instructions, detailed: +1. Create the `.ci/env` file, and populate the variables you need, keeping in mind that: + * The following variables will be passed over to the server container: `MM_LICENSE` (no enterprise features will be available if this is unset), and the exploded `MM_ENV` (a comma-separated list of env var specifications) + * The following variables will be passed over to the cypress container: `BRANCH`, `BUILD_ID`, `CI_BASE_URL`, `AUTOMATION_DASHBOARD_URL` and `AUTOMATION_DASHBOARD_TOKEN` + * The `SERVER_IMAGE` variable can also be set, if you want to select a custom mattermost-server image + * The `TEST_FILTER` variable can also be set, to customize which tests you want cypress to run + * All variables are optional, and will be set to sane defaults +2. (optional) `make start-dashboard`: start the automation-dashboard in the background + * This also sets the `AUTOMATION_DASHBOARD_URL` and `AUTOMATION_DASHBOARD_TOKEN` variables for the cypress container + * Note that if you run the dashboard locally, but also specify other `AUTOMATION_DASHBOARD_*` variables in your env, the latter variables will take precedence +3. `make`: start and prepare the server, then run the cypress tests + * You can track the progress of the run in the `http://localhost:4000/cycles` dashboard, if you launched it locally +4. `make stop`: tears down the server (and the dashboard, if running), then cleans up the env placeholder files + +Notes: +- Aside from some exceptions (e.g. `TEST_FILTER`), most of the variables in `.ci/env` must be set before the `make start-server` command is run. Modifting that file afterwards has no effect, because the containers' env files are generated in that step. +- If you restart the dashboard at any point, you must also restart the server containers, so that it picks up the new IP of the dashboard from the newly generated `.env.dashboard` file +- If you started the dashboard locally in the past, but want to point to another dasbhoard later, you can run `make clean-env-placeholders` to remove references to the local dasbhoard (you'll likely need to restart the server) +- Dynamically set variables for the server or cypress should be managed within the `.env.*` files, rather than in the docker-compose files, to streamline their management. + +##### How to control which tests to run + +The `TEST_FILTER` variable will control which test files to run Cypress tests against. Please check the `e2e-tests/cypress/run_tests.js` file for details about its format. diff --git a/e2e-tests/cypress/package-lock.json b/e2e-tests/cypress/package-lock.json index 2623f423eb..29aecb84e0 100644 --- a/e2e-tests/cypress/package-lock.json +++ b/e2e-tests/cypress/package-lock.json @@ -1,5 +1,5 @@ { - "name": "cypress", + "name": "app", "lockfileVersion": 2, "requires": true, "packages": { diff --git a/e2e-tests/cypress/tests/support/index.js b/e2e-tests/cypress/tests/support/index.js index 3a8c279606..d9e87c80cf 100644 --- a/e2e-tests/cypress/tests/support/index.js +++ b/e2e-tests/cypress/tests/support/index.js @@ -216,6 +216,9 @@ function sysadminSetup(user) { // # Deactivate test bots if any cy.apiDeactivateTestBots(); + // # Disable welcome tours if any + cy.apiDisableTutorials(user.id); + // # Check if default team is present; create if not found. cy.apiGetTeamsForUser().then(({teams}) => { const defaultTeam = teams && teams.length > 0 && teams.find((team) => team.name === DEFAULT_TEAM.name); diff --git a/server/build/gitlab-dc.common.yml b/server/build/gitlab-dc.common.yml index 935f0d2aa8..02cb0a9be0 100644 --- a/server/build/gitlab-dc.common.yml +++ b/server/build/gitlab-dc.common.yml @@ -1,29 +1,44 @@ version: '2.4' services: minio: - image: ${CI_REGISTRY}/mattermost/ci/images/minio:RELEASE.2019-10-11T00-38-09Z-1 + image: public.ecr.aws/mattermostqa/minio:RELEASE.2019-10-11T00-38-09Z-1 command: "server /data" environment: MINIO_ACCESS_KEY: minioaccesskey MINIO_SECRET_KEY: miniosecretkey MINIO_SSE_MASTER_KEY: "my-minio-key:6368616e676520746869732070617373776f726420746f206120736563726574" + healthcheck: + test: [ "CMD", "nc", "-z", "-w1", "127.0.0.1", "9000" ] + interval: 10s + timeout: 15s + retries: 12 inbucket: - image: ${CI_REGISTRY}/mattermost/ci/images/inbucket:v3.0.0-rc1-2-gc64e7a6-1 + image: public.ecr.aws/mattermostqa/inbucket:3.0.0 restart: always environment: INBUCKET_WEB_ADDR: "0.0.0.0:9001" INBUCKET_POP3_ADDR: "0.0.0.0:10110" INBUCKET_SMTP_ADDR: "0.0.0.0:10025" + healthcheck: + test: [ "CMD", "nc", "-z", "-w1", "127.0.0.1", "10025" ] + interval: 10s + timeout: 15s + retries: 12 openldap: - image: ${CI_REGISTRY}/mattermost/ci/images/openldap:1.4.0-1 + image: public.ecr.aws/mattermostqa/openldap:1.4.0 restart: always environment: LDAP_TLS_VERIFY_CLIENT: "never" LDAP_ORGANISATION: "Mattermost Test" LDAP_DOMAIN: "mm.test.com" LDAP_ADMIN_PASSWORD: "mostest" + healthcheck: + test: [ "CMD", "bash", "-o", "pipefail", "-c", "ss -ltn 'sport = :636' | grep -qE '^LISTEN'" ] + interval: 10s + timeout: 15s + retries: 12 elasticsearch: - image: ${CI_REGISTRY}/mattermost/ci/images/mattermost-elasticsearch-docker:7.17.3 + image: mattermost/mattermost-elasticsearch-docker:7.17.3 environment: http.host: "0.0.0.0" http.port: 9200 @@ -33,10 +48,20 @@ services: http.cors.allow-credentials: "true" transport.host: "127.0.0.1" ES_JAVA_OPTS: "-Xms512m -Xmx512m" + healthcheck: + test: [ "CMD", "bash", "-o", "pipefail", "-c", "curl --silent localhost:9200/_cat/health | awk '{ print $$4 }' | grep -qE '^green$$'" ] + interval: 10s + timeout: 15s + retries: 12 dejavu: - image: ${CI_REGISTRY}/mattermost/ci/images/dejavu:3.4.2-1 + image: public.ecr.aws/mattermostqa/dejavu:3.4.2 + healthcheck: + test: [ "CMD", "nc", "-z", "-w1", "127.0.0.1", "1358" ] + interval: 10s + timeout: 15s + retries: 12 keycloak: - image: ${CI_REGISTRY}/mattermost/ci/images/keycloak:10.0.2-1 + image: public.ecr.aws/mattermostqa/keycloak:10.0.2 restart: always environment: KEYCLOAK_USER: mmuser @@ -45,13 +70,29 @@ services: KEYCLOAK_IMPORT: /setup/realm.json volumes: - "./docker/keycloak:/setup" + healthcheck: + test: [ "CMD", "bash", "-o", "pipefail", "-c", "curl --silent localhost:9990/health | grep -q '\"status\":\"UP\"'" ] + interval: 10s + timeout: 15s + retries: 12 prometheus: - image: ${CI_REGISTRY}/mattermost/ci/images/prometheus:2.27.1-1 + image: public.ecr.aws/mattermostqa/prometheus:v2.27.1 volumes: - "./docker/prometheus-linux.yml:/etc/prometheus/prometheus.yml" + healthcheck: + test: [ "CMD", "wget", "-q", "-O-", "127.0.0.1:9090/-/ready" ] + interval: 10s + timeout: 15s + retries: 12 + # wget -q -O- localhost:3000/healthz | grep -q Ok grafana: - image: ${CI_REGISTRY}/mattermost/ci/images/grafana:8.0.1-1 + image: public.ecr.aws/mattermostqa/grafana:8.0.1 volumes: - "./docker/grafana/grafana.ini:/etc/grafana/grafana.ini" - "./docker/grafana/provisioning:/etc/grafana/provisioning" - "./docker/grafana/dashboards:/var/lib/grafana/dashboards" + healthcheck: + test: [ "CMD", "bash", "-o", "pipefail", "-c", "wget -q -O- localhost:3000/healthz | grep -q Ok" ] + interval: 10s + timeout: 15s + retries: 12 diff --git a/server/build/gitlab-dc.mysql.yml b/server/build/gitlab-dc.mysql.yml index c64e17bc78..49b8aa1dc3 100644 --- a/server/build/gitlab-dc.mysql.yml +++ b/server/build/gitlab-dc.mysql.yml @@ -1,7 +1,7 @@ version: '2.4' services: mysql: - image: ${CI_REGISTRY}/mattermost/ci/images/mysql:5.7-1 + image: public.ecr.aws/mattermostqa/mysql:5.7.12 restart: always environment: MYSQL_ROOT_HOST: "%" @@ -83,7 +83,7 @@ services: - grafana start_dependencies: - image: ${CI_REGISTRY}/mattermost/ci/images/mattermost-wait-for-dep:latest-1 + image: mattermost/mattermost-wait-for-dep:latest depends_on: - mysql - minio @@ -95,8 +95,3 @@ services: command: mysql:3306 minio:9000 inbucket:9001 openldap:389 elasticsearch:9200 prometheus:9090 grafana:3000 networks: default: - -networks: - default: - external: - name: ${COMPOSE_PROJECT_NAME} diff --git a/server/build/gitlab-dc.postgres.yml b/server/build/gitlab-dc.postgres.yml index 80d884bcf0..24f4e67b88 100644 --- a/server/build/gitlab-dc.postgres.yml +++ b/server/build/gitlab-dc.postgres.yml @@ -1,7 +1,7 @@ version: '2.4' services: postgres: - image: ${CI_REGISTRY}/mattermost/ci/images/postgres:10-1 + image: public.ecr.aws/mattermostqa/postgres:12 restart: always environment: POSTGRES_USER: mmuser @@ -12,9 +12,9 @@ services: - "./docker/postgres.conf:/etc/postgresql/postgresql.conf" healthcheck: test: [ "CMD", "pg_isready", "-h", "localhost" ] - interval: 5s - timeout: 10s - retries: 3 + interval: 10s + timeout: 15s + retries: 12 networks: default: aliases: @@ -81,7 +81,7 @@ services: - grafana start_dependencies: - image: ${CI_REGISTRY}/mattermost/ci/images/mattermost-wait-for-dep:latest-1 + image: mattermost/mattermost-wait-for-dep:latest depends_on: - postgres - minio @@ -93,9 +93,3 @@ services: command: postgres:5432 minio:9000 inbucket:9001 openldap:389 elasticsearch:9200 prometheus:9090 grafana:3000 networks: default: - - -networks: - default: - external: - name: ${COMPOSE_PROJECT_NAME} diff --git a/server/build/gitlab-dc.schemamysql.yml b/server/build/gitlab-dc.schemamysql.yml index 77f2688ad5..422a1cd7af 100644 --- a/server/build/gitlab-dc.schemamysql.yml +++ b/server/build/gitlab-dc.schemamysql.yml @@ -1,7 +1,7 @@ version: '2.4' services: mysql: - image: ${CI_REGISTRY}/mattermost/ci/images/mysql:5.7-1 + image: public.ecr.aws/mattermostqa/mysql:5.7.12 restart: always environment: MYSQL_ROOT_HOST: "%" @@ -23,14 +23,9 @@ services: - mysql start_dependencies: - image: ${CI_REGISTRY}/mattermost/ci/images/mattermost-wait-for-dep:latest-1 + image: mattermost/mattermost-wait-for-dep:latest depends_on: - mysql command: mysql:3306 networks: default: - -networks: - default: - external: - name: ${COMPOSE_PROJECT_NAME} diff --git a/server/build/gitlab-dc.schemapostgres.yml b/server/build/gitlab-dc.schemapostgres.yml index 458566adc6..b27f41ff85 100644 --- a/server/build/gitlab-dc.schemapostgres.yml +++ b/server/build/gitlab-dc.schemapostgres.yml @@ -1,7 +1,7 @@ version: '2.4' services: postgres: - image: ${CI_REGISTRY}/mattermost/ci/images/postgres:10-1 + image: public.ecr.aws/mattermostqa/postgres:12 restart: always environment: POSTGRES_USER: mmuser @@ -21,14 +21,9 @@ services: - postgres start_dependencies: - image: ${CI_REGISTRY}/mattermost/ci/images/mattermost-wait-for-dep:latest-1 + image: mattermost/mattermost-wait-for-dep:latest depends_on: - postgres command: postgres:5432 networks: default: - -networks: - default: - external: - name: ${COMPOSE_PROJECT_NAME}