Skip to content

feat: enforce template-level constraints for TTL and autostart #2018

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.

Sign up for GitHub

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 20 commits into from
Jun 7, 2022
Merged

feat: enforce template-level constraints for TTL and autostart #2018

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
1713431
RED: add failing unit tests
johnstcn Jun 2, 2022
f11f942
RED: add migrations and make gen
johnstcn Jun 2, 2022
c5c9a7a
ORANGE: fix audit/diff tests
johnstcn Jun 2, 2022
74f4dee
fixup! RED: add migrations and make gen
johnstcn Jun 2, 2022
7da27a0
fixup! RED: add migrations and make gen
johnstcn Jun 2, 2022
5ad048b
feat: schedule: add schedule.Min function to determine minimum interval
johnstcn Jun 2, 2022
65b980e
ORANGE: coderd: fix a whole bunch of tests
johnstcn Jun 2, 2022
aa298a6
RED: fast-fail some slow-failing tests
johnstcn Jun 2, 2022
a5ec9bf
GREEN: fix even more tests
johnstcn Jun 3, 2022
a6255d6
GREEN: fix final unit test
johnstcn Jun 3, 2022
245795e
cli: templatecreate: add CLI flags --max-ttl --min-autostart-interval
johnstcn Jun 3, 2022
709db5b
fixup! cli: templatecreate: add CLI flags --max-ttl --min-autostart-i…
johnstcn Jun 3, 2022
c4a0927
make gen
johnstcn Jun 3, 2022
244e479
update test entities
johnstcn Jun 3, 2022
60ef479
Merge remote-tracking branch 'origin/main' into 1433-template-constra…
johnstcn Jun 7, 2022
c9aab8b
fixup! Merge remote-tracking branch 'origin/main' into 1433-template-…
johnstcn Jun 7, 2022
f997af2
coderd: default newly-minted workspaces to template max_ttl
johnstcn Jun 7, 2022
d7f697b
address PR comment
johnstcn Jun 7, 2022
ebe4c15
fix broken unit test
johnstcn Jun 7, 2022
08ef2eb
fix some more tests
johnstcn Jun 7, 2022
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
Prev Previous commit
Next Next commit
fixup! cli: templatecreate: add CLI flags --max-ttl --min-autostart-i… 
…nterval
  • Loading branch information
@johnstcn
johnstcn committed Jun 3, 2022
commit 709db5b22f36583c04ea2fdfab8fa3c62d323f1a
31 changes: 25 additions & 6 deletions cli/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"github.com/coder/coder/cli/cliflag"
"github.com/coder/coder/cli/cliui"
"github.com/coder/coder/coderd/autobuild/schedule"
"github.com/coder/coder/coderd/util/ptr"
"github.com/coder/coder/codersdk"
)
Expand Down Expand Up @@ -114,10 +115,22 @@ func create() *cobra.Command {
}
}

schedSpec := buildSchedule(autostartMinute, autostartHour, autostartDow, tzName)
schedSpec, err := validSchedule(
autostartMinute,
autostartHour,
autostartDow,
tzName,
time.Duration(template.MinAutostartIntervalMillis)*time.Millisecond,
)
if err != nil {
return xerrors.Errorf("Invalid autostart schedule: %w", err)
}
if ttl < time.Minute {
return xerrors.Errorf("TTL must be at least 1 minute")
}
if ttlMax := time.Duration(template.MaxTTLMillis) * time.Millisecond; ttl > ttlMax {
return xerrors.Errorf("TTL must be below template maximum %s", ttlMax)
}

