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

Adds tests for demo configuration java tool #3807

Merged

stephen-crawford merged 26 commits into opensearch-project:main from DarshitChanpura:demo-config-java-tool-tests-only

Dec 13, 2023

Member

DarshitChanpura commented Dec 7, 2023

Description

This PR adds tests associated with the demo-configuration tool.

Issues Resolved:

Resolves Implement tests to verify changes to default admin credentials #3636

Testing

Unit Testing
Integration Testing

Check List

New functionality includes testing
~~- [ ] New functionality has been documented~~
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

DarshitChanpura mentioned this pull request

Updates demo script to execute with bundled jdk #3777

Merged

1 task

DarshitChanpura force-pushed the demo-config-java-tool-tests-only branch from 4e83fe7 to 8926ce4 Compare

December 7, 2023 19:00

codecov bot commented Dec 7, 2023 •

edited

Loading

Codecov Report

Merging #3807 (b865415) into main (06d8c29) will increase coverage by 1.36%.
Report is 2 commits behind head on main.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3807      +/-   ##
==========================================
+ Coverage   65.14%   66.50%   +1.36%     
==========================================
  Files         298      298              
  Lines       21196    21199       +3     
  Branches     3454     3454              
==========================================
+ Hits        13808    14099     +291     
+ Misses       5692     5379     -313     
- Partials     1696     1721      +25

Files	Coverage Δ
...pensearch/security/tools/democonfig/Installer.java	`71.67% <100.00%> (+71.67%)`	⬆️

... and 9 files with indirect coverage changes

Member Author

DarshitChanpura commented Dec 8, 2023 •

edited

Loading

continuing the discussion here from #3777 :

You've got an methods showHelp() and readOptions() both of these do not share any common code, there are many libraries such as those used by the SecurityAdmin that handle these use cases. Then rather than checking a string output you could verify the collection - or frankly not even verify that since its just configuration at that point.

Tests should verify something that can break the API / user contract. Consider the usage of the code and work backward for what should be tested.

DarshitChanpura self-assigned this

DarshitChanpura mentioned this pull request

[Backport 2.x] Demo configuration related changes #3827

Closed

10 tasks

DarshitChanpura added 22 commits

December 12, 2023 17:28


          Initial commit to add tests

8d29d42

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Added unit tests for Installer class

0ca5c71

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds tests for SecuritySettingsConfigurer class and modifies relevant…

1cb00f6

… classes and configuration

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds tests for CertificateGenerator class

053b785

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds missing license headers

52a5325

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds integration tests to valid demo config script against a remote c…

b56965e

…luster

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Upddates line end characters to use System.lineSeparator()

7a1ae99

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds a common certificate validity check

dcaa380

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes 1 of 2 broken windows tests

0e45884

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes codehygiene check

c77fe79

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes issue with shell script while using bundled jdk to execute the …

9bb7333

…demo install script

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes demo certificate validator tests

c3416fe

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes broken windows tests

4de2cc7

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Updates settings writer to use snakeyaml

3feca2e

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Rewrite the whole tool to use singleton pattern

de15846

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Script no longer generates password if one is not supplied. Instead t…

1ce63ff

…he script execution fails

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Fixes Installer test to fetch expected version

5c7d3e5

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Updates tests to reflect to changes around buildOptions

de18a16

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Adds more comments

788ae2f

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Updates the way keys are looked up in yaml file

93ff488

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Updates the tests related to yml fieldName lookup

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Refactors references to renamed source method

daa0fae

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura force-pushed the demo-config-java-tool-tests-only branch from 14ba7af to daa0fae Compare

December 12, 2023 22:33

peternied reviewed

View reviewed changes

src/test/java/org/opensearch/security/sanity/tests/SecurityRestTestCase.java Outdated Show resolved Hide resolved

src/test/java/org/opensearch/security/sanity/tests/InvalidAdminPasswordIT.java Outdated Show resolved Hide resolved

src/test/java/org/opensearch/security/sanity/tests/SingleClusterSanityIT.java Outdated Show resolved Hide resolved

src/test/java/org/opensearch/security/sanity/tests/SingleClusterSanityIT.java Show resolved Hide resolved

src/test/java/org/opensearch/security/tools/democonfig/CertificateGeneratorTests.java Outdated Show resolved Hide resolved

