-
Notifications
You must be signed in to change notification settings - Fork 25k
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 get stored script and delete stored script to high level REST API #31355
Changes from 2 commits
fae58be
e8ded37
48af52f
00f3689
8c34d9e
3dadad8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,6 +26,10 @@ | |
import org.elasticsearch.action.ActionListener; | ||
import org.elasticsearch.action.ActionRequest; | ||
import org.elasticsearch.action.ActionRequestValidationException; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptResponse; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse; | ||
import org.elasticsearch.action.bulk.BulkRequest; | ||
import org.elasticsearch.action.bulk.BulkResponse; | ||
import org.elasticsearch.action.delete.DeleteRequest; | ||
|
@@ -652,6 +656,62 @@ public final FieldCapabilitiesResponse fieldCaps(FieldCapabilitiesRequest fieldC | |
FieldCapabilitiesResponse::fromXContent, emptySet()); | ||
} | ||
|
||
/** | ||
* Get stored script by id. | ||
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html"> | ||
* How to use scripts on elastic.co</a> | ||
* @param request the request | ||
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized | ||
* @return the response | ||
* @throws IOException in case there is a problem sending the request or parsing back the response | ||
*/ | ||
public GetStoredScriptResponse getStoredScript(GetStoredScriptRequest request, RequestOptions options) throws IOException { | ||
return performRequestAndParseEntity(request, RequestConverters::getScript, options, | ||
GetStoredScriptResponse::fromXContent, emptySet()); | ||
} | ||
|
||
/** | ||
* Asynchronously get stored script by id. | ||
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html"> | ||
* How to use scripts on elastic.co</a> | ||
* @param request the request | ||
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized | ||
* @param listener the listener to be notified upon request completion | ||
*/ | ||
public void getStoredScriptAsync(GetStoredScriptRequest request, RequestOptions options, | ||
ActionListener<GetStoredScriptResponse> listener) { | ||
performRequestAsyncAndParseEntity(request, RequestConverters::getScript, options, | ||
GetStoredScriptResponse::fromXContent, listener, emptySet()); | ||
} | ||
|
||
/** | ||
* Delete stored script by id. | ||
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html"> | ||
* How to use scripts on elastic.co</a> | ||
* @param request the request | ||
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized | ||
* @return the response | ||
* @throws IOException in case there is a problem sending the request or parsing back the response | ||
*/ | ||
public DeleteStoredScriptResponse deleteStoredScript(DeleteStoredScriptRequest request, RequestOptions options) throws IOException { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. here too, remove the stored part |
||
return performRequestAndParseEntity(request, RequestConverters::deleteScript, options, | ||
DeleteStoredScriptResponse::fromXContent, emptySet()); | ||
} | ||
|
||
/** | ||
* Asynchronously delete stored script by id. | ||
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html"> | ||
* How to use scripts on elastic.co</a> | ||
* @param request the request | ||
* @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized | ||
* @param listener the listener to be notified upon request completion | ||
*/ | ||
public void deleteStoredScriptAsync(DeleteStoredScriptRequest request, RequestOptions options, | ||
ActionListener<DeleteStoredScriptResponse> listener) { | ||
performRequestAsyncAndParseEntity(request, RequestConverters::deleteScript, options, | ||
DeleteStoredScriptResponse::fromXContent, listener, emptySet()); | ||
} | ||
|
||
/** | ||
* Asynchronously executes a request using the Field Capabilities API. | ||
* See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html">Field Capabilities API | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,6 +37,8 @@ | |
import org.elasticsearch.action.admin.cluster.repositories.put.PutRepositoryRequest; | ||
import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryRequest; | ||
import org.elasticsearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest; | ||
import org.elasticsearch.action.admin.indices.alias.Alias; | ||
import org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest; | ||
import org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest.AliasActions; | ||
|
@@ -1913,6 +1915,26 @@ public void testGetTemplateRequest() throws Exception { | |
assertThat(request.getEntity(), nullValue()); | ||
} | ||
|
||
public void testGetScriptRequest() { | ||
GetStoredScriptRequest storedScriptRequest = new GetStoredScriptRequest("x-script"); | ||
|
||
Request request = RequestConverters.getScript(storedScriptRequest); | ||
assertThat(request.getEndpoint(), equalTo("/_scripts/" + storedScriptRequest.id())); | ||
assertThat(request.getMethod(), equalTo(HttpGet.METHOD_NAME)); | ||
assertThat(request.getParameters().isEmpty(), equalTo(true)); | ||
assertThat(request.getEntity(), nullValue()); | ||
} | ||
|
||
public void testDeleteScriptRequest() { | ||
DeleteStoredScriptRequest storedScriptRequest = new DeleteStoredScriptRequest("x-script"); | ||
|
||
Request request = RequestConverters.deleteScript(storedScriptRequest); | ||
assertThat(request.getEndpoint(), equalTo("/_scripts/" + storedScriptRequest.id())); | ||
assertThat(request.getMethod(), equalTo(HttpDelete.METHOD_NAME)); | ||
assertThat(request.getParameters().isEmpty(), equalTo(true)); | ||
assertThat(request.getEntity(), nullValue()); | ||
} | ||
|
||
private static void assertToXContentBody(ToXContent expectedBody, HttpEntity actualEntity) throws IOException { | ||
BytesReference expectedBytes = XContentHelper.toXContent(expectedBody, REQUEST_BODY_CONTENT_TYPE, false); | ||
assertEquals(XContentType.JSON.mediaTypeWithoutParameters(), actualEntity.getContentType().getValue()); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add a test for deleteScript here as well? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks. Good catch |
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
package org.elasticsearch.client;/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
|
||
import org.apache.http.entity.ContentType; | ||
import org.apache.http.entity.StringEntity; | ||
import org.apache.http.util.EntityUtils; | ||
import org.elasticsearch.ElasticsearchStatusException; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptResponse; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest; | ||
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse; | ||
import org.elasticsearch.common.Strings; | ||
import org.elasticsearch.common.xcontent.ToXContent; | ||
import org.elasticsearch.common.xcontent.XContentType; | ||
import org.elasticsearch.rest.RestStatus; | ||
import org.elasticsearch.script.Script; | ||
import org.elasticsearch.script.StoredScriptSource; | ||
|
||
import java.util.Collections; | ||
|
||
import static java.util.Collections.emptyMap; | ||
import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; | ||
import static org.hamcrest.Matchers.equalTo; | ||
|
||
public class StoredScriptsIT extends ESRestHighLevelClientTestCase { | ||
|
||
final String id = "calculate-score"; | ||
|
||
public void testGetStoredScript() throws Exception { | ||
final StoredScriptSource scriptSource = | ||
new StoredScriptSource("painless", | ||
"Math.log(_score * 2) + params.my_modifier", | ||
Collections.singletonMap(Script.CONTENT_TYPE_OPTION, XContentType.JSON.mediaType())); | ||
|
||
final String script = Strings.toString(scriptSource.toXContent(jsonBuilder(), ToXContent.EMPTY_PARAMS)); | ||
// TODO: change to HighLevel PutStoredScriptRequest when it will be ready | ||
// so far - using low-level REST API | ||
Response putResponse = | ||
adminClient() | ||
.performRequest("PUT", "/_scripts/calculate-score", emptyMap(), | ||
new StringEntity("{\"script\":" + script + "}", | ||
ContentType.APPLICATION_JSON)); | ||
assertEquals(putResponse.getStatusLine().getReasonPhrase(), 200, putResponse.getStatusLine().getStatusCode()); | ||
assertEquals("{\"acknowledged\":true}", EntityUtils.toString(putResponse.getEntity())); | ||
|
||
GetStoredScriptRequest getRequest = new GetStoredScriptRequest("calculate-score"); | ||
|
||
GetStoredScriptResponse getResponse = execute(getRequest, highLevelClient()::getStoredScript, | ||
highLevelClient()::getStoredScriptAsync); | ||
|
||
assertThat(getResponse.getSource(), equalTo(scriptSource)); | ||
} | ||
|
||
public void testDeleteStoredScript() throws Exception { | ||
final StoredScriptSource scriptSource = | ||
new StoredScriptSource("painless", | ||
"Math.log(_score * 2) + params.my_modifier", | ||
Collections.singletonMap(Script.CONTENT_TYPE_OPTION, XContentType.JSON.mediaType())); | ||
|
||
final String script = Strings.toString(scriptSource.toXContent(jsonBuilder(), ToXContent.EMPTY_PARAMS)); | ||
// TODO: change to HighLevel PutStoredScriptRequest when it will be ready | ||
// so far - using low-level REST API | ||
Response putResponse = | ||
adminClient() | ||
.performRequest("PUT", "/_scripts/" + id, emptyMap(), | ||
new StringEntity("{\"script\":" + script + "}", | ||
ContentType.APPLICATION_JSON)); | ||
assertEquals(putResponse.getStatusLine().getReasonPhrase(), 200, putResponse.getStatusLine().getStatusCode()); | ||
assertEquals("{\"acknowledged\":true}", EntityUtils.toString(putResponse.getEntity())); | ||
|
||
DeleteStoredScriptRequest deleteRequest = new DeleteStoredScriptRequest(id); | ||
|
||
DeleteStoredScriptResponse deleteResponse = execute(deleteRequest, highLevelClient()::deleteStoredScript, | ||
highLevelClient()::deleteStoredScriptAsync); | ||
|
||
assertThat(deleteResponse.isAcknowledged(), equalTo(true)); | ||
|
||
GetStoredScriptRequest getRequest = new GetStoredScriptRequest(id); | ||
|
||
final ElasticsearchStatusException statusException = expectThrows(ElasticsearchStatusException.class, | ||
() -> execute(getRequest, highLevelClient()::getStoredScript, | ||
highLevelClient()::getStoredScriptAsync)); | ||
assertThat(statusException.status(), equalTo(RestStatus.NOT_FOUND)); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the SPEC have get_script, can we call these methods getScript ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove stored from all methods names?