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.

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

Document running it tests from intellij IDE #12440

Merged

Conversation

TSFenwick
Copy link
Contributor

Document how to run integration tests from IntelliJ IDE

Description

Document how to run Integration Tests from IntelliJ IDE


Key changed/added classes in this PR
  • integration-tests/README.md

This PR has:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors.
  • added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
  • added or updated version, license, or notice information in licenses.yaml
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added unit tests or modified existing tests to cover new code paths, ensuring the threshold for code coverage is met.
  • added integration tests.
  • been tested in a test Druid cluster.

Comment on lines 128 to 129
A prerequisite to run tests from intellij you need a cluster up and running. Modify the run configuration's `VM options`
to the values below.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A prerequisite to run tests from intellij you need a cluster up and running. Modify the run configuration's `VM options`
to the values below.
Before running tests from IntelliJ, ensure you have a Druid cluster running.
In IntelliJ, edit configurations to add the following VM options:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reads a lot better. Will just make slight naming changes to make sure it matches exactly with intellij's naming

-Ddruid.client.https.keyManagerPassword=druid123
-Ddruid.client.https.keyStorePassword=druid123
```
and to run the test you need to run the test from the test configuration often times found around the top right corner
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
and to run the test you need to run the test from the test configuration often times found around the top right corner
Run tests from the test configuration found in the top right corner of the IDE.

Is there a certain icon or menu item to look for?

@FrankChen021 FrankChen021 added the Area - Dev For items related to the project itself, like dev docs and checklists, but not CI label Apr 18, 2022
@FrankChen021
Copy link
Member

I was looking for such guidance for a long time when I first started my work in Druid.
Thanks for your great work @TSFenwick

@FrankChen021 FrankChen021 merged commit 7b3b71f into apache:master Apr 19, 2022
@FrankChen021
Copy link
Member

I merged this because the failed CI has nothing to do with the doc change in this PR.

@abhishekagarwal87 abhishekagarwal87 added this to the 0.23.0 milestone May 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area - Dev For items related to the project itself, like dev docs and checklists, but not CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants