Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update project level README #258

Merged
merged 2 commits into from
Apr 8, 2021
Merged

Update project level README #258

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c517fd1
Update README with new run command and Running Tests section
Apr 8, 2021
22dc07d
Address PR comments
Apr 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ We officially began work on the new fork on January 21st, 2021. Since then, we'v

## What doesn’t works

* Jest Unit test cases
boktorbb marked this conversation as resolved.
Show resolved Hide resolved
* Integration test cases
* Functional test cases
* 3rd party plugins (including OpenDistro)

Expand Down Expand Up @@ -49,9 +47,20 @@ Or

To run Dashboards with OpenSearch
* Run ```yarn osd bootstrap``` in the OpenSearch Dashboards directory
* While OpenSearch is running locally, run ```yarn start --oss```
* While OpenSearch is running locally, run ```yarn start```
* You can now navigate to ```http://localhost:5601``` where Dashboards runs by default

## Running tests

### Jest Unit Tests

Run the command ```yarn test:jest``` in the OpenSearch Dashboards project directory to run unit tests

### Jest Integration Tests

For the integration tests, you must pass the absolute path of your extracted OpenSearch build artifacts through the ```TEST_OPENSEARCH_FROM``` env variable so that Dashboards can run an OpenSearch cluster. You can run:
```TEST_OPENSEARCH_FROM=/path/to/extracted/build/artifact yarn test:jest_integration```

## How you can help

### Look for the label "help wanted"
Expand Down