From 8f1518885a3792172464c92282ae1fce1e378cd1 Mon Sep 17 00:00:00 2001 From: Sam <128482925+samuelcostae@users.noreply.github.com> Date: Fri, 18 Aug 2023 16:49:32 +0100 Subject: [PATCH] Adding testing info do DEVELOPER_GUIDE.md (#1554) * Make the steps diagram honor the theme (#1538) Signed-off-by: Miki Co-authored-by: Craig Perkins Co-authored-by: Ryan Liang <109499885+RyanL1997@users.noreply.github.com> Signed-off-by: Sam * Adding testing info do DEVELOPER_GUIDE.md Signed-off-by: Sam * Minor changes and adding link Signed-off-by: Sam --------- Signed-off-by: Miki Signed-off-by: Sam Co-authored-by: Miki Co-authored-by: Craig Perkins Co-authored-by: Ryan Liang <109499885+RyanL1997@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index c1f9096d8..2331b3a20 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -92,7 +92,15 @@ Next, go to the base directory (`cd ../..`) and run `yarn osd bootstrap` to inst From the base directory, run `yarn start`. This should start dashboard UI successfully. `Cmd+click` the url in the console output (It should look something like `http://0:5601/omf`). Once the page loads, you should be able to log in with user `admin` and password `admin`. -## Integration Tests +## Testing + +The security-dashboards-plugin project uses Jest, Cypress and Selenium and makes use of the [OpenSearch Dashboards Functional Test]( https://github.com/opensearch-project/opensearch-dashboards-functional-test) project. + +Make sure you have the OpenSearch and OpenSearch Dashboards running with the Security Plugin and that you can log in to it using a web browser. + +Clone [OpenSearch Dashboards Functional Test]( https://github.com/opensearch-project/opensearch-dashboards-functional-test) in your local machine and follow the instructions in its DEVELOPER_GUIDE.md + +### Integration Tests To run selenium based integration tests, download and export the firefox web-driver to your PATH. Also, run `node scripts/build_opensearch_dashboards_platform_plugins.js` or `yarn start` before running the tests. This is essential to generate the bundles.