Added IgnoreAboveTest

Author: Kubik42

server/src/main/java/org/elasticsearch/index/IgnoreAbove.java

@@ -11,10 +11,15 @@
 
 import org.elasticsearch.xcontent.XContentString;
 
+import java.util.Objects;
+
 import static org.elasticsearch.index.IndexSettings.IGNORE_ABOVE_DEFAULT_LOGSDB_INDICES;
 import static org.elasticsearch.index.IndexSettings.IGNORE_ABOVE_DEFAULT_STANDARD_INDICES;
 
-public record IgnoreAbove(Integer value, int defaultValue) {
+/**
+ * This class models the ignore_above parameter in indices.
+ */
+public class IgnoreAbove {
 
     public static final IgnoreAbove IGNORE_ABOVE_STANDARD_INDICES = IgnoreAbove.builder()
         .defaultValue(IGNORE_ABOVE_DEFAULT_STANDARD_INDICES)
@@ -24,14 +29,29 @@ public record IgnoreAbove(Integer value, int defaultValue) {
         .defaultValue(IGNORE_ABOVE_DEFAULT_LOGSDB_INDICES)
         .build();
 
+    private final Integer value;
+    private final Integer defaultValue;
+
+    public IgnoreAbove(Integer value, Integer defaultValue) {
+        this.value = value;
+        this.defaultValue = Objects.requireNonNull(defaultValue);
+    }
+
     public int get() {
         return value != null ? value : defaultValue;
     }
 
+    /**
+     * Returns whether ignore_above is set; at field or index level.
+     */
     public boolean isSet() {
-        return value != null && value != defaultValue;
+        // if ignore_above equals default, its not considered to be set, even if it was explicitly set to the default value
+        return value != null && value.equals(defaultValue) == false;
     }
 
+    /**
+     * Returns whether the given string will be ignored.
+     */
     public boolean isIgnored(final String s) {
         if (s == null) return false;
         return lengthExceedsIgnoreAbove(s.length());
@@ -53,7 +73,7 @@ public static Builder builder() {
     public static final class Builder {
 
         private Integer value;
-        private int defaultValue;  // cannot be null, hence int
+        private Integer defaultValue;
 
         private Builder() {}
 
@@ -62,7 +82,7 @@ public Builder value(Integer value) {
             return this;
         }
 
-        public Builder defaultValue(int defaultValue) {
+        public Builder defaultValue(Integer defaultValue) {
             this.defaultValue = defaultValue;
             return this;
         }

server/src/test/java/org/elasticsearch/index/IgnoreAboveTests.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.index;
+
+import org.elasticsearch.test.ESTestCase;
+import org.elasticsearch.xcontent.Text;
+
+public class IgnoreAboveTests extends ESTestCase {
+
+    public void test_ignore_above_with_value_and_default() {
+        // given
+        IgnoreAbove ignoreAbove = IgnoreAbove.builder().value(123).defaultValue(456).build();
+
+        // when/then
+        assertEquals(123, ignoreAbove.get());
+        assertTrue(ignoreAbove.isSet());
+    }
+
+    public void test_ignore_above_with_default_only_is_valid() {
+        // given
+        IgnoreAbove ignoreAbove = IgnoreAbove.builder().defaultValue(456).build();
+
+        // when/then
+        assertEquals(456, ignoreAbove.get());
+        assertFalse(ignoreAbove.isSet());
+    }
+
+    public void test_ignore_above_with_same_value_and_default() {
+        // given
+        IgnoreAbove ignoreAbove = IgnoreAbove.builder().value(123).defaultValue(123).build();
+
+        // when/then
+        assertEquals(123, ignoreAbove.get());
+        assertFalse(ignoreAbove.isSet());
+    }
+
+    public void test_ignore_above_with_value_only_should_throw() {
+        // given/when/then
+        assertThrows(NullPointerException.class, () -> IgnoreAbove.builder().value(123).build());
+    }
+
+    public void test_ignore_above_with_nothing_should_throw() {
+        // given/when/then
+        assertThrows(NullPointerException.class, () -> IgnoreAbove.builder().build());
+    }
+
+    public void test_string_isIgnored() {
+        // given
+        IgnoreAbove ignoreAbove = IgnoreAbove.builder().value(10).defaultValue(456).build();
+
+        // when/then
+        assertFalse(ignoreAbove.isIgnored("potato"));
+        assertFalse(ignoreAbove.isIgnored("1234567890"));
+        assertTrue(ignoreAbove.isIgnored("12345678901"));
+        assertTrue(ignoreAbove.isIgnored("potato potato tomato tomato"));
+    }
+
+    public void test_XContentString_isIgnored() {
+        // given
+        IgnoreAbove ignoreAbove = IgnoreAbove.builder().value(10).defaultValue(456).build();
+
+        // when/then
+        assertFalse(ignoreAbove.isIgnored(new Text("potato")));
+        assertFalse(ignoreAbove.isIgnored(new Text("1234567890")));
+        assertTrue(ignoreAbove.isIgnored(new Text("12345678901")));
+        assertTrue(ignoreAbove.isIgnored(new Text("potato potato tomato tomato")));
+    }
+
+}

server/src/test/java/org/elasticsearch/index/mapper/KeywordFieldTypeTests.java

@@ -9,6 +9,7 @@
 package org.elasticsearch.index.mapper;
 
 import com.carrotsearch.randomizedtesting.generators.RandomStrings;
+
 import org.apache.lucene.analysis.Analyzer;
 import org.apache.lucene.analysis.LowerCaseFilter;
 import org.apache.lucene.analysis.TokenFilter;

x-pack/plugin/wildcard/src/test/java/org/elasticsearch/xpack/wildcard/mapper/WildcardFieldMapperTests.java

@@ -721,7 +721,10 @@ protected Object getSampleValueForDocument() {
     @Override
     protected void registerParameters(ParameterChecker checker) throws IOException {
         checker.registerConflictCheck("null_value", b -> b.field("null_value", "foo"));
-        checker.registerUpdateCheck(b -> b.field("ignore_above", 256), m -> assertEquals(256, ((WildcardFieldMapper) m).ignoreAbove().get()));
+        checker.registerUpdateCheck(
+            b -> b.field("ignore_above", 256),
+            m -> assertEquals(256, ((WildcardFieldMapper) m).ignoreAbove().get())
+        );
 
     }