Skip to content

chore: include all templates in cli template list #13841

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 4 commits into from
Jul 9, 2024
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
10 changes: 2 additions & 8 deletions cli/templatelist.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
)

func (r *RootCmd) templateList() *serpent.Command {
orgContext := NewOrganizationContext()
formatter := cliui.NewOutputFormatter(
cliui.TableFormat([]templateTableRow{}, []string{"name", "organization name", "last updated", "used by"}),
cliui.JSONFormat(),
Expand All @@ -26,17 +25,13 @@ func (r *RootCmd) templateList() *serpent.Command {
r.InitClient(client),
),
Handler: func(inv *serpent.Invocation) error {
organization, err := orgContext.Selected(inv, client)
if err != nil {
return err
}
templates, err := client.TemplatesByOrganization(inv.Context(), organization.ID)
templates, err := client.Templates(inv.Context(), codersdk.TemplateFilter{})
if err != nil {
return err
}

if len(templates) == 0 {
_, _ = fmt.Fprintf(inv.Stderr, "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))
_, _ = fmt.Fprintf(inv.Stderr, "%s No templates found! Create one:\n\n", Caret)
_, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString(" $ coder templates push <directory>\n"))
return nil
}
Expand All @@ -53,6 +48,5 @@ func (r *RootCmd) templateList() *serpent.Command {
}

formatter.AttachOptions(&cmd.Options)
orgContext.AttachOptions(cmd)
return cmd
}
41 changes: 36 additions & 5 deletions cli/templatelist_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,6 @@ func TestTemplateList(t *testing.T) {
client := coderdtest.New(t, &coderdtest.Options{})
owner := coderdtest.CreateFirstUser(t, client)

org, err := client.Organization(context.Background(), owner.OrganizationID)
require.NoError(t, err)

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

inv, root := clitest.New(t, "templates", "list")
Expand All @@ -110,8 +107,42 @@ func TestTemplateList(t *testing.T) {

require.NoError(t, <-errC)

pty.ExpectMatch("No templates found in")
pty.ExpectMatch(org.Name)
pty.ExpectMatch("No templates found")
pty.ExpectMatch("Create one:")
})

t.Run("MultiOrg", func(t *testing.T) {
t.Parallel()
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
owner := coderdtest.CreateFirstUser(t, client)

// Template in the first organization
firstVersion := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, nil)
_ = coderdtest.AwaitTemplateVersionJobCompleted(t, client, firstVersion.ID)
_ = coderdtest.CreateTemplate(t, client, owner.OrganizationID, firstVersion.ID)

secondOrg := coderdtest.CreateOrganization(t, client, coderdtest.CreateOrganizationOptions{
IncludeProvisionerDaemon: true,
})
secondVersion := coderdtest.CreateTemplateVersion(t, client, secondOrg.ID, nil)
_ = coderdtest.CreateTemplate(t, client, secondOrg.ID, secondVersion.ID)

// Create a site wide template admin
templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())

inv, root := clitest.New(t, "templates", "list", "--output=json")
clitest.SetupConfig(t, templateAdmin, root)

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

out := bytes.NewBuffer(nil)
inv.Stdout = out
err := inv.WithContext(ctx).Run()
require.NoError(t, err)

var templates []codersdk.Template
require.NoError(t, json.Unmarshal(out.Bytes(), &templates))
require.Len(t, templates, 2)
})
}
3 changes: 0 additions & 3 deletions cli/testdata/coder_templates_list_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ USAGE:
Aliases: ls

OPTIONS:
-O, --org string, $CODER_ORGANIZATION
Select which organization (uuid or name) to use.

-c, --column string-array (default: name,organization name,last updated,used by)
Columns to display in table output. Available columns: name, created
at, last updated, organization id, organization name, provisioner,
Expand Down
9 changes: 0 additions & 9 deletions docs/cli/templates_list.md

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

Loading