src/test/java/org/opensearch/security/tools/democonfig/CertificateGeneratorTests.java Outdated Show resolved Hide resolved

src/test/java/org/opensearch/security/tools/democonfig/CertificateGeneratorTests.java Show resolved Hide resolved

src/test/java/org/opensearch/security/tools/democonfig/CertificateGeneratorTests.java Outdated Show resolved Hide resolved

DarshitChanpura added 4 commits

December 12, 2023 22:41


          Removes static variable code smell

c9b351c

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Renames test classes

ebe3d6d

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Refactors certificate generator tests

bcfb5e6

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>


          Refactors out stream assertions

b865415

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Member Author

DarshitChanpura commented Dec 13, 2023

ty @peternied for the feedback. I've addressed all comments and have refactored some tests.

DarshitChanpura marked this pull request as ready for review

December 13, 2023 06:13

DarshitChanpura requested review from cliu123, cwperks, davidlago, RyanL1997, stephen-crawford, reta and willyborankin as code owners

December 13, 2023 06:13

peternied approved these changes

View reviewed changes

stephen-crawford approved these changes

View reviewed changes

Contributor

stephen-crawford left a comment

Looks good to me! Thanks DC!

stephen-crawford merged commit e698315 into opensearch-project:main

82 checks passed

DarshitChanpura added a commit to DarshitChanpura/security that referenced this pull request


          Adds tests for demo configuration java tool (opensearch-project#3807)

dc65ba5

### Description
This PR adds tests associated with the demo-configuration tool.

## Issues Resolved:
 - Resolves opensearch-project#3636

### Testing
- Unit Testing
- Integration Testing

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

DarshitChanpura mentioned this pull request

[2.x] Extracts demo configuration setup into a java tool, adds support for Bundled JDK for this tool and updates DEVELOPER_GUIDE.md #3845

Merged

10 tasks

cwperks pushed a commit that referenced this pull request


          [2.x] Extracts demo configuration setup into a java tool, adds suppor…

ea9546e

…t for Bundled JDK for this tool and updates DEVELOPER_GUIDE.md (#3845)

### Description
Backports following commits related to demo configuration tool from main
to 2.x:

- [x]
[17748b9](17748b9)
from #3669
- [x]
[4496440](4496440)
from #3734
- [x]
[06d8c29](06d8c29)
from #3777
- [x]
[e698315](e698315)
from #3807
- [x]
[9d11524](9d11524)
from #3843
- [x]
[62aed21](62aed21)
from #3850
- [x]
[ceabe13](ceabe13)
from #3844

### Issues Resolved
- Related to #3827


### Testing
- automated tests

### Check List
- [x] New functionality includes testing
- [x] New functionality has been documented
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
Signed-off-by: Darshit Chanpura <35282393+DarshitChanpura@users.noreply.github.com>

prabhask5 pushed a commit to prabhask5/opensearch-security that referenced this pull request


          Adds tests for demo configuration java tool (opensearch-project#3807)

a57def3

### Description
This PR adds tests associated with the demo-configuration tool.

## Issues Resolved:
 - Resolves opensearch-project#3636

### Testing
- Unit Testing
- Integration Testing

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
Signed-off-by: Prabhas Kurapati <prabhask@berkeley.edu>

dlin2028 pushed a commit to dlin2028/security that referenced this pull request


          Adds tests for demo configuration java tool (opensearch-project#3807)

d1cbe33

### Description
This PR adds tests associated with the demo-configuration tool.

## Issues Resolved:
 - Resolves opensearch-project#3636

### Testing
- Unit Testing
- Integration Testing

### Check List
- [x] New functionality includes testing
~- [ ] New functionality has been documented~
- [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and
signing off your commits, please check
[here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

---------

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

stephen-crawford stephen-crawford approved these changes

peternied peternied approved these changes

cliu123 Awaiting requested review from cliu123

cwperks Awaiting requested review from cwperks cwperks is a code owner

davidlago Awaiting requested review from davidlago

RyanL1997 Awaiting requested review from RyanL1997 RyanL1997 is a code owner

reta Awaiting requested review from reta reta is a code owner

willyborankin Awaiting requested review from willyborankin willyborankin is a code owner

Labels

None yet