honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

REST spec: Validate that api name matches file name that contains it (#27366) 

This commit validates that each spec json file contains an API that has the same name as the file
This commit is contained in:
Luca Cavanna 2017-11-14 14:53:00 +01:00 committed by GitHub
parent be399965e3
commit 382da0f227
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
test/framework/src/main/java/org/elasticsearch/test/rest/yaml/restspec/ClientYamlSuiteRestApiParser.java
View File

@ -40,7 +40,12 @@ public class ClientYamlSuiteRestApiParser {
//move to first field name
}
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApi(location, parser.currentName());
String apiName = parser.currentName();
if (location.endsWith(apiName + ".json") == false) {
throw new IllegalArgumentException("API [" + apiName + "] should have the same name as its file [" + location + "]");
}
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApi(location, apiName);
int level = -1;
while (parser.nextToken() != XContentParser.Token.END_OBJECT || level >= 0) {

21
test/framework/src/test/java/org/elasticsearch/test/rest/yaml/restspec/ClientYamlSuiteRestApiParserFailingTests.java
View File

@ -20,7 +20,6 @@ package org.elasticsearch.test.rest.yaml.restspec;
import org.elasticsearch.common.xcontent.XContent;
import org.elasticsearch.common.xcontent.XContentParser;
import org.elasticsearch.common.xcontent.json.JsonXContent;
import org.elasticsearch.common.xcontent.yaml.YamlXContent;
import org.elasticsearch.test.ESTestCase;
@ -49,7 +48,7 @@ public class ClientYamlSuiteRestApiParserFailingTests extends ESTestCase {
" }," +
" \"body\": null" +
" }" +
"}", "Found duplicate method [PUT]");
"}", "ping.json", "Found duplicate method [PUT]");
}
public void testDuplicatePaths() throws Exception {
@ -69,7 +68,7 @@ public class ClientYamlSuiteRestApiParserFailingTests extends ESTestCase {
" }," +
" \"body\": null" +
" }" +
"}", "Found duplicate path [/pingtwo]");
"}", "ping.json", "Found duplicate path [/pingtwo]");
}
public void testDuplicateParts() throws Exception {
@ -103,7 +102,7 @@ public class ClientYamlSuiteRestApiParserFailingTests extends ESTestCase {
" }," +
" \"body\": null" +
" }" +
"}", "Found duplicate part [index]");
"}", "ping.json", "Found duplicate part [index]");
}
public void testDuplicateParams() throws Exception {
@ -135,22 +134,26 @@ public class ClientYamlSuiteRestApiParserFailingTests extends ESTestCase {
" }," +
" \"body\": null" +
" }" +
"}", "Found duplicate param [timeout]");
"}", "ping.json", "Found duplicate param [timeout]");
}
public void testBrokenSpecShouldThrowUsefulExceptionWhenParsingFailsOnParams() throws Exception {
parseAndExpectFailure(BROKEN_SPEC_PARAMS, "Expected params field in rest api definition to contain an object");
parseAndExpectFailure(BROKEN_SPEC_PARAMS, "ping.json", "Expected params field in rest api definition to contain an object");
}
public void testBrokenSpecShouldThrowUsefulExceptionWhenParsingFailsOnParts() throws Exception {
parseAndExpectFailure(BROKEN_SPEC_PARTS, "Expected parts field in rest api definition to contain an object");
parseAndExpectFailure(BROKEN_SPEC_PARTS, "ping.json", "Expected parts field in rest api definition to contain an object");
}
private void parseAndExpectFailure(String brokenJson, String expectedErrorMessage) throws Exception {
public void testSpecNameMatchesFilename() throws Exception {
parseAndExpectFailure("{\"ping\":{}}", "not_matching.json", "API [ping] should have the same name as its file [not_matching.json]");
}
private void parseAndExpectFailure(String brokenJson, String location, String expectedErrorMessage) throws Exception {
XContentParser parser = createParser(YamlXContent.yamlXContent, brokenJson);
ClientYamlSuiteRestApiParser restApiParser = new ClientYamlSuiteRestApiParser();
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> restApiParser.parse("location", parser));
IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> restApiParser.parse(location, parser));
assertThat(e.getMessage(), containsString(expectedErrorMessage));
}

10
test/framework/src/test/java/org/elasticsearch/test/rest/yaml/restspec/ClientYamlSuiteRestApiParserTests.java
View File

@ -30,7 +30,7 @@ import static org.hamcrest.Matchers.notNullValue;
public class ClientYamlSuiteRestApiParserTests extends AbstractClientYamlTestFragmentParserTestCase {
public void testParseRestSpecIndexApi() throws Exception {
parser = createParser(YamlXContent.yamlXContent, REST_SPEC_INDEX_API);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("location", parser);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("index.json", parser);
assertThat(restApi, notNullValue());
assertThat(restApi.getName(), equalTo("index"));
@ -47,14 +47,14 @@ public class ClientYamlSuiteRestApiParserTests extends AbstractClientYamlTestFra
assertThat(restApi.getPathParts(), hasEntry("id", false));
assertThat(restApi.getParams().size(), equalTo(4));
assertThat(restApi.getParams().keySet(), containsInAnyOrder("wait_for_active_shards", "op_type", "parent", "refresh"));
restApi.getParams().entrySet().stream().forEach(e -> assertThat(e.getValue(), equalTo(false)));
restApi.getParams().entrySet().forEach(e -> assertThat(e.getValue(), equalTo(false)));
assertThat(restApi.isBodySupported(), equalTo(true));
assertThat(restApi.isBodyRequired(), equalTo(true));
}
public void testParseRestSpecGetTemplateApi() throws Exception {
parser = createParser(YamlXContent.yamlXContent, REST_SPEC_GET_TEMPLATE_API);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("location", parser);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("indices.get_template.json", parser);
assertThat(restApi, notNullValue());
assertThat(restApi.getName(), equalTo("indices.get_template"));
assertThat(restApi.getMethods().size(), equalTo(1));
@ -71,7 +71,7 @@ public class ClientYamlSuiteRestApiParserTests extends AbstractClientYamlTestFra
public void testParseRestSpecCountApi() throws Exception {
parser = createParser(YamlXContent.yamlXContent, REST_SPEC_COUNT_API);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("location", parser);
ClientYamlSuiteRestApi restApi = new ClientYamlSuiteRestApiParser().parse("count.json", parser);
assertThat(restApi, notNullValue());
assertThat(restApi.getName(), equalTo("count"));
assertThat(restApi.getMethods().size(), equalTo(2));
@ -83,7 +83,7 @@ public class ClientYamlSuiteRestApiParserTests extends AbstractClientYamlTestFra
assertThat(restApi.getPaths().get(2), equalTo("/{index}/{type}/_count"));
assertThat(restApi.getPathParts().size(), equalTo(2));
assertThat(restApi.getPathParts().keySet(), containsInAnyOrder("index", "type"));
restApi.getPathParts().entrySet().stream().forEach(e -> assertThat(e.getValue(), equalTo(false)));
restApi.getPathParts().entrySet().forEach(e -> assertThat(e.getValue(), equalTo(false)));
assertThat(restApi.getParams().size(), equalTo(1));
assertThat(restApi.getParams().keySet(), contains("ignore_unavailable"));
assertThat(restApi.getParams(), hasEntry("ignore_unavailable", false));