// Copyright 2025 Google LLC
//
// Licensed 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 elasticsearchesql
import (
"reflect"
"testing"
"github.com/goccy/go-yaml"
"github.com/google/go-cmp/cmp"
"github.com/googleapis/genai-toolbox/internal/server"
"github.com/googleapis/genai-toolbox/internal/testutils"
"github.com/googleapis/genai-toolbox/internal/util/parameters"
)
func TestParseFromYamlElasticsearchEsql(t *testing.T) {
ctx, err := testutils.ContextWithNewLogger()
if err != nil {
t.Fatalf("unexpected error: %s", err)
}
tcs := []struct {
desc string
in string
want server.ToolConfigs
}{
{
desc: "basic search example",
in: `
tools:
example_tool:
kind: elasticsearch-esql
source: my-elasticsearch-instance
description: Elasticsearch ES|QL tool
query: |
FROM my-index
| KEEP first_name, last_name
`,
want: server.ToolConfigs{
"example_tool": Config{
Name: "example_tool",
Kind: "elasticsearch-esql",
Source: "my-elasticsearch-instance",
Description: "Elasticsearch ES|QL tool",
AuthRequired: []string{},
Query: "FROM my-index\n| KEEP first_name, last_name\n",
},
},
},
{
desc: "search with customizable limit parameter",
in: `
tools:
example_tool:
kind: elasticsearch-esql
source: my-elasticsearch-instance
description: Elasticsearch ES|QL tool with customizable limit
parameters:
- name: limit
type: integer
description: Limit the number of results
query: |
FROM my-index
| LIMIT ?limit
`,
want: server.ToolConfigs{
"example_tool": Config{
Name: "example_tool",
Kind: "elasticsearch-esql",
Source: "my-elasticsearch-instance",
Description: "Elasticsearch ES|QL tool with customizable limit",
AuthRequired: []string{},
Parameters: parameters.Parameters{
parameters.NewIntParameter("limit", "Limit the number of results"),
},
Query: "FROM my-index\n| LIMIT ?limit\n",
},
},
},
}
for _, tc := range tcs {
t.Run(tc.desc, func(t *testing.T) {
got := struct {
Tools server.ToolConfigs `yaml:"tools"`
}{}
// Parse contents
err := yaml.UnmarshalContext(ctx, testutils.FormatYaml(tc.in), &got)
if err != nil {
t.Fatalf("unable to unmarshal: %s", err)
}
if diff := cmp.Diff(tc.want, got.Tools); diff != "" {
t.Fatalf("incorrect parse: diff %v", diff)
}
})
}
}
func TestTool_esqlToMap(t1 *testing.T) {
tests := []struct {
name string
result esqlResult
want []map[string]any
}{
{
name: "simple case with two rows",
result: esqlResult{
Columns: []esqlColumn{
{Name: "first_name", Type: "text"},
{Name: "last_name", Type: "text"},
},
Values: [][]any{
{"John", "Doe"},
{"Jane", "Smith"},
},
},
want: []map[string]any{
{"first_name": "John", "last_name": "Doe"},
{"first_name": "Jane", "last_name": "Smith"},
},
},
{
name: "different data types",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
{Name: "active", Type: "boolean"},
{Name: "score", Type: "float"},
},
Values: [][]any{
{1, true, 95.5},
{2, false, 88.0},
},
},
want: []map[string]any{
{"id": 1, "active": true, "score": 95.5},
{"id": 2, "active": false, "score": 88.0},
},
},
{
name: "no rows",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
{Name: "name", Type: "text"},
},
Values: [][]any{},
},
want: []map[string]any{},
},
{
name: "null values",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
{Name: "name", Type: "text"},
},
Values: [][]any{
{1, nil},
{2, "Alice"},
},
},
want: []map[string]any{
{"id": 1, "name": nil},
{"id": 2, "name": "Alice"},
},
},
{
name: "missing values in a row",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
{Name: "name", Type: "text"},
{Name: "age", Type: "integer"},
},
Values: [][]any{
{1, "Bob"},
{2, "Charlie", 30},
},
},
want: []map[string]any{
{"id": 1, "name": "Bob", "age": nil},
{"id": 2, "name": "Charlie", "age": 30},
},
},
{
name: "all null row",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
{Name: "name", Type: "text"},
},
Values: [][]any{
nil,
},
},
want: []map[string]any{
{},
},
},
{
name: "empty columns",
result: esqlResult{
Columns: []esqlColumn{},
Values: [][]any{
{},
{},
},
},
want: []map[string]any{
{},
{},
},
},
{
name: "more values than columns",
result: esqlResult{
Columns: []esqlColumn{
{Name: "id", Type: "integer"},
},
Values: [][]any{
{1, "extra"},
},
},
want: []map[string]any{
{"id": 1},
},
},
{
name: "no columns but with values",
result: esqlResult{
Columns: []esqlColumn{},
Values: [][]any{
{1, "data"},
},
},
want: []map[string]any{
{},
},
},
}
for _, tt := range tests {
t1.Run(tt.name, func(t1 *testing.T) {
t := Tool{}
if got := t.esqlToMap(tt.result); !reflect.DeepEqual(got, tt.want) {
t1.Errorf("esqlToMap() = %v, want %v", got, tt.want)
}
})
}
}