Linear: [CODAGT-1101](https://linear.app/codercom/issue/CODAGT-1101/agent-plugins-read-only-support-behind-the-agent-plugins-experiment) **tl;dr:** Adds the `agent-plugins` experiment and the Agent API v2.17 messages that carry Agent Plugins data from the agent to coderd. First of eight stacked PRs adding read-only [Agent Plugins](https://agent-plugins.org/) v1.0.0 support. A plugin is a directory with a `plugin.json` manifest, skills under `skills/`, and an optional `mcp.json`. Across the stack, the agent discovers plugins in `plugins/` and `.agents/plugins/` under its scan roots (for example `~/.coder/plugins/<name>`), chatd lists their skills with plugin attribution, the agent runs the MCP servers of plugins in the workspace working directory, and the Agents page shows plugin attribution in the chat context. Hooks, commands, agents, install flows, and org-managed plugins are out of scope. Background: [research/agent-plugins-standard.md](https://github.com/coder/scott-misc/blob/main/research/agent-plugins-standard.md) (internal). This PR adds `codersdk.ExperimentAgentPlugins` and a `PluginBody` oneof variant on `ContextResource` (tag 18) that carries the validated manifest fields and nests the plugin's skills and MCP servers. `Manifest` gains `agent_plugins_enabled` (field 23), which coderd sets when the experiment is enabled; the agent discovers plugins only then. coderd stores each nested resource as its own row with the plugin's name in a new `plugin_name` column (migration 000642), which the hydrate, MCP sync, and re-pin queries copy. With the experiment off, `PushContextState` drops plugin resources and everything nested in them. Otherwise it rejects pushes with plugin names that fail `workspacesdk.ValidatePluginName` (the spec's name grammar, shared by agent and coderd), OK plugins without a name or with a duplicate name, a non-OK plugin that nests resources, nested entries of the wrong kind, plugin skill sources outside `<plugin source>/skills/`, and plugin MCP servers with an empty `server_name` or a source other than `<plugin name>/<server_name>`. Nested resources count toward the 1000-resource cap. Agents now dial v2.17, so a new agent needs a coderd that supports it, as with every Agent API minor. Turning the experiment off does not remove plugin data already pinned to existing chats. <!-- pr-map:start --> <details><summary>PR map</summary> `main..4b0cfc9657` | Category | Files | + | - | |---|---:|---:|---:| | prod (backend) | 15 | 342 | 78 | | test (backend) | 9 | 534 | 3 | | migrations | 2 | 14 | 0 | | generated (backend) | 7 | 1216 | 1027 | | generated (frontend) | 1 | 2 | 0 | | **Total** | 34 | 2108 | 1108 | 1. `coderd/agentapi/context.go` (+211/-51, API): drops plugin resources when the experiment is off; otherwise validates plugin names and nesting, and stores each nested skill and MCP server as its own row with the plugin's name. 2. `agent/proto/agent.proto` (+39/-9, API): `PluginBody` with nested `skills` and `mcp_servers`, and `Manifest.agent_plugins_enabled`. 3. `codersdk/workspacesdk/frontmatter.go` (+31/-0): `ValidatePluginName` and `MaxPluginNameLength` (manifest name grammar). 4. `coderd/database/queries/chats.sql`, `workspaceagentcontext.sql`, migration 000642 (+28/-7, DB): the `plugin_name` column on both context resource tables, copied by the hydrate, MCP sync, and re-pin queries. 5. `codersdk/agentsdk/agentsdk.go`, `agent/agent.go` (+18/-4, API): `Manifest.AgentPluginsEnabled` and `ConnectRPC217WithRole`; the agent dials v2.17. 6. `coderd/agentapi/api.go`, `manifest.go` (+4): the manifest flag follows the experiment. 7. `tailnet/proto/version.go` (+8/-1, API): Agent API v2.17. 8. `codersdk/deployment.go` (+4, API): the `agent-plugins` experiment. </details> <!-- pr-map:end --> --- This PR was generated by Coder Agents on behalf of @jscottmiller. Co-authored-by: Garrett Delfosse <delfossegarrett@gmail.com>
786 lines
29 KiB
Go
786 lines
29 KiB
Go
package agentapi_test
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/url"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/sqlc-dev/pqtype"
|
|
"github.com/stretchr/testify/require"
|
|
"go.uber.org/mock/gomock"
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
"tailscale.com/tailcfg"
|
|
|
|
agentproto "github.com/coder/coder/v2/agent/proto"
|
|
"github.com/coder/coder/v2/coderd/agentapi"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbmock"
|
|
"github.com/coder/coder/v2/coderd/database/dbtime"
|
|
"github.com/coder/coder/v2/coderd/externalauth"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/tailnet"
|
|
)
|
|
|
|
func TestGetManifest(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
someTime, err := time.Parse(time.RFC3339, "2023-01-01T00:00:00Z")
|
|
require.NoError(t, err)
|
|
someTime = dbtime.Time(someTime)
|
|
|
|
expectedEnvVars := map[string]string{
|
|
"FOO": "bar",
|
|
"COOL_ENV": "dean was here",
|
|
}
|
|
expectedEnvVarsJSON, err := json.Marshal(expectedEnvVars)
|
|
require.NoError(t, err)
|
|
|
|
var (
|
|
owner = database.User{
|
|
ID: uuid.New(),
|
|
Username: "cool-user",
|
|
}
|
|
workspace = database.Workspace{
|
|
ID: uuid.New(),
|
|
OwnerID: owner.ID,
|
|
OwnerUsername: owner.Username,
|
|
Name: "cool-workspace",
|
|
TemplateID: uuid.New(),
|
|
TemplateName: "cool-template",
|
|
}
|
|
// agentBuild is the build that created the agent; workspace secrets
|
|
// are looked up by its ID.
|
|
agentBuild = database.WorkspaceBuild{
|
|
ID: uuid.New(),
|
|
WorkspaceID: workspace.ID,
|
|
}
|
|
agent = database.WorkspaceAgent{
|
|
ID: uuid.New(),
|
|
Name: "cool-agent",
|
|
EnvironmentVariables: pqtype.NullRawMessage{
|
|
RawMessage: expectedEnvVarsJSON,
|
|
Valid: true,
|
|
},
|
|
Directory: "/cool/dir",
|
|
MOTDFile: "/cool/motd",
|
|
}
|
|
childAgent = database.WorkspaceAgent{
|
|
ID: uuid.New(),
|
|
Name: "cool-child-agent",
|
|
ParentID: uuid.NullUUID{Valid: true, UUID: agent.ID},
|
|
Directory: "/workspace/dir",
|
|
MOTDFile: "/workspace/motd",
|
|
}
|
|
apps = []database.WorkspaceApp{
|
|
{
|
|
ID: uuid.New(),
|
|
Url: sql.NullString{String: "http://localhost:1234", Valid: true},
|
|
External: false,
|
|
Slug: "cool-app-1",
|
|
DisplayName: "app 1",
|
|
Command: sql.NullString{String: "cool command", Valid: true},
|
|
Icon: "/icon.png",
|
|
Subdomain: true,
|
|
SharingLevel: database.AppSharingLevelAuthenticated,
|
|
Health: database.WorkspaceAppHealthHealthy,
|
|
HealthcheckUrl: "http://localhost:1234/health",
|
|
HealthcheckInterval: 10,
|
|
HealthcheckThreshold: 3,
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
Url: sql.NullString{String: "http://google.com", Valid: true},
|
|
External: true,
|
|
Slug: "google",
|
|
DisplayName: "Literally Google",
|
|
Command: sql.NullString{Valid: false},
|
|
Icon: "/google.png",
|
|
Subdomain: false,
|
|
SharingLevel: database.AppSharingLevelPublic,
|
|
Health: database.WorkspaceAppHealthDisabled,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
Url: sql.NullString{String: "http://localhost:4321", Valid: true},
|
|
External: true,
|
|
Slug: "cool-app-2",
|
|
DisplayName: "another COOL app",
|
|
Command: sql.NullString{Valid: false},
|
|
Icon: "",
|
|
Subdomain: false,
|
|
SharingLevel: database.AppSharingLevelOwner,
|
|
Health: database.WorkspaceAppHealthUnhealthy,
|
|
HealthcheckUrl: "http://localhost:4321/health",
|
|
HealthcheckInterval: 20,
|
|
HealthcheckThreshold: 5,
|
|
Hidden: true,
|
|
},
|
|
}
|
|
scripts = []database.GetWorkspaceAgentScriptsByAgentIDsRow{
|
|
{
|
|
ID: uuid.New(),
|
|
WorkspaceAgentID: agent.ID,
|
|
LogSourceID: uuid.New(),
|
|
LogPath: "/cool/log/path/1",
|
|
DisplayName: "Install tools",
|
|
Script: "cool script 1",
|
|
Cron: "30 2 * * *",
|
|
StartBlocksLogin: true,
|
|
RunOnStart: true,
|
|
RunOnStop: false,
|
|
TimeoutSeconds: 60,
|
|
ResourceAddress: "coder_script.install_tools",
|
|
Dependencies: json.RawMessage(`[{"prerequisite_resource_address":"coder_script.clone_repo","requirement":"success"}]`),
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
WorkspaceAgentID: agent.ID,
|
|
LogSourceID: uuid.New(),
|
|
LogPath: "/cool/log/path/2",
|
|
DisplayName: "Clone repo",
|
|
Script: "cool script 2",
|
|
Cron: "",
|
|
StartBlocksLogin: false,
|
|
RunOnStart: false,
|
|
RunOnStop: true,
|
|
TimeoutSeconds: 30,
|
|
ResourceAddress: "coder_script.clone_repo",
|
|
Dependencies: json.RawMessage(`[]`),
|
|
},
|
|
}
|
|
metadata = []database.WorkspaceAgentMetadatum{
|
|
{
|
|
WorkspaceAgentID: agent.ID,
|
|
DisplayName: "cool metadata 1",
|
|
Key: "cool-key-1",
|
|
Script: "cool script 1",
|
|
Value: "cool value 1",
|
|
Error: "",
|
|
Timeout: int64(time.Minute),
|
|
Interval: int64(time.Minute),
|
|
CollectedAt: someTime,
|
|
},
|
|
{
|
|
WorkspaceAgentID: agent.ID,
|
|
DisplayName: "cool metadata 2",
|
|
Key: "cool-key-2",
|
|
Script: "cool script 2",
|
|
Value: "cool value 2",
|
|
Error: "some uncool error",
|
|
Timeout: int64(5 * time.Second),
|
|
Interval: int64(20 * time.Minute),
|
|
CollectedAt: someTime.Add(time.Hour),
|
|
},
|
|
}
|
|
devcontainers = []database.WorkspaceAgentDevcontainer{
|
|
{
|
|
ID: uuid.New(),
|
|
Name: "cool",
|
|
WorkspaceAgentID: agent.ID,
|
|
WorkspaceFolder: "/cool/folder",
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
Name: "another",
|
|
WorkspaceAgentID: agent.ID,
|
|
WorkspaceFolder: "/another/cool/folder",
|
|
ConfigPath: "/another/cool/folder/.devcontainer/devcontainer.json",
|
|
},
|
|
}
|
|
derpMapFn = func() *tailcfg.DERPMap {
|
|
return &tailcfg.DERPMap{
|
|
Regions: map[int]*tailcfg.DERPRegion{
|
|
1: {RegionName: "cool region"},
|
|
},
|
|
}
|
|
}
|
|
)
|
|
|
|
// These are done manually to ensure the conversion logic matches what a
|
|
// human expects.
|
|
var (
|
|
protoScripts = []*agentproto.WorkspaceAgentScript{
|
|
{
|
|
Id: scripts[0].ID[:],
|
|
LogSourceId: scripts[0].LogSourceID[:],
|
|
LogPath: scripts[0].LogPath,
|
|
Script: scripts[0].Script,
|
|
Cron: scripts[0].Cron,
|
|
RunOnStart: scripts[0].RunOnStart,
|
|
RunOnStop: scripts[0].RunOnStop,
|
|
StartBlocksLogin: scripts[0].StartBlocksLogin,
|
|
Timeout: durationpb.New(time.Duration(scripts[0].TimeoutSeconds) * time.Second),
|
|
DisplayName: scripts[0].DisplayName,
|
|
ResourceAddress: "coder_script.install_tools",
|
|
Dependencies: []*agentproto.WorkspaceAgentScriptDependency{{
|
|
PrerequisiteResourceAddress: "coder_script.clone_repo",
|
|
Requirement: agentproto.WorkspaceAgentScriptDependency_REQUIREMENT_SUCCESS,
|
|
}},
|
|
},
|
|
{
|
|
Id: scripts[1].ID[:],
|
|
LogSourceId: scripts[1].LogSourceID[:],
|
|
LogPath: scripts[1].LogPath,
|
|
Script: scripts[1].Script,
|
|
Cron: scripts[1].Cron,
|
|
RunOnStart: scripts[1].RunOnStart,
|
|
RunOnStop: scripts[1].RunOnStop,
|
|
StartBlocksLogin: scripts[1].StartBlocksLogin,
|
|
Timeout: durationpb.New(time.Duration(scripts[1].TimeoutSeconds) * time.Second),
|
|
DisplayName: scripts[1].DisplayName,
|
|
ResourceAddress: "coder_script.clone_repo",
|
|
// An unordered script sends no entries, not placeholders.
|
|
Dependencies: nil,
|
|
},
|
|
}
|
|
protoMetadata = []*agentproto.WorkspaceAgentMetadata_Description{
|
|
{
|
|
DisplayName: metadata[0].DisplayName,
|
|
Key: metadata[0].Key,
|
|
Script: metadata[0].Script,
|
|
Interval: durationpb.New(time.Duration(metadata[0].Interval)),
|
|
Timeout: durationpb.New(time.Duration(metadata[0].Timeout)),
|
|
},
|
|
{
|
|
DisplayName: metadata[1].DisplayName,
|
|
Key: metadata[1].Key,
|
|
Script: metadata[1].Script,
|
|
Interval: durationpb.New(time.Duration(metadata[1].Interval)),
|
|
Timeout: durationpb.New(time.Duration(metadata[1].Timeout)),
|
|
},
|
|
}
|
|
protoDevcontainers = []*agentproto.WorkspaceAgentDevcontainer{
|
|
{
|
|
Id: devcontainers[0].ID[:],
|
|
Name: devcontainers[0].Name,
|
|
WorkspaceFolder: devcontainers[0].WorkspaceFolder,
|
|
},
|
|
{
|
|
Id: devcontainers[1].ID[:],
|
|
Name: devcontainers[1].Name,
|
|
WorkspaceFolder: devcontainers[1].WorkspaceFolder,
|
|
ConfigPath: devcontainers[1].ConfigPath,
|
|
},
|
|
}
|
|
)
|
|
|
|
t.Run("OK", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
protoApps := []*agentproto.WorkspaceApp{
|
|
{
|
|
Id: apps[0].ID[:],
|
|
Url: apps[0].Url.String,
|
|
External: apps[0].External,
|
|
Slug: apps[0].Slug,
|
|
DisplayName: apps[0].DisplayName,
|
|
Command: apps[0].Command.String,
|
|
Icon: apps[0].Icon,
|
|
Subdomain: apps[0].Subdomain,
|
|
SubdomainName: fmt.Sprintf("%s--%s--%s", apps[0].Slug, workspace.Name, owner.Username),
|
|
SharingLevel: agentproto.WorkspaceApp_AUTHENTICATED,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: apps[0].HealthcheckUrl,
|
|
Interval: durationpb.New(time.Duration(apps[0].HealthcheckInterval) * time.Second),
|
|
Threshold: apps[0].HealthcheckThreshold,
|
|
},
|
|
Health: agentproto.WorkspaceApp_HEALTHY,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
Id: apps[1].ID[:],
|
|
Url: apps[1].Url.String,
|
|
External: apps[1].External,
|
|
Slug: apps[1].Slug,
|
|
DisplayName: apps[1].DisplayName,
|
|
Command: apps[1].Command.String,
|
|
Icon: apps[1].Icon,
|
|
Subdomain: false,
|
|
SubdomainName: "",
|
|
SharingLevel: agentproto.WorkspaceApp_PUBLIC,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: "",
|
|
Interval: durationpb.New(0),
|
|
Threshold: 0,
|
|
},
|
|
Health: agentproto.WorkspaceApp_DISABLED,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
Id: apps[2].ID[:],
|
|
Url: apps[2].Url.String,
|
|
External: apps[2].External,
|
|
Slug: apps[2].Slug,
|
|
DisplayName: apps[2].DisplayName,
|
|
Command: apps[2].Command.String,
|
|
Icon: apps[2].Icon,
|
|
Subdomain: false,
|
|
SubdomainName: "",
|
|
SharingLevel: agentproto.WorkspaceApp_OWNER,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: apps[2].HealthcheckUrl,
|
|
Interval: durationpb.New(time.Duration(apps[2].HealthcheckInterval) * time.Second),
|
|
Threshold: apps[2].HealthcheckThreshold,
|
|
},
|
|
Health: agentproto.WorkspaceApp_UNHEALTHY,
|
|
Hidden: true,
|
|
},
|
|
}
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "*--apps.example.com",
|
|
ExternalAuthConfigs: []*externalauth.Config{
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitHub)},
|
|
{Type: "some-provider"},
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitLab)},
|
|
},
|
|
DisableDirectConnections: true,
|
|
DerpForceWebSockets: true,
|
|
AgentPluginsEnabled: true,
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return agent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return(apps, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{agent.ID}).Return(scripts, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: agent.ID,
|
|
Keys: nil, // all
|
|
}).Return(metadata, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), agent.ID).Return(devcontainers, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return(nil, nil)
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return(nil, nil)
|
|
|
|
got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.NoError(t, err)
|
|
|
|
expected := &agentproto.Manifest{
|
|
AgentId: agent.ID[:],
|
|
AgentName: agent.Name,
|
|
ParentId: nil,
|
|
OwnerUsername: owner.Username,
|
|
WorkspaceId: workspace.ID[:],
|
|
WorkspaceBuildId: agentBuild.ID[:],
|
|
WorkspaceName: workspace.Name,
|
|
TemplateId: workspace.TemplateID[:],
|
|
TemplateName: workspace.TemplateName,
|
|
GitAuthConfigs: 2, // two "enhanced" external auth configs
|
|
EnvironmentVariables: expectedEnvVars,
|
|
Directory: agent.Directory,
|
|
VsCodePortProxyUri: fmt.Sprintf("https://{{port}}--%s--%s--%s--apps.example.com", agent.Name, workspace.Name, owner.Username),
|
|
MotdPath: agent.MOTDFile,
|
|
DisableDirectConnections: true,
|
|
DerpForceWebsockets: true,
|
|
AgentPluginsEnabled: true,
|
|
// tailnet.DERPMapToProto() is extensively tested elsewhere, so it's
|
|
// not necessary to manually recreate a big DERP map here like we
|
|
// did for apps and metadata.
|
|
DerpMap: tailnet.DERPMapToProto(derpMapFn()),
|
|
Scripts: protoScripts,
|
|
Apps: protoApps,
|
|
Metadata: protoMetadata,
|
|
Devcontainers: protoDevcontainers,
|
|
Secrets: []*agentproto.WorkspaceSecret{},
|
|
}
|
|
|
|
// Log got and expected with spew.
|
|
// t.Log("got:\n" + spew.Sdump(got))
|
|
// t.Log("expected:\n" + spew.Sdump(expected))
|
|
|
|
require.Equal(t, expected, got)
|
|
})
|
|
|
|
t.Run("OK/Child", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "*--apps.example.com",
|
|
ExternalAuthConfigs: []*externalauth.Config{
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitHub)},
|
|
{Type: "some-provider"},
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitLab)},
|
|
},
|
|
DisableDirectConnections: true,
|
|
DerpForceWebSockets: true,
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return childAgent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceApp{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{childAgent.ID}).Return([]database.GetWorkspaceAgentScriptsByAgentIDsRow{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: childAgent.ID,
|
|
Keys: nil, // all
|
|
}).Return([]database.WorkspaceAgentMetadatum{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceAgentDevcontainer{}, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return(nil, nil)
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return(nil, nil)
|
|
|
|
got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.NoError(t, err)
|
|
|
|
expected := &agentproto.Manifest{
|
|
AgentId: childAgent.ID[:],
|
|
AgentName: childAgent.Name,
|
|
ParentId: agent.ID[:],
|
|
OwnerUsername: owner.Username,
|
|
WorkspaceId: workspace.ID[:],
|
|
WorkspaceBuildId: agentBuild.ID[:],
|
|
WorkspaceName: workspace.Name,
|
|
TemplateId: workspace.TemplateID[:],
|
|
TemplateName: workspace.TemplateName,
|
|
GitAuthConfigs: 2, // two "enhanced" external auth configs
|
|
EnvironmentVariables: nil,
|
|
Directory: childAgent.Directory,
|
|
VsCodePortProxyUri: fmt.Sprintf("https://{{port}}--%s--%s--%s--apps.example.com", childAgent.Name, workspace.Name, owner.Username),
|
|
MotdPath: childAgent.MOTDFile,
|
|
DisableDirectConnections: true,
|
|
DerpForceWebsockets: true,
|
|
// tailnet.DERPMapToProto() is extensively tested elsewhere, so it's
|
|
// not necessary to manually recreate a big DERP map here like we
|
|
// did for apps and metadata.
|
|
DerpMap: tailnet.DERPMapToProto(derpMapFn()),
|
|
Scripts: []*agentproto.WorkspaceAgentScript{},
|
|
Apps: []*agentproto.WorkspaceApp{},
|
|
Metadata: []*agentproto.WorkspaceAgentMetadata_Description{},
|
|
Devcontainers: []*agentproto.WorkspaceAgentDevcontainer{},
|
|
Secrets: []*agentproto.WorkspaceSecret{},
|
|
}
|
|
|
|
require.Equal(t, expected, got)
|
|
})
|
|
|
|
t.Run("SubagentScriptDependencies", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "*--apps.example.com",
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return childAgent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
subagentScripts := []database.GetWorkspaceAgentScriptsByAgentIDsRow{
|
|
{
|
|
ID: uuid.New(),
|
|
WorkspaceAgentID: childAgent.ID,
|
|
LogSourceID: uuid.New(),
|
|
Script: "echo a",
|
|
RunOnStart: true,
|
|
ResourceAddress: "coder_script.a",
|
|
Dependencies: json.RawMessage(`[]`),
|
|
},
|
|
{
|
|
ID: uuid.New(),
|
|
WorkspaceAgentID: childAgent.ID,
|
|
LogSourceID: uuid.New(),
|
|
Script: "echo b",
|
|
RunOnStart: true,
|
|
ResourceAddress: "coder_script.b",
|
|
Dependencies: json.RawMessage(`[{"prerequisite_resource_address":"coder_script.a","requirement":"completion"}]`),
|
|
},
|
|
}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceApp{}, nil)
|
|
// Only the subagent's own rows are loaded, never the parent's.
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{childAgent.ID}).Return(subagentScripts, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: childAgent.ID,
|
|
Keys: nil, // all
|
|
}).Return([]database.WorkspaceAgentMetadatum{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceAgentDevcontainer{}, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return(nil, nil)
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return(nil, nil)
|
|
|
|
got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, []*agentproto.WorkspaceAgentScript{
|
|
{
|
|
Id: subagentScripts[0].ID[:],
|
|
LogSourceId: subagentScripts[0].LogSourceID[:],
|
|
Script: "echo a",
|
|
RunOnStart: true,
|
|
Timeout: durationpb.New(0),
|
|
ResourceAddress: "coder_script.a",
|
|
},
|
|
{
|
|
Id: subagentScripts[1].ID[:],
|
|
LogSourceId: subagentScripts[1].LogSourceID[:],
|
|
Script: "echo b",
|
|
RunOnStart: true,
|
|
Timeout: durationpb.New(0),
|
|
ResourceAddress: "coder_script.b",
|
|
Dependencies: []*agentproto.WorkspaceAgentScriptDependency{{
|
|
PrerequisiteResourceAddress: "coder_script.a",
|
|
Requirement: agentproto.WorkspaceAgentScriptDependency_REQUIREMENT_COMPLETION,
|
|
}},
|
|
},
|
|
}, got.Scripts)
|
|
})
|
|
|
|
t.Run("CorruptScriptDependencies", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "*--apps.example.com",
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return agent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
corruptScripts := []database.GetWorkspaceAgentScriptsByAgentIDsRow{{
|
|
ID: uuid.New(),
|
|
WorkspaceAgentID: agent.ID,
|
|
LogSourceID: uuid.New(),
|
|
ResourceAddress: "coder_script.install_tools",
|
|
Dependencies: json.RawMessage(`[{"requirement":"success"}]`),
|
|
}}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{agent.ID}).Return(corruptScripts, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: agent.ID,
|
|
Keys: nil, // all
|
|
}).Return([]database.WorkspaceAgentMetadatum{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceAgentDevcontainer{}, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return(nil, nil)
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return(nil, nil)
|
|
|
|
_, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.ErrorContains(t, err, "empty prerequisite resource address")
|
|
})
|
|
|
|
t.Run("SecretsFiltering", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "*--apps.example.com",
|
|
ExternalAuthConfigs: []*externalauth.Config{
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitHub)},
|
|
{Type: "some-provider"},
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitLab)},
|
|
},
|
|
DisableDirectConnections: true,
|
|
DerpForceWebSockets: true,
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return childAgent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceApp{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{childAgent.ID}).Return([]database.GetWorkspaceAgentScriptsByAgentIDsRow{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: childAgent.ID,
|
|
Keys: nil,
|
|
}).Return([]database.WorkspaceAgentMetadatum{}, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceAgentDevcontainer{}, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
|
|
// Return a mix of secrets: env-only, file-only, both, and
|
|
// one explicitly disabled. The disabled secret should be
|
|
// filtered out.
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return([]database.UserSecret{
|
|
{EnvName: "GITHUB_TOKEN", FilePath: "", Value: "ghp_xxxx", Enabled: true},
|
|
{EnvName: "", FilePath: "~/.ssh/id_rsa", Value: "private-key", Enabled: true},
|
|
{EnvName: "BOTH_ENV", FilePath: "/etc/both", Value: "both-val", Enabled: true},
|
|
{EnvName: "DISABLED_ENV", FilePath: "", Value: "disabled-val", Enabled: false},
|
|
}, nil)
|
|
// A workspace secret on the same env var as a user secret wins.
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return([]database.WorkspaceSecret{
|
|
{EnvName: "GITHUB_TOKEN", Value: sql.NullString{String: "ghp_workspace", Valid: true}},
|
|
}, nil)
|
|
|
|
got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.NoError(t, err)
|
|
|
|
// The disabled secret is filtered out, and the workspace secret
|
|
// replaces the user secret on GITHUB_TOKEN, so that user secret is
|
|
// not sent at all.
|
|
require.Len(t, got.Secrets, 3)
|
|
require.Equal(t, "", got.Secrets[0].EnvName)
|
|
require.Equal(t, "~/.ssh/id_rsa", got.Secrets[0].FilePath)
|
|
require.Equal(t, []byte("private-key"), got.Secrets[0].Value)
|
|
|
|
require.Equal(t, "BOTH_ENV", got.Secrets[1].EnvName)
|
|
require.Equal(t, "/etc/both", got.Secrets[1].FilePath)
|
|
require.Equal(t, []byte("both-val"), got.Secrets[1].Value)
|
|
|
|
require.Equal(t, "GITHUB_TOKEN", got.Secrets[2].EnvName)
|
|
require.Equal(t, []byte("ghp_workspace"), got.Secrets[2].Value)
|
|
})
|
|
|
|
t.Run("NoAppHostname", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
protoApps := []*agentproto.WorkspaceApp{
|
|
{
|
|
Id: apps[0].ID[:],
|
|
Url: apps[0].Url.String,
|
|
External: apps[0].External,
|
|
Slug: apps[0].Slug,
|
|
DisplayName: apps[0].DisplayName,
|
|
Command: apps[0].Command.String,
|
|
Icon: apps[0].Icon,
|
|
Subdomain: apps[0].Subdomain,
|
|
SubdomainName: "", // Empty because AppHostname is empty
|
|
SharingLevel: agentproto.WorkspaceApp_AUTHENTICATED,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: apps[0].HealthcheckUrl,
|
|
Interval: durationpb.New(time.Duration(apps[0].HealthcheckInterval) * time.Second),
|
|
Threshold: apps[0].HealthcheckThreshold,
|
|
},
|
|
Health: agentproto.WorkspaceApp_HEALTHY,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
Id: apps[1].ID[:],
|
|
Url: apps[1].Url.String,
|
|
External: apps[1].External,
|
|
Slug: apps[1].Slug,
|
|
DisplayName: apps[1].DisplayName,
|
|
Command: apps[1].Command.String,
|
|
Icon: apps[1].Icon,
|
|
Subdomain: false,
|
|
SubdomainName: "",
|
|
SharingLevel: agentproto.WorkspaceApp_PUBLIC,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: "",
|
|
Interval: durationpb.New(0),
|
|
Threshold: 0,
|
|
},
|
|
Health: agentproto.WorkspaceApp_DISABLED,
|
|
Hidden: false,
|
|
},
|
|
{
|
|
Id: apps[2].ID[:],
|
|
Url: apps[2].Url.String,
|
|
External: apps[2].External,
|
|
Slug: apps[2].Slug,
|
|
DisplayName: apps[2].DisplayName,
|
|
Command: apps[2].Command.String,
|
|
Icon: apps[2].Icon,
|
|
Subdomain: false,
|
|
SubdomainName: "",
|
|
SharingLevel: agentproto.WorkspaceApp_OWNER,
|
|
Healthcheck: &agentproto.WorkspaceApp_Healthcheck{
|
|
Url: apps[2].HealthcheckUrl,
|
|
Interval: durationpb.New(time.Duration(apps[2].HealthcheckInterval) * time.Second),
|
|
Threshold: apps[2].HealthcheckThreshold,
|
|
},
|
|
Health: agentproto.WorkspaceApp_UNHEALTHY,
|
|
Hidden: true,
|
|
},
|
|
}
|
|
|
|
mDB := dbmock.NewMockStore(gomock.NewController(t))
|
|
|
|
api := &agentapi.ManifestAPI{
|
|
AccessURL: &url.URL{Scheme: "https", Host: "example.com"},
|
|
AppHostname: "",
|
|
ExternalAuthConfigs: []*externalauth.Config{
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitHub)},
|
|
{Type: "some-provider"},
|
|
{Type: string(codersdk.EnhancedExternalAuthProviderGitLab)},
|
|
},
|
|
DisableDirectConnections: true,
|
|
DerpForceWebSockets: true,
|
|
|
|
AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) { return agent, nil },
|
|
WorkspaceID: workspace.ID,
|
|
WorkspaceBuildID: agentBuild.ID,
|
|
Database: mDB,
|
|
DerpMapFn: derpMapFn,
|
|
}
|
|
|
|
mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return(apps, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{agent.ID}).Return(scripts, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
|
|
WorkspaceAgentID: agent.ID,
|
|
Keys: nil, // all
|
|
}).Return(metadata, nil)
|
|
mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), agent.ID).Return(devcontainers, nil)
|
|
mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
|
|
mDB.EXPECT().ListUserSecretsWithValues(gomock.Any(), workspace.OwnerID).Return(nil, nil)
|
|
mDB.EXPECT().ListActiveWorkspaceSecrets(gomock.Any(), agentBuild.ID).Return(nil, nil)
|
|
|
|
got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
|
|
require.NoError(t, err)
|
|
|
|
expected := &agentproto.Manifest{
|
|
AgentId: agent.ID[:],
|
|
AgentName: agent.Name,
|
|
OwnerUsername: owner.Username,
|
|
WorkspaceId: workspace.ID[:],
|
|
WorkspaceBuildId: agentBuild.ID[:],
|
|
WorkspaceName: workspace.Name,
|
|
TemplateId: workspace.TemplateID[:],
|
|
TemplateName: workspace.TemplateName,
|
|
GitAuthConfigs: 2, // two "enhanced" external auth configs
|
|
EnvironmentVariables: expectedEnvVars,
|
|
Directory: agent.Directory,
|
|
VsCodePortProxyUri: "", // empty with no AppHost
|
|
MotdPath: agent.MOTDFile,
|
|
DisableDirectConnections: true,
|
|
DerpForceWebsockets: true,
|
|
// tailnet.DERPMapToProto() is extensively tested elsewhere, so it's
|
|
// not necessary to manually recreate a big DERP map here like we
|
|
// did for apps and metadata.
|
|
DerpMap: tailnet.DERPMapToProto(derpMapFn()),
|
|
Scripts: protoScripts,
|
|
Apps: protoApps,
|
|
Metadata: protoMetadata,
|
|
Devcontainers: protoDevcontainers,
|
|
Secrets: []*agentproto.WorkspaceSecret{},
|
|
}
|
|
|
|
// Log got and expected with spew.
|
|
// t.Log("got:\n" + spew.Sdump(got))
|
|
// t.Log("expected:\n" + spew.Sdump(expected))
|
|
|
|
require.Equal(t, expected, got)
|
|
})
|
|
}
|