Files
genai-toolbox/internal/tools/cloudmonitoring/cloudmonitoring_test.go
Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369)
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>
2026-01-27 16:58:43 -08:00

231 lines
6.4 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_test
import (
"strings"
"testing"
"github.com/google/go-cmp/cmp"
"github.com/googleapis/genai-toolbox/internal/server"
"github.com/googleapis/genai-toolbox/internal/sources"
cloudmonitoringsrc "github.com/googleapis/genai-toolbox/internal/sources/cloudmonitoring"
"github.com/googleapis/genai-toolbox/internal/testutils"
"github.com/googleapis/genai-toolbox/internal/tools"
"github.com/googleapis/genai-toolbox/internal/tools/cloudmonitoring"
"github.com/googleapis/genai-toolbox/internal/util/parameters"
)
// mockIncompatibleSource is a source of a different type to test error paths.
type mockIncompatibleSource struct{ sources.Source }
func TestInitialize(t *testing.T) {
t.Parallel()
testSource := &cloudmonitoringsrc.Source{Config: cloudmonitoringsrc.Config{Type: "cloud-monitoring"}}
srcs := map[string]sources.Source{
"my-monitoring-source": testSource,
"incompatible-source": &mockIncompatibleSource{},
}
wantParams := parameters.Parameters{
parameters.NewStringParameterWithRequired("projectId", "The Id of the Google Cloud project.", true),
parameters.NewStringParameterWithRequired("query", "The promql query to execute.", true),
}
testCases := []struct {
desc string
cfg cloudmonitoring.Config
want *tools.Manifest
wantErr string
}{
{
desc: "Success case with nil authRequired",
cfg: cloudmonitoring.Config{
Name: "test-tool",
Type: "cloud-monitoring-query-prometheus",
Source: "my-monitoring-source",
Description: "A test description.",
AuthRequired: nil,
},
want: &tools.Manifest{
Description: "A test description.",
Parameters: wantParams.Manifest(),
AuthRequired: nil,
},
},
{
desc: "Success case with specified authRequired",
cfg: cloudmonitoring.Config{
Name: "test-tool-with-auth",
Type: "cloud-monitoring-query-prometheus",
Source: "my-monitoring-source",
Description: "Another test description.",
AuthRequired: []string{"google-auth-service"},
},
want: &tools.Manifest{
Description: "Another test description.",
Parameters: wantParams.Manifest(),
AuthRequired: []string{"google-auth-service"},
},
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
tool, err := tc.cfg.Initialize(srcs)
if tc.wantErr != "" {
if err == nil {
t.Fatalf("Initialize() succeeded, want error containing %q", tc.wantErr)
}
if !strings.Contains(err.Error(), tc.wantErr) {
t.Errorf("Initialize() error = %q, want error containing %q", err, tc.wantErr)
}
return
}
if err != nil {
t.Fatalf("Initialize() failed: %v", err)
}
got := tool.Manifest()
if diff := cmp.Diff(tc.want, &got); diff != "" {
t.Errorf("Initialize() manifest mismatch (-want +got):\n%s", diff)
}
})
}
}
func TestParseFromYamlCloudMonitoring(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: `
kind: tools
name: example_tool
type: cloud-monitoring-query-prometheus
source: my-instance
description: some description
`,
want: server.ToolConfigs{
"example_tool": cloudmonitoring.Config{
Name: "example_tool",
Type: "cloud-monitoring-query-prometheus",
Source: "my-instance",
Description: "some description",
AuthRequired: []string{},
},
},
},
{
desc: "advanced example",
in: `
kind: tools
name: example_tool
type: cloud-monitoring-query-prometheus
source: my-instance
description: some description
authRequired:
- my-google-auth-service
- other-auth-service
`,
want: server.ToolConfigs{
"example_tool": cloudmonitoring.Config{
Name: "example_tool",
Type: "cloud-monitoring-query-prometheus",
Source: "my-instance",
Description: "some description",
AuthRequired: []string{"my-google-auth-service", "other-auth-service"},
},
},
},
}
for _, tc := range tcs {
t.Run(tc.desc, func(t *testing.T) {
_, _, _, got, _, _, err := server.UnmarshalResourceConfig(ctx, testutils.FormatYaml(tc.in))
if err != nil {
t.Fatalf("unable to unmarshal: %s", err)
}
if diff := cmp.Diff(tc.want, got, cmp.AllowUnexported(cloudmonitoring.Config{})); diff != "" {
t.Fatalf("incorrect parse: diff %v", diff)
}
})
}
}
func TestFailParseFromYamlCloudMonitoring(t *testing.T) {
ctx, err := testutils.ContextWithNewLogger()
if err != nil {
t.Fatalf("unexpected error: %s", err)
}
tcs := []struct {
desc string
in string
err string
}{
{
desc: "Invalid type",
in: `
kind: tools
name: example_tool
type: invalid-type
source: my-instance
description: some description
`,
err: `unknown tool type: "invalid-type"`,
},
{
desc: "missing source",
in: `
kind: tools
name: example_tool
type: cloud-monitoring-query-prometheus
description: some description
`,
err: `Key: 'Config.Source' Error:Field validation for 'Source' failed on the 'required' tag`,
},
{
desc: "missing description",
in: `
kind: tools
name: example_tool
type: cloud-monitoring-query-prometheus
source: my-instance
`,
err: `Key: 'Config.Description' Error:Field validation for 'Description' failed on the 'required' tag`,
},
}
for _, tc := range tcs {
t.Run(tc.desc, func(t *testing.T) {
_, _, _, _, _, _, err := server.UnmarshalResourceConfig(ctx, testutils.FormatYaml(tc.in))
if err == nil {
t.Fatalf("expect parsing to fail")
}
errStr := err.Error()
if !strings.Contains(errStr, tc.err) {
t.Fatalf("unexpected error string: got %q, want substring %q", errStr, tc.err)
}
})
}
}