feat: hide default dashboard setting when workspace is enabled (#2198) #462
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: [pull_request, push] | |
env: | |
PLUGIN_NAME: dashboards-observability | |
OPENSEARCH_DASHBOARDS_VERSION: "main" | |
OPENSEARCH_VERSION: "3.0.0" | |
OPENSEARCH_PLUGIN_VERSION: "3.0.0.0" | |
jobs: | |
tests: | |
name: Run test group of ${{ matrix.testgroups }} | |
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: [21] | |
testgroups: | |
[ | |
app_analytics_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 21 | |
uses: actions/setup-java@v3 | |
with: | |
distribution: "corretto" | |
java-version: "21" | |
- 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: Configure OpenSearch Dashboards | |
run: | | |
rm -rf ./config/opensearch_dashboards.yml | |
cat << 'EOT' > ./config/opensearch_dashboards.yml | |
server.host: "0.0.0.0" | |
home.disableWelcomeScreen: true | |
EOT | |
working-directory: OpenSearch-Dashboards | |
- 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') }} | |
restore-keys: | | |
${{ runner.OS }}-build- | |
- 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: 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 --headless --spec '.cypress/integration/${{ matrix.testgroups }}/*' | |
- name: Capture failure screenshots | |
uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: cypress-screenshots-${{ matrix.os }} | |
path: OpenSearch-Dashboards/plugins/dashboards-observability/.cypress/screenshots | |
- name: Capture test video | |
uses: actions/upload-artifact@v4 | |
if: always() | |
with: | |
name: cypress-videos-${{ matrix.os }} | |
path: OpenSearch-Dashboards/plugins/dashboards-observability/.cypress/videos |