POC for running cypress tests outside FT repo

Signed-off-by: Manasvini B Suryanarayana <[email protected]>

.github/workflows/build_and_test_workflow.yml

@@ -6,7 +6,7 @@ name: Build and test
 # trigger on every commit push and PR for all branches except pushes for backport branches
 on:
  push:
- branches: ['**', '!backport/**']
+ branches: ['**', '!backport/**', '!POC/**']
  paths-ignore:
  - '**/*.md'
  - 'docs/**'

.github/workflows/cypress_workflow.yml

@@ -207,4 +207,4 @@ jobs:
 
  #### Link to results: 
  ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
- edit-mode: replace
+ edit-mode: replace

.github/workflows/remote_cypress_workflow.yml

@@ -0,0 +1,165 @@
+name: remote_cypress_workflow
+run-name: remote_cypress_workflow [${{ inputs.UNIQUE_ID}}] # Unique workflow number appended to the workflow run-name to filter the run results based on that.
+# trigger on every PR for all branches
+on:
+ push:
+ branches: [ '**' ]
+ workflow_dispatch:
+ inputs:
+ test_repo:
+ description: 'Cypress test repo'
+ default: ''
+ required: false
+ type: string
+ test_branch:
+ description: 'Cypress test branch (default: source branch)'
+ required: false
+ type: string
+ specs:
+ description: 'Tests to run (default: osd:ciGroup)'
+ required: false
+ type: string
+ build_id:
+ description: 'Build Id'
+ required: false
+ type: string
+ OS_URL:
+ description: 'OpenSearch release artifact'
+ required: false
+ type: string
+ OSD_URL:
+ description: 'OpenSearch Dashboards release artifact'
+ required: false
+ type: string
+ UNIQUE_ID:
+ description: 'Unique Id for the workflow execution'
+ required: true
+ type: string
+
+env:
+ TEST_REPO: ${{ inputs.test_repo != '' && inputs.test_repo || github.repository }}
+ TEST_BRANCH: "${{ inputs.test_branch != '' && inputs.test_branch || github.base_ref }}"
+ OSD_PATH: 'osd'
+ START_CMD: 'node ../scripts/opensearch_dashboards --dev --no-base-path --no-watch --savedObjects.maxImportPayloadBytes=10485760 --server.maxPayloadBytes=1759977 --logging.json=false --data.search.aggs.shardDelay.enabled=true'
+ OPENSEARCH_SNAPSHOT_CMD: 'node ../scripts/opensearch snapshot -E cluster.routing.allocation.disk.threshold_enabled=false'
+ CYPRESS_BROWSER: 'chromium'
+ JOB_ID: ${{ inputs.UNIQUE_ID}}
+ OPENSEARCH: ${{ inputs.OS_URL != '' && inputs.OS_URL || 'https://artifacts.opensearch.org/releases/bundle/opensearch/2.10.0/opensearch-2.10.0-linux-x64.tar.gz' }}
+ DASHBOARDS: ${{ inputs.OSD_URL != '' && inputs.OSD_URL || 'https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/2.10.0/opensearch-dashboards-2.10.0-linux-x64.tar.gz' }}
+ OPENSEARCH_DIR: 'cypress/opensearch'
+ DASHBOARDS_DIR: 'cypress/opensearch-dashboards'
+ SECURITY_ENABLED: 'false'
+ RUN_DASHBOARDS_SUCCESS: 'false'
+
+jobs:
+ cypress-tests:
+ runs-on: ubuntu-latest
+ container:
+ image: docker://opensearchstaging/ci-runner:ci-runner-rockylinux8-opensearch-dashboards-integtest-v2
+ options: --user 1001
+ env:
+ # prevents extra Cypress installation progress messages
+ CI: 1
+ # avoid warnings like "tput: No value for $TERM and no -T specified"
+ TERM: xterm
+ name: Run cypress tests (${{ inputs.UNIQUE_ID}})
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+ with:
+ path: ./osd
+ repository: ${{ env.TEST_REPO }}
+ ref: '${{ env.TEST_BRANCH }}'
+
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version-file: './osd/.nvmrc'
+ registry-url: 'https://registry.npmjs.org'
+
+ - name: Setup Yarn
+ run: |
+ npm uninstall -g yarn
+ npm i -g [email protected]
+ yarn config set network-timeout 1000000 -g
+ 
+ - name: Cache Cypress
+ id: cache-cypress
+ uses: actions/cache@v1
+ with:
+ path: ~/.cache/Cypress
+ key: cypress-cache-v2-${{ runner.os }}-${{ hashFiles('**/package.json') }}
+ env:
+ CYPRESS_INSTALL_BINARY: ${{ steps.cypress_version.outputs.cypress_version }}
+ - run: npx cypress cache list
+ - run: npx cypress cache path
+
+ - name: Download and extract Opensearch artifacts
+ run: |
+ current_directory=$(pwd)
+ echo "Current working directory: $current_directory"
+ mkdir -p $current_directory/${{ env.OPENSEARCH_DIR }}
+ source scripts/bwc/utils.sh
+ open_artifact $current_directory/${{ env.OPENSEARCH_DIR }} ${{ env.OPENSEARCH }}
+
+ - name: Run OpenSearch
+ run: |
+ current_directory=$(pwd)
+ echo "Current working directory: $current_directory"
+ source scripts/cypress_tests.sh
+ run_opensearch
+ 
+ - name: Download and extract Opensearch Dashboards artifacts
+ run: |
+ current_directory=$(pwd)
+ echo "Current working directory: $current_directory"
+ mkdir -p $current_directory/${{ env.DASHBOARDS_DIR }}
+ source scripts/bwc/utils.sh
+ open_artifact $current_directory/${{ env.DASHBOARDS_DIR }} ${{ env.DASHBOARDS }}
+
+ - name: Copy tests
+ run: |
+ current_directory=$(pwd)
+ echo "Current working directory: $current_directory"
+ SOURCE_PATH="$current_directory/cypress/integration/dasboard_sanity_test.spec.js"
+ DESTINATION_PATH="$current_directory/${{ env.DASHBOARDS_DIR }}/cypress/integration"
+ mkdir -p "$DESTINATION_PATH"
+ cp -r "$SOURCE_PATH" "$DESTINATION_PATH/"
+ ls -R "$DESTINATION_PATH/"
+
+ - name: Run OpenSearch Dashboards
+ id: run-dashboards
+ run: |
+ current_directory=$(pwd)
+ echo "Current working directory: $current_directory"
+ source scripts/cypress_tests.sh
+ run_dashboards
+
+ - name: Run tests
+ run: |
+ current_directory=$(pwd)
+ echo "Run Tests Current working directory: $current_directory"
+ sudo npx cypress run --browser chromium --spec $current_directory/${{ env.DASHBOARDS_DIR }}/cypress/integration/dasboard_sanity_test.spec.js
+
+
+ # Screenshots are only captured on failure, will change this once we do visual regression tests
+ - uses: actions/upload-artifact@v3
+ if: failure()
+ with:
+ name: osd-cypress-screenshots
+ path: ${{ env.OSD_PATH }}/cypress/screenshots
+ retention-days: 1
+
+ - uses: actions/upload-artifact@v3
+ if: always()
+ with:
+ name: osd-cypress-videos
+ path: ${{ env.OSD_PATH }}/cypress/videos
+ retention-days: 1
+
+ - uses: actions/upload-artifact@v3
+ if: always()
+ with:
+ name: osd-cypress-results
+ path: ${{ env.OSD_PATH }}/cypress/results
+ retention-days: 1

cypress.json

@@ -0,0 +1,12 @@
+{
+ "defaultCommandTimeout": 60000,
+ "requestTimeout": 60000,
+ "responseTimeout": 60000,
+ "baseUrl": "http://localhost:5601",
+ "viewportWidth": 2000,
+ "viewportHeight": 1320,
+ "env": {
+ "openSearchUrl": "http://localhost:9200",
+ "SECURITY_ENABLED": false
+ }
+ }

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+ "name": "Using fixtures to represent data",
+ "email": "[email protected]",
+ "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/integration/dasboard_sanity_test.spec.js

@@ -0,0 +1,70 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {
+ CommonUI,
+ MiscUtils,
+} from '@opensearch-dashboards-test/opensearch-dashboards-test-library';
+
+/**
+ * dashboard_sample_data test suite description:
+ * 1) Visit the dev tool page of opensearchdashboard, check key UI elements display
+ */
+export function dashboardSanityTests() {
+ const commonUI = new CommonUI(cy);
+ const miscUtils = new MiscUtils(cy);
+
+ describe('dashboard sample data validation', () => {
+ before(() => {});
+
+ after(() => {});
+ describe('checking Dev Tools', () => {
+ before(() => {
+ // Go to the Dev Tools page
+ miscUtils.visitPage('app/dev_tools#/console');
+ });
+
+ after(() => {});
+
+ it('checking welcome panel display', () => {
+ commonUI.checkElementExists('div[data-test-subj="welcomePanel"]', 1);
+ });
+
+ it('checking dismiss button display', () => {
+ commonUI.checkElementExists('button[data-test-subj="help-close-button"]', 1);
+ });
+
+ it('checking console input area display', () => {
+ commonUI.checkElementExists('div[data-test-subj="request-editor"]', 1);
+ });
+
+ it('checking console output area display', () => {
+ commonUI.checkElementExists('div[data-test-subj="response-editor"]', 1);
+ });
+ });
+
+ describe('checking Visualize', () => {
+ before(() => {
+ // Go to the Visualize page
+ miscUtils.visitPage('app/visualize#/');
+ });
+
+ after(() => {});
+
+ it('checking visualizations list display', () => {
+ commonUI.checkElementExists('div[data-test-subj="itemsInMemTable"]', 1);
+ });
+
+ it('checking search bar display', () => {
+ commonUI.checkElementExists('input[placeholder="Search..."]', 1);
+ });
+
+ it('checking create visualization button display', () => {
+ commonUI.checkElementExists('button[data-test-subj="newItemButton"]', 1);
+ });
+ });
+ });
+}
+dashboardSanityTests();

