-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: use "overrides" to install desired version of tough-cookie and …
…word-wrap. (#772) (#774) * feat: use npm v8 to install and initialize package-lock Signed-off-by: SuZhou-Joe <[email protected]> * feat: add Node version requirement in DEVELOPER_GUIDE Signed-off-by: SuZhou-Joe <[email protected]> --------- Signed-off-by: SuZhou-Joe <[email protected]> (cherry picked from commit 11e2141)
- Loading branch information
1 parent
8684f66
commit fba7e84
Showing
3 changed files
with
4,621 additions
and
21 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| <p align="center"><img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_dashboards_logo_darkmode.svg" height="64px"/></p> | ||
| <h1 align="center">Functional Test Developer Guide</h1> | ||
|
|
||
| This guide applies to all development within the OpenSearch Dashboards Functional Test. | ||
|
|
||
| - [Getting Started](#getting-started) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [opensearch-dashboards-test-library](#opensearch-dashboards-test-library) | ||
| - [Run Tests](#run-tests) | ||
| - [Writing tests](#writing-tests) | ||
| - [Tests for OpenSearch Dashboards](#tests-for-opensearch-dashboards) | ||
| - [Tests for OpenSearch Dashboard Plugins](#tests-for-opensearch-dashboard-plugins) | ||
| - [Experimental Features](#experimental-features) | ||
| - [General](#general) | ||
| - [Formatting](#formatting) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| If you would like to install and develop OpenSearch Dashboards or its plugins, please see the [OpenSearch Dashboards Developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md). The content in this guide outlines how to develop and run functional tests for OpenSearch Dashboards and it plugins. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| You should have a running instance of OpenSearch Dashboards to run these tests against them. Refer to the [OpenSearch Dashboards Developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) for details on how to do that. | ||
|
|
||
| - Node v16.20.0 | ||
|
|
||
| ### Installation | ||
|
|
||
| To install the dependencies run | ||
|
|
||
| ``` | ||
| npm install | ||
| ``` | ||
|
|
||
| also install yarn globally | ||
|
|
||
| ```sh | ||
| npm install -g yarn | ||
| ``` | ||
|
|
||
| #### opensearch-dashboards-test-library | ||
|
|
||
| opensearch-dashboards-test-library is the test utility library used by this project, it is already a published package in NPM. You can optionally import the lastest version by installing from NPM registry | ||
|
|
||
| ``` | ||
| "@opensearch-dashboards-test/opensearch-dashboards-test-library": "^1.0.1" | ||
| ``` | ||
|
|
||
| You can also import from the git repository target branch to use the development code directly | ||
|
|
||
| ``` | ||
| "@opensearch-dashboards-test/opensearch-dashboards-test-library": "opensearch-project/opensearch-dashboards-test-library#main" | ||
| ``` | ||
|
|
||
| You need to delete the package from the node_modules folder and run npm install again, to reflect the change. | ||
|
|
||
| ``` | ||
| $ npm uninstall @opensearch-dashboards-test/opensearch-dashboards-test-library && npm install opensearch-project/opensearch-dashboards-test-library#main | ||
| ``` | ||
|
|
||
| ### Run Tests | ||
|
|
||
| To start the Cypress UI run: | ||
|
|
||
| ``` | ||
| yarn cypress:open | ||
| ``` | ||
|
|
||
| All the available test in the repo should be available there. | ||
|
|
||
| You can also run the cypress tests by cli. There are some handy scripts in [package.json](package.json) to run the tests with some pre-set configurations. | ||
|
|
||
| To run tests against a local cluster | ||
|
|
||
| without security: | ||
|
|
||
| ``` | ||
| $ yarn cypress run-without-security --spec "cypress/integration/core-opensearch-dashboards/vanilla-opensearch-dashboards/*.js" | ||
| ``` | ||
|
|
||
| with security: | ||
|
|
||
| ``` | ||
| $ yarn cypress run-with-security --spec "cypress/integration/core-opensearch-dashboards/opensearch-dashboards/*.js" | ||
| ``` | ||
|
|
||
| These tests run in headless mode by default. | ||
|
|
||
| And you can override certain [cypress config or environment variable](cypress.json) by applying additional cli arguments, for example to override the baseUrl and openSearchUrl to test a remote OpenSearch endpoint: | ||
|
|
||
| ``` | ||
| $ yarn cypress run --spec "cypress/integration/core-opensearch-dashboards/opensearch-dashboards/*.js" --config "baseUrl=https://<endpoint>/_dashboards" --env "openSearchUrl=https://<endpoint>,SECURITY_ENABLED=true,username=admin,password=xxxxxxxx,ENDPOINT_WITH_PROXY=true" | ||
| ``` | ||
|
|
||
| `SECURITY_ENABLED`: if true, the `username` and `password` passing in are used as basic authentication credentials during `cy.visit` and `cy.request`. Also, please notice security enabled endpoint normally uses https protocol, so you may want to pass in different urls. | ||
|
|
||
| `ENDPOINT_WITH_PROXY`: for an OpenSearch endpoint wrapped with a proxy that redirects the visiting url to the login url, even with auth option provided in `cy.visit`, the redirection to the login url still happens. So a login request before tests and cache the security cookie are needed and can be switched on by this argument. | ||
|
|
||
| `MANAGED_SERVICE_ENDPOINT`: set to true if tests are running against managed service domains. | ||
|
|
||
|
|
||
| ## Writing tests | ||
|
|
||
| The testing library uses [Cypress](https://www.cypress.io/) as its testing framework and follow its high level folder structure. All tests are written under the `./cypress/integration` folder. | ||
|
|
||
| ### Tests for OpenSearch Dashboards | ||
|
|
||
| Tests for core features specific to [OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards) can be written under | ||
|
|
||
| ``` | ||
| /cypress | ||
| /integration | ||
| /core-opensearch-dashboards | ||
| /opensearch-dashboards | ||
| ``` | ||
|
|
||
| ### Tests for OpenSearch Dashboard Plugins | ||
|
|
||
| Tests for plugins that are not a part of the [OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards) repository but released as a part of its release process | ||
|
|
||
| ``` | ||
| /cypress | ||
| /integration | ||
| /plugins | ||
| /<YOUR_PLUGIN_NAME> | ||
| ``` | ||
| ### Experimental Features | ||
|
|
||
| When writing tests for experimental features, please follow these steps. | ||
|
|
||
| 1. Figure out the folder location to put the tests | ||
|
|
||
| Similar to the regular tests, OSD Core tests go to the [folder](integration/core-opensearch-dashboards/opensearch-dashboards/) and OSD plugin tests go to the [folder](cypress/integration/plugins/). | ||
|
|
||
| 2. Develop tests with a flag to turn on and off | ||
|
|
||
| Add an environment variable (e.g boolean) to only run tests for the experiemental feature when it is true. (Define such in [cypress configuration](cypress.json). Refer to `SECURITY_ENABLED` as an example) This is to ensure backward compatibility when integrating with [opensearch-build repo](https://github.com/opensearch-project/opensearch-build/blob/main/src/test_workflow/integ_test/service_opensearch_dashboards.py) whose OpenSearch Dashboards execution command or yml configuration may not be updated to support the experimental feature yet. | ||
|
|
||
| 3. Set up Github action to run the tests inside the current repo | ||
|
|
||
| Create a new workflow by referring to [this template](https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/.github/workflows/release-e2e-workflow-template.yml) for OSD plugin or [this workflow](https://github.com/opensearch-project/opensearch-dashboards-functional-test/blob/main/.github/workflows/cypress-workflow-vanilla-snapshot-based.yml) for OSD Core. This workflow is to run the OSD from artifact. You could enable your experimental feature through either `./bin/opensearch-dashboards --vis_builder.enabled` or through modifying the content of the yml file. (In order to run the tests from the source code repo of the feature, you can set up workflows to check out the source code and use `yarn` to start OSD.) | ||
|
|
||
| 4. Run tests from `opensearch-build` | ||
|
|
||
| To make the build repo enable your experimental feature when spinning up OSD service, make sure that you update [this file](https://github.com/opensearch-project/opensearch-build/blob/main/src/test_workflow/integ_test/service_opensearch_dashboards.py) You could either modify the start command or the yml file. To avoid a potentially long start command, it is preferred to modify the yml file to turn on the feature. | ||
|
|
||
| ## General | ||
| ### Formatting | ||
|
|
||
| `prettier` and `ESLint` is integrated and used to standardize formatting of files, where `prettier` takes care of the code formatting and `ESLint` takes care of the code style. You can check the formatting of all files (new and existing) by running | ||
|
|
||
| ``` | ||
| $ yarn lint | ||
| ``` | ||
| and auto fix the formatting of all files (new and existing) by running | ||
| ``` | ||
| $ yarn lint --fix | ||
| ``` | ||
|
|
||
| `Husky` precommit hook is used to automatically run `yarn lint`, please fix the files according to lint result before commiting code changes (run `yarn lint --fix` for fixable errors, or manully fix code according to error messages). If you have any doubts on `ESLint` rules, feel free to [open an issue](issues). |
Oops, something went wrong.