mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-03 11:45:10 -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>
262 lines
7.6 KiB
Go
262 lines
7.6 KiB
Go
// Copyright 2024 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 server_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/googleapis/genai-toolbox/internal/auth"
|
|
"github.com/googleapis/genai-toolbox/internal/embeddingmodels"
|
|
"github.com/googleapis/genai-toolbox/internal/log"
|
|
"github.com/googleapis/genai-toolbox/internal/prompts"
|
|
"github.com/googleapis/genai-toolbox/internal/server"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/sources/alloydbpg"
|
|
"github.com/googleapis/genai-toolbox/internal/telemetry"
|
|
"github.com/googleapis/genai-toolbox/internal/testutils"
|
|
"github.com/googleapis/genai-toolbox/internal/tools"
|
|
"github.com/googleapis/genai-toolbox/internal/util"
|
|
)
|
|
|
|
func TestServe(t *testing.T) {
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
|
|
addr, port := "127.0.0.1", 5000
|
|
cfg := server.ServerConfig{
|
|
Version: "0.0.0",
|
|
Address: addr,
|
|
Port: port,
|
|
AllowedHosts: []string{"*"},
|
|
}
|
|
|
|
otelShutdown, err := telemetry.SetupOTel(ctx, "0.0.0", "", false, "toolbox")
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
defer func() {
|
|
err := otelShutdown(ctx)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
}()
|
|
|
|
testLogger, err := log.NewStdLogger(os.Stdout, os.Stderr, "info")
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
ctx = util.WithLogger(ctx, testLogger)
|
|
|
|
instrumentation, err := telemetry.CreateTelemetryInstrumentation(cfg.Version)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
|
|
ctx = util.WithInstrumentation(ctx, instrumentation)
|
|
|
|
s, err := server.NewServer(ctx, cfg)
|
|
if err != nil {
|
|
t.Fatalf("unable to initialize server: %v", err)
|
|
}
|
|
|
|
err = s.Listen(ctx)
|
|
if err != nil {
|
|
t.Fatalf("unable to start server: %v", err)
|
|
}
|
|
|
|
// start server in background
|
|
errCh := make(chan error)
|
|
go func() {
|
|
defer close(errCh)
|
|
|
|
err = s.Serve(ctx)
|
|
if err != nil {
|
|
errCh <- err
|
|
}
|
|
}()
|
|
|
|
url := fmt.Sprintf("http://%s:%d/", addr, port)
|
|
resp, err := http.Get(url)
|
|
if err != nil {
|
|
t.Fatalf("error when sending a request: %s", err)
|
|
}
|
|
defer resp.Body.Close()
|
|
if resp.StatusCode != 200 {
|
|
t.Fatalf("response status code is not 200")
|
|
}
|
|
raw, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
t.Fatalf("error reading from request body: %s", err)
|
|
}
|
|
if got := string(raw); strings.Contains(got, "0.0.0") {
|
|
t.Fatalf("version missing from output: %q", got)
|
|
}
|
|
}
|
|
|
|
func TestUpdateServer(t *testing.T) {
|
|
ctx, err := testutils.ContextWithNewLogger()
|
|
if err != nil {
|
|
t.Fatalf("error setting up logger: %s", err)
|
|
}
|
|
|
|
addr, port := "127.0.0.1", 5000
|
|
cfg := server.ServerConfig{
|
|
Version: "0.0.0",
|
|
Address: addr,
|
|
Port: port,
|
|
}
|
|
|
|
instrumentation, err := telemetry.CreateTelemetryInstrumentation(cfg.Version)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
|
|
ctx = util.WithInstrumentation(ctx, instrumentation)
|
|
|
|
s, err := server.NewServer(ctx, cfg)
|
|
if err != nil {
|
|
t.Fatalf("error setting up server: %s", err)
|
|
}
|
|
|
|
newSources := map[string]sources.Source{
|
|
"example-source": &alloydbpg.Source{
|
|
Config: alloydbpg.Config{
|
|
Name: "example-alloydb-source",
|
|
Type: "alloydb-postgres",
|
|
},
|
|
},
|
|
}
|
|
newAuth := map[string]auth.AuthService{"example-auth": nil}
|
|
newEmbeddingModels := map[string]embeddingmodels.EmbeddingModel{"example-model": nil}
|
|
newTools := map[string]tools.Tool{"example-tool": nil}
|
|
newToolsets := map[string]tools.Toolset{
|
|
"example-toolset": {
|
|
ToolsetConfig: tools.ToolsetConfig{
|
|
Name: "example-toolset",
|
|
},
|
|
Tools: []*tools.Tool{},
|
|
},
|
|
}
|
|
newPrompts := map[string]prompts.Prompt{"example-prompt": nil}
|
|
newPromptsets := map[string]prompts.Promptset{
|
|
"example-promptset": {
|
|
PromptsetConfig: prompts.PromptsetConfig{
|
|
Name: "example-promptset",
|
|
},
|
|
Prompts: []*prompts.Prompt{},
|
|
},
|
|
}
|
|
s.ResourceMgr.SetResources(newSources, newAuth, newEmbeddingModels, newTools, newToolsets, newPrompts, newPromptsets)
|
|
if err != nil {
|
|
t.Errorf("error updating server: %s", err)
|
|
}
|
|
|
|
gotSource, _ := s.ResourceMgr.GetSource("example-source")
|
|
if diff := cmp.Diff(gotSource, newSources["example-source"]); diff != "" {
|
|
t.Errorf("error updating server, sources (-want +got):\n%s", diff)
|
|
}
|
|
|
|
gotAuthService, _ := s.ResourceMgr.GetAuthService("example-auth")
|
|
if diff := cmp.Diff(gotAuthService, newAuth["example-auth"]); diff != "" {
|
|
t.Errorf("error updating server, authServices (-want +got):\n%s", diff)
|
|
}
|
|
|
|
gotTool, _ := s.ResourceMgr.GetTool("example-tool")
|
|
if diff := cmp.Diff(gotTool, newTools["example-tool"]); diff != "" {
|
|
t.Errorf("error updating server, tools (-want +got):\n%s", diff)
|
|
}
|
|
|
|
gotToolset, _ := s.ResourceMgr.GetToolset("example-toolset")
|
|
if diff := cmp.Diff(gotToolset, newToolsets["example-toolset"]); diff != "" {
|
|
t.Errorf("error updating server, toolset (-want +got):\n%s", diff)
|
|
}
|
|
|
|
gotPrompt, _ := s.ResourceMgr.GetPrompt("example-prompt")
|
|
if diff := cmp.Diff(gotPrompt, newPrompts["example-prompt"]); diff != "" {
|
|
t.Errorf("error updating server, prompts (-want +got):\n%s", diff)
|
|
}
|
|
|
|
gotPromptset, _ := s.ResourceMgr.GetPromptset("example-promptset")
|
|
if diff := cmp.Diff(gotPromptset, newPromptsets["example-promptset"]); diff != "" {
|
|
t.Errorf("error updating server, promptset (-want +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
func TestNameValidation(t *testing.T) {
|
|
testCases := []struct {
|
|
desc string
|
|
resourceName string
|
|
errStr string
|
|
}{
|
|
{
|
|
desc: "names with 0 length",
|
|
resourceName: "",
|
|
errStr: "resource name SHOULD be between 1 and 128 characters in length (inclusive)",
|
|
},
|
|
{
|
|
desc: "names with allowed length",
|
|
resourceName: "foo",
|
|
},
|
|
{
|
|
desc: "names with 128 length",
|
|
resourceName: strings.Repeat("a", 128),
|
|
},
|
|
{
|
|
desc: "names with more than 128 length",
|
|
resourceName: strings.Repeat("a", 129),
|
|
errStr: "resource name SHOULD be between 1 and 128 characters in length (inclusive)",
|
|
},
|
|
{
|
|
desc: "names with space",
|
|
resourceName: "foo bar",
|
|
errStr: "invalid character for resource name; only uppercase and lowercase ASCII letters (A-Z, a-z), digits (0-9), underscore (_), hyphen (-), and dot (.) is allowed",
|
|
},
|
|
{
|
|
desc: "names with commas",
|
|
resourceName: "foo,bar",
|
|
errStr: "invalid character for resource name; only uppercase and lowercase ASCII letters (A-Z, a-z), digits (0-9), underscore (_), hyphen (-), and dot (.) is allowed",
|
|
},
|
|
{
|
|
desc: "names with other special character",
|
|
resourceName: "foo!",
|
|
errStr: "invalid character for resource name; only uppercase and lowercase ASCII letters (A-Z, a-z), digits (0-9), underscore (_), hyphen (-), and dot (.) is allowed",
|
|
},
|
|
{
|
|
desc: "names with allowed special character",
|
|
resourceName: "foo_.-bar6",
|
|
},
|
|
}
|
|
for _, tc := range testCases {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
err := server.NameValidation(tc.resourceName)
|
|
if err != nil {
|
|
if tc.errStr != err.Error() {
|
|
t.Fatalf("unexpected error: %s", err)
|
|
}
|
|
}
|
|
if err == nil && tc.errStr != "" {
|
|
t.Fatalf("expect error: %s", tc.errStr)
|
|
}
|
|
})
|
|
}
|
|
}
|