[Feature/extensions] Added unit test for createComponent workflow #3750
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gradle Check (Jenkins) Run Completed with:
|
@peterzhuamazon bot commented before the gradle check is still running. Any idea here? |
Gradle Check (Jenkins) Run Completed with:
|
Hi Owais, you force pushed the branch so it takes both @owaiskazi19 owaiskazi19 force-pushed the unit-tests branch from 3f6b8b8 to 34b9d0e 1 hour ago
|
to
|
saratvemulapalli
changed the title
server/src/test/java/org/opensearch/extensions/ExtensionsOrchestratorTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/opensearch/extensions/ExtensionsOrchestratorTests.java
Outdated
Show resolved
Hide resolved
server/src/test/java/org/opensearch/extensions/ExtensionsOrchestratorTests.java
Outdated
Show resolved
Hide resolved
| false, | ||
| ExtensionRequest::new, | ||
| (request, channel, task) -> { | ||
| channel.sendResponse(new ClusterStateResponse(clusterName, null, false)); |
There was a problem hiding this comment.
Why are we creating a new ClusterStateResponse here?
Ideally we should be able to test the response coming from extensionsOrchestrator.handleExtensionRequest(request)
Or Am I missing something here?
There was a problem hiding this comment.
Added another test here to test the response.
This test focusses on mocking registerRequestHandler. Let me know if you have other thoughts.
Signed-off-by: Owais Kazi <[email protected]>
Signed-off-by: Owais Kazi <[email protected]>
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Comment on lines
349
to
351
| ClusterName clusterName = new ClusterName("cluster-1"); | ||
| ClusterStateResponse clusterStateResponse = new ClusterStateResponse(clusterName, null, false); | ||
| assertEquals(clusterStateResponse.getClusterName(), clusterName); |
There was a problem hiding this comment.
This is testing the ClusterStateResponse which is good, but its not testing the handler response.
Lets write unit tests for:
handleExtensionRequestpass in a request and verify the response params it sends back.- Test all responses, eg
ClusterStateResponseinClusterStateResponseTestfile. - How can we verify if
ExtensionsOrchestratoris registering all the handlers we expect?
Unit tests are usually for that specific class. Lets write new files for every different class we'd want to test.
There was a problem hiding this comment.
- Done. Mocked the class type to verify the response is correct
- We already have ClusterStateResponseTest file present in OpenSearch. Rest of the responses are handled when verifying the class type of return object of handleExtensionRequest test.
- Can you please elaborate more on this? From my understanding I have added a test to verify if a different RequestType is passed.
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Signed-off-by: Owais Kazi <[email protected]>
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
| assertEquals(extensionsOrchestrator.handleExtensionRequest(localNodeRequest).getClass(), LocalNodeResponse.class); | ||
|
|
||
| ExtensionRequest nullRequest = new ExtensionRequest(ExtensionsOrchestrator.RequestType.GET_SETTINGS); | ||
| assertEquals(extensionsOrchestrator.handleExtensionRequest(nullRequest), null); |
There was a problem hiding this comment.
Lets not return null. Its going to make the system indeterministic when the caller doesnt handle it cleanly.
Lets throw an exception and make sure this test expects that exception.
Gradle Check (Jenkins) Run Completed with:
|
Signed-off-by: Owais Kazi <[email protected]>
Gradle Check (Jenkins) Run Completed with:
|
saratvemulapalli
approved these changes
Jul 19, 2022
| @@ -107,10 +107,14 @@ public ExtensionsOrchestrator(Settings settings, Path extensionsPath) throws IOE | |||
|
|
|||
| public void setTransportService(TransportService transportService) { | |||
| this.transportService = transportService; | |||
| registerRequestHandler(); | |||
There was a problem hiding this comment.
super nit
Suggested change
| registerRequestHandler(); | |
| registerRequestHandlers(); |
There was a problem hiding this comment.
Sure. Will cover it in the next PR :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Owais Kazi [email protected]
Description
Added Unit tests for registerHandler of ClusterState, ClusterSettings and LocalNode
Issues Resolved
Part of opensearch-project/opensearch-sdk-java#25
Check List
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.