Skip to content

chore: refactor dynamic parameters into dedicated package #18420

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.

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 24 commits into from
Jun 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
129 changes: 129 additions & 0 deletions coderd/coderdtest/dynamicparameters.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
package coderdtest

import (
"encoding/json"
"testing"

"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/coderd/util/ptr"
"github.com/coder/coder/v2/coderd/util/slice"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/provisioner/echo"
"github.com/coder/coder/v2/provisionersdk/proto"
)

type DynamicParameterTemplateParams struct {
MainTF string
Plan json.RawMessage
ModulesArchive []byte

// StaticParams is used if the provisioner daemon version does not support dynamic parameters.
StaticParams []*proto.RichParameter
}

func DynamicParameterTemplate(t *testing.T, client *codersdk.Client, org uuid.UUID, args DynamicParameterTemplateParams) (codersdk.Template, codersdk.TemplateVersion) {
t.Helper()

files := echo.WithExtraFiles(map[string][]byte{
"main.tf": []byte(args.MainTF),
})
files.ProvisionPlan = []*proto.Response{{
Type: &proto.Response_Plan{
Plan: &proto.PlanComplete{
Plan: args.Plan,
ModuleFiles: args.ModulesArchive,
Parameters: args.StaticParams,
},
},
}}

version := CreateTemplateVersion(t, client, org, files)
AwaitTemplateVersionJobCompleted(t, client, version.ID)
tpl := CreateTemplate(t, client, org, version.ID)

var err error
tpl, err = client.UpdateTemplateMeta(t.Context(), tpl.ID, codersdk.UpdateTemplateMeta{
UseClassicParameterFlow: ptr.Ref(false),
})
require.NoError(t, err)

return tpl, version
}

type ParameterAsserter struct {
Name string
Params []codersdk.PreviewParameter
t *testing.T
}

func AssertParameter(t *testing.T, name string, params []codersdk.PreviewParameter) *ParameterAsserter {
return &ParameterAsserter{
Name: name,
Params: params,
t: t,
}
}

func (a *ParameterAsserter) find(name string) *codersdk.PreviewParameter {
a.t.Helper()
for _, p := range a.Params {
if p.Name == name {
return &p
}
}

assert.Fail(a.t, "parameter not found", "expected parameter %q to exist", a.Name)
return nil
}

func (a *ParameterAsserter) NotExists() *ParameterAsserter {
a.t.Helper()

names := slice.Convert(a.Params, func(p codersdk.PreviewParameter) string {
return p.Name
})

assert.NotContains(a.t, names, a.Name)
return a
}

func (a *ParameterAsserter) Exists() *ParameterAsserter {
a.t.Helper()

names := slice.Convert(a.Params, func(p codersdk.PreviewParameter) string {
return p.Name
})

assert.Contains(a.t, names, a.Name)
return a
}

func (a *ParameterAsserter) Value(expected string) *ParameterAsserter {
a.t.Helper()

p := a.find(a.Name)
if p == nil {
return a
}

assert.Equal(a.t, expected, p.Value.Value)
return a
}

func (a *ParameterAsserter) Options(expected ...string) *ParameterAsserter {
a.t.Helper()

p := a.find(a.Name)
if p == nil {
return a
}

optValues := slice.Convert(p.Options, func(p codersdk.PreviewParameterOption) string {
return p.Value.Value
})
assert.ElementsMatch(a.t, expected, optValues, "parameter %q options", a.Name)
return a
}
25 changes: 25 additions & 0 deletions coderd/coderdtest/stream.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package coderdtest

import "github.com/coder/coder/v2/codersdk/wsjson"

// SynchronousStream returns a function that assumes the stream is synchronous.
// Meaning each request sent assumes exactly one response will be received.
// The function will block until the response is received or an error occurs.
//
// This should not be used in production code, as it does not handle edge cases.
// The second function `pop` can be used to retrieve the next response from the
// stream without sending a new request. This is useful for dynamic parameters
func SynchronousStream[R any, W any](stream *wsjson.Stream[R, W]) (do func(W) (R, error), pop func() R) {
rec := stream.Chan()

return func(req W) (R, error) {
err := stream.Send(req)
if err != nil {
return *new(R), err
}

return <-rec, nil
}, func() R {
return <-rec
}
}
Loading
Loading