From 45a334b797e0aa316b5057ea067adb63e91c8bbe Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:44:33 +0800 Subject: [PATCH] [osci23] update installation commands (#908) (#912) Signed-off-by: qiwen li (cherry picked from commit e53ba8e9071de78410deb0be8a964236fe040f21) Co-authored-by: Riley Li <71857976+MadaniKK@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 690ed1c84..5bc2c3d17 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -27,7 +27,7 @@ You should have a running instance of OpenSearch Dashboards to run these tests a ### Installation -To install the dependencies run +To install the dependencies run ``` npm install @@ -76,16 +76,16 @@ To run tests against a local cluster without security: ``` -$ yarn cypress run-without-security --spec "cypress/integration/core-opensearch-dashboards/vanilla-opensearch-dashboards/*.js" +$ 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" +$ yarn cypress:run-with-security --spec "cypress/integration/core-opensearch-dashboards/opensearch-dashboards/*.js" ``` -These tests run in headless mode by default. +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: @@ -99,7 +99,6 @@ $ yarn cypress run --spec "cypress/integration/core-opensearch-dashboards/opense `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. @@ -125,6 +124,7 @@ Tests for plugins that are not a part of the [OpenSearch Dashboards](https://git /plugins / ``` + ### Experimental Features When writing tests for experimental features, please follow these steps. @@ -146,6 +146,7 @@ Create a new workflow by referring to [this template](https://github.com/opensea 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 @@ -153,9 +154,11 @@ To make the build repo enable your experimental feature when spinning up OSD ser ``` $ 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). \ No newline at end of file +`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).