Adding KqlQuery to esql-core query dsl supported queries.

Author: afoucret

x-pack/plugin/esql-core/build.gradle

@@ -6,7 +6,7 @@ esplugin {
   name 'x-pack-esql-core'
   description 'Elasticsearch infrastructure plugin for ESQL'
   classname 'org.elasticsearch.xpack.esql.core.plugin.EsqlCorePlugin'
-  extendedPlugins = ['x-pack-core']
+  extendedPlugins = ['x-pack-core', 'x-pack-kql']
 }
 
 base {
@@ -17,6 +17,7 @@ dependencies {
   api "org.antlr:antlr4-runtime:${versions.antlr4}"
   api project(path: xpackModule('mapper-version'))
   compileOnly project(path: xpackModule('core'))
+  compileOnly project(path: xpackModule('kql'))
   testApi(project(xpackModule('esql-core:test-fixtures'))) {
     exclude group: 'org.elasticsearch.plugin', module: 'esql-core'
   }

x-pack/plugin/esql-core/src/main/java/org/elasticsearch/xpack/esql/core/querydsl/query/KqlQuery.java

@@ -0,0 +1,84 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+package org.elasticsearch.xpack.esql.core.querydsl.query;
+
+import org.elasticsearch.core.Booleans;
+import org.elasticsearch.index.query.QueryBuilder;
+import org.elasticsearch.xpack.esql.core.tree.Source;
+import org.elasticsearch.xpack.kql.query.KqlQueryBuilder;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Objects;
+import java.util.function.BiConsumer;
+
+import static java.util.Map.entry;
+
+public class KqlQuery extends Query {
+
+    private static final Map<String, BiConsumer<KqlQueryBuilder, String>> BUILDER_APPLIERS = Map.ofEntries(
+        entry(KqlQueryBuilder.TIME_ZONE_FIELD.getPreferredName(), KqlQueryBuilder::timeZone),
+        entry(KqlQueryBuilder.DEFAULT_FIELD_FIELD.getPreferredName(), KqlQueryBuilder::defaultField),
+        entry(KqlQueryBuilder.CASE_INSENSITIVE_FIELD.getPreferredName(), (qb, s) -> qb.caseInsensitive(Booleans.parseBoolean(s)))
+    );
+
+    private final String query;
+
+    private final Map<String, String> options;
+
+    // dedicated constructor for QueryTranslator
+    public KqlQuery(Source source, String query) {
+        this(source, query, null);
+    }
+
+    public KqlQuery(Source source, String query, Map<String, String> options) {
+        super(source);
+        this.query = query;
+        this.options = options == null ? Collections.emptyMap() : options;
+    }
+
+    @Override
+    public QueryBuilder asBuilder() {
+        final KqlQueryBuilder queryBuilder = new KqlQueryBuilder(query);
+        options.forEach((k, v) -> {
+            if (BUILDER_APPLIERS.containsKey(k)) {
+                BUILDER_APPLIERS.get(k).accept(queryBuilder, v);
+            } else {
+                throw new IllegalArgumentException("illegal kql query option [" + k + "]");
+            }
+        });
+        return queryBuilder;
+    }
+
+    public String query() {
+        return query;
+    }
+
+    public Map<String, String> options() {
+        return options;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(query, options);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (false == super.equals(obj)) {
+            return false;
+        }
+
+        KqlQuery other = (KqlQuery) obj;
+        return Objects.equals(query, other.query) && Objects.equals(options, other.options);
+    }
+
+    @Override
+    protected String innerToString() {
+        return query;
+    }
+}

x-pack/plugin/esql-core/src/test/java/org/elasticsearch/xpack/esql/core/querydsl/query/KqlQueryTests.java

@@ -0,0 +1,77 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+package org.elasticsearch.xpack.esql.core.querydsl.query;
+
+import org.elasticsearch.test.ESTestCase;
+import org.elasticsearch.xpack.esql.core.expression.predicate.fulltext.StringQueryPredicate;
+import org.elasticsearch.xpack.esql.core.tree.Source;
+import org.elasticsearch.xpack.esql.core.tree.SourceTests;
+import org.elasticsearch.xpack.esql.core.util.StringUtils;
+import org.elasticsearch.xpack.kql.query.KqlQueryBuilder;
+
+import java.time.ZoneId;
+import java.time.zone.ZoneRulesException;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
+
+import static org.elasticsearch.test.EqualsHashCodeTestUtils.checkEqualsAndHashCode;
+import static org.hamcrest.Matchers.equalTo;
+
+public class KqlQueryTests extends ESTestCase {
+    static KqlQuery randomMatchQuery() {
+        return new KqlQuery(SourceTests.randomSource(), randomAlphaOfLength(5));
+        // TODO add the options
+    }
+
+    public void testEqualsAndHashCode() {
+        checkEqualsAndHashCode(randomMatchQuery(), KqlQueryTests::copy, KqlQueryTests::mutate);
+    }
+
+    private static KqlQuery copy(KqlQuery query) {
+        return new KqlQuery(query.source(), query.query(), query.options());
+    }
+
+    private static KqlQuery mutate(KqlQuery query) {
+        List<Function<KqlQuery, KqlQuery>> options = Arrays.asList(
+            q -> new KqlQuery(SourceTests.mutate(q.source()), q.query(), q.options()),
+            q -> new KqlQuery(q.source(), randomValueOtherThan(q.query(), () -> randomAlphaOfLength(5)), q.options())
+        );
+        // TODO mutate the options
+        return randomFrom(options).apply(query);
+    }
+
+    public void testQueryBuilding() {
+        KqlQueryBuilder qb = getBuilder("case_insensitive=false");
+        assertThat(qb.caseInsensitive(), equalTo(false));
+
+        qb = getBuilder("case_insensitive=false;time_zone=UTC;default_field=foo");
+        assertThat(qb.caseInsensitive(), equalTo(false));
+        assertThat(qb.timeZone(), equalTo(ZoneId.of("UTC")));
+        assertThat(qb.defaultField(), equalTo("foo"));
+
+        Exception e = expectThrows(IllegalArgumentException.class, () -> getBuilder("pizza=yummy"));
+        assertThat(e.getMessage(), equalTo("illegal kql query option [pizza]"));
+
+        e = expectThrows(ZoneRulesException.class, () -> getBuilder("time_zone=aoeu"));
+        assertThat(e.getMessage(), equalTo("Unknown time-zone ID: aoeu"));
+    }
+
+    private static KqlQueryBuilder getBuilder(String options) {
+        final Source source = new Source(1, 1, StringUtils.EMPTY);
+        final StringQueryPredicate predicate = new StringQueryPredicate(source, "eggplant", options);
+        final KqlQuery kqlQuery = new KqlQuery(source, "eggplant", predicate.optionMap());
+        return (KqlQueryBuilder) kqlQuery.asBuilder();
+    }
+
+    public void testToString() {
+        final Source source = new Source(1, 1, StringUtils.EMPTY);
+        final KqlQuery kqlQuery = new KqlQuery(source, "eggplant", Map.of());
+        assertEquals("KqlQuery@1:2[eggplant]", kqlQuery.toString());
+    }
+}