Skip to content

fix(cli): allow specifying empty provisioner tag set with --provisioner-tag="-" #18205

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 1 commit into from
Jun 3, 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
58 changes: 42 additions & 16 deletions cli/templatepush.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"net/http"
"os"
"path/filepath"
"slices"
"strings"
"time"

Expand Down Expand Up @@ -80,6 +81,46 @@ func (r *RootCmd) templatePush() *serpent.Command {
createTemplate = true
}

var tags map[string]string
// Passing --provisioner-tag="-" allows the user to clear all provisioner tags.
Copy link
Member

Choose a reason for hiding this comment

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

Nice workaround 👍

if len(provisionerTags) == 1 && strings.TrimSpace(provisionerTags[0]) == "-" {
cliui.Warn(inv.Stderr, "Not reusing provisioner tags from the previous template version.")
tags = map[string]string{}
} else {
tags, err = ParseProvisionerTags(provisionerTags)
if err != nil {
return err
}

// If user hasn't provided new provisioner tags, inherit ones from the active template version.
if len(tags) == 0 && template.ActiveVersionID != uuid.Nil {
templateVersion, err := client.TemplateVersion(inv.Context(), template.ActiveVersionID)
if err != nil {
return err
}
tags = templateVersion.Job.Tags
cliui.Info(inv.Stderr, "Re-using provisioner tags from the active template version.")
cliui.Info(inv.Stderr, "Tip: You can override these tags by passing "+cliui.Code(`--provisioner-tag="key=value"`)+".")
cliui.Info(inv.Stderr, " You can also clear all provisioner tags by passing "+cliui.Code(`--provisioner-tag="-"`)+".")
}
}

{ // For clarity, display provisioner tags to the user.
var tmp []string
for k, v := range tags {
if k == provisionersdk.TagScope || k == provisionersdk.TagOwner {
continue
}
tmp = append(tmp, fmt.Sprintf("%s=%q", k, v))
}
slices.Sort(tmp)
tagStr := strings.Join(tmp, " ")
if len(tmp) == 0 {
tagStr = "<none>"
}
cliui.Info(inv.Stderr, "Provisioner tags: "+cliui.Code(tagStr))
}

err = uploadFlags.checkForLockfile(inv)
if err != nil {
return xerrors.Errorf("check for lockfile: %w", err)
Expand All @@ -104,21 +145,6 @@ func (r *RootCmd) templatePush() *serpent.Command {
return err
}

tags, err := ParseProvisionerTags(provisionerTags)
if err != nil {
return err
}

// If user hasn't provided new provisioner tags, inherit ones from the active template version.
if len(tags) == 0 && template.ActiveVersionID != uuid.Nil {
templateVersion, err := client.TemplateVersion(inv.Context(), template.ActiveVersionID)
if err != nil {
return err
}
tags = templateVersion.Job.Tags
inv.Logger.Info(inv.Context(), "reusing existing provisioner tags", "tags", tags)
}

userVariableValues, err := codersdk.ParseUserVariableValues(
varsFiles,
variablesFile,
Expand Down Expand Up @@ -214,7 +240,7 @@ func (r *RootCmd) templatePush() *serpent.Command {
},
{
Flag: "provisioner-tag",
Description: "Specify a set of tags to target provisioner daemons.",
Description: "Specify a set of tags to target provisioner daemons. If you do not specify any tags, the tags from the active template version will be reused, if available. To remove existing tags, use --provisioner-tag=\"-\".",
Value: serpent.StringArrayOf(&provisionerTags),
},
{
Expand Down
71 changes: 70 additions & 1 deletion cli/templatepush_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ func TestTemplatePush(t *testing.T) {
templateVersion = coderdtest.AwaitTemplateVersionJobCompleted(t, client, templateVersion.ID)
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, templateVersion.ID)

// Push new template version without provisioner tags. CLI should reuse tags from the previous version.
// Push new template version with different provisioner tags.
source := clitest.CreateTemplateVersionSource(t, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionApply: echo.ApplyComplete,
Expand Down Expand Up @@ -639,6 +639,75 @@ func TestTemplatePush(t *testing.T) {
require.EqualValues(t, map[string]string{"foobar": "foobaz", "owner": "", "scope": "organization"}, templateVersion.Job.Tags)
})

t.Run("DeleteTags", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitLong)

// Start the first provisioner with no tags.
client, provisionerDocker, api := coderdtest.NewWithAPI(t, &coderdtest.Options{
IncludeProvisionerDaemon: true,
ProvisionerDaemonTags: map[string]string{},
})
defer provisionerDocker.Close()

// Start the second provisioner with a tag set.
provisionerFoobar := coderdtest.NewTaggedProvisionerDaemon(t, api, "provisioner-foobar", map[string]string{
"foobar": "foobaz",
})
defer provisionerFoobar.Close()

owner := coderdtest.CreateFirstUser(t, client)
templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())

// Create the template with initial tagged template version.
templateVersion := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, nil, func(ctvr *codersdk.CreateTemplateVersionRequest) {
ctvr.ProvisionerTags = map[string]string{
"foobar": "foobaz",
}
})
templateVersion = coderdtest.AwaitTemplateVersionJobCompleted(t, client, templateVersion.ID)
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, templateVersion.ID)

// Stop the tagged provisioner daemon.
provisionerFoobar.Close()

// Push new template version with no provisioner tags.
source := clitest.CreateTemplateVersionSource(t, &echo.Responses{
Parse: echo.ParseComplete,
ProvisionApply: echo.ApplyComplete,
})
inv, root := clitest.New(t, "templates", "push", template.Name, "--directory", source, "--test.provisioner", string(database.ProvisionerTypeEcho), "--name", template.Name, "--provisioner-tag=\"-\"")
clitest.SetupConfig(t, templateAdmin, root)
pty := ptytest.New(t).Attach(inv)

execDone := make(chan error)
go func() {
execDone <- inv.WithContext(ctx).Run()
}()

matches := []struct {
match string
write string
}{
{match: "Upload", write: "yes"},
}
for _, m := range matches {
pty.ExpectMatch(m.match)
pty.WriteLine(m.write)
}

require.NoError(t, <-execDone)

// Verify template version tags
template, err := client.Template(ctx, template.ID)
require.NoError(t, err)

templateVersion, err = client.TemplateVersion(ctx, template.ActiveVersionID)
require.NoError(t, err)
require.EqualValues(t, map[string]string{"owner": "", "scope": "organization"}, templateVersion.Job.Tags)
})

t.Run("DoNotChangeTags", func(t *testing.T) {
t.Parallel()

Expand Down
5 changes: 4 additions & 1 deletion cli/testdata/coder_templates_push_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@ OPTIONS:
generated if not provided.

--provisioner-tag string-array
Specify a set of tags to target provisioner daemons.
Specify a set of tags to target provisioner daemons. If you do not
specify any tags, the tags from the active template version will be
reused, if available. To remove existing tags, use
--provisioner-tag="-".

--var string-array
Alias of --variable.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/templates_push.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading