mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-04 04:05:22 -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>
196 lines
4.6 KiB
Go
196 lines
4.6 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 postgres_test
|
|
|
|
import (
|
|
"context"
|
|
"sort"
|
|
"strings"
|
|
"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/postgres"
|
|
"github.com/googleapis/genai-toolbox/internal/testutils"
|
|
)
|
|
|
|
func TestParseFromYamlPostgres(t *testing.T) {
|
|
tcs := []struct {
|
|
desc string
|
|
in string
|
|
want server.SourceConfigs
|
|
}{
|
|
{
|
|
desc: "basic example",
|
|
in: `
|
|
kind: sources
|
|
name: my-pg-instance
|
|
type: postgres
|
|
host: my-host
|
|
port: my-port
|
|
database: my_db
|
|
user: my_user
|
|
password: my_pass
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-pg-instance": postgres.Config{
|
|
Name: "my-pg-instance",
|
|
Type: postgres.SourceType,
|
|
Host: "my-host",
|
|
Port: "my-port",
|
|
Database: "my_db",
|
|
User: "my_user",
|
|
Password: "my_pass",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "example with query params",
|
|
in: `
|
|
kind: sources
|
|
name: my-pg-instance
|
|
type: postgres
|
|
host: my-host
|
|
port: my-port
|
|
database: my_db
|
|
user: my_user
|
|
password: my_pass
|
|
queryParams:
|
|
sslmode: verify-full
|
|
sslrootcert: /tmp/ca.crt
|
|
`,
|
|
want: map[string]sources.SourceConfig{
|
|
"my-pg-instance": postgres.Config{
|
|
Name: "my-pg-instance",
|
|
Type: postgres.SourceType,
|
|
Host: "my-host",
|
|
Port: "my-port",
|
|
Database: "my_db",
|
|
User: "my_user",
|
|
Password: "my_pass",
|
|
QueryParams: map[string]string{
|
|
"sslmode": "verify-full",
|
|
"sslrootcert": "/tmp/ca.crt",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
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 !cmp.Equal(tc.want, got) {
|
|
t.Fatalf("incorrect parse: want %v, got %v", tc.want, got)
|
|
}
|
|
})
|
|
}
|
|
|
|
}
|
|
|
|
func TestFailParseFromYaml(t *testing.T) {
|
|
tcs := []struct {
|
|
desc string
|
|
in string
|
|
err string
|
|
}{
|
|
{
|
|
desc: "extra field",
|
|
in: `
|
|
kind: sources
|
|
name: my-pg-instance
|
|
type: postgres
|
|
host: my-host
|
|
port: my-port
|
|
database: my_db
|
|
user: my_user
|
|
password: my_pass
|
|
foo: bar
|
|
`,
|
|
err: "error unmarshaling sources: unable to parse source \"my-pg-instance\" as \"postgres\": [2:1] unknown field \"foo\"\n 1 | database: my_db\n> 2 | foo: bar\n ^\n 3 | host: my-host\n 4 | name: my-pg-instance\n 5 | password: my_pass\n 6 | ",
|
|
},
|
|
{
|
|
desc: "missing required field",
|
|
in: `
|
|
kind: sources
|
|
name: my-pg-instance
|
|
type: postgres
|
|
host: my-host
|
|
port: my-port
|
|
database: my_db
|
|
user: my_user
|
|
`,
|
|
err: "error unmarshaling sources: unable to parse source \"my-pg-instance\" as \"postgres\": Key: 'Config.Password' Error:Field validation for 'Password' 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 TestConvertParamMapToRawQuery(t *testing.T) {
|
|
tcs := []struct {
|
|
desc string
|
|
in map[string]string
|
|
want string
|
|
}{
|
|
{
|
|
desc: "nil param",
|
|
in: nil,
|
|
want: "",
|
|
},
|
|
{
|
|
desc: "single query param",
|
|
in: map[string]string{
|
|
"foo": "bar",
|
|
},
|
|
want: "foo=bar",
|
|
},
|
|
{
|
|
desc: "more than one query param",
|
|
in: map[string]string{
|
|
"foo": "bar",
|
|
"hello": "world",
|
|
},
|
|
want: "foo=bar&hello=world",
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
got := postgres.ConvertParamMapToRawQuery(tc.in)
|
|
if strings.Contains(got, "&") {
|
|
splitGot := strings.Split(got, "&")
|
|
sort.Strings(splitGot)
|
|
got = strings.Join(splitGot, "&")
|
|
}
|
|
if got != tc.want {
|
|
t.Fatalf("incorrect conversion: got %s want %s", got, tc.want)
|
|
}
|
|
})
|
|
}
|
|
}
|