Files
genai-toolbox/internal/tools/alloydbainl/alloydbainl_test.go
Kurtis Van Gent b4862825e8 refactor: implement dynamic tool registration (#613)
This PR refactors the tool configuration and loading mechanism to use a
dynamic registration pattern. Each tool package now registers itself
with a central registry, and the server configuration code uses this
registry to decode and initialize tools.

Key changes:
- Introduced tools.Register and tools.DecodeToolConfig for dynamic tool
handling.
- Removed direct imports of specific tool packages from
internal/server/config.go.
- Updated individual tool packages to include init() functions for
self-registration.
- Modified ToolKind constants to be local kind constants within each
tool package.
- Adjusted test files to reflect the changes in tool kind identifiers.

This change simplifies adding new tools and decouples the server
configuration from specific tool implementations.

---------

Co-authored-by: Yuan Teoh <yuanteoh@google.com>
Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
2025-06-04 10:19:42 -07:00

132 lines
3.9 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 alloydbainl_test
import (
"testing"
yaml "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/tools"
"github.com/googleapis/genai-toolbox/internal/tools/alloydbainl"
)
func TestParseFromYamlAlloyDBNLA(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 example",
in: `
tools:
example_tool:
kind: alloydb-ai-nl
source: my-alloydb-instance
description: AlloyDB natural language query tool
nlConfig: 'my_nl_config'
authRequired:
- my-google-auth-service
nlConfigParameters:
- name: user_id
type: string
description: user_id to use
authServices:
- name: my-google-auth-service
field: sub
`,
want: server.ToolConfigs{
"example_tool": alloydbainl.Config{
Name: "example_tool",
Kind: "alloydb-ai-nl",
Source: "my-alloydb-instance",
Description: "AlloyDB natural language query tool",
NLConfig: "my_nl_config",
AuthRequired: []string{"my-google-auth-service"},
NLConfigParameters: []tools.Parameter{
tools.NewStringParameterWithAuth("user_id", "user_id to use",
[]tools.ParamAuthService{{Name: "my-google-auth-service", Field: "sub"}}),
},
},
},
},
{
desc: "with multiple parameters",
in: `
tools:
complex_tool:
kind: alloydb-ai-nl
source: my-alloydb-instance
description: AlloyDB natural language query tool with multiple parameters
nlConfig: 'complex_nl_config'
authRequired:
- my-google-auth-service
- other-auth-service
nlConfigParameters:
- name: user_id
type: string
description: user_id to use
authServices:
- name: my-google-auth-service
field: sub
- name: user_email
type: string
description: user_email to use
authServices:
- name: my-google-auth-service
field: user_email
`,
want: server.ToolConfigs{
"complex_tool": alloydbainl.Config{
Name: "complex_tool",
Kind: "alloydb-ai-nl",
Source: "my-alloydb-instance",
Description: "AlloyDB natural language query tool with multiple parameters",
NLConfig: "complex_nl_config",
AuthRequired: []string{"my-google-auth-service", "other-auth-service"},
NLConfigParameters: []tools.Parameter{
tools.NewStringParameterWithAuth("user_id", "user_id to use",
[]tools.ParamAuthService{{Name: "my-google-auth-service", Field: "sub"}}),
tools.NewStringParameterWithAuth("user_email", "user_email to use",
[]tools.ParamAuthService{{Name: "my-google-auth-service", Field: "user_email"}}),
},
},
},
},
}
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)
}
})
}
}