mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-12 08:05:06 -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>
234 lines
6.5 KiB
Go
234 lines
6.5 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 cloudgda_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"regexp"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/googleapis/genai-toolbox/internal/server/mcp/jsonrpc"
|
|
"github.com/googleapis/genai-toolbox/internal/testutils"
|
|
"github.com/googleapis/genai-toolbox/internal/tools/cloudgda"
|
|
"github.com/googleapis/genai-toolbox/tests"
|
|
)
|
|
|
|
var (
|
|
cloudGdaToolType = "cloud-gemini-data-analytics-query"
|
|
)
|
|
|
|
type cloudGdaTransport struct {
|
|
transport http.RoundTripper
|
|
url *url.URL
|
|
}
|
|
|
|
func (t *cloudGdaTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
if strings.HasPrefix(req.URL.String(), "https://geminidataanalytics.googleapis.com") {
|
|
req.URL.Scheme = t.url.Scheme
|
|
req.URL.Host = t.url.Host
|
|
}
|
|
return t.transport.RoundTrip(req)
|
|
}
|
|
|
|
type masterHandler struct {
|
|
t *testing.T
|
|
}
|
|
|
|
func (h *masterHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|
if !strings.Contains(r.UserAgent(), "genai-toolbox/") {
|
|
h.t.Errorf("User-Agent header not found")
|
|
}
|
|
|
|
if r.Method != http.MethodPost {
|
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
|
return
|
|
}
|
|
|
|
// Verify URL structure
|
|
// Expected: /v1beta/projects/{project}/locations/global:queryData
|
|
if !strings.Contains(r.URL.Path, ":queryData") || !strings.Contains(r.URL.Path, "locations/global") {
|
|
h.t.Errorf("unexpected URL path: %s", r.URL.Path)
|
|
http.Error(w, "Not found", http.StatusNotFound)
|
|
return
|
|
}
|
|
|
|
var reqBody cloudgda.QueryDataRequest
|
|
if err := json.NewDecoder(r.Body).Decode(&reqBody); err != nil {
|
|
h.t.Fatalf("failed to decode request body: %v", err)
|
|
}
|
|
|
|
if reqBody.Prompt == "" {
|
|
http.Error(w, "missing prompt", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
response := map[string]any{
|
|
"queryResult": "SELECT * FROM table;",
|
|
"naturalLanguageAnswer": "Here is the answer.",
|
|
}
|
|
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(http.StatusOK)
|
|
if err := json.NewEncoder(w).Encode(response); err != nil {
|
|
http.Error(w, err.Error(), http.StatusInternalServerError)
|
|
}
|
|
}
|
|
|
|
func TestCloudGdaToolEndpoints(t *testing.T) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
|
|
defer cancel()
|
|
|
|
handler := &masterHandler{t: t}
|
|
server := httptest.NewServer(handler)
|
|
defer server.Close()
|
|
|
|
serverURL, err := url.Parse(server.URL)
|
|
if err != nil {
|
|
t.Fatalf("failed to parse server URL: %v", err)
|
|
}
|
|
|
|
originalTransport := http.DefaultClient.Transport
|
|
if originalTransport == nil {
|
|
originalTransport = http.DefaultTransport
|
|
}
|
|
http.DefaultClient.Transport = &cloudGdaTransport{
|
|
transport: originalTransport,
|
|
url: serverURL,
|
|
}
|
|
t.Cleanup(func() {
|
|
http.DefaultClient.Transport = originalTransport
|
|
})
|
|
|
|
var args []string
|
|
toolsFile := getCloudGdaToolsConfig()
|
|
cmd, cleanup, err := tests.StartCmd(ctx, toolsFile, args...)
|
|
if err != nil {
|
|
t.Fatalf("command initialization returned an error: %s", err)
|
|
}
|
|
defer cleanup()
|
|
|
|
waitCtx, cancel := context.WithTimeout(ctx, 10*time.Second)
|
|
defer cancel()
|
|
out, err := testutils.WaitForString(waitCtx, regexp.MustCompile(`Server ready to serve`), cmd.Out)
|
|
if err != nil {
|
|
t.Logf("toolbox command logs: \n%s", out)
|
|
t.Fatalf("toolbox didn't start successfully: %s", err)
|
|
}
|
|
|
|
toolName := "cloud-gda-query"
|
|
|
|
// 1. RunToolGetTestByName
|
|
expectedManifest := map[string]any{
|
|
toolName: map[string]any{
|
|
"description": "Test GDA Tool\n\n" + cloudgda.Guidance,
|
|
"parameters": []any{
|
|
map[string]any{
|
|
"name": "query",
|
|
"type": "string",
|
|
"description": "A natural language formulation of a database query.",
|
|
"required": true,
|
|
"authSources": []any{},
|
|
},
|
|
},
|
|
"authRequired": []any{},
|
|
},
|
|
}
|
|
tests.RunToolGetTestByName(t, toolName, expectedManifest)
|
|
|
|
// 2. RunToolInvokeParametersTest
|
|
params := []byte(`{"query": "test question"}`)
|
|
tests.RunToolInvokeParametersTest(t, toolName, params, "\"queryResult\":\"SELECT * FROM table;\"")
|
|
|
|
// 3. Manual MCP Tool Call Test
|
|
// Initialize MCP session
|
|
sessionId := tests.RunInitialize(t, "2024-11-05")
|
|
|
|
// Construct MCP Request
|
|
mcpReq := jsonrpc.JSONRPCRequest{
|
|
Jsonrpc: "2.0",
|
|
Id: "test-mcp-call",
|
|
Request: jsonrpc.Request{
|
|
Method: "tools/call",
|
|
},
|
|
Params: map[string]any{
|
|
"name": toolName,
|
|
"arguments": map[string]any{
|
|
"query": "test question",
|
|
},
|
|
},
|
|
}
|
|
reqBytes, _ := json.Marshal(mcpReq)
|
|
|
|
headers := map[string]string{}
|
|
if sessionId != "" {
|
|
headers["Mcp-Session-Id"] = sessionId
|
|
}
|
|
|
|
// Send Request
|
|
resp, respBody := tests.RunRequest(t, http.MethodPost, "http://127.0.0.1:5000/mcp", bytes.NewBuffer(reqBytes), headers)
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
t.Fatalf("MCP request failed with status %d: %s", resp.StatusCode, string(respBody))
|
|
}
|
|
|
|
// Check Response
|
|
respStr := string(respBody)
|
|
if !strings.Contains(respStr, "SELECT * FROM table;") {
|
|
t.Errorf("MCP response does not contain expected query result: %s", respStr)
|
|
}
|
|
}
|
|
|
|
func getCloudGdaToolsConfig() map[string]any {
|
|
// Mocked responses and a dummy `projectId` are used in this integration
|
|
// test due to limited project-specific allowlisting. API functionality is
|
|
// verified via internal monitoring; this test specifically validates the
|
|
// integration flow between the source and the tool.
|
|
return map[string]any{
|
|
"sources": map[string]any{
|
|
"my-gda-source": map[string]any{
|
|
"type": "cloud-gemini-data-analytics",
|
|
"projectId": "test-project",
|
|
},
|
|
},
|
|
"tools": map[string]any{
|
|
"cloud-gda-query": map[string]any{
|
|
"type": cloudGdaToolType,
|
|
"source": "my-gda-source",
|
|
"description": "Test GDA Tool",
|
|
"location": "us-central1",
|
|
"context": map[string]any{
|
|
"datasourceReferences": map[string]any{
|
|
"spannerReference": map[string]any{
|
|
"databaseReference": map[string]any{
|
|
"projectId": "test-project",
|
|
"instanceId": "test-instance",
|
|
"databaseId": "test-db",
|
|
"engine": "GOOGLE_SQL",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
}
|