MM-52642 CLD-6352 MM-54007 Prepare setup for Playwright pipeline (#24647)

* pipeline(playwright): prepare setup for playwright

* feedback address

* clean up readme

* Fix docker-compose command and definition for dashboard

* fix the dashboard

* ignore dashboard when formatting

---------

Co-authored-by: Mattermost Build <build@mattermost.com>
Co-authored-by: Mario Vitale <mvitale1989@hotmail.com>
Этот коммит содержится в:
Saturnino Abril
2023-10-14 07:02:32 +08:00
коммит произвёл GitHub
родитель e9da1ee8ca
Коммит 6746857ee7
53 изменённых файлов: 907 добавлений и 358 удалений

Просмотреть файл

@@ -1,7 +1,7 @@
# shellcheck disable=SC2148,SC2155
# 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 -f ../../server/build/gitlab-dc.postgres.yml) -f $(readlink -f ./server.override.yml)"
export MME2E_DC_DASHBOARD="docker compose -p mmdashboard -f $(readlink -f ./dashboard/docker/docker-compose.yml) -f $(readlink -f ./dashboard.override.yml)"
export MME2E_UID=$(id -u)
export MME2E_OSTYPE=$(docker version -f '{{ .Client.Os }}')
export MME2E_ARCHTYPE=$(docker version -f '{{ .Client.Arch }}')
@@ -34,17 +34,18 @@ mme2e_get_current_shopt_arg () {
esac
}
mme2e_load_env_file () {
# This loads the ./env file. Variables are automatically exported
[ -f ./env ] || return 0
# 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
mme2e_log "Loading .env file"
. ./.env
# shellcheck disable=SC2086
set ${MME2E_PREVIOUS_ALLEXPORT}
}
mme2e_generate_envfile_from_var_names () {
# Read var names from stdin, one per line
while read VARIABLE; do
while read -r VARIABLE; do
[ -z "${!VARIABLE:-}" ] || echo "${VARIABLE}=${!VARIABLE}";
done
}
@@ -59,8 +60,9 @@ mme2e_wait_command_success () {
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
sleep "$RETRIES_INTERVAL"
done
# shellcheck disable=SC2086
set ${MME2E_PREVIOUS_PIPEFAIL}
if [ "$RETRIES_LEFT" = "0" ]; then
exit 1
@@ -92,11 +94,6 @@ mme2e_legacy_setup () {
docker network inspect ${COMPOSE_PROJECT_NAME} >/dev/null 2>&1 || docker network create --driver=${DOCKER_NETWORK_DRIVER} ${COMPOSE_PROJECT_NAME}
}
# 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
mme2e_legacy_setup # Temporary

22
e2e-tests/.ci/.e2erc_setup Обычный файл
Просмотреть файл

@@ -0,0 +1,22 @@
# shellcheck disable=SC2148
# Set up base docker compose file and export
DC_FILE="docker-compose.server.override.yml"
if [ ! -f docker-compose.server.override.yml ]; then
echo "No './.ci/docker-compose.server.override.yml' found. You may need to run 'make generate-docker-compose'"
exit 1
fi
if [ "$TEST" = "cypress" ]; then
MME2E_DC_SERVER="docker compose -p mmserver -f ./$DC_FILE -f ./docker-compose.cypress.yml"
elif [ "$TEST" = "playwright" ]; then
MME2E_DC_SERVER="docker compose -p mmserver -f ./$DC_FILE -f ./docker-compose.playwright.yml"
else
MME2E_DC_SERVER="docker compose -p mmserver -f ./$DC_FILE"
fi
export MME2E_DC_SERVER=$MME2E_DC_SERVER
alias docker-compose-mmserver='${MME2E_DC_SERVER}'
export MME2E_DC_DASHBOARD="docker compose -p mmdashboard -f ./dashboard/docker/docker-compose.yml -f ./dashboard.override.yml"
alias docker-compose-mmdashboard='${MME2E_DC_DASHBOARD}'

1
e2e-tests/.ci/.env.server.cloud Обычный файл
Просмотреть файл

@@ -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

3
e2e-tests/.ci/.gitignore поставляемый
Просмотреть файл

@@ -1,5 +1,6 @@
dashboard
env
.env
!.env.cypress
!.env.server
!.env.server.cloud
!.env.dashboard

4
e2e-tests/.ci/.shellcheckrc Обычный файл
Просмотреть файл

@@ -0,0 +1,4 @@
# SC1091: Not following: <file>
# https://www.shellcheck.net/wiki/SC1091
disable=SC1091
# Used to ignore for sourcing ".e2erc*"

Просмотреть файл

@@ -7,14 +7,14 @@ npm install
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
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
echo "Migration script failed, exhausted attempts. Giving up."
exit 1
}
# Launch the dashboard

Просмотреть файл

@@ -1,7 +1,8 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
MME2E_DASHBOARD_REF_DEFAULT="origin/main"
MME2E_DASHBOARD_REF=${MME2E_DASHBOARD_REF:-$MME2E_DASHBOARD_REF_DEFAULT}
@@ -9,26 +10,34 @@ MME2E_DASHBOARD_REF=${MME2E_DASHBOARD_REF:-$MME2E_DASHBOARD_REF_DEFAULT}
mme2e_log "Cloning the automation-dashboard project"
if [ ! -d dashboard ]; then
git clone https://github.com/saturninoabril/automation-dashboard.git dashboard
. .e2erc # Must reinitialize some variables that depend on the dashboard repo being checked out
# Must reinitialize some variables that depend on the dashboard repo being checked out
. .e2erc
. .e2erc_setup
fi
git -C dashboard fetch
git -C dashboard checkout $MME2E_DASHBOARD_REF
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"
case $MME2E_OSTYPE in
darwin )
AUTOMATION_DASHBOARD_IP=$(ifconfig $(route get 1.1.1.1 | grep interface | awk '{print $2}') | grep -w inet | awk '{print $2}') ;;
* )
MME2E_DC_DASHBOARD_NETWORK=$(docker inspect $(${MME2E_DC_DASHBOARD} ps -q dashboard) | jq -r '.[0].NetworkSettings.Networks | (keys|.[0])')
AUTOMATION_DASHBOARD_IP=$(docker network inspect $MME2E_DC_DASHBOARD_NETWORK | jq -r '.[0].IPAM.Config[0].Gateway')
darwin)
# shellcheck disable=SC2046
AUTOMATION_DASHBOARD_IP=$(ifconfig $(route get 1.1.1.1 | grep interface | awk '{print $2}') | grep -w inet | awk '{print $2}')
;;
*)
# shellcheck disable=SC2046
MME2E_DC_DASHBOARD_NETWORK=$(docker inspect $(${MME2E_DC_DASHBOARD} ps -q dashboard) | jq -r '.[0].NetworkSettings.Networks | (keys|.[0])')
AUTOMATION_DASHBOARD_IP=$(docker network inspect "$MME2E_DC_DASHBOARD_NETWORK" | jq -r '.[0].IPAM.Config[0].Gateway')
;;
esac
# shellcheck disable=SC2034
AUTOMATION_DASHBOARD_URL="http://${AUTOMATION_DASHBOARD_IP}:4000/api"
mme2e_log "Generating a signed JWT token for accessing the dashboard"
${MME2E_DC_DASHBOARD} exec -T dashboard npm i
${MME2E_DC_DASHBOARD} exec -T dashboard bash -c "rm -rf node_modules && npm install --cache /tmp/empty-cache"
# shellcheck disable=SC2034
AUTOMATION_DASHBOARD_TOKEN=$(${MME2E_DC_DASHBOARD} exec -T 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"

Просмотреть файл

@@ -1,7 +1,8 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
if [ -d dashboard ]; then
mme2e_log "Stopping the dashboard containers"

61
e2e-tests/.ci/docker-compose.cypress.yml Обычный файл
Просмотреть файл

@@ -0,0 +1,61 @@
# Image hashes in this file are for amd64 systems
version: "2.4"
services:
cypress:
image: "cypress/browsers:node-18.16.1-chrome-114.0.5735.133-1-ff-114.0.2-edge-114.0.1823.51-1"
### Temporarily disabling this image, until both the amd64 and arm64 version are mirrored
# image: "mattermostdevelopment/mirrored-cypress-browsers-public:node-18.16.1-chrome-114.0.5735.133-1-ff-114.0.2-edge-114.0.1823.51-1"
entrypoint: ["/bin/bash", "-c"]
command: ["until [ -f /var/run/mm_terminate ]; do sleep 5; done"]
env_file:
- "../../e2e-tests/.ci/.env.dashboard"
- "../../e2e-tests/.ci/.env.cypress"
environment:
REPO: "mattermost"
# Cypress configuration
HEADLESS: "true"
CYPRESS_baseUrl: "http://server:8065"
CYPRESS_dbConnection: "postgres://mmuser:mostest@postgres:5432/mattermost_test?sslmode=disable&connect_timeout=10"
CYPRESS_smtpUrl: "http://inbucket:9001"
CYPRESS_webhookBaseUrl: "http://webhook-interactions:3000"
CYPRESS_chromeWebSecurity: "false"
CYPRESS_firstTest: "true"
CYPRESS_resetBeforeTest: "true"
CYPRESS_allowedUntrustedInternalConnections: "localhost webhook-interactions"
TM4J_ENABLE: "false"
# disable shared memory X11 affecting Cypress v4 and Chrome
# https://github.com/cypress-io/cypress-docker-images/issues/270
QT_X11_NO_MITSHM: "1"
_X11_NO_MITSHM: "1"
_MITSHM: "0"
# avoid too many progress messages
# https://github.com/cypress-io/cypress/issues/1243
CI: "1"
# Ensure we're independent from the global node environment
PATH: /cypress/node_modules/.bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
ulimits:
nofile:
soft: 8096
hard: 1048576
working_dir: /cypress
volumes:
- "../../e2e-tests/cypress/:/cypress"
webhook-interactions:
image: mattermostdevelopment/mirrored-node:${NODE_VERSION_REQUIRED}
command: sh -c "npm install --legacy-peer-deps && exec node webhook_serve.js"
environment:
NODE_PATH: /usr/local/lib/node_modules/
healthcheck:
test: ["CMD", "curl", "-s", "-o/dev/null", "127.0.0.1:3000"]
interval: 10s
timeout: 15s
retries: 12
working_dir: /cypress
volumes:
- "../../e2e-tests/cypress/:/cypress:ro"
networks:
default:
aliases:
- webhook-interactions

32
e2e-tests/.ci/docker-compose.playwright.yml Обычный файл
Просмотреть файл

@@ -0,0 +1,32 @@
# Image hashes in this file are for amd64 systems
version: "2.4"
services:
playwright:
image: mcr.microsoft.com/playwright:v1.38.1-jammy
entrypoint: ["/bin/bash", "-c"]
command: ["until [ -f /var/run/mm_terminate ]; do sleep 5; done"]
env_file:
- "./.env.playwright"
environment:
CI: "true"
NODE_OPTIONS: --no-experimental-fetch
PW_BASE_URL: http://server:8065
PW_ADMIN_USERNAME: sysadmin
PW_ADMIN_PASSWORD: Sys@dmin-sample1
PW_ADMIN_EMAIL: sysadmin@sample.mattermost.com
PW_ENSURE_PLUGINS_INSTALLED: ""
PW_HA_CLUSTER_ENABLED: "false"
PW_RESET_BEFORE_TEST: "false"
PW_HEADLESS: "true"
PW_SLOWMO: 0
PW_WORKERS: 2
PW_SNAPSHOT_ENABLE: "false"
PW_PERCY_ENABLE: "false"
ulimits:
nofile:
soft: 8096
hard: 1048576
working_dir: /mattermost
volumes:
- "../../:/mattermost"

242
e2e-tests/.ci/docker_compose_generator.sh Исполняемый файл
Просмотреть файл

@@ -0,0 +1,242 @@
#!/bin/bash
# SC2034: <variable> appears unused.
# https://www.shellcheck.net/wiki/SC2034
# shellcheck disable=SC2034
# Note: Variables are dynamically used depending on usage input (ENABLED_DOCKER_SERVICES)
set -e -u -o pipefail
cd "$(dirname "$0")"
. .e2erc
# File to be used for overriding docker compose
CONFIG_FILE="docker-compose.server.override.yml"
# Check if ENABLED_DOCKER_SERVICES is set or not
if [ -n "${ENABLED_DOCKER_SERVICES-}" ] && [ -n "$ENABLED_DOCKER_SERVICES" ]; then
mme2e_log "ENABLED_DOCKER_SERVICES: $ENABLED_DOCKER_SERVICES"
else
# If not set, then remove the override file if it exists and exit
mme2e_log "ENABLED_DOCKER_SERVICES is empty or unset."
if [ -f $CONFIG_FILE ]; then
rm -f $CONFIG_FILE
mme2e_log "$CONFIG_FILE removed."
else
mme2e_log "No override to docker compose."
fi
exit 0
fi
# Define list of valid services
validServices=("postgres:5432" "minio:9000" "inbucket:9001" "openldap:389" "elasticsearch:9200" "keycloak:8080")
# Read the enabled docker services and split them into an array
enabled_docker_services="$ENABLED_DOCKER_SERVICES"
read -ra docker_services <<<"$enabled_docker_services"
# Initialize variables for required services
postgres_found=false
inbucket_found=false
# Get service and post of valid services
services=()
for service in "${docker_services[@]}"; do
port=""
for svcPort in "${validServices[@]}"; do
svc=${svcPort%%:*}
if [ "$service" == "$svc" ]; then
port=${svcPort#*:}
# Find the required services
if [ "$service" == "$svc" ]; then
if [ "$service" == "postgres" ]; then
postgres_found=true
elif [ "$service" == "inbucket" ]; then
inbucket_found=true
fi
fi
break
fi
done
if [ -z "$port" ]; then
mme2e_log "Unknown service $svc"
exit 1
fi
services+=("$service:$port")
done
# Check if the required services such as postgres and inbucket are found
# Do not continue if any of the required services are not found.
if [ "$postgres_found" != true ] || [ "$inbucket_found" != true ]; then
mme2e_log "When overriding docker compose via ENABLED_DOCKER_SERVICES, postgres and inbucket are both required."
exit 1
fi
# Define each service values
postgres='
postgres:
image: mattermostdevelopment/mirrored-postgres:12
restart: always
environment:
POSTGRES_USER: mmuser
POSTGRES_PASSWORD: mostest
POSTGRES_DB: mattermost_test
command: postgres -c "config_file=/etc/postgresql/postgresql.conf"
volumes:
- ../../server/build/docker/postgres.conf:/etc/postgresql/postgresql.conf
healthcheck:
test: ["CMD", "pg_isready", "-h", "localhost"]
interval: 10s
timeout: 15s
retries: 12
networks:
default:
aliases:
- postgres'
inbucket='
inbucket:
restart: "no"
container_name: mattermost-inbucket
ports:
- "9001:9001"
- "10025:10025"
- "10110:10110"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: inbucket'
minio='
minio:
restart: "no"
container_name: mattermost-minio
ports:
- "9000:9000"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: minio'
openldap='
openldap:
restart: "no"
container_name: mattermost-openldap
ports:
- "389:389"
- "636:636"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: openldap'
elasticsearch='
elasticsearch:
restart: "no"
container_name: mattermost-elasticsearch
ports:
- "9200:9200"
- "9300:9300"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: elasticsearch'
elasticsearch_arm64='
elasticsearch:
image: mattermostdevelopment/mattermost-elasticsearch:7.17.10
platform: linux/arm64/v8
restart: "no"
container_name: mattermost-elasticsearch
ports:
- "9200:9200"
- "9300:9300"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: elasticsearch'
keycloak='
keycloak:
restart: "no"
container_name: mattermost-keycloak
ports:
- "8484:8080"
extends:
file: ../../server/build/gitlab-dc.common.yml
service: keycloak'
# Function to get the service value based on the key
get_service_val_by_key() {
local key="$1"
if [ "$MME2E_ARCHTYPE" = "arm64" ] && [ "$key" = "elasticsearch" ]; then
# Use arm64 version of elasticsearch
key="elasticsearch_arm64"
fi
# Use variable indirection to retrieve the value
local service_val="${!key}"
echo "$service_val"
}
# Generate the docker compose override file
cat <<EOL >"$CONFIG_FILE"
# Image hashes in this file are for amd64 systems
# NB: May include paths relative to the "server/build" directory, which contains the original compose file that this yaml is overriding
version: "2.4"
services:
server:
image: \${SERVER_IMAGE}
restart: always
env_file:
- "./.env.server"
- "./.env.server.cloud"
environment:
MM_LICENSE: \${MM_LICENSE}
MM_SERVICESETTINGS_SITEURL: http://server:8065
MM_SERVICESETTINGS_ENABLELOCALMODE: "true"
MM_PLUGINSETTINGS_ENABLED: "true"
MM_PLUGINSETTINGS_ENABLEUPLOADS: "true"
MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS: "true"
MM_TEAMSETTINGS_ENABLEOPENSERVER: "true"
MM_SQLSETTINGS_DATASOURCE: "postgres://mmuser:mostest@postgres:5432/mattermost_test?sslmode=disable&connect_timeout=10&binary_parameters=yes"
MM_SQLSETTINGS_DRIVERNAME: "postgres"
MM_EMAILSETTINGS_SMTPSERVER: "inbucket"
MM_CLUSTERSETTINGS_READONLYCONFIG: "false"
MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW: "false"
MM_FEATUREFLAGS_ONBOARDINGTOURTIPS: "false"
MM_SERVICEENVIRONMENT: "test"
ports:
- "8065:8065"
depends_on:
$(for service in "${docker_services[@]}"; do
echo " $service:"
echo " condition: service_healthy"
done)
$(for service in "${docker_services[@]}"; do
service_val=$(get_service_val_by_key "$service")
if [ -n "$service_val" ]; then
echo "$service_val"
fi
done)
start_dependencies:
image: mattermost/mattermost-wait-for-dep:latest
depends_on:
$(for service in "${docker_services[@]}"; do
echo " - $service"
done)
command: $(
IFS=' '
echo "${services[*]}"
)
networks:
default:
networks:
default:
name: \${COMPOSE_PROJECT_NAME}
external: true
EOL
mme2e_log "Configuration generated in $CONFIG_FILE"

38
e2e-tests/.ci/server.cloud_customer_create.sh Исполняемый файл
Просмотреть файл

@@ -0,0 +1,38 @@
#!/bin/bash
set -e -u -o pipefail
cd "$(dirname "$0")"
. .e2erc
if [ "$SERVER" != "cloud" ]; then
mme2e_log "Not applicable to SERVER='$SERVER'. For cloud only."
exit 0
fi
# Check if CWS_URL is set or not
if [ -n "${CWS_URL-}" ] && [ -n "$CWS_URL" ]; then
mme2e_log "CWS_URL is set."
else
mme2e_log "Environment variable CWS_URL is empty or unset. It must be set to create test cloud customer."
exit 1
fi
response=$(curl -X POST "${CWS_URL}/api/v1/internal/tests/create-customer?sku=cloud-enterprise&is_paid=true")
MM_CUSTOMER_ID=$(echo "$response" | jq -r .customer_id)
MM_CLOUD_API_KEY=$(echo "$response" | jq -r .api_key)
MM_CLOUD_INSTALLATION_ID=$(echo "$response" | jq -r .installation_id)
export MM_CUSTOMER_ID=$MM_CUSTOMER_ID
export MM_CLOUD_API_KEY=$MM_CLOUD_API_KEY
export MM_CLOUD_INSTALLATION_ID=$MM_CLOUD_INSTALLATION_ID
export MM_CLOUDSETTINGS_CWSURL=$CWS_URL
export MM_CLOUDSETTINGS_CWSAPIURL=$CWS_URL
mme2e_generate_envfile_from_var_names >.env.server.cloud <<EOF
MM_CLOUDSETTINGS_CWSURL
MM_CLOUDSETTINGS_CWSAPIURL
MM_CLOUD_API_KEY
MM_CUSTOMER_ID
MM_CLOUD_INSTALLATION_ID
EOF
mme2e_log "Test cloud customer created, MM_CUSTOMER_ID: $MM_CUSTOMER_ID."

25
e2e-tests/.ci/server.cloud_customer_delete.sh Исполняемый файл
Просмотреть файл

@@ -0,0 +1,25 @@
#!/bin/bash
set -e -u -o pipefail
cd "$(dirname "$0")"
. .e2erc
if [ "$SERVER" != "cloud" ]; then
mme2e_log "Not applicable to SERVER='$SERVER'. For cloud only."
exit 0
fi
mme2e_log "Loading .env.server.cloud"
. .env.server.cloud
# Check if CWS_URL is set or not
if [ -n "${CWS_URL-}" ] && [ -n "$CWS_URL" ]; then
mme2e_log "CWS_URL is set."
else
mme2e_log "Environment variable CWS_URL is empty or unset. It must be set to delete test cloud customer."
exit 1
fi
mme2e_log "Deleting customer $MM_CUSTOMER_ID."
curl -X DELETE "${CWS_URL}/api/v1/internal/tests/customers/$MM_CUSTOMER_ID/payment-customer"
mme2e_log "Test cloud customer deleted, MM_CUSTOMER_ID: $MM_CUSTOMER_ID."

Просмотреть файл

@@ -1,131 +0,0 @@
---
# Image hashes in this file are for amd64 systems
# NB: paths relative to the `server/build` directory, which contains the original compose file that this yaml is overriding
version: "2.4"
services:
server:
image: "${SERVER_IMAGE}"
restart: always
env_file:
- "../../e2e-tests/.ci/.env.server"
environment:
MM_SERVICESETTINGS_SITEURL: "http://server:8065"
MM_SERVICESETTINGS_ENABLELOCALMODE: "true"
MM_SERVICESETTINGS_ALLOWCORSFROM: "http://localhost:8065"
MM_PLUGINSETTINGS_ENABLED: "true"
MM_PLUGINSETTINGS_ENABLEUPLOADS: "true"
MM_PLUGINSETTINGS_AUTOMATICPREPACKAGEDPLUGINS: "true"
MM_TEAMSETTINGS_ENABLEOPENSERVER: "true"
MM_ELASTICSEARCHSETTINGS_CONNECTIONURL: "true"
MM_SQLSETTINGS_DATASOURCE: "postgres://mmuser:mostest@postgres:5432/mattermost_test?sslmode=disable&connect_timeout=10&binary_parameters=yes"
MM_SQLSETTINGS_DRIVERNAME: "postgres"
MM_LDAPSETTINGS_LDAPSERVER: "openldap"
MM_EMAILSETTINGS_SMTPSERVER: "inbucket"
MM_CLUSTERSETTINGS_READONLYCONFIG: "false"
MM_FEATUREFLAGS_USECASEONBOARDING: "false"
MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW: "false"
MM_FEATUREFLAGS_ONBOARDINGTOURTIPS: "false"
MM_SERVICEENVIRONMENT: "test"
volumes:
- "server-config:/mattermost/config"
ports:
- "8065:8065"
depends_on:
postgres:
condition: service_healthy
minio:
condition: service_healthy
inbucket:
condition: service_healthy
openldap:
condition: service_healthy
elasticsearch:
condition: service_healthy
keycloak:
condition: service_healthy
dejavu:
condition: service_healthy
prometheus:
condition: service_healthy
grafana:
condition: service_healthy
webhook-interactions:
condition: service_healthy
webhook-interactions:
image: mattermostdevelopment/mirrored-node:${NODE_VERSION_REQUIRED}
command: sh -c "npm install -g axios express client-oauth2@larkox/js-client-oauth2#e24e2eb5dfcbbbb3a59d095e831dbe0012b0ac49 && exec node webhook_serve.js"
environment:
NODE_PATH: /usr/local/lib/node_modules/
healthcheck:
test: ["CMD", "curl", "-s", "-o/dev/null", "127.0.0.1:3000"]
interval: 10s
timeout: 15s
retries: 12
working_dir: /cypress
volumes:
- "../../e2e-tests/cypress/:/cypress:ro"
networks:
default:
aliases:
- webhook-interactions
cypress:
image: "cypress/browsers:node-18.16.1-chrome-114.0.5735.133-1-ff-114.0.2-edge-114.0.1823.51-1"
### Temorarily disabling this image, until both the amd64 and arm64 version are mirrored
# image: "mattermostdevelopment/mirrored-cypress-browsers-public:node-18.16.1-chrome-114.0.5735.133-1-ff-114.0.2-edge-114.0.1823.51-1"
entrypoint: ["/bin/bash", "-c"]
command: ["until [ -f /var/run/mm_terminate ]; do sleep 5; done"]
env_file:
- "../../e2e-tests/.ci/.env.dashboard"
- "../../e2e-tests/.ci/.env.cypress"
environment:
REPO: "mattermost-server"
# Cypress configuration
HEADLESS: "true"
CYPRESS_baseUrl: "http://server:8065"
CYPRESS_dbConnection: "postgres://mmuser:mostest@postgres:5432/mattermost_test?sslmode=disable&connect_timeout=10"
CYPRESS_elasticsearchConnectionURL: "http://elasticsearch:9200"
CYPRESS_keycloakBaseUrl: "http://keycloak:8484"
CYPRESS_ldapServer: "openldap"
CYPRESS_minioS3Endpoint: "minio:9000"
CYPRESS_smtpUrl: "http://inbucket:9001"
CYPRESS_webhookBaseUrl: "http://webhook-interactions:3000"
CYPRESS_chromeWebSecurity: "false"
CYPRESS_firstTest: "true"
CYPRESS_resetBeforeTest: "true"
CYPRESS_runLDAPSync: "true"
CYPRESS_allowedUntrustedInternalConnections: "localhost webhook-interactions"
CYPRESS_serverEdition: E20
TM4J_ENABLE: "false"
# disable shared memory X11 affecting Cypress v4 and Chrome
# https://github.com/cypress-io/cypress-docker-images/issues/270
QT_X11_NO_MITSHM: "1"
_X11_NO_MITSHM: "1"
_MITSHM: "0"
# avoid too many progress messages
# https://github.com/cypress-io/cypress/issues/1243
CI: "1"
# Ensure we're independent from the global node environment
PATH: /cypress/node_modules/.bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
ulimits:
nofile:
soft: 8096
hard: 1048576
working_dir: /cypress
volumes:
- "../../e2e-tests/cypress/:/cypress"
utils:
image: "mattermost/mattermost-build-server:20230904_golang-1.20.7"
entrypoint: ["/bin/bash", "-c"]
command: ["until [ -f /var/run/mm_terminate ]; do sleep 5; done"]
environment:
MM_SERVICEENVIRONMENT: "test" # Currently required for running the config_generator with the right environment
working_dir: "/opt/mattermost-server"
volumes:
- "../../:/opt/mattermost-server"
- "server-config:/opt/server-config"
volumes:
server-config:

Просмотреть файл

@@ -1,27 +1,34 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
if [ "$TEST" != "cypress" ]; then
mme2e_log "Not applicable to TEST='$TEST'. For cypress only."
exit 0
fi
# Install cypress dependencies
mme2e_log "Prepare Cypress: install dependencies"
${MME2E_DC_SERVER} exec -T -u 0 -- cypress bash -c "id $MME2E_UID || useradd -u $MME2E_UID -m nodeci" # Works around the node image's assumption that the app files are owned by user 1000
${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress npm i
${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress cypress install
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- cypress npm i
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- cypress cypress install
# Populate cypress fixtures
mme2e_log "Prepare Cypress: populating fixtures"
${MME2E_DC_SERVER} exec -T -- server curl -L --silent https://github.com/mattermost/mattermost-plugin-gitlab/releases/download/v1.3.0/com.github.manland.mattermost-plugin-gitlab-1.3.0.tar.gz | ${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress tee tests/fixtures/com.github.manland.mattermost-plugin-gitlab-1.3.0.tar.gz >/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
${MME2E_DC_SERVER} exec -T -- server curl -L --silent https://github.com/mattermost/mattermost-plugin-gitlab/releases/download/v1.3.0/com.github.manland.mattermost-plugin-gitlab-1.3.0.tar.gz | ${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- cypress tee tests/fixtures/com.github.manland.mattermost-plugin-gitlab-1.3.0.tar.gz >/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
if [[ $ENABLED_DOCKER_SERVICES == *"openldap"* ]]; then
${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
fi
if [[ $ENABLED_DOCKER_SERVICES == *"minio"* ]]; then
${MME2E_DC_SERVER} exec -T -- minio sh -c 'mkdir -p /data/mattermost-test'
fi
# 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)"

Просмотреть файл

@@ -1,7 +1,8 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
# Set required variables
TEST_FILTER_DEFAULT='--stage=@prod --group=@smoke'
@@ -9,8 +10,8 @@ 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"
${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 <<INNEREOF
node version: $(node -v)
npm version: $(npm -v)
@@ -23,7 +24,7 @@ EOF
# Initialize cypress report directory
mme2e_log "Prepare Cypress: clean and initialize report and logs directory"
${MME2E_DC_SERVER} exec -T -u $MME2E_UID -- cypress bash <<EOF
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- cypress bash <<EOF
rm -rf logs results
mkdir -p logs
mkdir -p results/junit
@@ -33,13 +34,16 @@ 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
# shellcheck disable=SC2016
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"
# shellcheck disable=SC2086
${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
mme2e_log "AUTOMATION_DASHBOARD_URL is unset. Using run_tests.js for the cypress run"
# shellcheck disable=SC2086
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- cypress node run_tests.js $TEST_FILTER | tee ../cypress/logs/cypress.log
fi
# Collect server logs

28
e2e-tests/.ci/server.run_playwright.sh Исполняемый файл
Просмотреть файл

@@ -0,0 +1,28 @@
#!/bin/bash
set -e -u -o pipefail
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
# Initialize Playwright report directory
mme2e_log "Prepare Playwright: clean and initialize report and logs directory"
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- playwright bash <<EOF
cd e2e-tests/playwright
rm -rf logs playwright-report test-results storage_state
mkdir -p logs
touch logs/mattermost.log
EOF
# Install Playwright dependencies
mme2e_log "Prepare Playwright: install dependencies"
${MME2E_DC_SERVER} exec -T -u "$MME2E_UID" -- playwright bash -c "cd e2e-tests/playwright && rm -rf node_modules && npm install --cache /tmp/empty-cache"
# Enable next line to debug Playwright
# export DEBUG=pw:protocol,pw:browser,pw:api
# Run Playwright test
# Note: Run on chrome but eventually will enable to all projects which include firefox and ipad.
${MME2E_DC_SERVER} exec -i -u "$MME2E_UID" -- playwright bash -c "cd e2e-tests/playwright && npm run test -- --project=chrome" | tee ../playwright/logs/playwright.log
# Collect server logs
${MME2E_DC_SERVER} logs --no-log-prefix -- server >../playwright/logs/mattermost.log 2>&1

Просмотреть файл

@@ -1,31 +1,48 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
export BRANCH_DEFAULT=$(git branch --show-current)
if [ "$TEST" != "cypress" ] && [ "$TEST" != "playwright" ] && [ "$TEST" != "server" ]; then
mme2e_log "Invalid TEST='$TEST', expected: 'cypress', 'playwright' or 'server'"
exit 1
fi
BRANCH_DEFAULT=$(git branch --show-current)
export BRANCH=${BRANCH:-$BRANCH_DEFAULT}
export BUILD_ID_DEFAULT=$(date +%s)
BUILD_ID_DEFAULT=$(date +%s)
export BUILD_ID=${BUILD_ID:-$BUILD_ID_DEFAULT}
export CI_BASE_URL="${CI_BASE_URL:-localhost}"
export SITE_URL="${SITE_URL:-http://server:8065}"
# Cleanup old containers, if any
mme2e_log "Stopping leftover E2E containers, if any are running"
${MME2E_DC_SERVER} down -v
${MME2E_DC_SERVER} down -v --remove-orphans
# Generate .env.server
mme2e_log "Generating .env.server"
if [ "$SERVER" = "cloud" ]; then
export "MM_NOTIFY_ADMIN_COOL_OFF_DAYS=0.00000001"
export 'MM_FEATUREFLAGS_ANNUALSUBSCRIPTION="true"'
fi
mme2e_generate_envfile_from_var_names >.env.server <<EOF
MM_LICENSE
MM_ELASTICSEARCHSETTINGS_CONNECTIONURL
MM_LDAPSETTINGS_LDAPSERVER
MM_NOTIFY_ADMIN_COOL_OFF_DAYS
MM_FEATUREFLAGS_ANNUALSUBSCRIPTION
EOF
# shellcheck disable=SC2086
envarr=$(echo ${MM_ENV:-} | tr "," "\n")
for env in $envarr; do
echo "$env" >> .env.server
echo "$env" >>.env.server
done
# Generate .env.cypress
mme2e_log "Generating .env.cypress"
mme2e_generate_envfile_from_var_names >.env.cypress <<EOF
if [ "$TEST" = "cypress" ]; then
# Generate .env.cypress
mme2e_log "Cypress: Generating .env.cypress"
mme2e_generate_envfile_from_var_names >.env.cypress <<EOF
BRANCH
BUILD_ID
CI_BASE_URL
@@ -34,30 +51,47 @@ AUTOMATION_DASHBOARD_URL
AUTOMATION_DASHBOARD_TOKEN
EOF
# Additional variables to .env.cypress
if [[ $ENABLED_DOCKER_SERVICES == *"openldap"* ]]; then
echo "CYPRESS_ldapServer=openldap" >>.env.cypress
echo "CYPRESS_runLDAPSync=true" >>.env.cypress
fi
if [[ $ENABLED_DOCKER_SERVICES == *"minio"* ]]; then
echo "CYPRESS_minioS3Endpoint=minio:9000" >>.env.cypress
fi
if [[ $ENABLED_DOCKER_SERVICES == *"keycloak"* ]]; then
echo "CYPRESS_keycloakBaseUrl=http://keycloak:8484" >>.env.cypress
fi
if [[ $ENABLED_DOCKER_SERVICES == *"elasticsearch"* ]]; then
echo "CYPRESS_elasticsearchConnectionURL=http://elasticsearch:9200" >>.env.cypress
fi
if [ "$SERVER" = "cloud" ]; then
echo "CYPRESS_serverEdition=Cloud" >>.env.cypress
else
echo "CYPRESS_serverEdition=E20" >>.env.cypress
fi
elif [ "$TEST" = "playwright" ]; then
# Generate .env.playwright
mme2e_log "Playwright: Generating .env.playwright"
mme2e_generate_envfile_from_var_names >.env.playwright <<EOF
BRANCH
BUILD_ID
EOF
else
mme2e_log "Preparing server setup only"
fi
# Wait for the required server image
mme2e_log "Waiting for server image to be available"
mme2e_wait_image ${SERVER_IMAGE} 30 60
# Create the containers and generate the server config
mme2e_log "Creating E2E containers and generating server config"
${MME2E_DC_SERVER} create
${MME2E_DC_SERVER} up -d -- utils
${MME2E_DC_SERVER} exec -T -w /opt/mattermost-server/server -- utils bash <<EOF
OUTPUT_CONFIG=/tmp/config_generated.json go run scripts/config_generator/main.go
jq "
.ServiceSettings.SiteURL=\"http://server:8065\"
| .PluginSettings.Enable=true
| .PluginSettings.EnableUploads=true
| .PluginSettings.AutomaticPrepackagedPlugins=true
| .TeamSettings.EnableOpenServer=true
| .ElasticsearchSettings.ConnectionURL=\"http://elasticsearch:9200\"
" </tmp/config_generated.json >/opt/server-config/config.json
echo "### Generated server config:"
cat /opt/server-config/config.json
EOF
mme2e_wait_image "$SERVER_IMAGE" 30 60
# Launch mattermost-server, and wait for it to be healthy
mme2e_log "Starting E2E containers"
${MME2E_DC_SERVER} create
${MME2E_DC_SERVER} up -d
if ! mme2e_wait_service_healthy server 60 10; then
mme2e_log "Mattermost container not healthy, retry attempts exhausted. Giving up." >&2

Просмотреть файл

@@ -1,7 +1,8 @@
#!/bin/bash
set -e -u -o pipefail
cd $(dirname $0)
cd "$(dirname "$0")"
. .e2erc
. .e2erc_setup
mme2e_log "Stopping E2E containers"
${MME2E_DC_SERVER} down -v
${MME2E_DC_SERVER} down -v --remove-orphans