Skip to content

refactor(test): toolset tests act as snapshot tests #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2025
Merged

refactor(test): toolset tests act as snapshot tests #514

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 35 additions & 22 deletions pkg/mcp/toolsets_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ package mcp

import (
"encoding/json"
"os"
"path/filepath"
"runtime"
"strconv"
"testing"

Expand All @@ -17,20 +20,24 @@ import (
clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
)

const updateJsonEnvVar = "UPDATE_TOOLSETS_JSON"

type ToolsetsSuite struct {
suite.Suite
originalToolsets []api.Toolset
*test.MockServer
*test.McpClient
Cfg *configuration.StaticConfig
mcpServer *Server
Cfg *configuration.StaticConfig
mcpServer *Server
updateJson bool
}

func (s *ToolsetsSuite) SetupTest() {
s.originalToolsets = toolsets.Toolsets()
s.MockServer = test.NewMockServer()
s.Cfg = configuration.Default()
s.Cfg.KubeConfig = s.KubeconfigFile(s.T())
s.updateJson = os.Getenv(updateJsonEnvVar) != ""
}

func (s *ToolsetsSuite) TearDownTest() {
Expand Down Expand Up @@ -76,10 +83,7 @@ func (s *ToolsetsSuite) TestDefaultToolsetsTools() {
s.NoError(err, "Expected no error from ListTools")
})
s.Run("ListTools returns correct Tool metadata", func() {
expectedMetadata := test.ReadFile("testdata", "toolsets-full-tools.json")
metadata, err := json.MarshalIndent(tools.Tools, "", " ")
s.Require().NoErrorf(err, "failed to marshal tools metadata: %v", err)
s.JSONEq(expectedMetadata, string(metadata), "tools metadata does not match expected")
s.assertJsonSnapshot("toolsets-full-tools.json", tools.Tools)
})
})
}
Expand All @@ -97,10 +101,7 @@ func (s *ToolsetsSuite) TestDefaultToolsetsToolsInOpenShift() {
s.NoError(err, "Expected no error from ListTools")
})
s.Run("ListTools returns correct Tool metadata", func() {
expectedMetadata := test.ReadFile("testdata", "toolsets-full-tools-openshift.json")
metadata, err := json.MarshalIndent(tools.Tools, "", " ")
s.Require().NoErrorf(err, "failed to marshal tools metadata: %v", err)
s.JSONEq(expectedMetadata, string(metadata), "tools metadata does not match expected")
s.assertJsonSnapshot("toolsets-full-tools-openshift.json", tools.Tools)
})
})
}
Expand All @@ -123,10 +124,7 @@ func (s *ToolsetsSuite) TestDefaultToolsetsToolsInMultiCluster() {
s.NoError(err, "Expected no error from ListTools")
})
s.Run("ListTools returns correct Tool metadata", func() {
expectedMetadata := test.ReadFile("testdata", "toolsets-full-tools-multicluster.json")
metadata, err := json.MarshalIndent(tools.Tools, "", " ")
s.Require().NoErrorf(err, "failed to marshal tools metadata: %v", err)
s.JSONEq(expectedMetadata, string(metadata), "tools metadata does not match expected")
s.assertJsonSnapshot("toolsets-full-tools-multicluster.json", tools.Tools)
})
})
}
Expand All @@ -147,10 +145,7 @@ func (s *ToolsetsSuite) TestDefaultToolsetsToolsInMultiClusterEnum() {
s.NoError(err, "Expected no error from ListTools")
})
s.Run("ListTools returns correct Tool metadata", func() {
expectedMetadata := test.ReadFile("testdata", "toolsets-full-tools-multicluster-enum.json")
metadata, err := json.MarshalIndent(tools.Tools, "", " ")
s.Require().NoErrorf(err, "failed to marshal tools metadata: %v", err)
s.JSONEq(expectedMetadata, string(metadata), "tools metadata does not match expected")
s.assertJsonSnapshot("toolsets-full-tools-multicluster-enum.json", tools.Tools)
})
})
}
Expand All @@ -173,10 +168,7 @@ func (s *ToolsetsSuite) TestGranularToolsetsTools() {
s.NoError(err, "Expected no error from ListTools")
})
s.Run("ListTools returns correct Tool metadata", func() {
expectedMetadata := test.ReadFile("testdata", "toolsets-"+testCase.GetName()+"-tools.json")
metadata, err := json.MarshalIndent(tools.Tools, "", " ")
s.Require().NoErrorf(err, "failed to marshal tools metadata: %v", err)
s.JSONEq(expectedMetadata, string(metadata), "tools metadata does not match expected")
s.assertJsonSnapshot("toolsets-"+testCase.GetName()+"-tools.json", tools.Tools)
})
})
}
Expand Down Expand Up @@ -211,6 +203,27 @@ func (s *ToolsetsSuite) InitMcpClient() {
s.McpClient = test.NewMcpClient(s.T(), s.mcpServer.ServeHTTP())
}

func (s *ToolsetsSuite) assertJsonSnapshot(snapshotFile string, actual any) {
_, file, _, _ := runtime.Caller(1)
snapshotPath := filepath.Join(filepath.Dir(file), "testdata", snapshotFile)
actualJson, err := json.MarshalIndent(actual, "", " ")
s.Require().NoErrorf(err, "failed to marshal actual data: %v", err)
if s.updateJson {
err := os.WriteFile(snapshotPath, append(actualJson, '\n'), 0644)
s.Require().NoErrorf(err, "failed to write snapshot file %s: %v", snapshotFile, err)
s.T().Logf("Updated snapshot: %s", snapshotFile)
return
}
expectedJson := test.ReadFile("testdata", snapshotFile)
s.JSONEq(
expectedJson,
string(actualJson),
"snapshot %s does not match - to update snapshots re-run the tests with %s=1",
snapshotFile,
updateJsonEnvVar,
)
}

func TestToolsets(t *testing.T) {
suite.Run(t, new(ToolsetsSuite))
}