improve yaml assertion

Author: javanna

rest-api-spec/src/main/resources/rest-api-spec/test/scroll/10_basic.yml

@@ -33,6 +33,7 @@
   - set: {_scroll_id: scroll_id}
   - match: {hits.total:      2    }
   - length: {hits.hits:      1    }
+  - match: { hits.max_score: null }
   - match: {hits.hits.0._id: "42" }
 
   - do:
@@ -52,6 +53,7 @@
   - match: {hits.total:      2    }
   - length: {hits.hits:      1    }
   - match: {hits.hits.0._id: "43" }
+  - match: { hits.max_score: null }
 
   - do:
       scroll:
@@ -60,6 +62,7 @@
 
   - match: {hits.total:      2    }
   - length: {hits.hits:      0    }
+  - is_false: hits.max_score
 
   - do:
       clear_scroll:
@@ -105,6 +108,7 @@
   - set: {_scroll_id: scroll_id}
   - match: {hits.total:      2    }
   - length: {hits.hits:      1    }
+  - match: { hits.max_score: null }
   - match: {hits.hits.0._id: "42" }
 
   - do:
@@ -123,6 +127,7 @@
 
   - match: {hits.total:      2    }
   - length: {hits.hits:      1    }
+  - match: { hits.max_score: null }
   - match: {hits.hits.0._id: "43" }
 
   - do:
@@ -132,6 +137,7 @@
 
   - match: {hits.total:      2    }
   - length: {hits.hits:      0    }
+  - match: { hits.max_score: null }
 
   - do:
       clear_scroll:

rest-api-spec/src/main/resources/rest-api-spec/test/search/110_field_collapsing.yml

@@ -243,6 +243,7 @@ setup:
 
   - match: { hits.total: 6 }
   - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
 
 ---
 "field collapsing and multiple inner_hits":

rest-api-spec/src/main/resources/rest-api-spec/test/search/120_batch_reduce_size.yml

@@ -53,6 +53,8 @@ setup:
 
   - match: { num_reduce_phases: 4 }
   - match: { hits.total: 3 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
   - length: { aggregations.str_terms.buckets: 2 }
   - match: { aggregations.str_terms.buckets.0.key: "abc" }
   - is_false: aggregations.str_terms.buckets.0.key_as_string

rest-api-spec/src/main/resources/rest-api-spec/test/search/140_pre_filter_search_shards.yml

@@ -79,6 +79,8 @@ setup:
   - match: { _shards.skipped: 0 }
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
 
   # this is the case where we have an empty body and don't skip anything since it's match_all
   - do:
@@ -102,6 +104,8 @@ setup:
   - match: { _shards.skipped : 1}
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
 
   # this case we skip all except of one since we need a real result
   - do:
@@ -115,6 +119,8 @@ setup:
   - match: { _shards.skipped : 2} 
   - match: { _shards.failed: 0 }
   - match: { hits.total: 0 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
 
   - do:
       search:
@@ -126,9 +132,10 @@ setup:
   - match: { _shards.skipped : 0 }
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
   - match: { aggregations.some_agg.doc_count: 3 }
 
-
   - do:
       search:
         pre_filter_shard_size: 1
@@ -139,6 +146,8 @@ setup:
   - match: { _shards.skipped : 0 }
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
   - length: { aggregations.idx_terms.buckets: 3 }
 
   - do:
@@ -151,6 +160,8 @@ setup:
   - match: { _shards.skipped : 1 }
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
   - length: { aggregations.idx_terms.buckets: 2 }
 
 

rest-api-spec/src/main/resources/rest-api-spec/test/search/150_rewrite_on_coordinator.yml

@@ -69,6 +69,8 @@
   - match: { _shards.skipped: 0 }
   - match: { _shards.failed: 0 }
   - match: { hits.total: 2 }
+  - length: { hits.hits: 0 }
+  - match: { hits.max_score: null }
 
   - do:
       indices.stats: { index: 'lookup_index', "metric": "get"}

rest-api-spec/src/main/resources/rest-api-spec/test/search/190_index_prefix_search.yml

@@ -39,6 +39,7 @@ setup:
         df: text
 
   - match: {hits.total: 1}
+  - match: {hits.max_score: 1}
   - match: {hits.hits.0._score: 1}
 
   - do:
@@ -52,6 +53,7 @@ setup:
               boost: 2
 
   - match: {hits.total: 1}
+  - match: {hits.max_score: 2}
   - match: {hits.hits.0._score: 2}
 
   - do:
@@ -61,6 +63,7 @@ setup:
         df: text
 
   - match: {hits.total: 1}
+  - match: {hits.max_score: 1}
   - match: {hits.hits.0._score: 1}
 
 ---

rest-api-spec/src/main/resources/rest-api-spec/test/search/210_rescore_explain.yml

@@ -29,6 +29,7 @@
               query_weight: 5
               rescore_query_weight: 10
 
+  - match: {hits.max_score: 15}
   - match: { hits.hits.0._score: 15 }
   - match: { hits.hits.0._explanation.value: 15 }
 

test/framework/src/main/java/org/elasticsearch/test/rest/yaml/section/MatchAssertion.java

@@ -32,6 +32,7 @@
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 
 /**
@@ -70,8 +71,13 @@ protected void doAssert(Object actualValue, Object expectedValue) {
             }
         }
 
-        assertNotNull("field [" + getField() + "] is null", actualValue);
         logger.trace("assert that [{}] matches [{}] (field [{}])", actualValue, expectedValue, getField());
+        if (expectedValue == null) {
+            assertNull("field [" + getField() + "] should be null but was [" + actualValue + "]", actualValue);
+            return;
+        }
+        assertNotNull("field [" + getField() + "] is null", actualValue);
+
         if (actualValue.getClass().equals(safeClass(expectedValue)) == false) {
             if (actualValue instanceof Number && expectedValue instanceof Number) {
                 //Double 1.0 is equal to Integer 1

test/framework/src/test/java/org/elasticsearch/test/rest/yaml/section/MatchAssertionTests.java

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+package org.elasticsearch.test.rest.yaml.section;
+
+import org.elasticsearch.common.xcontent.XContentLocation;
+import org.elasticsearch.test.ESTestCase;
+
+public class MatchAssertionTests extends ESTestCase  {
+
+    public void testNull() {
+        XContentLocation xContentLocation = new XContentLocation(0, 0);
+        {
+            MatchAssertion matchAssertion = new MatchAssertion(xContentLocation, "field", null);
+            matchAssertion.doAssert(null, null);
+            expectThrows(AssertionError.class, () -> matchAssertion.doAssert("non-null", null));
+        }
+        {
+            MatchAssertion matchAssertion = new MatchAssertion(xContentLocation, "field", "non-null");
+            expectThrows(AssertionError.class, () -> matchAssertion.doAssert(null, "non-null"));
+        }
+        {
+            MatchAssertion matchAssertion = new MatchAssertion(xContentLocation, "field", "/exp/");
+            expectThrows(AssertionError.class, () -> matchAssertion.doAssert(null, "/exp/"));
+        }
+    }
+}