Skip to content

update _common.json format #46872

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

Merged
merged 7 commits into from
Sep 23, 2019
Merged

update _common.json format #46872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4308cab
update _common.json format
javanna Sep 19, 2019
7f5f308
fixed parsing
javanna Sep 23, 2019
3926259
unused import
javanna Sep 23, 2019
9565ff1
line length
javanna Sep 23, 2019
445f493
Merge branch 'master' into spec/update_common_parsing_format
javanna Sep 23, 2019
d6b8ca8
Update rest-api-spec/src/main/resources/rest-api-spec/api/_common.json
javanna Sep 23, 2019
08831e2
Update rest-api-spec/src/main/resources/rest-api-spec/api/_common.json
javanna Sep 23, 2019
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
6 changes: 4 additions & 2 deletions rest-api-spec/src/main/resources/rest-api-spec/api/_common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"description": "Parameters that are accepted by all API endpoints.",
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html",
"documentation" : {
"description": "Parameters that are accepted by all API endpoints.",
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html"
},
"params": {
"pretty": {
"type": "boolean",
Expand Down
66 changes: 38 additions & 28 deletions ...work/src/main/java/org/elasticsearch/test/rest/yaml/restspec/ClientYamlSuiteRestSpec.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
*/
package org.elasticsearch.test.rest.yaml.restspec;

import org.elasticsearch.common.io.PathUtils;
import org.elasticsearch.common.xcontent.LoggingDeprecationHandler;
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.json.JsonXContent;

import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
Expand All @@ -30,20 +36,14 @@
import java.util.Set;
import java.util.stream.Stream;

import org.elasticsearch.common.io.PathUtils;
import org.elasticsearch.common.xcontent.LoggingDeprecationHandler;
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.json.JsonXContent;

/**
* Holds the specification used to turn {@code do} actions in the YAML suite into REST api calls.
*/
public class ClientYamlSuiteRestSpec {
private final Set<String> globalParameters = new HashSet<>();
private final Map<String, ClientYamlSuiteRestApi> restApiMap = new HashMap<>();

private ClientYamlSuiteRestSpec() {}
ClientYamlSuiteRestSpec() {}

private void addApi(ClientYamlSuiteRestApi restApi) {
ClientYamlSuiteRestApi previous = restApiMap.putIfAbsent(restApi.getName(), restApi);
Expand Down Expand Up @@ -99,27 +99,7 @@ private static void parseSpecFile(ClientYamlSuiteRestApiParser restApiParser, Pa
JsonXContent.jsonXContent.createParser(NamedXContentRegistry.EMPTY, LoggingDeprecationHandler.INSTANCE, stream)) {
String filename = jsonFile.getFileName().toString();
if (filename.equals("_common.json")) {
String currentFieldName = null;
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
if (parser.currentToken() == XContentParser.Token.FIELD_NAME) {
currentFieldName = parser.currentName();
} else if (parser.currentToken() == XContentParser.Token.START_OBJECT
&& "params".equals(currentFieldName)) {
while (parser.nextToken() == XContentParser.Token.FIELD_NAME) {
String param = parser.currentName();
if (restSpec.globalParameters.contains(param)) {
throw new IllegalArgumentException("Found duplicate global param [" + param + "]");
}
restSpec.globalParameters.add(param);
parser.nextToken();
if (parser.currentToken() != XContentParser.Token.START_OBJECT) {
throw new IllegalArgumentException("Expected params field in rest api definition to " +
"contain an object");
}
parser.skipChildren();
}
}
}
parseCommonSpec(parser, restSpec);
} else {
ClientYamlSuiteRestApi restApi = restApiParser.parse(jsonFile.toString(), parser);
String expectedApiName = filename.substring(0, filename.lastIndexOf('.'));
Expand All @@ -134,4 +114,34 @@ private static void parseSpecFile(ClientYamlSuiteRestApiParser restApiParser, Pa
throw new UncheckedIOException("Can't parse rest spec file: [" + jsonFile + "]", ex);
}
}

static void parseCommonSpec(XContentParser parser, ClientYamlSuiteRestSpec restSpec) throws IOException {
String currentFieldName = null;
parser.nextToken();
assert parser.currentToken() == XContentParser.Token.START_OBJECT;
while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
if (parser.currentToken() == XContentParser.Token.FIELD_NAME) {
currentFieldName = parser.currentName();
} else if (parser.currentToken() == XContentParser.Token.START_OBJECT) {
if ("params".equals(currentFieldName)) {
while (parser.nextToken() == XContentParser.Token.FIELD_NAME) {
String param = parser.currentName();
if (restSpec.globalParameters.contains(param)) {
throw new IllegalArgumentException("Found duplicate global param [" + param + "]");
}
restSpec.globalParameters.add(param);
parser.nextToken();
if (parser.currentToken() != XContentParser.Token.START_OBJECT) {
throw new IllegalArgumentException("Expected params field in rest api definition to " +
"contain an object");
}
parser.skipChildren();
}
} else {
parser.skipChildren();
}
}
}

}
}
45 changes: 45 additions & 0 deletions .../src/test/java/org/elasticsearch/test/rest/yaml/restspec/ClientYamlSuiteRestApiTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@

public class ClientYamlSuiteRestApiTests extends ESTestCase {

public void testParseCommonSpec() throws IOException {
XContentParser parser = createParser(YamlXContent.yamlXContent, COMMON_SPEC);
ClientYamlSuiteRestSpec restSpec = new ClientYamlSuiteRestSpec();
ClientYamlSuiteRestSpec.parseCommonSpec(parser, restSpec);
assertTrue(restSpec.isGlobalParameter("pretty"));
assertTrue(restSpec.isGlobalParameter("human"));
assertTrue(restSpec.isGlobalParameter("error_trace"));
assertTrue(restSpec.isGlobalParameter("source"));
assertTrue(restSpec.isGlobalParameter("filter_path"));
assertFalse(restSpec.isGlobalParameter("unknown"));
}

public void testPathMatching() throws IOException {
XContentParser parser = createParser(YamlXContent.yamlXContent, REST_SPEC_API);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("index.json", parser);
Expand Down Expand Up @@ -66,6 +78,39 @@ public void testPathMatching() throws IOException {
}
}

private static final String COMMON_SPEC = "{\n"+
" \"documentation\" : {\n"+
" \"url\": \"Parameters that are accepted by all API endpoints.\",\n"+
" \"documentation\": \"https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html\"\n"+
" },\n"+
" \"params\": {\n"+
" \"pretty\": {\n"+
" \"type\": \"boolean\",\n"+
" \"description\": \"Pretty format the returned JSON response.\",\n"+
" \"default\": false\n"+
" },\n"+
" \"human\": {\n"+
" \"type\": \"boolean\",\n"+
" \"description\": \"Return human readable values for statistics.\",\n"+
" \"default\": true\n"+
" },\n"+
" \"error_trace\": {\n"+
" \"type\": \"boolean\",\n"+
" \"description\": \"Include the stack trace of returned errors.\",\n"+
" \"default\": false\n"+
" },\n"+
" \"source\": {\n"+
" \"type\": \"string\",\n"+
" \"description\": \"The URL-encoded request definition." +
" Useful for libraries that do not accept a request body for non-POST requests.\"\n"+
" },\n"+
" \"filter_path\": {\n"+
" \"type\": \"list\",\n"+
" \"description\": \"A comma-separated list of filters used to reduce the response.\"\n"+
" }\n"+
" }\n"+
"}\n";

private static final String REST_SPEC_API = "{\n" +
" \"index\":{\n" +
" \"documentation\":{\n" +
Expand Down