run.sh

#!/usr/bin/env bash

if [ ! -f "cypress.config.js" ]; then
  echo "ERROR: you need to run this script in e2e folder!"
  exit 1
fi

function help_me() {
  echo "Usage: run.sh --host|-h HOST --e2e-path|-e2e --record|-r --app|-a --browser|-b chrome|firefox|electron* --debug|-d CYPRESS-DEBUG-FLAG* SPEC_FILE*"
  echo "       run.sh --help                                                   # will print out this message"
  echo "       run.sh --host https://ui.juno.qa-de-1.cloud.sap/ ui-components  # run ui-components tests"
  echo "       run.sh --host https://juno.qa-de-1.cloud.sap/ dashboard         # run dashboard tests"
  echo "       run.sh --host http://localhost:3000 --debug 'cypress:network:*' # will show debug information about the networking"
  echo "       run.sh --e2e_path                                               # this optional if not set \$PWD is used"
  echo "       run.sh --record (Not Supported!)                                # record your test in cypress-dashboard"
  echo "       run.sh --browser chrome                                         # choose browser to test (default is chrome)"
  echo "       run.sh --app JUNO_APP                                           # this is optional and specify the specfile to run"
  echo ""
  echo "MAC users: ./run.sh --host http://host.docker.internal:3000"
  echo ""
  echo "Debugging options: https://docs.cypress.io/guides/references/troubleshooting#Log-sources"
  echo "cypress:cli                 The top-level command line parsing problems"
  echo "cypress:server:args         Incorrect parsed command line arguments"
  echo "cypress:server:specs        Not finding the expected specs"
  echo "cypress:server:project      Opening the project"
  echo "cypress:server:browsers     Finding installed browsers"
  echo "cypress:launcher            Launching the found browser"
  echo "cypress:network:*           Adding network interceptors"
  echo "cypress:net-stubbing*       Network interception in the proxy layer"
  echo "cypress:server:reporter     Problems with test reporters"
  echo "cypress:server:preprocessor Processing specs"
  echo "cypress:server:plugins      Running the plugins file and bundling specs"
  echo "cypress:server:socket-e2e   Watching spec files"
  echo "cypress:server:task         Invoking the cy.task() command"
  echo "cypress:server:socket-base  Debugging cy.request() command"
  echo "cypress:webpack             Bundling specs using webpack"
  exit 1
}

SPECS_FOLDER="cypress/integration/**/*"
CY_CMD="cypress"
if [[ "$1" == "--help" ]]; then
  help_me
else
  while [[ $# -gt 0 ]]; do
    key="$1"

    case $key in
    -h | --host)
      HOST="$2"
      shift # past argument
      shift # past value
      ;;
    -d | --debug)
      DEBUG="$2"
      shift # past argument
      shift # past value
      ;;
    -e2e | --e2e-path) # local path for e2e
      E2E_PATH="$2"
      shift # past argument
      shift # past value
      ;;
    -a | --app)
      JUNO_APP="$2"
      SPECS_FOLDER="cypress/integration/$JUNO_APP/*"
      shift # past argument
      shift # past value
      ;;
    -b | --browser)
      CYPRESS_BROWSER="$2"
      shift # past argument
      shift # past value
      ;;
    -i | --info)
      docker run -it --rm --entrypoint=cypress keppel.eu-de-1.cloud.sap/ccloud/cypress-client:latest info
      exit
      ;;
    -r | --record)
      hostname=$(hostname)
      CI_BUID_ID="$(date) - DEV - $hostname"
      CY_CMD="cypress-cloud"
      shift # past argument
      ;;
    *) # test folder
      if [[ -z "$JUNO_APP" ]]; then
        SPECS_FOLDER="cypress/integration/$1/*"
      else
        SPECS_FOLDER="cypress/integration/$JUNO_APP/$1/*"
      fi
      shift # past argument
      ;;
    esac
  done
fi

if [[ -z "${E2E_PATH}" ]]; then
  E2E_PATH=$PWD
fi

# find the host if nothing was given
if [[ -z "${HOST}" ]]; then
  if [ -f "/usr/local/bin/wb" ]; then
    # this runs only in workspaces!!!
    APP_PORT=$(wb juno 'echo $APP_PORT' | tail -1 | tr -d '\r')
    SHOW_APP_PORT="APP_PORT     => $APP_PORT"
    HOST="http://localhost:$APP_PORT"
  fi

  if [[ -z "${APP_PORT}" ]]; then
    echo "Error: no APP_PORT found"
    help_me
  fi
fi

if [[ -z "${CYPRESS_BROWSER}" ]]; then
  CYPRESS_BROWSER="chrome"
fi

# https://docs.cypress.io/guides/guides/command-line#cypress-run
# --ci-build-id https://docs.cypress.io/guides/guides/command-line#cypress-run-ci-build-id-lt-id-gt
# --paralell    https://docs.cypress.io/guides/guides/parallelization#Turning-on-parallelization
# https://docs.sorry-cypress.dev/guide/get-started
# NOTE: for record you will find all other options in the currents.config.js file
if [[ -n "${CI_BUID_ID}" ]]; then
  CY_OPTIONS=(--record --parallel --ci-build-id "$CI_BUID_ID - $CYPRESS_BROWSER")
fi

echo "$SHOW_APP_PORT"
echo "HOST          => $HOST"
echo "BROWSER       => $CYPRESS_BROWSER"
echo "SPECS         => $SPECS_FOLDER"
echo "E2E_PATH      => $E2E_PATH"
if [[ -n "$DEBUG" ]]; then
  echo "DEBUG:       => $DEBUG"
fi
echo ""

docker run --rm -it --volume "$E2E_PATH:/e2e" \
  --workdir "/e2e" \
  --env DEBUG="$DEBUG" \
  --env CYPRESS_BASE_URL="$HOST" \
  --entrypoint $CY_CMD \
  --network=host \
  keppel.eu-de-1.cloud.sap/ccloud-dockerhub-mirror/cypress/included:12.17.3 run "${CY_OPTIONS[@]}" --spec "$SPECS_FOLDER" --browser $CYPRESS_BROWSER
# https://github.wdf.sap.corp/cc/secrets/tree/master/ci/cypress-dashboard/Dockerfile
# https://main.ci.eu-de-2.cloud.sap/teams/services/pipelines/cypress-dashboard/jobs/build-cypress-client-image/