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>
114 lines
3.2 KiB
Go
114 lines
3.2 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 cloudmonitoring
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/googleapis/genai-toolbox/internal/tools/cloudmonitoring"
|
|
"github.com/googleapis/genai-toolbox/internal/util/parameters"
|
|
)
|
|
|
|
func TestTool_Invoke(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Mock the monitoring server
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.URL.Path != "/v1/projects/test-project/location/global/prometheus/api/v1/query" {
|
|
http.Error(w, "not found", http.StatusNotFound)
|
|
return
|
|
}
|
|
query := r.URL.Query().Get("query")
|
|
if query != "up" {
|
|
http.Error(w, "bad request", http.StatusBadRequest)
|
|
return
|
|
}
|
|
w.Header().Set("Content-Type", "application/json")
|
|
fmt.Fprintln(w, `{"status":"success","data":{"resultType":"vector","result":[]}}`)
|
|
}))
|
|
defer server.Close()
|
|
|
|
// Create a new observability tool
|
|
tool := cloudmonitoring.Tool{
|
|
Config: cloudmonitoring.Config{
|
|
Name: "test-cloudmonitoring",
|
|
Type: "cloud-monitoring-query-prometheus",
|
|
Description: "Test Cloudmonitoring Tool",
|
|
},
|
|
AllParams: parameters.Parameters{},
|
|
}
|
|
|
|
// Define the test parameters
|
|
params := parameters.ParamValues{
|
|
{Name: "projectId", Value: "test-project"},
|
|
{Name: "query", Value: "up"},
|
|
}
|
|
|
|
// Invoke the tool
|
|
result, err := tool.Invoke(context.Background(), nil, params, "")
|
|
if err != nil {
|
|
t.Fatalf("Invoke() error = %v", err)
|
|
}
|
|
|
|
// Check the result
|
|
expected := map[string]any{
|
|
"status": "success",
|
|
"data": map[string]any{
|
|
"resultType": "vector",
|
|
"result": []any{},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result); diff != "" {
|
|
t.Errorf("Invoke() result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
func TestTool_Invoke_Error(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Mock the monitoring server to return an error
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
http.Error(w, "internal server error", http.StatusInternalServerError)
|
|
}))
|
|
defer server.Close()
|
|
|
|
// Create a new observability tool
|
|
tool := cloudmonitoring.Tool{
|
|
Config: cloudmonitoring.Config{
|
|
Name: "test-cloudmonitoring",
|
|
Type: "clou-monitoring-query-prometheus",
|
|
Description: "Test Cloudmonitoring Tool",
|
|
},
|
|
AllParams: parameters.Parameters{},
|
|
}
|
|
|
|
// Define the test parameters
|
|
params := parameters.ParamValues{
|
|
{Name: "projectId", Value: "test-project"},
|
|
{Name: "query", Value: "up"},
|
|
}
|
|
|
|
// Invoke the tool
|
|
_, err := tool.Invoke(context.Background(), nil, params, "")
|
|
if err == nil {
|
|
t.Fatal("Invoke() error = nil, want error")
|
|
}
|
|
}
|