Skip to content

fix: prevent change in defaults if user unsets in template edit #10793

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 3 commits into from
Nov 21, 2023
Merged

fix: prevent change in defaults if user unsets in template edit #10793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37d419d
fix: template edit not change defaults if user unset
Emyrk Nov 20, 2023
dd05c60
fix unit test
Emyrk Nov 20, 2023
ebc5110
Merge remote-tracking branch 'origin/main' into stevenmasley/template…
Emyrk Nov 20, 2023
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
20 changes: 14 additions & 6 deletions cli/templateedit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,16 +120,24 @@ func (r *RootCmd) templateEdit() *clibase.Cmd {
autostopRequirementDaysOfWeek = []string{}
}

// Only pass explicitly set deprecated values since the empty string
// removes the deprecated message. By default if we pass a nil,
// there is no change to this field.
// Default values
if !userSetOption(inv, "description") {
description = template.Description
}

if !userSetOption(inv, "icon") {
icon = template.Icon
}

if !userSetOption(inv, "display-name") {
displayName = template.DisplayName
}

var deprecated *string
opt := inv.Command.Options.ByName(deprecatedFlagName)
if !(opt.ValueSource == "" || opt.ValueSource == clibase.ValueSourceDefault) {
if !userSetOption(inv, "deprecated") {
deprecated = &deprecationMessage
}

// NOTE: coderd will ignore empty fields.
req := codersdk.UpdateTemplateMeta{
Name: name,
DisplayName: displayName,
Expand Down
40 changes: 40 additions & 0 deletions cli/templateedit_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,9 @@ func TestTemplateEdit(t *testing.T) {
"templates",
"edit",
template.Name,
"--description", "",
"--display-name", "",
"--icon", "",
}
inv, root := clitest.New(t, cmdArgs...)
clitest.SetupConfig(t, templateAdmin, root)
Expand Down Expand Up @@ -1047,4 +1050,41 @@ func TestTemplateEdit(t *testing.T) {
require.Error(t, err)
require.ErrorContains(t, err, "appears to be an AGPL deployment")
})
t.Run("DefaultValues", func(t *testing.T) {
t.Parallel()
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
owner := coderdtest.CreateFirstUser(t, client)

version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, nil)
_ = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
ctr.Name = "random"
ctr.Icon = "/icon/foobar.png"
ctr.DisplayName = "Foobar"
ctr.Description = "Some description"
})

// We need to change some field to get a db write.
cmdArgs := []string{
"templates",
"edit",
template.Name,
"--name", "something-new",
}
inv, root := clitest.New(t, cmdArgs...)
//nolint
clitest.SetupConfig(t, client, root)

ctx := testutil.Context(t, testutil.WaitLong)
err := inv.WithContext(ctx).Run()
require.NoError(t, err)

updated, err := client.Template(context.Background(), template.ID)
require.NoError(t, err)
assert.Equal(t, "something-new", updated.Name)
assert.Equal(t, template.Icon, updated.Icon)
assert.Equal(t, template.DisplayName, updated.DisplayName)
assert.Equal(t, template.Description, updated.Description)
assert.Equal(t, template.DeprecationMessage, updated.DeprecationMessage)
})
}
14 changes: 14 additions & 0 deletions cli/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (

"golang.org/x/xerrors"

"github.com/coder/coder/v2/cli/clibase"
"github.com/coder/coder/v2/coderd/schedule/cron"
"github.com/coder/coder/v2/coderd/util/tz"
)
Expand All @@ -18,6 +19,19 @@ var (
errUnsupportedTimezone = xerrors.New("The location you provided looks like a timezone. Check https://ipinfo.io for your location.")
)

// userSetOption returns true if the option was set by the user.
// This is helpful if the zero value of a flag is meaningful, and you need
// to distinguish between the user setting the flag to the zero value and
// the user not setting the flag at all.
func userSetOption(inv *clibase.Invocation, flagName string) bool {
for _, opt := range inv.Command.Options {
if opt.Name == flagName {
return !(opt.ValueSource == clibase.ValueSourceNone || opt.ValueSource == clibase.ValueSourceDefault)
}
}
return false
}

// durationDisplay formats a duration for easier display:
// - Durations of 24 hours or greater are displays as Xd
// - Durations less than 1 minute are displayed as <1m
Expand Down