Part of [DEVEX-556](https://linear.app/codercom/issue/DEVEX-556). Builds on the base agent metadata added in #28794. ## Summary Surfaces the backend multi-agent support through the SDK and HTTP API: the bases endpoint returns each base's agents, and compose/create-template accept a per-module `agent_name`. ## What changed - `codersdk/templatebuilder.go`: added `TemplateBuilderBaseAgent`, `TemplateBuilderBase.Agents`, and `TemplateBuilderComposeModule.AgentName` (`agent_name,omitempty`). - `coderd/templatebuilder_handler.go`: added `baseAgentsToSDK`; the bases endpoint returns agents, and the compose and create-template endpoints forward `AgentName`. - `make gen` regenerated `site/src/api/typesGenerated.ts`, `coderd/apidoc/docs.go`, `coderd/apidoc/swagger.json`, `docs/reference/api/schemas.md`, and `docs/reference/api/templatebuilder.md`. - `wizardState.test.ts`: added `agents: []` to the base fixture now that the field is required on the generated type. ## Scope SDK/API plumbing only. `ComposeModule.AgentName` now has a producer (the handlers) but no caller sets it yet — the wizard UI (follow-up) is what will populate it. No DB change, so `enterprise/audit/table.go` is unaffected. ## Testing - Bases endpoint asserts each base returns agents with exactly one default (and the `dev`/`main` names). - Per-module `agent_name` round-trip and unknown-agent (400) compose tests. - `make gen` (idempotent), `make fmt` (no changes), `golangci-lint ./coderd/... ./codersdk/...`, the Go template-builder tests, frontend `tsc` + `biome check`, and docs markdownlint all pass. <details> <summary>Design note</summary> `display_name` is intentionally returned as `""` for now: every base is single-agent, so no base authors a per-agent label. The field exists for multi-agent bases where the wizard radio needs a human-readable name; consumers fall back to the agent `name` when it is empty. </details> --- 🤖 Generated by Coder Agents on behalf of @jeremyruppel. Co-authored-by: Coder Agents <agents@coder.com>
421 lines
12 KiB
Go
421 lines
12 KiB
Go
package coderd_test
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/coderdtest"
|
|
"github.com/coder/coder/v2/coderd/templatebuilder"
|
|
"github.com/coder/coder/v2/codersdk"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
func TestTemplateBuilderBases(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("OK", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
resp, err := client.TemplateBuilderBases(ctx)
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, resp.Bases)
|
|
require.Len(t, resp.Bases, len(templatebuilder.BaseTemplateIDs()))
|
|
|
|
basesByID := make(map[string]codersdk.TemplateBuilderBase, len(resp.Bases))
|
|
for _, b := range resp.Bases {
|
|
basesByID[b.ID] = b
|
|
}
|
|
|
|
type baseSpec struct {
|
|
id string
|
|
expectedOS string
|
|
expectedVars []string
|
|
hasVariables bool
|
|
}
|
|
|
|
specs := []baseSpec{
|
|
{
|
|
// Quickstart exposes no builder variables today: its base.json
|
|
// declares none. Locking that here flags drift if it changes,
|
|
// e.g. if it later exposes a container_image selector.
|
|
id: "quickstart",
|
|
expectedOS: "linux",
|
|
hasVariables: false,
|
|
},
|
|
{
|
|
id: "docker",
|
|
expectedOS: "linux",
|
|
hasVariables: true,
|
|
expectedVars: []string{"container_image"},
|
|
},
|
|
{
|
|
id: "kubernetes",
|
|
expectedOS: "linux",
|
|
hasVariables: true,
|
|
expectedVars: []string{"container_image", "namespace", "use_kubeconfig"},
|
|
},
|
|
{
|
|
id: "aws-linux",
|
|
expectedOS: "linux",
|
|
hasVariables: false,
|
|
},
|
|
{
|
|
id: "aws-windows",
|
|
expectedOS: "windows",
|
|
hasVariables: false,
|
|
},
|
|
{
|
|
id: "gcp-windows",
|
|
expectedOS: "windows",
|
|
hasVariables: true,
|
|
expectedVars: []string{"project_id"},
|
|
},
|
|
}
|
|
|
|
for _, spec := range specs {
|
|
b, ok := basesByID[spec.id]
|
|
require.True(t, ok, "base %q missing from response", spec.id)
|
|
require.NotEmpty(t, b.Name, "base %q should have a name", spec.id)
|
|
require.NotEmpty(t, b.Icon, "base %q should have an icon", spec.id)
|
|
require.Equal(t, spec.expectedOS, b.OS, "base %q OS mismatch", spec.id)
|
|
require.NotNil(t, b.Variables, "base %q should have non-nil variables slice", spec.id)
|
|
|
|
if spec.hasVariables {
|
|
require.NotEmpty(t, b.Variables, "base %q should have variables", spec.id)
|
|
varNames := make(map[string]bool, len(b.Variables))
|
|
for _, v := range b.Variables {
|
|
varNames[v.Name] = true
|
|
}
|
|
for _, expected := range spec.expectedVars {
|
|
require.True(t, varNames[expected],
|
|
"base %q should have variable %q", spec.id, expected)
|
|
}
|
|
} else {
|
|
require.Empty(t, b.Variables, "base %q should have no variables", spec.id)
|
|
}
|
|
|
|
// Every base declares at least one agent, exactly one default.
|
|
require.NotEmpty(t, b.Agents, "base %q should declare agents", spec.id)
|
|
defaults := 0
|
|
for _, a := range b.Agents {
|
|
if a.Default {
|
|
defaults++
|
|
}
|
|
}
|
|
require.Equal(t, 1, defaults, "base %q should mark exactly one default agent", spec.id)
|
|
}
|
|
|
|
// aws-linux names its agent "dev"; the rest use "main".
|
|
require.Equal(t,
|
|
[]codersdk.TemplateBuilderBaseAgent{{Name: "dev", Default: true}},
|
|
basesByID["aws-linux"].Agents)
|
|
require.Equal(t,
|
|
[]codersdk.TemplateBuilderBaseAgent{{Name: "main", Default: true}},
|
|
basesByID["docker"].Agents)
|
|
})
|
|
|
|
t.Run("Sorted", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
resp, err := client.TemplateBuilderBases(ctx)
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, resp.Bases)
|
|
|
|
// Bases are returned sorted by display name (with ID as a deterministic
|
|
// tiebreak), so the whole list is in non-decreasing name order.
|
|
for i := 1; i < len(resp.Bases); i++ {
|
|
require.LessOrEqual(t, resp.Bases[i-1].Name, resp.Bases[i].Name,
|
|
"bases should be sorted by display name")
|
|
}
|
|
})
|
|
|
|
t.Run("DisabledReturns404", func(t *testing.T) {
|
|
t.Parallel()
|
|
dv := coderdtest.DeploymentValues(t)
|
|
dv.TemplateBuilder.Disabled = true
|
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
DeploymentValues: dv,
|
|
})
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
_, err := client.TemplateBuilderBases(ctx)
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
|
|
})
|
|
}
|
|
|
|
func TestTemplateBuilderModules(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("OK", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
resp, err := client.TemplateBuilderModules(ctx, "")
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, resp.Modules)
|
|
|
|
for _, m := range resp.Modules {
|
|
require.NotEmpty(t, m.ID)
|
|
require.NotEmpty(t, m.Version)
|
|
}
|
|
})
|
|
|
|
t.Run("FilteredByBase", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
resp, err := client.TemplateBuilderModules(ctx, "docker")
|
|
require.NoError(t, err)
|
|
|
|
for _, m := range resp.Modules {
|
|
if len(m.CompatibleOS) > 0 {
|
|
require.Contains(t, m.CompatibleOS, "linux",
|
|
"module %q should be compatible with linux when filtered by docker base", m.ID)
|
|
}
|
|
}
|
|
})
|
|
|
|
t.Run("BaseExcludesIncludedModules", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
// The quickstart base bundles the git-clone module, so the module
|
|
// list for that base must omit git-clone to avoid a collision. The
|
|
// docker base does not bundle it, so it stays available there.
|
|
quickstartResp, err := client.TemplateBuilderModules(ctx, "quickstart")
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, quickstartResp.Modules,
|
|
"quickstart should still offer modules other than the ones it bundles")
|
|
for _, m := range quickstartResp.Modules {
|
|
require.NotEqual(t, "git-clone", m.ID,
|
|
"git-clone should be excluded for the quickstart base")
|
|
}
|
|
|
|
dockerResp, err := client.TemplateBuilderModules(ctx, "docker")
|
|
require.NoError(t, err)
|
|
var dockerHasGitClone bool
|
|
for _, m := range dockerResp.Modules {
|
|
if m.ID == "git-clone" {
|
|
dockerHasGitClone = true
|
|
break
|
|
}
|
|
}
|
|
require.True(t, dockerHasGitClone,
|
|
"git-clone should remain available for bases that do not bundle it")
|
|
})
|
|
|
|
t.Run("ComputedVariablesExcluded", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
resp, err := client.TemplateBuilderModules(ctx, "")
|
|
require.NoError(t, err)
|
|
|
|
// The embedded code-server module has agent_id with computed=true.
|
|
// It must not appear in the API response.
|
|
var found bool
|
|
for _, m := range resp.Modules {
|
|
if m.ID == "code-server" {
|
|
found = true
|
|
for _, v := range m.Variables {
|
|
require.NotEqual(t, "agent_id", v.Name,
|
|
"computed variable agent_id must not appear in API response")
|
|
}
|
|
}
|
|
}
|
|
require.True(t, found, "code-server module must be in the catalog")
|
|
})
|
|
|
|
t.Run("UnknownBaseReturns400", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
_, err := client.TemplateBuilderModules(ctx, "nonexistent")
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusBadRequest, sdkErr.StatusCode())
|
|
})
|
|
|
|
t.Run("DisabledReturns404", func(t *testing.T) {
|
|
t.Parallel()
|
|
dv := coderdtest.DeploymentValues(t)
|
|
dv.TemplateBuilder.Disabled = true
|
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
DeploymentValues: dv,
|
|
})
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
_, err := client.TemplateBuilderModules(ctx, "")
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
|
|
})
|
|
}
|
|
|
|
func TestTemplateBuilderSession(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("WizardEntry", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := client.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
SessionID: uuid.New(),
|
|
EventType: codersdk.TemplateBuilderSessionEventWizardEntry,
|
|
})
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("ComposeCompletion", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := client.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
SessionID: uuid.New(),
|
|
EventType: codersdk.TemplateBuilderSessionEventComposeCompletion,
|
|
BaseTemplateID: "docker",
|
|
ModuleIDs: []string{"code-server", "git-clone"},
|
|
DurationSeconds: 42.5,
|
|
Success: true,
|
|
})
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("MissingSessionID", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := client.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
EventType: codersdk.TemplateBuilderSessionEventWizardEntry,
|
|
})
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusBadRequest, sdkErr.StatusCode())
|
|
})
|
|
|
|
t.Run("InvalidEventType", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := client.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
EventType: "invalid_event",
|
|
})
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusBadRequest, sdkErr.StatusCode())
|
|
})
|
|
|
|
t.Run("DisabledReturns404", func(t *testing.T) {
|
|
t.Parallel()
|
|
dv := coderdtest.DeploymentValues(t)
|
|
dv.TemplateBuilder.Disabled = true
|
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
DeploymentValues: dv,
|
|
})
|
|
_ = coderdtest.CreateFirstUser(t, client)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := client.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
EventType: codersdk.TemplateBuilderSessionEventWizardEntry,
|
|
})
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
|
|
})
|
|
|
|
t.Run("MemberCannotSubmit", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, nil)
|
|
admin := coderdtest.CreateFirstUser(t, client)
|
|
|
|
memberClient, _ := coderdtest.CreateAnotherUser(t, client, admin.OrganizationID)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
|
|
err := memberClient.TemplateBuilderSession(ctx, codersdk.TemplateBuilderSessionRequest{
|
|
EventType: codersdk.TemplateBuilderSessionEventWizardEntry,
|
|
})
|
|
require.Error(t, err)
|
|
|
|
var sdkErr *codersdk.Error
|
|
require.ErrorAs(t, err, &sdkErr)
|
|
require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
|
|
})
|
|
}
|