Dashboards observability plugin E2E test #147
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: Dashboards observability plugin E2E test | |
on: | |
schedule: | |
- cron: '0 0 * * *' | |
workflow_dispatch: | |
env: | |
PLUGIN_NAME: dashboards-observability | |
OPENSEARCH_DASHBOARDS_VERSION: 'main' | |
OPENSEARCH_VERSION: '3.0.0' | |
OPENSEARCH_PLUGIN_VERSION: '3.0.0.0' | |
jobs: | |
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] | |
testgroups: [ | |
app_analytics_test, | |
notebooks_test, | |
datasources_test, | |
event_analytics_test, | |
integrations_test, | |
metrics_analytics_test, | |
notebooks_test, | |
panels_test, | |
trace_analytics_test | |
] | |
include: | |
- os: ubuntu-latest | |
cypress_cache_folder: ~/.cache/Cypress | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Set up Java 11 | |
uses: actions/setup-java@v3 | |
with: | |
distribution: 'corretto' | |
java-version: '11' | |
- 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 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 | |
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: Bootstrap the plugin | |
run: | | |
cd OpenSearch-Dashboards/plugins/dashboards-observability | |
yarn osd bootstrap | |
- 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 | |
echo "Start checking OpenSearch Dashboards." | |
for i in {1..60}; do | |
if grep -q "bundles compiled successfully after" "dashboard.log"; then | |
echo "OpenSearch Dashboards compiled successfully." | |
break | |
fi | |
if [ $i -eq 60 ]; then | |
echo "Timeout for 600 seconds reached. OpenSearch Dashboards did not finish compiling." | |
exit 1 | |
fi | |
sleep 10 | |
done | |
- name: Install Cypress | |
run: | | |
cd ./OpenSearch-Dashboards/plugins/dashboards-observability | |
npx cypress install | |
shell: bash | |
- name: Get Cypress version | |
id: cypress_version | |
run: | | |
cd ./OpenSearch-Dashboards/plugins/dashboards-observability | |
echo "::set-output name=cypress_version::$(cat ./package.json | jq '.dependencies.cypress' | tr -d '"')" | |
- name: Reset npm's script shell | |
if: ${{ matrix.os == 'windows-latest' }} | |
run: | | |
npm config delete script-shell | |
- name: Run Cypress tests for test group of ${{ matrix.testgroups }} | |
run: | | |
cd ./OpenSearch-Dashboards/plugins/dashboards-observability | |
yarn cypress:run --browser chrome --headless --spec '.cypress/integration/${{ matrix.testgroups }}/*' | |
- name: Capture failure screenshots | |
uses: actions/upload-artifact@v1 | |
if: failure() | |
with: | |
name: cypress-screenshots-${{ matrix.os }} | |
path: OpenSearch-Dashboards/plugins/dashboards-observability/.cypress/screenshots | |
- name: Capture test video | |
uses: actions/upload-artifact@v1 | |
if: always() | |
with: | |
name: cypress-videos-${{ matrix.os }} | |
path: OpenSearch-Dashboards/plugins/dashboards-observability/.cypress/videos |