Skip to content

Commit b1e0d69

Browse files
AbhineetJainAbhineetJain
authored
Implement basic templates versions CLI (coder#3145)
1 parent df20dd7 commit b1e0d69

File tree

4 files changed

+184
-4
lines changed

4 files changed

+184
-4
lines changed

‎cli/templatelist.go

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ func templateList() *cobra.Command {
1313
)
1414
cmd := &cobra.Command{
1515
Use: "list",
16+
Short: "List all the templates available for the organization",
1617
Aliases: []string{"ls"},
1718
RunE: func(cmd *cobra.Command, args []string) error {
1819
client, err := createClient(cmd)

‎cli/templatelist_test.go

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
package cli_test
2+
3+
import (
4+
"testing"
5+
6+
"github.com/stretchr/testify/require"
7+
8+
"github.com/coder/coder/cli/clitest"
9+
"github.com/coder/coder/coderd/coderdtest"
10+
"github.com/coder/coder/pty/ptytest"
11+
)
12+
13+
func TestTemplateList(t *testing.T) {
14+
t.Parallel()
15+
t.Run("ListTemplates", func(t *testing.T) {
16+
t.Parallel()
17+
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
18+
user := coderdtest.CreateFirstUser(t, client)
19+
firstVersion := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
20+
_ = coderdtest.AwaitTemplateVersionJob(t, client, firstVersion.ID)
21+
firstTemplate := coderdtest.CreateTemplate(t, client, user.OrganizationID, firstVersion.ID)
22+
23+
secondVersion := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
24+
_ = coderdtest.AwaitTemplateVersionJob(t, client, secondVersion.ID)
25+
secondTemplate := coderdtest.CreateTemplate(t, client, user.OrganizationID, secondVersion.ID)
26+
27+
cmd, root := clitest.New(t, "templates", "list")
28+
clitest.SetupConfig(t, client, root)
29+
30+
pty := ptytest.New(t)
31+
cmd.SetIn(pty.Input())
32+
cmd.SetOut(pty.Output())
33+
34+
errC := make(chan error)
35+
go func() {
36+
errC <- cmd.Execute()
37+
}()
38+
39+
require.NoError(t, <-errC)
40+
41+
pty.ExpectMatch(firstTemplate.Name)
42+
pty.ExpectMatch(secondTemplate.Name)
43+
})
44+
t.Run("NoTemplates", func(t *testing.T) {
45+
t.Parallel()
46+
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
47+
coderdtest.CreateFirstUser(t, client)
48+
49+
cmd, root := clitest.New(t, "templates", "list")
50+
clitest.SetupConfig(t, client, root)
51+
52+
pty := ptytest.New(t)
53+
cmd.SetIn(pty.Input())
54+
cmd.SetOut(pty.Output())
55+
56+
errC := make(chan error)
57+
go func() {
58+
errC <- cmd.Execute()
59+
}()
60+
61+
require.NoError(t, <-errC)
62+
63+
pty.ExpectMatch("No templates found in testuser! Create one:")
64+
})
65+
}

‎cli/templateversions.go

+77-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,88 @@
11
package cli
22

3-
import "github.com/spf13/cobra"
3+
import (
4+
"fmt"
5+
"strings"
6+
7+
"github.com/google/uuid"
8+
"github.com/jedib0t/go-pretty/v6/table"
9+
"github.com/spf13/cobra"
10+
"golang.org/x/xerrors"
11+
12+
"github.com/coder/coder/cli/cliui"
13+
"github.com/coder/coder/codersdk"
14+
)
415

516
func templateVersions() *cobra.Command {
6-
return &cobra.Command{
17+
cmd := &cobra.Command{
718
Use: "versions",
19+
Short: "Manage different versions of the specified template",
820
Aliases: []string{"version"},
21+
Example: formatExamples(
22+
example{
23+
Description: "List versions of a specific template",
24+
Command: "coder templates versions list my-template",
25+
},
26+
),
27+
}
28+
cmd.AddCommand(
29+
templateVersionsList(),
30+
)
31+
32+
return cmd
33+
}
34+
35+
func templateVersionsList() *cobra.Command {
36+
return &cobra.Command{
37+
Use: "list <template>",
38+
Args: cobra.ExactArgs(1),
39+
Short: "List all the versions of the specified template",
940
RunE: func(cmd *cobra.Command, args []string) error {
10-
return nil
41+
client, err := createClient(cmd)
42+
if err != nil {
43+
return xerrors.Errorf("create client: %w", err)
44+
}
45+
organization, err := currentOrganization(cmd, client)
46+
if err != nil {
47+
return xerrors.Errorf("get current organization: %w", err)
48+
}
49+
template, err := client.TemplateByName(cmd.Context(), organization.ID, args[0])
50+
if err != nil {
51+
return xerrors.Errorf("get template by name: %w", err)
52+
}
53+
req := codersdk.TemplateVersionsByTemplateRequest{
54+
TemplateID: template.ID,
55+
}
56+
57+
versions, err := client.TemplateVersionsByTemplate(cmd.Context(), req)
58+
if err != nil {
59+
return xerrors.Errorf("get template versions by template: %w", err)
60+
}
61+
_, err = fmt.Fprintln(cmd.OutOrStdout(), displayTemplateVersions(template.ActiveVersionID, versions...))
62+
return err
1163
},
1264
}
1365
}
1466

15-
// coder template versions
67+
// displayTemplateVersions will return a table displaying existing
68+
// template versions for the specified template.
69+
func displayTemplateVersions(activeVersionID uuid.UUID, templateVersions ...codersdk.TemplateVersion) string {
70+
tableWriter := cliui.Table()
71+
header := table.Row{
72+
"Name", "Created At", "Created By", "Status", ""}
73+
tableWriter.AppendHeader(header)
74+
for _, templateVersion := range templateVersions {
75+
var activeStatus = ""
76+
if templateVersion.ID == activeVersionID {
77+
activeStatus = cliui.Styles.Code.Render(cliui.Styles.Keyword.Render("Active"))
78+
}
79+
tableWriter.AppendRow(table.Row{
80+
templateVersion.Name,
81+
templateVersion.CreatedAt.Format("03:04:05 PM MST on Jan 2, 2006"),
82+
templateVersion.CreatedByName,
83+
strings.Title(string(templateVersion.Job.Status)),
84+
activeStatus,
85+
})
86+
}
87+
return tableWriter.Render()
88+
}

‎cli/templateversions_test.go

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
package cli_test
2+
3+
import (
4+
"testing"
5+
6+
"github.com/stretchr/testify/require"
7+
8+
"github.com/coder/coder/cli/clitest"
9+
"github.com/coder/coder/coderd/coderdtest"
10+
"github.com/coder/coder/pty/ptytest"
11+
)
12+
13+
func TestTemplateVersions(t *testing.T) {
14+
t.Parallel()
15+
t.Run("ListVersions", func(t *testing.T) {
16+
t.Parallel()
17+
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
18+
user := coderdtest.CreateFirstUser(t, client)
19+
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
20+
_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
21+
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
22+
23+
cmd, root := clitest.New(t, "templates", "versions", "list", template.Name)
24+
clitest.SetupConfig(t, client, root)
25+
26+
pty := ptytest.New(t)
27+
cmd.SetIn(pty.Input())
28+
cmd.SetOut(pty.Output())
29+
30+
errC := make(chan error)
31+
go func() {
32+
errC <- cmd.Execute()
33+
}()
34+
35+
require.NoError(t, <-errC)
36+
37+
pty.ExpectMatch(version.Name)
38+
pty.ExpectMatch(version.CreatedByName)
39+
pty.ExpectMatch("Active")
40+
})
41+
}

0 commit comments

Comments
 (0)