Skip to content

Commit 95b29d7

Browse files
deansheatherpull[bot]
deansheather
authored and
pull[bot]
committed
chore: rename template restart requirement to autostop requirement (#9295)
1 parent 37a6c76 commit 95b29d7

40 files changed

+925
-891
lines changed

‎cli/schedule_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,8 @@ func TestScheduleOverride(t *testing.T) {
316316
stdoutBuf = &bytes.Buffer{}
317317
)
318318
require.Zero(t, template.DefaultTTLMillis)
319-
require.Empty(t, template.RestartRequirement.DaysOfWeek)
320-
require.Zero(t, template.RestartRequirement.Weeks)
319+
require.Empty(t, template.AutostopRequirement.DaysOfWeek)
320+
require.Zero(t, template.AutostopRequirement.Weeks)
321321

322322
// Unset the workspace TTL
323323
err = client.UpdateWorkspaceTTL(ctx, workspace.ID, codersdk.UpdateWorkspaceTTLRequest{TTLMillis: nil})

‎cli/templateedit.go

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ import (
1515

1616
func (r *RootCmd) templateEdit() *clibase.Cmd {
1717
var (
18-
name string
19-
displayName string
20-
description string
21-
icon string
22-
defaultTTL time.Duration
23-
maxTTL time.Duration
24-
restartRequirementDaysOfWeek []string
25-
restartRequirementWeeks int64
26-
failureTTL time.Duration
27-
inactivityTTL time.Duration
28-
allowUserCancelWorkspaceJobs bool
29-
allowUserAutostart bool
30-
allowUserAutostop bool
18+
name string
19+
displayName string
20+
description string
21+
icon string
22+
defaultTTL time.Duration
23+
maxTTL time.Duration
24+
autostopRequirementDaysOfWeek []string
25+
autostopRequirementWeeks int64
26+
failureTTL time.Duration
27+
inactivityTTL time.Duration
28+
allowUserCancelWorkspaceJobs bool
29+
allowUserAutostart bool
30+
allowUserAutostop bool
3131
)
3232
client := new(codersdk.Client)
3333

@@ -51,9 +51,9 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
5151
}
5252
}
5353

54-
unsetRestartRequirementDaysOfWeek := len(restartRequirementDaysOfWeek) == 1 && restartRequirementDaysOfWeek[0] == "none"
55-
requiresEntitlement := (len(restartRequirementDaysOfWeek) > 0 && !unsetRestartRequirementDaysOfWeek) ||
56-
restartRequirementWeeks > 0 ||
54+
unsetAutostopRequirementDaysOfWeek := len(autostopRequirementDaysOfWeek) == 1 && autostopRequirementDaysOfWeek[0] == "none"
55+
requiresEntitlement := (len(autostopRequirementDaysOfWeek) > 0 && !unsetAutostopRequirementDaysOfWeek) ||
56+
autostopRequirementWeeks > 0 ||
5757
!allowUserAutostart ||
5858
!allowUserAutostop ||
5959
maxTTL != 0 ||
@@ -84,11 +84,11 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
8484

8585
// Copy the default value if the list is empty, or if the user
8686
// specified the "none" value clear the list.
87-
if len(restartRequirementDaysOfWeek) == 0 {
88-
restartRequirementDaysOfWeek = template.RestartRequirement.DaysOfWeek
87+
if len(autostopRequirementDaysOfWeek) == 0 {
88+
autostopRequirementDaysOfWeek = template.AutostopRequirement.DaysOfWeek
8989
}
90-
if unsetRestartRequirementDaysOfWeek {
91-
restartRequirementDaysOfWeek = []string{}
90+
if unsetAutostopRequirementDaysOfWeek {
91+
autostopRequirementDaysOfWeek = []string{}
9292
}
9393

9494
// NOTE: coderd will ignore empty fields.
@@ -99,9 +99,9 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
9999
Icon: icon,
100100
DefaultTTLMillis: defaultTTL.Milliseconds(),
101101
MaxTTLMillis: maxTTL.Milliseconds(),
102-
RestartRequirement: &codersdk.TemplateRestartRequirement{
103-
DaysOfWeek: restartRequirementDaysOfWeek,
104-
Weeks: restartRequirementWeeks,
102+
AutostopRequirement: &codersdk.TemplateAutostopRequirement{
103+
DaysOfWeek: autostopRequirementDaysOfWeek,
104+
Weeks: autostopRequirementWeeks,
105105
},
106106
FailureTTLMillis: failureTTL.Milliseconds(),
107107
TimeTilDormantMillis: inactivityTTL.Milliseconds(),
@@ -151,28 +151,28 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
151151
Value: clibase.DurationOf(&maxTTL),
152152
},
153153
{
154-
Flag: "restart-requirement-weekdays",
155-
Description: "Edit the template restart requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the restart requirement for the template), pass 'none'.",
154+
Flag: "autostop-requirement-weekdays",
155+
Description: "Edit the template autostop requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the autostop requirement for the template), pass 'none'.",
156156
// TODO(@dean): unhide when we delete max_ttl
157157
Hidden: true,
158-
Value: clibase.Validate(clibase.StringArrayOf(&restartRequirementDaysOfWeek), func(value *clibase.StringArray) error {
158+
Value: clibase.Validate(clibase.StringArrayOf(&autostopRequirementDaysOfWeek), func(value *clibase.StringArray) error {
159159
v := value.GetSlice()
160160
if len(v) == 1 && v[0] == "none" {
161161
return nil
162162
}
163163
_, err := codersdk.WeekdaysToBitmap(v)
164164
if err != nil {
165-
return xerrors.Errorf("invalid restart requirement days of week %q: %w", strings.Join(v, ","), err)
165+
return xerrors.Errorf("invalid autostop requirement days of week %q: %w", strings.Join(v, ","), err)
166166
}
167167
return nil
168168
}),
169169
},
170170
{
171-
Flag: "restart-requirement-weeks",
172-
Description: "Edit the template restart requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.",
171+
Flag: "autostop-requirement-weeks",
172+
Description: "Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.",
173173
// TODO(@dean): unhide when we delete max_ttl
174174
Hidden: true,
175-
Value: clibase.Int64Of(&restartRequirementWeeks),
175+
Value: clibase.Int64Of(&autostopRequirementWeeks),
176176
},
177177
{
178178
Flag: "failure-ttl",

‎cli/templateedit_test.go

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ func TestTemplateEdit(t *testing.T) {
242242
assert.Equal(t, "", updated.Icon)
243243
assert.Equal(t, "", updated.DisplayName)
244244
})
245-
t.Run("RestartRequirement", func(t *testing.T) {
245+
t.Run("AutostopRequirement", func(t *testing.T) {
246246
t.Parallel()
247247
t.Run("BlockedAGPL", func(t *testing.T) {
248248
t.Parallel()
@@ -252,7 +252,7 @@ func TestTemplateEdit(t *testing.T) {
252252
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
253253
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
254254
ctr.DefaultTTLMillis = nil
255-
ctr.RestartRequirement = nil
255+
ctr.AutostopRequirement = nil
256256
})
257257

258258
cases := []struct {
@@ -263,20 +263,20 @@ func TestTemplateEdit(t *testing.T) {
263263
{
264264
name: "Weekdays",
265265
flags: []string{
266-
"--restart-requirement-weekdays", "monday",
266+
"--autostop-requirement-weekdays", "monday",
267267
},
268268
},
269269
{
270270
name: "WeekdaysNoneAllowed",
271271
flags: []string{
272-
"--restart-requirement-weekdays", "none",
272+
"--autostop-requirement-weekdays", "none",
273273
},
274274
ok: true,
275275
},
276276
{
277277
name: "Weeks",
278278
flags: []string{
279-
"--restart-requirement-weeks", "1",
279+
"--autostop-requirement-weeks", "1",
280280
},
281281
},
282282
}
@@ -312,8 +312,8 @@ func TestTemplateEdit(t *testing.T) {
312312
assert.Equal(t, template.Icon, updated.Icon)
313313
assert.Equal(t, template.DisplayName, updated.DisplayName)
314314
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
315-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
316-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
315+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
316+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
317317
})
318318
}
319319
})
@@ -326,7 +326,7 @@ func TestTemplateEdit(t *testing.T) {
326326
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
327327
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
328328
ctr.DefaultTTLMillis = nil
329-
ctr.RestartRequirement = nil
329+
ctr.AutostopRequirement = nil
330330
})
331331

332332
// Make a proxy server that will return a valid entitlements
@@ -377,20 +377,20 @@ func TestTemplateEdit(t *testing.T) {
377377
{
378378
name: "Weekdays",
379379
flags: []string{
380-
"--restart-requirement-weekdays", "monday",
380+
"--autostop-requirement-weekdays", "monday",
381381
},
382382
},
383383
{
384384
name: "WeekdaysNoneAllowed",
385385
flags: []string{
386-
"--restart-requirement-weekdays", "none",
386+
"--autostop-requirement-weekdays", "none",
387387
},
388388
ok: true,
389389
},
390390
{
391391
name: "Weeks",
392392
flags: []string{
393-
"--restart-requirement-weeks", "1",
393+
"--autostop-requirement-weeks", "1",
394394
},
395395
},
396396
}
@@ -426,8 +426,8 @@ func TestTemplateEdit(t *testing.T) {
426426
assert.Equal(t, template.Icon, updated.Icon)
427427
assert.Equal(t, template.DisplayName, updated.DisplayName)
428428
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
429-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
430-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
429+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
430+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
431431
})
432432
}
433433
})
@@ -439,7 +439,7 @@ func TestTemplateEdit(t *testing.T) {
439439
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
440440
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
441441
ctr.DefaultTTLMillis = nil
442-
ctr.RestartRequirement = nil
442+
ctr.AutostopRequirement = nil
443443
})
444444

445445
// Make a proxy server that will return a valid entitlements
@@ -475,8 +475,8 @@ func TestTemplateEdit(t *testing.T) {
475475
var req codersdk.UpdateTemplateMeta
476476
err = json.Unmarshal(body, &req)
477477
require.NoError(t, err)
478-
assert.Equal(t, req.RestartRequirement.DaysOfWeek, []string{"monday", "tuesday"})
479-
assert.EqualValues(t, req.RestartRequirement.Weeks, 3)
478+
assert.Equal(t, req.AutostopRequirement.DaysOfWeek, []string{"monday", "tuesday"})
479+
assert.EqualValues(t, req.AutostopRequirement.Weeks, 3)
480480

481481
r.Body = io.NopCloser(bytes.NewReader(body))
482482
atomic.AddInt64(&updateTemplateCalled, 1)
@@ -504,8 +504,8 @@ func TestTemplateEdit(t *testing.T) {
504504
"templates",
505505
"edit",
506506
template.Name,
507-
"--restart-requirement-weekdays", "monday,tuesday",
508-
"--restart-requirement-weeks", "3",
507+
"--autostop-requirement-weekdays", "monday,tuesday",
508+
"--autostop-requirement-weeks", "3",
509509
}
510510
inv, root := clitest.New(t, cmdArgs...)
511511
clitest.SetupConfig(t, proxyClient, root)
@@ -525,8 +525,8 @@ func TestTemplateEdit(t *testing.T) {
525525
assert.Equal(t, template.Icon, updated.Icon)
526526
assert.Equal(t, template.DisplayName, updated.DisplayName)
527527
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
528-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
529-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
528+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
529+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
530530
})
531531
})
532532
// TODO(@dean): remove this test when we remove max_ttl
@@ -750,7 +750,7 @@ func TestTemplateEdit(t *testing.T) {
750750
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
751751
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
752752
ctr.DefaultTTLMillis = nil
753-
ctr.RestartRequirement = nil
753+
ctr.AutostopRequirement = nil
754754
ctr.FailureTTLMillis = nil
755755
ctr.TimeTilDormantMillis = nil
756756
})
@@ -793,8 +793,8 @@ func TestTemplateEdit(t *testing.T) {
793793
assert.Equal(t, template.Icon, updated.Icon)
794794
assert.Equal(t, template.DisplayName, updated.DisplayName)
795795
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
796-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
797-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
796+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
797+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
798798
assert.Equal(t, template.AllowUserAutostart, updated.AllowUserAutostart)
799799
assert.Equal(t, template.AllowUserAutostop, updated.AllowUserAutostop)
800800
assert.Equal(t, template.FailureTTLMillis, updated.FailureTTLMillis)
@@ -887,8 +887,8 @@ func TestTemplateEdit(t *testing.T) {
887887
assert.Equal(t, template.Icon, updated.Icon)
888888
assert.Equal(t, template.DisplayName, updated.DisplayName)
889889
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
890-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
891-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
890+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
891+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
892892
assert.Equal(t, template.AllowUserAutostart, updated.AllowUserAutostart)
893893
assert.Equal(t, template.AllowUserAutostop, updated.AllowUserAutostop)
894894
assert.Equal(t, template.FailureTTLMillis, updated.FailureTTLMillis)
@@ -985,8 +985,8 @@ func TestTemplateEdit(t *testing.T) {
985985
assert.Equal(t, template.Icon, updated.Icon)
986986
assert.Equal(t, template.DisplayName, updated.DisplayName)
987987
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
988-
assert.Equal(t, template.RestartRequirement.DaysOfWeek, updated.RestartRequirement.DaysOfWeek)
989-
assert.Equal(t, template.RestartRequirement.Weeks, updated.RestartRequirement.Weeks)
988+
assert.Equal(t, template.AutostopRequirement.DaysOfWeek, updated.AutostopRequirement.DaysOfWeek)
989+
assert.Equal(t, template.AutostopRequirement.Weeks, updated.AutostopRequirement.Weeks)
990990
assert.Equal(t, template.AllowUserAutostart, updated.AllowUserAutostart)
991991
assert.Equal(t, template.AllowUserAutostop, updated.AllowUserAutostop)
992992
assert.Equal(t, template.FailureTTLMillis, updated.FailureTTLMillis)

‎coderd/activitybump_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func TestWorkspaceActivityBump(t *testing.T) {
2626
ctx := context.Background()
2727

2828
// deadline allows you to forcibly set a max_deadline on the build. This
29-
// doesn't use template restart requirements and instead edits the
29+
// doesn't use template autostop requirements and instead edits the
3030
// max_deadline on the build directly in the database.
3131
setupActivityTest := func(t *testing.T, deadline ...time.Duration) (client *codersdk.Client, workspace codersdk.Workspace, assertBumped func(want bool)) {
3232
const ttl = time.Minute
@@ -49,7 +49,7 @@ func TestWorkspaceActivityBump(t *testing.T) {
4949
UserAutostopEnabled: true,
5050
DefaultTTL: ttl,
5151
// We set max_deadline manually below.
52-
RestartRequirement: schedule.TemplateRestartRequirement{},
52+
AutostopRequirement: schedule.TemplateAutostopRequirement{},
5353
}, nil
5454
},
5555
},

0 commit comments

Comments
 (0)