honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-09 06:25:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Omit shard failures assertion for incompatible responses (#31430)

Browse Source 
Filter out the assertion for _cat and _xpack/ml/datafeed APIs
This commit is contained in:
David Kyle 2018-06-20 16:57:51 +01:00 committed by GitHub
parent f012de0f00
commit 6ebe6e32cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTask.groovy
View File

@ -27,7 +27,6 @@ import org.gradle.api.tasks.OutputDirectory
import java.nio.file.Files import java.nio.file.Files
import java.nio.file.Path import java.nio.file.Path
import java.util.regex.Matcher
/** /**
* Generates REST tests for each snippet marked // TEST. * Generates REST tests for each snippet marked // TEST.
@ -100,6 +99,14 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
return snippet.language == 'js' || snippet.curl return snippet.language == 'js' || snippet.curl
} }
/**
* Certain requests should not have the shard failure check because the
* format of the response is incompatible i.e. it is not a JSON object.
*/
static shouldAddShardFailureCheck(String path) {
return path.startsWith('_cat') == false && path.startsWith('_xpack/ml/datafeeds/') == false
}
/** /**
* Converts Kibana's block quoted strings into standard JSON. These * Converts Kibana's block quoted strings into standard JSON. These
* {@code """} delimited strings can be embedded in CONSOLE and can * {@code """} delimited strings can be embedded in CONSOLE and can
@ -309,13 +316,11 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
* no shard succeeds. But we need to fail the tests on all of these * no shard succeeds. But we need to fail the tests on all of these
* because they mean invalid syntax or broken queries or something * because they mean invalid syntax or broken queries or something
* else that we don't want to teach people to do. The REST test * else that we don't want to teach people to do. The REST test
* framework doesn't allow us to has assertions in the setup * framework doesn't allow us to have assertions in the setup
* section so we have to skip it there. We also have to skip _cat * section so we have to skip it there. We also omit the assertion
* actions because they don't return json so we can't is_false * from APIs that don't return a JSON object
* them. That is ok because they don't have this
* partial-success-is-success thing.
*/ */
if (false == inSetup && false == path.startsWith('_cat')) { if (false == inSetup && shouldAddShardFailureCheck(path)) {
current.println(" - is_false: _shards.failures") current.println(" - is_false: _shards.failures")
} }
} }

10
buildSrc/src/test/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTaskTest.groovy
View File

@ -19,9 +19,7 @@
package org.elasticsearch.gradle.doc package org.elasticsearch.gradle.doc
import org.elasticsearch.gradle.doc.SnippetsTask.Snippet import static org.elasticsearch.gradle.doc.RestTestsFromSnippetsTask.shouldAddShardFailureCheck
import org.gradle.api.InvalidUserDataException
import static org.elasticsearch.gradle.doc.RestTestsFromSnippetsTask.replaceBlockQuote import static org.elasticsearch.gradle.doc.RestTestsFromSnippetsTask.replaceBlockQuote
class RestTestFromSnippetsTaskTest extends GroovyTestCase { class RestTestFromSnippetsTaskTest extends GroovyTestCase {
@ -47,4 +45,10 @@ class RestTestFromSnippetsTaskTest extends GroovyTestCase {
assertEquals("\"foo\": \"bort\\n baz\"", assertEquals("\"foo\": \"bort\\n baz\"",
replaceBlockQuote("\"foo\": \"\"\"bort\n baz\"\"\"")); replaceBlockQuote("\"foo\": \"\"\"bort\n baz\"\"\""));
} }
void testIsDocWriteRequest() {
assertTrue(shouldAddShardFailureCheck("doc-index/_search"));
assertFalse(shouldAddShardFailureCheck("_cat"))
assertFalse(shouldAddShardFailureCheck("_xpack/ml/datafeeds/datafeed-id/_preview"));
}
} }