[Backport 2.x] Fix flaky cypress tests #3519
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: FTR E2E Dashboards observability Test | |
on: | |
push: | |
pull_request: | |
schedule: | |
- cron: "0 0 * * *" | |
env: | |
PLUGIN_NAME: dashboards-observability | |
OPENSEARCH_DASHBOARDS_VERSION: "2.x" | |
jobs: | |
tests: | |
name: Run FTR E2E Dashboards Observability Tests | |
env: | |
# Prevents extra Cypress installation progress messages | |
CI: 1 | |
# Avoid warnings like "tput: No value for $TERM and no -T specified" | |
TERM: xterm | |
WORKING_DIR: ${{ matrix.working_directory }}. | |
strategy: | |
fail-fast: false | |
matrix: | |
os: [ubuntu-latest] | |
java: [11] | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Set up Java 11 | |
uses: actions/setup-java@v3 | |
with: | |
distribution: "corretto" | |
java-version: "11" | |
- name: Checkout Branch | |
uses: actions/checkout@v3 | |
- name: Set env | |
run: | | |
opensearch_version=$(node -p "require('./opensearch_dashboards.json').opensearchDashboardsVersion") | |
plugin_version=$(node -p "require('./opensearch_dashboards.json').version") | |
echo "OPENSEARCH_VERSION=$opensearch_version" >> $GITHUB_ENV | |
echo "OPENSEARCH_PLUGIN_VERSION=$plugin_version" >> $GITHUB_ENV | |
shell: bash | |
- name: Download Job Scheduler artifact | |
uses: suisei-cn/[email protected] | |
with: | |
url: https://aws.oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=org.opensearch.plugin&a=opensearch-job-scheduler&v=${{ env.OPENSEARCH_PLUGIN_VERSION }}-SNAPSHOT&p=zip | |
target: plugin-artifacts/ | |
filename: opensearch-job-scheduler.zip | |
- name: Download observability artifact | |
uses: suisei-cn/[email protected] | |
with: | |
url: https://aws.oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=org.opensearch.plugin&a=opensearch-observability&v=${{ env.OPENSEARCH_PLUGIN_VERSION }}-SNAPSHOT&p=zip | |
target: plugin-artifacts/ | |
filename: observability.zip | |
- name: Download SQL artifact | |
uses: suisei-cn/[email protected] | |
with: | |
url: https://aws.oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=org.opensearch.plugin&a=opensearch-sql-plugin&v=${{ env.OPENSEARCH_PLUGIN_VERSION }}-SNAPSHOT&p=zip | |
target: plugin-artifacts/ | |
filename: sql.zip | |
- name: Download OpenSearch | |
uses: peternied/download-file@v2 | |
with: | |
url: https://artifacts.opensearch.org/snapshots/core/opensearch/${{ env.OPENSEARCH_VERSION }}-SNAPSHOT/opensearch-min-${{ env.OPENSEARCH_VERSION }}-SNAPSHOT-linux-x64-latest.tar.gz | |
- name: Extract OpenSearch | |
run: | | |
tar -xzf opensearch-*.tar.gz | |
rm -f opensearch-*.tar.gz | |
shell: bash | |
- name: Install job scheduler plugin | |
run: | | |
/bin/bash -c "yes | ./opensearch-${{ env.OPENSEARCH_VERSION }}-SNAPSHOT/bin/opensearch-plugin install file:$(pwd)/plugin-artifacts/opensearch-job-scheduler.zip" | |
shell: bash | |
- name: Install observability plugin | |
run: | | |
/bin/bash -c "yes | ./opensearch-${{ env.OPENSEARCH_VERSION }}-SNAPSHOT/bin/opensearch-plugin install file:$(pwd)/plugin-artifacts/observability.zip" | |
shell: bash | |
- name: Install SQL plugin | |
run: | | |
/bin/bash -c "yes | ./opensearch-${{ env.OPENSEARCH_VERSION }}-SNAPSHOT/bin/opensearch-plugin install file:$(pwd)/plugin-artifacts/sql.zip" | |
shell: bash | |
- name: Run OpenSearch | |
run: /bin/bash -c "./opensearch-${{ env.OPENSEARCH_VERSION }}-SNAPSHOT/bin/opensearch &" | |
shell: bash | |
- name: Checkout OpenSearch Dashboards | |
uses: actions/checkout@v2 | |
with: | |
repository: opensearch-project/Opensearch-Dashboards | |
ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }} | |
path: OpenSearch-Dashboards | |
- name: Checkout dashboards observability | |
uses: actions/checkout@v2 | |
with: | |
path: OpenSearch-Dashboards/plugins/dashboards-observability | |
- name: Get node and yarn versions | |
working-directory: ${{ env.WORKING_DIR }} | |
id: versions_step | |
run: | | |
echo "::set-output name=node_version::$(cat ./OpenSearch-Dashboards/.nvmrc | cut -d"." -f1)" | |
echo "::set-output name=yarn_version::$(node -p "(require('./OpenSearch-Dashboards/package.json').engines.yarn).match(/[.0-9]+/)[0]")" | |
- name: Setup node | |
uses: actions/setup-node@v1 | |
with: | |
node-version: ${{ steps.versions_step.outputs.node_version }} | |
registry-url: "https://registry.npmjs.org" | |
- name: Install correct yarn version for OpenSearch Dashboards | |
id: setup-yarn | |
run: | | |
npm uninstall -g yarn | |
echo "Installing yarn ${{ steps.versions_step.outputs.yarn_version }}" | |
npm i -g yarn@${{ steps.versions_step.outputs.yarn_version }} | |
- name: Yarn Cache | |
uses: actions/cache@v4 | |
with: | |
path: | | |
OpenSearch-Dashboards/**/target | |
OpenSearch-Dashboards/**/node_modules | |
key: ${{ runner.OS }}-build-${{ hashFiles('OpenSearch-Dashboards/**/yarn.lock') }} | |
- name: Bootstrap OpenSearch Dashboards | |
run: | | |
cd OpenSearch-Dashboards | |
yarn osd bootstrap --single-version=loose | |
- name: Compile OpenSearch Dashboards | |
run: | | |
cd OpenSearch-Dashboards | |
node scripts/build_opensearch_dashboards_platform_plugins --no-examples --workers=10 --verbose | |
- name: Run OpenSearch Dashboards server | |
run: | | |
cd OpenSearch-Dashboards | |
nohup yarn start --no-base-path --no-watch | tee dashboard.log & | |
- name: Check If OpenSearch Dashboards Is Ready | |
if: ${{ runner.os == 'Linux' }} | |
run: | | |
cd ./OpenSearch-Dashboards | |
if timeout 60 grep -q "http server running" <(tail -n +1 -f dashboard.log); then | |
echo "OpenSearch Dashboards started successfully." | |
else | |
echo "Timeout of 60 seconds reached. OpenSearch Dashboards did not start successfully." | |
exit 1 | |
fi& | |
- name: Checkout Dashboards Functioanl Test Repo | |
uses: actions/checkout@v2 | |
with: | |
path: opensearch-dashboards-functional-test | |
repository: opensearch-project/opensearch-dashboards-functional-test | |
ref: ${{ env.OPENSEARCH_DASHBOARDS_VERSION }} | |
fetch-depth: 0 | |
- name: Install Cypress | |
run: | | |
npm install cypress --save-dev | |
shell: bash | |
working-directory: opensearch-dashboards-functional-test | |
- name: Get Cypress version | |
id: cypress_version | |
run: | | |
echo "::set-output name=cypress_version::$(cat ./package.json | jq '.dependencies.cypress' | tr -d '"')" | |
working-directory: opensearch-dashboards-functional-test | |
- name: Run Cypress tests | |
run: | | |
yarn cypress:run-without-security --browser chromium --spec 'cypress/integration/plugins/observability-dashboards/*.js' | |
working-directory: opensearch-dashboards-functional-test | |
- name: Capture failure screenshots | |
uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: cypress-screenshots-${{ matrix.os }} | |
path: opensearch-dashboards-functional-test/cypress/screenshots | |
- name: Capture failure test video | |
uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: cypress-videos-${{ matrix.os }} | |
path: opensearch-dashboards-functional-test/cypress/videos |