[DOCS] Omit shard failures assertion for incompatible responses

buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTask.groovy

@@ -27,7 +27,7 @@ import org.gradle.api.tasks.OutputDirectory
 
 import java.nio.file.Files
 import java.nio.file.Path
-import java.util.regex.Matcher
+import java.util.regex.Pattern
 
 /**
  * Generates REST tests for each snippet marked // TEST.
@@ -39,6 +39,12 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
      */
     private static final List BAD_LANGUAGES = ['json', 'javascript']
 
+    /**
+     * Doc write operations start with an index name that cannot
+     * start with -, _ or + and must be lower case.
+     */
+    private static final Pattern DOCS_WRITE_OP_PATTERN = Pattern.compile("^[^_\\-\\+][a-z_-]+/");
+
     @Input
     Map<String, String> setups = new HashMap()
 
@@ -100,6 +106,13 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
         return snippet.language == 'js' || snippet.curl
     }
 
+    /**
+     * Is the URL path a doc write request?
+     */
+    static isDocWriteRequest(String path) {
+        return DOCS_WRITE_OP_PATTERN.matcher(path).find();
+    }
+
     /**
      * Converts Kibana's block quoted strings into standard JSON. These
      * {@code """} delimited strings can be embedded in CONSOLE and can
@@ -308,14 +321,12 @@ public class RestTestsFromSnippetsTask extends SnippetsTask {
             /* Catch any shard failures. These only cause a non-200 response if
              * no shard succeeds. But we need to fail the tests on all of these
              * because they mean invalid syntax or broken queries or something
-             * 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
-             * section so we have to skip it there. We also have to skip _cat
-             * actions because they don't return json so we can't is_false
-             * them. That is ok because they don't have this
-             * partial-success-is-success thing.
+             * else that we don't want to teach people to do. Shard failures
+             * can occur in document CRUD operations. The REST test
+             * framework doesn't allow us to have assertions in the setup
+             * section so we have to skip it there.
              */
-            if (false == inSetup && false == path.startsWith('_cat')) {
+            if (false == inSetup && isDocWriteRequest(path)) {
                 current.println("  - is_false: _shards.failures")
             }
         }

buildSrc/src/test/groovy/org/elasticsearch/gradle/doc/RestTestsFromSnippetsTaskTest.groovy

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