Skip to content

feat(cli): validate name length on template create #3823

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 6 commits into from
Sep 7, 2022
Merged

feat(cli): validate name length on template create #3823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
172647f
feat(cli): add template create validation test
jsjoeio Sep 1, 2022
7f8019b
fixup
jsjoeio Sep 2, 2022
c7e1c4e
fixup test
jsjoeio Sep 2, 2022
cfb2f40
feat(cli): add name validation to templatecreate
jsjoeio Sep 2, 2022
50d7147
fixup!: use utf8.RuneCountInString
jsjoeio Sep 2, 2022
dc7ff22
fixup!: remove pty from test
jsjoeio Sep 2, 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
5 changes: 5 additions & 0 deletions cli/templatecreate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"path/filepath"
"strings"
"time"
"unicode/utf8"

"github.com/briandowns/spinner"
"github.com/spf13/cobra"
Expand Down Expand Up @@ -49,6 +50,10 @@ func templateCreate() *cobra.Command {
templateName = args[0]
}

if utf8.RuneCountInString(templateName) > 31 {
return xerrors.Errorf("Template name must be less than 32 characters")
}

_, err = client.TemplateByName(cmd.Context(), organization.ID, templateName)
if err == nil {
return xerrors.Errorf("A template already exists named %q!", templateName)
Expand Down
15 changes: 15 additions & 0 deletions cli/templatecreate_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,21 @@ func TestTemplateCreate(t *testing.T) {
err = create()
require.NoError(t, err, "Template must be recreated without error")
})

t.Run("WithParameterExceedingCharLimit", func(t *testing.T) {
t.Parallel()
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
coderdtest.CreateFirstUser(t, client)
cmd, root := clitest.New(t, "templates", "create", "1234567890123456789012345678901234567891", "--test.provisioner", string(database.ProvisionerTypeEcho))
clitest.SetupConfig(t, client, root)

execDone := make(chan error)
go func() {
execDone <- cmd.Execute()
}()

require.EqualError(t, <-execDone, "Template name must be less than 32 characters")
})
}

func createTestParseResponse() []*proto.Parse_Response {
Expand Down