Skip to content

Commit 120a70a

Browse files
kylecarbskylecarbs
committed
Add deprecated key to codersdk parameter values
1 parent 4cd5826 commit 120a70a

17 files changed

+147
-147
lines changed

‎cli/cliui/parameter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/coder/coder/codersdk"
1111
)
1212

13-
func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.ParameterSchema) (string, error) {
13+
func ParameterSchema(cmd *cobra.Command, parameterSchema codersdk.DeprecatedParameterSchema) (string, error) {
1414
_, _ = fmt.Fprintln(cmd.OutOrStdout(), Styles.Bold.Render("var."+parameterSchema.Name))
1515
if parameterSchema.Description != "" {
1616
_, _ = fmt.Fprintln(cmd.OutOrStdout(), " "+strings.TrimSpace(strings.Join(strings.Split(parameterSchema.Description, "\n"), "\n "))+"\n")

‎cli/create.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ func create() *cobra.Command {
123123

124124
parameters, err := prepWorkspaceBuild(cmd, client, prepWorkspaceBuildArgs{
125125
Template: template,
126-
ExistingParams: []codersdk.Parameter{},
126+
ExistingParams: []codersdk.DeprecatedParameter{},
127127
ParameterFile: parameterFile,
128128
NewWorkspaceName: workspaceName,
129129
})
@@ -171,14 +171,14 @@ func create() *cobra.Command {
171171

172172
type prepWorkspaceBuildArgs struct {
173173
Template codersdk.Template
174-
ExistingParams []codersdk.Parameter
174+
ExistingParams []codersdk.DeprecatedParameter
175175
ParameterFile string
176176
NewWorkspaceName string
177177
}
178178

179179
// prepWorkspaceBuild will ensure a workspace build will succeed on the latest template version.
180180
// Any missing params will be prompted to the user.
181-
func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWorkspaceBuildArgs) ([]codersdk.CreateParameterRequest, error) {
181+
func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWorkspaceBuildArgs) ([]codersdk.DeprecatedCreateParameterRequest, error) {
182182
ctx := cmd.Context()
183183
templateVersion, err := client.TemplateVersion(ctx, args.Template.ActiveVersionID)
184184
if err != nil {
@@ -201,7 +201,7 @@ func prepWorkspaceBuild(cmd *cobra.Command, client *codersdk.Client, args prepWo
201201
}
202202
}
203203
disclaimerPrinted := false
204-
parameters := make([]codersdk.CreateParameterRequest, 0)
204+
parameters := make([]codersdk.DeprecatedCreateParameterRequest, 0)
205205
PromptParamLoop:
206206
for _, parameterSchema := range parameterSchemas {
207207
if !parameterSchema.AllowOverrideSource {
@@ -228,10 +228,10 @@ PromptParamLoop:
228228
return nil, err
229229
}
230230

231-
parameters = append(parameters, codersdk.CreateParameterRequest{
231+
parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
232232
Name: parameterSchema.Name,
233233
SourceValue: parameterValue,
234-
SourceScheme: codersdk.ParameterSourceSchemeData,
234+
SourceScheme: codersdk.DeprecatedParameterSourceSchemeData,
235235
DestinationScheme: parameterSchema.DefaultDestinationScheme,
236236
})
237237
}

‎cli/parameter.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func createParameterMapFromFile(parameterFile string) (map[string]string, error)
3838

3939
// Returns a parameter value from a given map, if the map exists, else takes input from the user.
4040
// Throws an error if the map exists but does not include a value for the parameter.
41-
func getParameterValueFromMapOrInput(cmd *cobra.Command, parameterMap map[string]string, parameterSchema codersdk.ParameterSchema) (string, error) {
41+
func getParameterValueFromMapOrInput(cmd *cobra.Command, parameterMap map[string]string, parameterSchema codersdk.DeprecatedParameterSchema) (string, error) {
4242
var parameterValue string
4343
if parameterMap != nil {
4444
var ok bool

‎cli/parameterslist.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ func parameterList() *cobra.Command {
3333
}
3434

3535
var scopeID uuid.UUID
36-
switch codersdk.ParameterScope(scope) {
37-
case codersdk.ParameterWorkspace:
36+
switch codersdk.DeprecatedParameterScope(scope) {
37+
case codersdk.DeprecatedParameterWorkspace:
3838
workspace, err := namedWorkspace(cmd, client, name)
3939
if err != nil {
4040
return err
4141
}
4242
scopeID = workspace.ID
43-
case codersdk.ParameterTemplate:
43+
case codersdk.DeprecatedParameterTemplate:
4444
template, err := client.TemplateByName(cmd.Context(), organization.ID, name)
4545
if err != nil {
4646
return xerrors.Errorf("get workspace template: %w", err)
4747
}
4848
scopeID = template.ID
49-
case codersdk.ParameterImportJob, "template_version":
50-
scope = string(codersdk.ParameterImportJob)
49+
case codersdk.DeprecatedParameterImportJob, "template_version":
50+
scope = string(codersdk.DeprecatedParameterImportJob)
5151
scopeID, err = uuid.Parse(name)
5252
if err != nil {
5353
return xerrors.Errorf("%q must be a uuid for this scope type", name)
@@ -61,12 +61,12 @@ func parameterList() *cobra.Command {
6161
}
6262

6363
default:
64-
return xerrors.Errorf("%q is an unsupported scope, use %v", scope, []codersdk.ParameterScope{
65-
codersdk.ParameterWorkspace, codersdk.ParameterTemplate, codersdk.ParameterImportJob,
64+
return xerrors.Errorf("%q is an unsupported scope, use %v", scope, []codersdk.DeprecatedParameterScope{
65+
codersdk.DeprecatedParameterWorkspace, codersdk.DeprecatedParameterTemplate, codersdk.DeprecatedParameterImportJob,
6666
})
6767
}
6868

69-
params, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterScope(scope), scopeID)
69+
params, err := client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterScope(scope), scopeID)
7070
if err != nil {
7171
return xerrors.Errorf("fetch params: %w", err)
7272
}

‎cli/templatecreate.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ type createValidTemplateVersionArgs struct {
158158
ReuseParameters bool
159159
}
160160

161-
func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVersionArgs, parameters ...codersdk.CreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.CreateParameterRequest, error) {
161+
func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVersionArgs, parameters ...codersdk.DeprecatedCreateParameterRequest) (*codersdk.TemplateVersion, []codersdk.DeprecatedCreateParameterRequest, error) {
162162
before := time.Now()
163163
client := args.Client
164164

@@ -210,15 +210,15 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
210210
// lastParameterValues are pulled from the current active template version if
211211
// templateID is provided. This allows pulling params from the last
212212
// version instead of prompting if we are updating template versions.
213-
lastParameterValues := make(map[string]codersdk.Parameter)
213+
lastParameterValues := make(map[string]codersdk.DeprecatedParameter)
214214
if args.ReuseParameters && args.Template != nil {
215215
activeVersion, err := client.TemplateVersion(cmd.Context(), args.Template.ActiveVersionID)
216216
if err != nil {
217217
return nil, nil, xerrors.Errorf("Fetch current active template version: %w", err)
218218
}
219219

220220
// We don't want to compute the params, we only want to copy from this scope
221-
values, err := client.DeprecatedParameters(cmd.Context(), codersdk.ParameterImportJob, activeVersion.Job.ID)
221+
values, err := client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterImportJob, activeVersion.Job.ID)
222222
if err != nil {
223223
return nil, nil, xerrors.Errorf("Fetch previous version parameters: %w", err)
224224
}
@@ -228,7 +228,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
228228
}
229229

230230
if provisionerd.IsMissingParameterError(version.Job.Error) {
231-
valuesBySchemaID := map[string]codersdk.ComputedParameter{}
231+
valuesBySchemaID := map[string]codersdk.DeprecatedComputedParameter{}
232232
for _, parameterValue := range parameterValues {
233233
valuesBySchemaID[parameterValue.SchemaID.String()] = parameterValue
234234
}
@@ -245,7 +245,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
245245

246246
// pulled params come from the last template version
247247
pulled := make([]string, 0)
248-
missingSchemas := make([]codersdk.ParameterSchema, 0)
248+
missingSchemas := make([]codersdk.DeprecatedParameterSchema, 0)
249249
for _, parameterSchema := range parameterSchemas {
250250
_, ok := valuesBySchemaID[parameterSchema.ID.String()]
251251
if ok {
@@ -258,7 +258,7 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
258258
if inherit, ok := lastParameterValues[parameterSchema.Name]; ok && !fileOk {
259259
// If the value is not in the param file, and can be pulled from the last template version,
260260
// then don't mark it as missing.
261-
parameters = append(parameters, codersdk.CreateParameterRequest{
261+
parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
262262
CloneID: inherit.ID,
263263
})
264264
pulled = append(pulled, fmt.Sprintf("%q", parameterSchema.Name))
@@ -279,10 +279,10 @@ func createValidTemplateVersion(cmd *cobra.Command, args createValidTemplateVers
279279
if err != nil {
280280
return nil, nil, err
281281
}
282-
parameters = append(parameters, codersdk.CreateParameterRequest{
282+
parameters = append(parameters, codersdk.DeprecatedCreateParameterRequest{
283283
Name: parameterSchema.Name,
284284
SourceValue: parameterValue,
285-
SourceScheme: codersdk.ParameterSourceSchemeData,
285+
SourceScheme: codersdk.DeprecatedParameterSourceSchemeData,
286286
DestinationScheme: parameterSchema.DefaultDestinationScheme,
287287
})
288288
_, _ = fmt.Fprintln(cmd.OutOrStdout())

‎cli/templatepush_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,15 +210,15 @@ func TestTemplatePush(t *testing.T) {
210210
})
211211
}
212212

213-
func latestTemplateVersion(t *testing.T, client *codersdk.Client, templateID uuid.UUID) (codersdk.TemplateVersion, []codersdk.Parameter) {
213+
func latestTemplateVersion(t *testing.T, client *codersdk.Client, templateID uuid.UUID) (codersdk.TemplateVersion, []codersdk.DeprecatedParameter) {
214214
t.Helper()
215215

216216
ctx := context.Background()
217217
newTemplate, err := client.Template(ctx, templateID)
218218
require.NoError(t, err)
219219
tv, err := client.TemplateVersion(ctx, newTemplate.ActiveVersionID)
220220
require.NoError(t, err)
221-
params, err := client.DeprecatedParameters(ctx, codersdk.ParameterImportJob, tv.Job.ID)
221+
params, err := client.DeprecatedParameters(ctx, codersdk.DeprecatedParameterImportJob, tv.Job.ID)
222222
require.NoError(t, err)
223223

224224
return tv, params

‎cli/update.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ func update() *cobra.Command {
3939
return nil
4040
}
4141

42-
var existingParams []codersdk.Parameter
42+
var existingParams []codersdk.DeprecatedParameter
4343
if !alwaysPrompt {
44-
existingParams, err = client.DeprecatedParameters(cmd.Context(), codersdk.ParameterWorkspace, workspace.ID)
44+
existingParams, err = client.DeprecatedParameters(cmd.Context(), codersdk.DeprecatedParameterWorkspace, workspace.ID)
4545
if err != nil {
4646
return nil
4747
}

‎coderd/coderdtest/authorize.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ type AuthTester struct {
298298
WorkspaceResource codersdk.WorkspaceResource
299299
File codersdk.UploadResponse
300300
TemplateVersionDryRun codersdk.ProvisionerJob
301-
TemplateParam codersdk.Parameter
301+
TemplateParam codersdk.DeprecatedParameter
302302
URLParams map[string]string
303303
}
304304

@@ -354,15 +354,15 @@ func NewAuthTester(ctx context.Context, t *testing.T, client *codersdk.Client, a
354354
workspaceResources, err := client.WorkspaceResourcesByBuild(ctx, workspace.LatestBuild.ID)
355355
require.NoError(t, err, "workspace resources")
356356
templateVersionDryRun, err := client.CreateTemplateVersionDryRun(ctx, version.ID, codersdk.CreateTemplateVersionDryRunRequest{
357-
ParameterValues: []codersdk.CreateParameterRequest{},
357+
ParameterValues: []codersdk.DeprecatedCreateParameterRequest{},
358358
})
359359
require.NoError(t, err, "template version dry-run")
360360

361-
templateParam, err := client.DeprecatedCreateParameter(ctx, codersdk.ParameterTemplate, template.ID, codersdk.CreateParameterRequest{
361+
templateParam, err := client.DeprecatedCreateParameter(ctx, codersdk.DeprecatedParameterTemplate, template.ID, codersdk.DeprecatedCreateParameterRequest{
362362
Name: "test-param",
363363
SourceValue: "hello world",
364-
SourceScheme: codersdk.ParameterSourceSchemeData,
365-
DestinationScheme: codersdk.ParameterDestinationSchemeProvisionerVariable,
364+
SourceScheme: codersdk.DeprecatedParameterSourceSchemeData,
365+
DestinationScheme: codersdk.DeprecatedParameterDestinationSchemeProvisionerVariable,
366366
})
367367
require.NoError(t, err, "create template param")
368368
urlParameters := map[string]string{

‎coderd/parameters.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func (api *API) deprecatedPostParameter(rw http.ResponseWriter, r *http.Request)
3333
return
3434
}
3535

36-
var createRequest codersdk.CreateParameterRequest
36+
var createRequest codersdk.DeprecatedCreateParameterRequest
3737
if !httpapi.Read(ctx, rw, r, &createRequest) {
3838
return
3939
}
@@ -108,7 +108,7 @@ func (api *API) deprecatedParameters(rw http.ResponseWriter, r *http.Request) {
108108
})
109109
return
110110
}
111-
apiParameterValues := make([]codersdk.Parameter, 0, len(parameterValues))
111+
apiParameterValues := make([]codersdk.DeprecatedParameter, 0, len(parameterValues))
112112
for _, parameterValue := range parameterValues {
113113
apiParameterValues = append(apiParameterValues, convertParameterValue(parameterValue))
114114
}
@@ -162,26 +162,26 @@ func (api *API) deprecatedDeleteParameter(rw http.ResponseWriter, r *http.Reques
162162
})
163163
}
164164

165-
func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.ParameterSchema, error) {
165+
func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.DeprecatedParameterSchema, error) {
166166
contains := []string{}
167167
if parameterSchema.ValidationCondition != "" {
168168
var err error
169169
contains, _, err = parameter.Contains(parameterSchema.ValidationCondition)
170170
if err != nil {
171-
return codersdk.ParameterSchema{}, xerrors.Errorf("parse validation condition for %q: %w", parameterSchema.Name, err)
171+
return codersdk.DeprecatedParameterSchema{}, xerrors.Errorf("parse validation condition for %q: %w", parameterSchema.Name, err)
172172
}
173173
}
174174

175-
return codersdk.ParameterSchema{
175+
return codersdk.DeprecatedParameterSchema{
176176
ID: parameterSchema.ID,
177177
CreatedAt: parameterSchema.CreatedAt,
178178
JobID: parameterSchema.JobID,
179179
Name: parameterSchema.Name,
180180
Description: parameterSchema.Description,
181-
DefaultSourceScheme: codersdk.ParameterSourceScheme(parameterSchema.DefaultSourceScheme),
181+
DefaultSourceScheme: codersdk.DeprecatedParameterSourceScheme(parameterSchema.DefaultSourceScheme),
182182
DefaultSourceValue: parameterSchema.DefaultSourceValue,
183183
AllowOverrideSource: parameterSchema.AllowOverrideSource,
184-
DefaultDestinationScheme: codersdk.ParameterDestinationScheme(parameterSchema.DefaultDestinationScheme),
184+
DefaultDestinationScheme: codersdk.DeprecatedParameterDestinationScheme(parameterSchema.DefaultDestinationScheme),
185185
AllowOverrideDestination: parameterSchema.AllowOverrideDestination,
186186
DefaultRefresh: parameterSchema.DefaultRefresh,
187187
RedisplayValue: parameterSchema.RedisplayValue,
@@ -193,16 +193,16 @@ func convertParameterSchema(parameterSchema database.ParameterSchema) (codersdk.
193193
}, nil
194194
}
195195

196-
func convertParameterValue(parameterValue database.ParameterValue) codersdk.Parameter {
197-
return codersdk.Parameter{
196+
func convertParameterValue(parameterValue database.ParameterValue) codersdk.DeprecatedParameter {
197+
return codersdk.DeprecatedParameter{
198198
ID: parameterValue.ID,
199199
CreatedAt: parameterValue.CreatedAt,
200200
UpdatedAt: parameterValue.UpdatedAt,
201-
Scope: codersdk.ParameterScope(parameterValue.Scope),
201+
Scope: codersdk.DeprecatedParameterScope(parameterValue.Scope),
202202
ScopeID: parameterValue.ScopeID,
203203
Name: parameterValue.Name,
204-
SourceScheme: codersdk.ParameterSourceScheme(parameterValue.SourceScheme),
205-
DestinationScheme: codersdk.ParameterDestinationScheme(parameterValue.DestinationScheme),
204+
SourceScheme: codersdk.DeprecatedParameterSourceScheme(parameterValue.SourceScheme),
205+
DestinationScheme: codersdk.DeprecatedParameterDestinationScheme(parameterValue.DestinationScheme),
206206
}
207207
}
208208

0 commit comments

Comments
 (0)