Files
coder/coderd/provisionerdserver/script_dependencies_internal_test.go
Bobby Ho dae7967bd1 feat: persist script resource addresses and dependencies (#30625)
feat(coderd): persist workspace agent script dependencies

Persist Terraform resource addresses and script dependencies supplied by
the provisioner (#30451, #30491), and expose them through the SDK and
REST API.

- Add migration 000618 with `resource_address` and `dependencies`
  columns, empty defaults, and a JSON-array constraint. API responses
  always include the address and omit empty dependency lists.
- Preserve `success` and `completion` requirements, including scripts
  on devcontainer subagents. Legacy scripts and older provisioners
  remain compatible through empty defaults.
- Reject empty prerequisite addresses and unsupported requirements,
  rolling back the entire job. Invalid stored dependencies return HTTP
  500 rather than silently dropping ordering.
- Add persistence, validation, rollback, devcontainer, API, and migration
  coverage; regenerate API docs and TypeScript types.

Unordered templates retain their existing execution behavior.
Dependency lists remain empty until #30556. Agent manifest wiring and
the agent API version bump are deferred to a follow-up.

Refs PLAT-548.
2026-10-13 03:43:55 +00:00

85 lines
2.4 KiB
Go

package provisionerdserver
import (
"testing"
"github.com/stretchr/testify/require"
sdkproto "github.com/coder/coder/v2/provisionersdk/proto"
)
func TestScriptDependenciesJSON(t *testing.T) {
t.Parallel()
cases := []struct {
name string
dependencies []*sdkproto.ScriptDependency
want string
wantErr string
}{
{
name: "NilIsEmptyArray",
want: `[]`,
},
{
name: "TwoEntriesKeepOrder",
dependencies: []*sdkproto.ScriptDependency{
{
PrerequisiteResourceAddress: "coder_script.clone_repo",
Requirement: sdkproto.ScriptDependencyRequirement_SCRIPT_DEPENDENCY_REQUIREMENT_SUCCESS,
},
{
PrerequisiteResourceAddress: "coder_script.warm_cache",
Requirement: sdkproto.ScriptDependencyRequirement_SCRIPT_DEPENDENCY_REQUIREMENT_COMPLETION,
},
},
want: `[{"prerequisite_resource_address":"coder_script.clone_repo","requirement":"success"},` +
`{"prerequisite_resource_address":"coder_script.warm_cache","requirement":"completion"}]`,
},
{
name: "UnspecifiedRequirement",
dependencies: []*sdkproto.ScriptDependency{{
PrerequisiteResourceAddress: "coder_script.clone_repo",
Requirement: sdkproto.ScriptDependencyRequirement_SCRIPT_DEPENDENCY_REQUIREMENT_UNSPECIFIED,
}},
wantErr: "dependency 0: unsupported requirement",
},
{
name: "UnknownRequirement",
dependencies: []*sdkproto.ScriptDependency{{
PrerequisiteResourceAddress: "coder_script.clone_repo",
Requirement: sdkproto.ScriptDependencyRequirement(99),
}},
wantErr: "dependency 0: unsupported requirement",
},
{
name: "EmptyAddress",
dependencies: []*sdkproto.ScriptDependency{
{
PrerequisiteResourceAddress: "coder_script.clone_repo",
Requirement: sdkproto.ScriptDependencyRequirement_SCRIPT_DEPENDENCY_REQUIREMENT_SUCCESS,
},
{
PrerequisiteResourceAddress: "",
Requirement: sdkproto.ScriptDependencyRequirement_SCRIPT_DEPENDENCY_REQUIREMENT_SUCCESS,
},
},
wantErr: "dependency 1 has an empty prerequisite resource address",
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
got, err := scriptDependenciesJSON(tc.dependencies)
if tc.wantErr != "" {
require.ErrorContains(t, err, tc.wantErr)
return
}
require.NoError(t, err)
require.JSONEq(t, tc.want, got)
})
}
}