mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-10 15:15:21 -05:00
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
391 lines
9.3 KiB
Go
391 lines
9.3 KiB
Go
// 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 bigquery_test
|
|
|
|
import (
|
|
"context"
|
|
"math/big"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/googleapis/genai-toolbox/internal/server"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/sources/bigquery"
|
|
"github.com/googleapis/genai-toolbox/internal/testutils"
|
|
"github.com/googleapis/genai-toolbox/internal/util"
|
|
"go.opentelemetry.io/otel/trace/noop"
|
|
)
|
|
|
|
func TestParseFromYamlBigQuery(t *testing.T) {
|
|
tcs := []struct {
|
|
desc string
|
|
in string
|
|
want server.SourceConfigs
|
|
}{
|
|
{
|
|
desc: "basic example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "",
|
|
WriteMode: "",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "all fields specified",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: asia
|
|
writeMode: blocked
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "asia",
|
|
WriteMode: "blocked",
|
|
UseClientOAuth: false,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "use client auth example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
useClientOAuth: true
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "us",
|
|
UseClientOAuth: true,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "with allowed datasets example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
allowedDatasets:
|
|
- my_dataset
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "us",
|
|
AllowedDatasets: []string{"my_dataset"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "with service account impersonation example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
impersonateServiceAccount: service-account@my-project.iam.gserviceaccount.com
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "us",
|
|
ImpersonateServiceAccount: "service-account@my-project.iam.gserviceaccount.com",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "with custom scopes example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
scopes:
|
|
- https://www.googleapis.com/auth/bigquery
|
|
- https://www.googleapis.com/auth/cloud-platform
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "us",
|
|
Scopes: []string{"https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "with max query result rows example",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
maxQueryResultRows: 10
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-instance": bigquery.Config{
|
|
Name: "my-instance",
|
|
Type: bigquery.SourceType,
|
|
Project: "my-project",
|
|
Location: "us",
|
|
MaxQueryResultRows: 10,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
got, _, _, _, _, _, err := server.UnmarshalResourceConfig(context.Background(), testutils.FormatYaml(tc.in))
|
|
if err != nil {
|
|
t.Fatalf("unable to unmarshal: %s", err)
|
|
}
|
|
if diff := cmp.Diff(tc.want, got); diff != "" {
|
|
t.Fatalf("incorrect parse (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestFailParseFromYaml(t *testing.T) {
|
|
tcs := []struct {
|
|
desc string
|
|
in string
|
|
err string
|
|
}{
|
|
{
|
|
desc: "extra field",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
project: my-project
|
|
location: us
|
|
foo: bar
|
|
`,
|
|
err: "error unmarshaling sources: unable to parse source \"my-instance\" as \"bigquery\": [1:1] unknown field \"foo\"\n> 1 | foo: bar\n ^\n 2 | location: us\n 3 | name: my-instance\n 4 | project: my-project\n 5 | ",
|
|
},
|
|
{
|
|
desc: "missing required field",
|
|
in: `
|
|
kind: sources
|
|
name: my-instance
|
|
type: bigquery
|
|
location: us
|
|
`,
|
|
err: "error unmarshaling sources: unable to parse source \"my-instance\" as \"bigquery\": Key: 'Config.Project' Error:Field validation for 'Project' failed on the 'required' tag",
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
_, _, _, _, _, _, err := server.UnmarshalResourceConfig(context.Background(), testutils.FormatYaml(tc.in))
|
|
if err == nil {
|
|
t.Fatalf("expect parsing to fail")
|
|
}
|
|
errStr := err.Error()
|
|
if errStr != tc.err {
|
|
t.Fatalf("unexpected error: got %q, want %q", errStr, tc.err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestInitialize_MaxQueryResultRows(t *testing.T) {
|
|
ctx, err := testutils.ContextWithNewLogger()
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
ctx = util.WithUserAgent(ctx, "test-agent")
|
|
tracer := noop.NewTracerProvider().Tracer("")
|
|
|
|
tcs := []struct {
|
|
desc string
|
|
cfg bigquery.Config
|
|
want int
|
|
}{
|
|
{
|
|
desc: "default value",
|
|
cfg: bigquery.Config{
|
|
Name: "test-default",
|
|
Type: bigquery.SourceType,
|
|
Project: "test-project",
|
|
UseClientOAuth: true,
|
|
},
|
|
want: 50,
|
|
},
|
|
{
|
|
desc: "configured value",
|
|
cfg: bigquery.Config{
|
|
Name: "test-configured",
|
|
Type: bigquery.SourceType,
|
|
Project: "test-project",
|
|
UseClientOAuth: true,
|
|
MaxQueryResultRows: 100,
|
|
},
|
|
want: 100,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tcs {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
src, err := tc.cfg.Initialize(ctx, tracer)
|
|
if err != nil {
|
|
t.Fatalf("Initialize failed: %v", err)
|
|
}
|
|
bqSrc, ok := src.(*bigquery.Source)
|
|
if !ok {
|
|
t.Fatalf("Expected *bigquery.Source, got %T", src)
|
|
}
|
|
if bqSrc.MaxQueryResultRows != tc.want {
|
|
t.Errorf("MaxQueryResultRows = %d, want %d", bqSrc.MaxQueryResultRows, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestNormalizeValue(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
input any
|
|
expected any
|
|
}{
|
|
{
|
|
name: "big.Rat 1/3 (NUMERIC scale 9)",
|
|
input: new(big.Rat).SetFrac64(1, 3), // 0.33333333333...
|
|
expected: "0.33333333333333333333333333333333333333", // FloatString(38)
|
|
},
|
|
{
|
|
name: "big.Rat 19/2 (9.5)",
|
|
input: new(big.Rat).SetFrac64(19, 2),
|
|
expected: "9.5",
|
|
},
|
|
{
|
|
name: "big.Rat 12341/10 (1234.1)",
|
|
input: new(big.Rat).SetFrac64(12341, 10),
|
|
expected: "1234.1",
|
|
},
|
|
{
|
|
name: "big.Rat 10/1 (10)",
|
|
input: new(big.Rat).SetFrac64(10, 1),
|
|
expected: "10",
|
|
},
|
|
{
|
|
name: "string",
|
|
input: "hello",
|
|
expected: "hello",
|
|
},
|
|
{
|
|
name: "int",
|
|
input: 123,
|
|
expected: 123,
|
|
},
|
|
{
|
|
name: "nested slice of big.Rat",
|
|
input: []any{
|
|
new(big.Rat).SetFrac64(19, 2),
|
|
new(big.Rat).SetFrac64(1, 4),
|
|
},
|
|
expected: []any{"9.5", "0.25"},
|
|
},
|
|
{
|
|
name: "nested map of big.Rat",
|
|
input: map[string]any{
|
|
"val1": new(big.Rat).SetFrac64(19, 2),
|
|
"val2": new(big.Rat).SetFrac64(1, 2),
|
|
},
|
|
expected: map[string]any{
|
|
"val1": "9.5",
|
|
"val2": "0.5",
|
|
},
|
|
},
|
|
{
|
|
name: "complex nested structure",
|
|
input: map[string]any{
|
|
"list": []any{
|
|
map[string]any{
|
|
"rat": new(big.Rat).SetFrac64(3, 2),
|
|
},
|
|
},
|
|
},
|
|
expected: map[string]any{
|
|
"list": []any{
|
|
map[string]any{
|
|
"rat": "1.5",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "slice of *big.Rat",
|
|
input: []*big.Rat{
|
|
new(big.Rat).SetFrac64(19, 2),
|
|
new(big.Rat).SetFrac64(1, 4),
|
|
},
|
|
expected: []any{"9.5", "0.25"},
|
|
},
|
|
{
|
|
name: "slice of strings",
|
|
input: []string{"a", "b"},
|
|
expected: []any{"a", "b"},
|
|
},
|
|
{
|
|
name: "byte slice (BYTES)",
|
|
input: []byte("hello"),
|
|
expected: []byte("hello"),
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got := bigquery.NormalizeValue(tt.input)
|
|
if !reflect.DeepEqual(got, tt.expected) {
|
|
t.Errorf("NormalizeValue() = %v, want %v", got, tt.expected)
|
|
}
|
|
})
|
|
}
|
|
}
|