cypress/support/commands.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })

cypress/support/index.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package.json

@@ -76,7 +76,9 @@
  "docs:acceptApiChanges": "scripts/use_node --max-old-space-size=6144 scripts/check_published_api_changes.js --accept",
  "osd:bootstrap": "scripts/use_node scripts/build_ts_refs && scripts/use_node scripts/register_git_hook",
  "spec_to_console": "scripts/use_node scripts/spec_to_console",
- "pkg-version": "scripts/use_node -e \"console.log(require('./package.json').version)\""
+ "pkg-version": "scripts/use_node -e \"console.log(require('./package.json').version)\"",
+ "cypress:run-without-security": "env TZ=America/Los_Angeles NO_COLOR=1 cypress run --headless --env SECURITY_ENABLED=false"
+
  },
  "repository": {
  "type": "git",
@@ -224,7 +226,9 @@
  "type-detect": "^4.0.8",
  "uuid": "3.3.2",
  "whatwg-fetch": "^3.0.0",
- "yauzl": "^2.10.0"
+ "yauzl": "^2.10.0",
+ "@opensearch-dashboards-test/opensearch-dashboards-test-library": "https:/opensearch-project/opensearch-dashboards-test-library/archive/refs/tags/1.0.6.tar.gz"
+
  },
  "devDependencies": {
  "@babel/core": "^7.16.5",
@@ -353,6 +357,7 @@
  "chromedriver": "^107.0.3",
  "classnames": "2.3.1",
  "compare-versions": "3.5.1",
+ "cypress": "9.5.4",
  "d3": "3.5.17",
  "d3-cloud": "1.2.5",
  "dedent": "^0.7.0",