team/e2e-tests/.ci/report.publish.sh

#!/bin/bash
# SC2034: <variable> appears unused.
# https://www.shellcheck.net/wiki/SC2034
# shellcheck disable=SC2034
# shellcheck disable=SC2086,SC2223

set -e -u -o pipefail
cd "$(dirname "$0")"
. .e2erc

# Default or assert variables required by the save_report.js script, and document optional variables
: ${FULL_REPORT:=false} # Valid values: true, false
: ${TYPE:=NONE}         # Valid values: PR, RELEASE, MASTER, MASTER_UNSTABLE, CLOUD, CLOUD_UNSTABLE, NONE (which is the same as omitting it); also known as REPORT_TYPE
: ${WEBHOOK_URL:-}      # Optional. Mattermost webhook to post the report back to
: ${RELEASE_DATE:-}     # Optional. If set, its value will be included in the report as the release date of the tested artifact
if [ "$TYPE" = "PR" ]; then
  # Try to determine PR number: first from PR_NUMBER, then from BRANCH (server-pr-XXXX format)
  if [ -n "${PR_NUMBER:-}" ]; then
    export PULL_REQUEST="https://github.com/mattermost/mattermost/pull/${PR_NUMBER}"
  elif grep -qE '^server-pr-[0-9]+$' <<<"${BRANCH:-}"; then
    PR_NUMBER="${BRANCH##*-}"
    export PULL_REQUEST="https://github.com/mattermost/mattermost/pull/${PR_NUMBER}"
  else
    mme2e_log "Warning: TYPE=PR but cannot determine PR number from PR_NUMBER or BRANCH. Falling back to TYPE=NONE."
    TYPE=NONE
  fi
fi

# Env vars used during the test. Their values will be included in the report
: ${TEST:?}   # See E2E tests' readme
: ${BRANCH:?} # May be either a ref, a commit hash, or 'server-pr-PR_NUMBER' (if TYPE=PR)
: ${BUILD_ID:?}
: ${SERVER:?} # May be either 'onprem' or 'cloud'
: ${MM_ENV:-}

# Populate intermediate variables
export BUILD_TAG="${SERVER_IMAGE##*/}"
export MM_DOCKER_IMAGE="${BUILD_TAG%%:*}" # NB: the 'mattermostdevelopment/' prefix is assumed
export MM_DOCKER_TAG="${BUILD_TAG##*:}"
export SERVER_TYPE="${SERVER}"
export AUTOMATION_DASHBOARD_FRONTEND_URL="${AUTOMATION_DASHBOARD_URL:+${AUTOMATION_DASHBOARD_URL%%/api}}"

if [ -n "${TM4J_API_KEY:-}" ]; then
  # Set additional variables required for Zephyr reporting
  if grep -q 'UNSTABLE' <<<"$TYPE"; then
    export TEST_SUITE=prod
  else
    export TEST_SUITE=unstable
  fi
  if [ "$TYPE" = "RELEASE" ]; then
    export SERVER_ARTIFACT_TYPE=release
  else
    export SERVER_ARTIFACT_TYPE=master
    export TEST_IS_DAILY=yes
  fi
  export TM4J_ENABLE=true
  export JIRA_PROJECT_KEY=MM
  export TM4J_ENVIRONMENT_NAME="${TEST@u}/${BROWSER@u}/${SERVER_ARTIFACT_TYPE}-${SERVER_TYPE}-ent${TEST_IS_DAILY:+-${TEST_SUITE}}"
  # Assert that the test type is among the ones supported by Zephyr, and select the corresponding folderId
  case "${SERVER}-${TYPE}" in
  onprem-RELEASE)
    export TM4J_FOLDER_ID="2014475"
    ;;
  onprem-MASTER)
    export TM4J_FOLDER_ID="2014476"
    ;;
  onprem-MASTER_UNSTABLE)
    export TM4J_FOLDER_ID="2014478"
    ;;
  cloud-RELEASE)
    export TM4J_FOLDER_ID="2014474"
    ;;
  cloud-CLOUD)
    export TM4J_FOLDER_ID="2014479"
    ;;
  cloud-CLOUD_UNSTABLE)
    export TM4J_FOLDER_ID="2014481"
    ;;
  *)
    mme2e_log "Error: unsupported Zephyr environment for the requested report (SERVER=${SERVER}, TYPE=${TYPE}). Aborting." >&2
    exit 1
    ;;
  esac
  : ${TEST_CYCLE_LINK_PREFIX:?}
  : ${TM4J_CYCLE_KEY:-}  # Optional. Populated automatically by the reporting script
  : ${TM4J_CYCLE_NAME:-} # Optional. Populated automatically by the reporting script
  mme2e_log "TMJ4 integration enabled. Environment: $TM4J_ENVIRONMENT_NAME"
fi

if [ -n "${DIAGNOSTIC_WEBHOOK_URL:-}" ]; then
  : ${DIAGNOSTIC_USER_ID:?}
  : ${DIAGNOSTIC_TEAM_ID:?}
  mme2e_log "Diagnostic report upload enabled."
fi

# Double check that the "results/" subdirectory to collect report informations from exists
cd "../${TEST}/"
if [ ! -d "results/" ]; then
  mme2e_log "Error: 'results/' directory does not exist. Aborting report data collection." >&2
  exit 1
fi

case "$TEST" in
cypress)
  npm i
  node save_report.js
  ;;
playwright)
  if [ -n "$WEBHOOK_URL" ]; then
    PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i
    # Utilize environment data and report files to generate the webhook body
    node report.webhookgen.js | curl -X POST -fsSL -H 'Content-Type: application/json' -d @- "$WEBHOOK_URL"
  fi
  ;;
esac