templateVersion, err := client.TemplateVersion(cmd.Context(), template.ActiveVersionID)
if err != nil {
Expand Down Expand Up @@ -257,11 +270,17 @@ func create() *cobra.Command {
return cmd
}

func buildSchedule(minute, hour, dow, tzName string) *string {
if minute == "" || hour == "" || dow == "" {
return nil
func validSchedule(minute, hour, dow, tzName string, min time.Duration) (*string, error) {
schedSpec := fmt.Sprintf("CRON_TZ=%s %s %s * * %s", tzName, minute, hour, dow)

sched, err := schedule.Weekly(schedSpec)
if err != nil {
return nil, err
}

schedSpec := fmt.Sprintf("CRON_TZ=%s %s %s * * %s", tzName, minute, hour, dow)
return &schedSpec
if schedMin := sched.Min(); schedMin < min {
return nil, xerrors.Errorf("minimum autostart interval %s is above template constraint %s", schedMin, min)
}

return &schedSpec, nil
}
4 changes: 2 additions & 2 deletions cli/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ func TestCreate(t *testing.T) {
cmd.SetIn(pty.Input())
cmd.SetOut(pty.Output())
err := cmd.Execute()
assert.ErrorContains(t, err, "ttl_ms: ttl must be below template maximum 12h0m0s")
assert.ErrorContains(t, err, "TTL must be below template maximum 12h0m0s")
})

t.Run("BelowTemplateMinAutostartInterval", func(t *testing.T) {
Expand All @@ -111,7 +111,7 @@ func TestCreate(t *testing.T) {
cmd.SetIn(pty.Input())
cmd.SetOut(pty.Output())
err := cmd.Execute()
assert.ErrorContains(t, err, "Minimum autostart interval 1m0s below template minimum 1h0m0s")
assert.ErrorContains(t, err, "minimum autostart interval 1m0s is above template constraint 1h0m0s")
})

t.Run("CreateErrInvalidTz", func(t *testing.T) {
Expand Down
20 changes: 11 additions & 9 deletions coderd/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,14 +314,16 @@ func convertTemplates(templates []database.Template, workspaceCounts []database.

func convertTemplate(template database.Template, workspaceOwnerCount uint32) codersdk.Template {
return codersdk.Template{
ID: template.ID,
CreatedAt: template.CreatedAt,
UpdatedAt: template.UpdatedAt,
OrganizationID: template.OrganizationID,
Name: template.Name,
Provisioner: codersdk.ProvisionerType(template.Provisioner),
ActiveVersionID: template.ActiveVersionID,
WorkspaceOwnerCount: workspaceOwnerCount,
Description: template.Description,
ID: template.ID,
CreatedAt: template.CreatedAt,
UpdatedAt: template.UpdatedAt,
OrganizationID: template.OrganizationID,
Name: template.Name,
Provisioner: codersdk.ProvisionerType(template.Provisioner),
ActiveVersionID: template.ActiveVersionID,
WorkspaceOwnerCount: workspaceOwnerCount,
Description: template.Description,
MaxTTLMillis: time.Duration(template.MaxTtl).Milliseconds(),
MinAutostartIntervalMillis: time.Duration(template.MinAutostartInterval).Milliseconds(),
}
}
20 changes: 11 additions & 9 deletions codersdk/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ import (
// Template is the JSON representation of a Coder template. This type matches the
// database object for now, but is abstracted for ease of change later on.
type Template struct {
ID uuid.UUID `json:"id"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
OrganizationID uuid.UUID `json:"organization_id"`
Name string `json:"name"`
Provisioner ProvisionerType `json:"provisioner"`
ActiveVersionID uuid.UUID `json:"active_version_id"`
WorkspaceOwnerCount uint32 `json:"workspace_owner_count"`
Description string `json:"description"`
ID uuid.UUID `json:"id"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
OrganizationID uuid.UUID `json:"organization_id"`
Name string `json:"name"`
Provisioner ProvisionerType `json:"provisioner"`
ActiveVersionID uuid.UUID `json:"active_version_id"`
WorkspaceOwnerCount uint32 `json:"workspace_owner_count"`
Description string `json:"description"`
MaxTTLMillis int64 `json:"max_ttl_ms"`
MinAutostartIntervalMillis int64 `json:"min_autostart_interval_ms"`
Comment on lines +25 to +26
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: following convention of codersdk types using int64 millisecond-timestamps for time.Duration

}

type UpdateActiveTemplateVersion struct {
Expand Down