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

Add UT for ml rest execute action #278

Merged
merged 1 commit into from
Apr 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions plugin/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,7 @@ jacocoTestReport {
List<String> jacocoExclusions = [
// TODO: add more unit test to meet the minimal test coverage.
'org.opensearch.ml.constant.CommonValue',
'org.opensearch.ml.plugin.MachineLearningPlugin*',
'org.opensearch.ml.rest.RestMLExecuteAction' //0.3
'org.opensearch.ml.plugin.MachineLearningPlugin*'
]

jacocoTestCoverageVerification {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

package org.opensearch.ml.rest;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.opensearch.ml.utils.TestHelper.getLocalSampleCalculatorRestRequest;

import java.io.IOException;
import java.util.List;

import org.junit.Before;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.opensearch.action.ActionListener;
import org.opensearch.client.node.NodeClient;
import org.opensearch.common.Strings;
import org.opensearch.common.settings.Settings;
import org.opensearch.ml.common.FunctionName;
import org.opensearch.ml.common.input.Input;
import org.opensearch.ml.common.transport.execute.MLExecuteTaskAction;
import org.opensearch.ml.common.transport.execute.MLExecuteTaskRequest;
import org.opensearch.ml.common.transport.execute.MLExecuteTaskResponse;
import org.opensearch.rest.RestChannel;
import org.opensearch.rest.RestHandler;
import org.opensearch.rest.RestRequest;
import org.opensearch.test.OpenSearchTestCase;
import org.opensearch.threadpool.TestThreadPool;
import org.opensearch.threadpool.ThreadPool;

public class RestMLExecuteActionTests extends OpenSearchTestCase {

private RestMLExecuteAction restMLExecuteAction;

NodeClient client;
private ThreadPool threadPool;

@Mock
RestChannel channel;

@Before
public void setup() {
MockitoAnnotations.openMocks(this);
restMLExecuteAction = new RestMLExecuteAction();

threadPool = new TestThreadPool(this.getClass().getSimpleName() + "ThreadPool");
client = spy(new NodeClient(Settings.EMPTY, threadPool));

doAnswer(invocation -> {
ActionListener<MLExecuteTaskResponse> actionListener = invocation.getArgument(2);
return null;
}).when(client).execute(eq(MLExecuteTaskAction.INSTANCE), any(), any());
}

@Override
public void tearDown() throws Exception {
super.tearDown();
threadPool.shutdown();
client.close();
}

public void testConstructor() {
RestMLExecuteAction restMLExecuteAction = new RestMLExecuteAction();
assertNotNull(restMLExecuteAction);
}

public void testGetName() {
String actionName = restMLExecuteAction.getName();
assertFalse(Strings.isNullOrEmpty(actionName));
assertEquals("ml_execute_action", actionName);
}

public void testRoutes() {
List<RestHandler.Route> routes = restMLExecuteAction.routes();
assertNotNull(routes);
assertFalse(routes.isEmpty());
RestHandler.Route route = routes.get(0);
assertEquals(RestRequest.Method.POST, route.getMethod());
assertEquals("/_plugins/_ml/_execute/{algorithm}", route.getPath());
}

public void testGetRequest() throws IOException {
RestRequest request = getLocalSampleCalculatorRestRequest();
MLExecuteTaskRequest executeTaskRequest = restMLExecuteAction.getRequest(request);

Input input = executeTaskRequest.getInput();
assertNotNull(input);
assertEquals(FunctionName.LOCAL_SAMPLE_CALCULATOR, input.getFunctionName());
}

public void testPrepareRequest() throws Exception {
RestRequest request = getLocalSampleCalculatorRestRequest();
restMLExecuteAction.handleRequest(request, channel, client);

ArgumentCaptor<MLExecuteTaskRequest> argumentCaptor = ArgumentCaptor.forClass(MLExecuteTaskRequest.class);
verify(client, times(1)).execute(eq(MLExecuteTaskAction.INSTANCE), argumentCaptor.capture(), any());
Input input = argumentCaptor.getValue().getInput();
assertEquals(FunctionName.LOCAL_SAMPLE_CALCULATOR, input.getFunctionName());
}
}
13 changes: 13 additions & 0 deletions plugin/src/test/java/org/opensearch/ml/utils/TestHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import org.opensearch.ml.common.dataset.MLInputDataType;
import org.opensearch.ml.common.dataset.SearchQueryInputDataset;
import org.opensearch.ml.common.input.MLInput;
import org.opensearch.ml.common.input.execute.samplecalculator.LocalSampleCalculatorInput;
import org.opensearch.ml.common.input.parameter.clustering.KMeansParams;
import org.opensearch.rest.RestRequest;
import org.opensearch.rest.RestStatus;
Expand Down Expand Up @@ -164,6 +165,17 @@ public static RestRequest getKMeansRestRequest() {
return request;
}

public static RestRequest getLocalSampleCalculatorRestRequest() {
Map<String, String> params = new HashMap<>();
params.put(PARAMETER_ALGORITHM, FunctionName.LOCAL_SAMPLE_CALCULATOR.name());
final String requestContent = "{\"operation\": \"max\",\"input_data\":[1.0, 2.0, 3.0]}";
RestRequest request = new FakeRestRequest.Builder(getXContentRegistry())
.withParams(params)
.withContent(new BytesArray(requestContent), XContentType.JSON)
.build();
return request;
}

public static RestRequest getSearchAllRestRequest() {
RestRequest request = new FakeRestRequest.Builder(getXContentRegistry())
.withContent(new BytesArray(TestData.matchAllSearchQuery()), XContentType.JSON)
Expand All @@ -186,6 +198,7 @@ private static NamedXContentRegistry getXContentRegistry() {
List<NamedXContentRegistry.Entry> entries = new ArrayList<>();
entries.addAll(searchModule.getNamedXContents());
entries.add(KMeansParams.XCONTENT_REGISTRY);
entries.add(LocalSampleCalculatorInput.XCONTENT_REGISTRY);
return new NamedXContentRegistry(entries);
}
}