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

Updates demo script to execute with bundled jdk #3777

Merged
merged 30 commits into from
Dec 12, 2023
Merged

Updates demo script to execute with bundled jdk #3777

merged 30 commits into from
Dec 12, 2023

Conversation

DarshitChanpura
Copy link
Member

@DarshitChanpura DarshitChanpura commented Nov 30, 2023 •
edited
Loading

Description

This PR adds changes to the tool to allow execution with bundled jdk. It also refactors usage of static variables.
It also addresses a small bug in isStringAlreadyPresentFile to modify from regex match to "startsWith".

Tests are added as fast-follow in #3807

Check List

- [ ] New functionality includes testing <- fast-follow via #3807
- [ ] 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
Initial commit to add tests
4ed4427 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Added unit tests for Installer class
c7a399c 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds tests for SecuritySettingsConfigurer class and modifies relevant…
b0ac474 
… classes and configuration

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds tests for CertificateGenerator class
b55b8a6 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds missing license headers
2cc8ba4 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds integration tests to valid demo config script against a remote c…
2c54f63 
…luster

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
peternied
peternied reviewed Nov 30, 2023
View reviewed changes
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

These tests look pretty brittle since they are handling output written to the console and files, I'd recommend breaking up how the parts of the tool work so you can have easier to maintain test cases.

Something to consider if the tool gets a new option, say <10 lines of code. In the tests you would only really need two new test cases (pass/fail) and no unrelated tests would break.

src/main/java/org/opensearch/security/tools/democonfig/Installer.java Outdated Show resolved Hide resolved
src/main/java/org/opensearch/security/tools/democonfig/Installer.java Outdated Show resolved Hide resolved
src/main/java/org/opensearch/security/tools/democonfig/Installer.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/InstallerTests.java Outdated Show resolved Hide resolved
@DarshitChanpura
Upddates line end characters to use System.lineSeparator()
50c67bb 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds a common certificate validity check
c91394b 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Copy link
Member Author

Looking into windows failures now.

@DarshitChanpura
Fixes java path configuration to pick up bundled jdk when java home i…
1333181 
…s not set

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Fixes 1 of 2 broken windows tests
daad144 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Fixes 2 of 2 broken windows tests
92c0de3 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Updates resetState to reset OS to actual value
7405d91 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Fixes codehygiene check
3282329 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Fixes issue with shell script while using bundled jdk to execute the …
3754512 
…demo install script

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Fixes issue with batch script while using bundled jdk to execute the …
1dcd596 
…demo install script

Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura DarshitChanpura marked this pull request as ready for review December 1, 2023 20:25
@DarshitChanpura
Fixes demo certificate validator tests
10c866b 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura DarshitChanpura changed the title Adds tests for demo configuration java tool Updates demo script to execute with bundled jdk and adds tests for demo configuration java tool Dec 1, 2023
cwperks
cwperks reviewed Dec 7, 2023
View reviewed changes
Copy link
Member

@cwperks cwperks left a comment

Choose a reason for hiding this comment

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

Took another pass. Nice work getting SnakeYaml to write to opensearch.yml!

src/main/java/org/opensearch/security/tools/democonfig/Installer.java Outdated Show resolved Hide resolved
src/main/java/org/opensearch/security/tools/democonfig/SecuritySettingsConfigurer.java Outdated Show resolved Hide resolved
src/main/java/org/opensearch/security/tools/democonfig/SecuritySettingsConfigurer.java Show resolved Hide resolved
src/main/java/org/opensearch/security/tools/democonfig/SecuritySettingsConfigurer.java Outdated Show resolved Hide resolved
@DarshitChanpura
Removes 'this' reference to Installer
6c6e80f 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura DarshitChanpura mentioned this pull request Dec 8, 2023
Merged
2 tasks
@DarshitChanpura
Copy link
Member Author

Code Coverage will be enhanced in #3807

@DarshitChanpura
Uses Options class to build the options supported by tool
5c675e5 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Adds a brief comment to explain addition of jvmArg while testing
5fbfdad 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@derek-ho
Copy link
Collaborator

Ship it 🚢

@DarshitChanpura
Adds more comments
76d487c 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura DarshitChanpura mentioned this pull request Dec 12, 2023
Closed
10 tasks
cwperks
cwperks previously approved these changes Dec 12, 2023
View reviewed changes
Copy link
Member

@cwperks cwperks left a comment

Choose a reason for hiding this comment

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

This PR LGTM.

One additional comment: Should the SecuritySettingsConfigurer get the values it needs in its constructor instead of the entire installer object?

@DarshitChanpura
Updates the way keys are looked up in yaml file
a1cfa75 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura
Copy link
Member Author

One additional comment: Should the SecuritySettingsConfigurer get the values it needs in its constructor instead of the entire installer object?

I started out with that but thought it might be better to pass just one reference installer rather than multiple local copies of variables inside Installer class. IMO, I'd prefer to keep it as is.

cwperks
cwperks previously approved these changes Dec 12, 2023
View reviewed changes
@DarshitChanpura
Renames a method
b0870a4 
Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
stephen-crawford
stephen-crawford approved these changes Dec 12, 2023
View reviewed changes
Copy link
Contributor

@stephen-crawford stephen-crawford left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks DC

@DarshitChanpura DarshitChanpura merged commit 06d8c29 into opensearch-project:main Dec 12, 2023
80 of 82 checks passed
DarshitChanpura added a commit to DarshitChanpura/security that referenced this pull request Dec 13, 2023
@DarshitChanpura
Updates demo script to execute with bundled jdk (opensearch-project#3777
4bcfd36 
)



Signed-off-by: Darshit Chanpura <dchanp@amazon.com>
@DarshitChanpura DarshitChanpura mentioned this pull request Dec 13, 2023
Merged
10 tasks
cwperks pushed a commit that referenced this pull request Dec 18, 2023
@DarshitChanpura
[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 Jan 11, 2024
@DarshitChanpura @prabhask5
Updates demo script to execute with bundled jdk (opensearch-project#3777
17762de 
)

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 May 1, 2024
@DarshitChanpura @dlin2028
Updates demo script to execute with bundled jdk (opensearch-project#3777
0e08c32 
)



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

@peternied peternied peternied left review comments

@stephen-crawford stephen-crawford stephen-crawford approved these changes

@derek-ho derek-ho derek-ho approved these changes

@cwperks cwperks cwperks approved these changes

@cliu123 cliu123 Awaiting requested review from cliu123

@davidlago davidlago Awaiting requested review from davidlago

@RyanL1997 RyanL1997 Awaiting requested review from RyanL1997 RyanL1997 is a code owner

@reta reta Awaiting requested review from reta reta is a code owner

@willyborankin willyborankin Awaiting requested review from willyborankin willyborankin is a code owner

Assignees

@DarshitChanpura DarshitChanpura

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@DarshitChanpura @peternied @derek-ho @cwperks @stephen-crawford