Jan 5, 2024 · Dec 20, 2023 · Dec 20, 2023 · Dec 20, 2023 · Dec 20, 2023 · Dec 20, 2023
diff --git a/.github/workflows/pr-deploy.yaml b/.github/workflows/pr-deploy.yaml

          # Create template
          cd ./.github/pr-deployments/template
          coder templatescreate -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes
          coder templatespush -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes

          # Create workspace
          coder create --template="kubernetes" kube --parameter cpu=2 --parameter memory=4 --parameter home_disk_size=2 -y
diff --git a/cli/cliui/deprecation.go b/cli/cliui/deprecation.go
 package cliui

 import (
 "fmt"

 "github.com/coder/coder/v2/cli/clibase"
 "github.com/coder/pretty"
 )

 func DeprecationWarning(message string) clibase.MiddlewareFunc {
 return func(next clibase.HandlerFunc) clibase.HandlerFunc {
 return func(i *clibase.Invocation) error {
 _, _ = fmt.Fprintln(i.Stdout, "\n"+pretty.Sprint(DefaultStyles.Wrap,
 pretty.Sprint(
 DefaultStyles.Warn,
 "DEPRECATION WARNING: This command will be removed in a future release."+"\n"+message+"\n"),
 ))
 return next(i)
 }
 }
 }
diff --git a/cli/templatecreate.go b/cli/templatecreate.go
 package cli

 import (
 "errors"
 "fmt"
 "io"
 "net/http"
 "strings"
 "time"
 "unicode/utf8"

 "github.com/google/uuid"
 "golang.org/x/xerrors"

 "github.com/coder/pretty"
 client := new(codersdk.Client)
 cmd := &clibase.Cmd{
 Use:   "create [name]",
 Short: "Create a template from the current directory or as specified by flag",
 Short: "DEPRECATED:Create a template from the current directory or as specified by flag",
 Middleware: clibase.Chain(
 clibase.RequireRangeArgs(0, 1),
 cliui.DeprecationWarning(
 "Use `coder templates push` command for creating and updating templates. \n"+
 "Use `coder templates edit` command for editing template settings. ",
 ),
 r.InitClient(client),
 ),
 Handler: func(inv *clibase.Invocation) error {
 cmd.Options = append(cmd.Options, uploadFlags.options()...)
 return cmd
 }

 type createValidTemplateVersionArgs struct {
 Name         string
 Message      string
 Client       *codersdk.Client
 Organization codersdk.Organization
 Provisioner  codersdk.ProvisionerType
 FileID       uuid.UUID

 // Template is only required if updating a template's active version.
 Template *codersdk.Template
 // ReuseParameters will attempt to reuse params from the Template field
 // before prompting the user. Set to false to always prompt for param
 // values.
 ReuseParameters    bool
 ProvisionerTags    map[string]string
 UserVariableValues []codersdk.VariableValue
 }

 func createValidTemplateVersion(inv *clibase.Invocation, args createValidTemplateVersionArgs) (*codersdk.TemplateVersion, error) {
 client := args.Client

 req := codersdk.CreateTemplateVersionRequest{
 Name:               args.Name,
 Message:            args.Message,
 StorageMethod:      codersdk.ProvisionerStorageMethodFile,
 FileID:             args.FileID,
 Provisioner:        args.Provisioner,
 ProvisionerTags:    args.ProvisionerTags,
 UserVariableValues: args.UserVariableValues,
 }
 if args.Template != nil {
 req.TemplateID = args.Template.ID
 }
 version, err := client.CreateTemplateVersion(inv.Context(), args.Organization.ID, req)
 if err != nil {
 return nil, err
 }

 err = cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
 Fetch: func() (codersdk.ProvisionerJob, error) {
 version, err := client.TemplateVersion(inv.Context(), version.ID)
 return version.Job, err
 },
 Cancel: func() error {
 return client.CancelTemplateVersion(inv.Context(), version.ID)
 },
 Logs: func() (<-chan codersdk.ProvisionerJobLog, io.Closer, error) {
 return client.TemplateVersionLogsAfter(inv.Context(), version.ID, 0)
 },
 })
 if err != nil {
 var jobErr *cliui.ProvisionerJobError
 if errors.As(err, &jobErr) && !codersdk.JobIsMissingParameterErrorCode(jobErr.Code) {
 return nil, err
 }
 if err != nil {
 return nil, err
 }
 }
 version, err = client.TemplateVersion(inv.Context(), version.ID)
 if err != nil {
 return nil, err
 }

 if version.Job.Status != codersdk.ProvisionerJobSucceeded {
 return nil, xerrors.New(version.Job.Error)
 }

 resources, err := client.TemplateVersionResources(inv.Context(), version.ID)
 if err != nil {
 return nil, err
 }

 // Only display the resources on the start transition, to avoid listing them more than once.
 var startResources []codersdk.WorkspaceResource
 for _, r := range resources {
 if r.Transition == codersdk.WorkspaceTransitionStart {
 startResources = append(startResources, r)
 }
 }
 err = cliui.WorkspaceResources(inv.Stdout, startResources, cliui.WorkspaceResourcesOptions{
 HideAgentState: true,
 HideAccess:     true,
 Title:          "Template Preview",
 })
 if err != nil {
 return nil, xerrors.Errorf("preview template resources: %w", err)
 }

 return &version, nil
 }

 func ParseProvisionerTags(rawTags []string) (map[string]string, error) {
 tags := map[string]string{}
 for _, rawTag := range rawTags {
 parts := strings.SplitN(rawTag, "=", 2)
 if len(parts) < 2 {
 return nil, xerrors.Errorf("invalid tag format for %q. must be key=value", rawTag)
 }
 tags[parts[0]] = parts[1]
 }
 return tags, nil
 }
diff --git a/cli/templatecreate_test.go b/cli/templatecreate_test.go
 "github.com/coder/coder/v2/testutil"
 )

 func completeWithAgent() *echo.Responses {
 return &echo.Responses{
 Parse: echo.ParseComplete,
 ProvisionPlan: []*proto.Response{
 {
 Type: &proto.Response_Plan{
 Plan: &proto.PlanComplete{
 Resources: []*proto.Resource{
 {
 Type: "compute",
 Name: "main",
 Agents: []*proto.Agent{
 {
 Name:            "smith",
 OperatingSystem: "linux",
 Architecture:    "i386",
 },
 },
 },
 },
 },
 },
 },
 },
 ProvisionApply: []*proto.Response{
 {
 Type: &proto.Response_Apply{
 Apply: &proto.ApplyComplete{
 Resources: []*proto.Resource{
 {
 Type: "compute",
 Name: "main",
 Agents: []*proto.Agent{
 {
 Name:            "smith",
 OperatingSystem: "linux",
 Architecture:    "i386",
 },
 },
 },
 },
 },
 },
 },
 },
 }
 }

 func TestTemplateCreate(t *testing.T) {
 t.Parallel()
 t.Run("Create", func(t *testing.T) {
 require.Contains(t, err.Error(), "your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
 })
 }

 // Need this for Windows because of a known issue with Go:
 // https://github.com/golang/go/issues/52986
 func removeTmpDirUntilSuccessAfterTest(t *testing.T, tempDir string) {
 t.Helper()
 t.Cleanup(func() {
 err := os.RemoveAll(tempDir)
 for err != nil {
 err = os.RemoveAll(tempDir)
 }
 })
 }
diff --git a/cli/templateedit.go b/cli/templateedit.go
 allowUserAutostop              bool
 requireActiveVersion           bool
 deprecationMessage             string
 disableEveryone                bool
 )
 client := new(codersdk.Client)

 AllowUserAutostop:              allowUserAutostop,
 RequireActiveVersion:           requireActiveVersion,
 DeprecationMessage:             deprecated,
 DisableEveryoneGroupAccess:     disableEveryone,
 }

 _, err = client.UpdateTemplateMeta(inv.Context(), template.ID, req)
 Value:       clibase.BoolOf(&requireActiveVersion),
 Default:     "false",
 },
 {
 Flag: "private",
 Description: "Disable the default behavior of granting template access to the 'everyone' group. " +
 "The template permissions must be updated to allow non-admin users to use this template.",
 Value:   clibase.BoolOf(&disableEveryone),
 Default: "false",
 },
 cliui.SkipPromptOption(),
 }

diff --git a/cli/templateinit.go b/cli/templateinit.go
 inv.Stdout,
 pretty.Sprint(
 cliui.DefaultStyles.Code,
 "cd "+relPath+" && coder templatescreate"),
 "cd "+relPath+" && coder templatespush"),
 )
 _, _ = fmt.Fprintln(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Wrap, "\nExamples provide a starting point and are expected to be edited! 🎨"))
 return nil
diff --git a/cli/templatelist.go b/cli/templatelist.go

 if len(templates) == 0 {
 _, _ = fmt.Fprintf(inv.Stderr, "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))
 _, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString("  $ coder templatescreate <directory>\n"))
 _, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString("  $ coder templatespush <directory>\n"))
 return nil
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -416,7 +416,7 @@ jobs:

		# Create template
		cd ./.github/pr-deployments/template
		coder templatescreate -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes
		coder templatespush -y --variable namespace=pr${{ env.PR_NUMBER }} kubernetes

		# Create workspace
		coder create --template="kubernetes" kube --parameter cpu=2 --parameter memory=4 --parameter home_disk_size=2 -y
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,21 @@
		package cliui

		import (
		"fmt"

		"github.com/coder/coder/v2/cli/clibase"
		"github.com/coder/pretty"
		)

		func DeprecationWarning(message string) clibase.MiddlewareFunc {
		return func(next clibase.HandlerFunc) clibase.HandlerFunc {
		return func(i *clibase.Invocation) error {
		_, _ = fmt.Fprintln(i.Stdout, "\n"+pretty.Sprint(DefaultStyles.Wrap,
		pretty.Sprint(
		DefaultStyles.Warn,
		"DEPRECATION WARNING: This command will be removed in a future release."+"\n"+message+"\n"),
		))
		return next(i)
		}
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -1,15 +1,11 @@
		package cli

		import (
		"errors"
		"fmt"
		"io"
		"net/http"
		"strings"
		"time"
		"unicode/utf8"

		"github.com/google/uuid"
		"golang.org/x/xerrors"

		"github.com/coder/pretty"
Expand DownExpand Up		@@ -40,9 +36,13 @@ func (r RootCmd) templateCreate() clibase.Cmd {
		client := new(codersdk.Client)
		cmd := &clibase.Cmd{
		Use: "create [name]",
		Short: "Create a template from the current directory or as specified by flag",
		Short: "DEPRECATED:Create a template from the current directory or as specified by flag",
		Middleware: clibase.Chain(
		clibase.RequireRangeArgs(0, 1),
		cliui.DeprecationWarning(
		"Use `coder templates push` command for creating and updating templates. \n"+
		"Use `coder templates edit` command for editing template settings. ",
		),
		r.InitClient(client),
		),
		Handler: func(inv *clibase.Invocation) error {
Expand DownExpand Up		@@ -253,107 +253,3 @@ func (r RootCmd) templateCreate() clibase.Cmd {
		cmd.Options = append(cmd.Options, uploadFlags.options()...)
		return cmd
		}

		type createValidTemplateVersionArgs struct {
		Name string
		Message string
		Client *codersdk.Client
		Organization codersdk.Organization
		Provisioner codersdk.ProvisionerType
		FileID uuid.UUID

		// Template is only required if updating a template's active version.
		Template *codersdk.Template
		// ReuseParameters will attempt to reuse params from the Template field
		// before prompting the user. Set to false to always prompt for param
		// values.
		ReuseParameters bool
		ProvisionerTags map[string]string
		UserVariableValues []codersdk.VariableValue
		}

		func createValidTemplateVersion(inv clibase.Invocation, args createValidTemplateVersionArgs) (codersdk.TemplateVersion, error) {
		client := args.Client

		req := codersdk.CreateTemplateVersionRequest{
		Name: args.Name,
		Message: args.Message,
		StorageMethod: codersdk.ProvisionerStorageMethodFile,
		FileID: args.FileID,
		Provisioner: args.Provisioner,
		ProvisionerTags: args.ProvisionerTags,
		UserVariableValues: args.UserVariableValues,
		}
		if args.Template != nil {
		req.TemplateID = args.Template.ID
		}
		version, err := client.CreateTemplateVersion(inv.Context(), args.Organization.ID, req)
		if err != nil {
		return nil, err
		}

		err = cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
		Fetch: func() (codersdk.ProvisionerJob, error) {
		version, err := client.TemplateVersion(inv.Context(), version.ID)
		return version.Job, err
		},
		Cancel: func() error {
		return client.CancelTemplateVersion(inv.Context(), version.ID)
		},
		Logs: func() (<-chan codersdk.ProvisionerJobLog, io.Closer, error) {
		return client.TemplateVersionLogsAfter(inv.Context(), version.ID, 0)
		},
		})
		if err != nil {
		var jobErr *cliui.ProvisionerJobError
		if errors.As(err, &jobErr) && !codersdk.JobIsMissingParameterErrorCode(jobErr.Code) {
		return nil, err
		}
		if err != nil {
		return nil, err
		}
		}
		version, err = client.TemplateVersion(inv.Context(), version.ID)
		if err != nil {
		return nil, err
		}

		if version.Job.Status != codersdk.ProvisionerJobSucceeded {
		return nil, xerrors.New(version.Job.Error)
		}

		resources, err := client.TemplateVersionResources(inv.Context(), version.ID)
		if err != nil {
		return nil, err
		}

		// Only display the resources on the start transition, to avoid listing them more than once.
		var startResources []codersdk.WorkspaceResource
		for _, r := range resources {
		if r.Transition == codersdk.WorkspaceTransitionStart {
		startResources = append(startResources, r)
		}
		}
		err = cliui.WorkspaceResources(inv.Stdout, startResources, cliui.WorkspaceResourcesOptions{
		HideAgentState: true,
		HideAccess: true,
		Title: "Template Preview",
		})
		if err != nil {
		return nil, xerrors.Errorf("preview template resources: %w", err)
		}

		return &version, nil
		}

		func ParseProvisionerTags(rawTags []string) (map[string]string, error) {
		tags := map[string]string{}
		for _, rawTag := range rawTags {
		parts := strings.SplitN(rawTag, "=", 2)
		if len(parts) < 2 {
		return nil, xerrors.Errorf("invalid tag format for %q. must be key=value", rawTag)
		}
		tags[parts[0]] = parts[1]
		}
		return tags, nil
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,54 +19,6 @@ import (
		"github.com/coder/coder/v2/testutil"
		)

		func completeWithAgent() *echo.Responses {
		return &echo.Responses{
		Parse: echo.ParseComplete,
		ProvisionPlan: []*proto.Response{
		{
		Type: &proto.Response_Plan{
		Plan: &proto.PlanComplete{
		Resources: []*proto.Resource{
		{
		Type: "compute",
		Name: "main",
		Agents: []*proto.Agent{
		{
		Name: "smith",
		OperatingSystem: "linux",
		Architecture: "i386",
		},
		},
		},
		},
		},
		},
		},
		},
		ProvisionApply: []*proto.Response{
		{
		Type: &proto.Response_Apply{
		Apply: &proto.ApplyComplete{
		Resources: []*proto.Resource{
		{
		Type: "compute",
		Name: "main",
		Agents: []*proto.Agent{
		{
		Name: "smith",
		OperatingSystem: "linux",
		Architecture: "i386",
		},
		},
		},
		},
		},
		},
		},
		},
		}
		}

		func TestTemplateCreate(t *testing.T) {
		t.Parallel()
		t.Run("Create", func(t *testing.T) {
Expand DownExpand Up		@@ -418,15 +370,3 @@ func TestTemplateCreate(t *testing.T) {
		require.Contains(t, err.Error(), "your deployment appears to be an AGPL deployment, so you cannot set enterprise-only flags")
		})
		}

		// Need this for Windows because of a known issue with Go:
		// https://github.com/golang/go/issues/52986
		func removeTmpDirUntilSuccessAfterTest(t *testing.T, tempDir string) {
		t.Helper()
		t.Cleanup(func() {
		err := os.RemoveAll(tempDir)
		for err != nil {
		err = os.RemoveAll(tempDir)
		}
		})
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,6 +35,7 @@ func (r RootCmd) templateEdit() clibase.Cmd {
		allowUserAutostop bool
		requireActiveVersion bool
		deprecationMessage string
		disableEveryone bool
		)
		client := new(codersdk.Client)

Expand DownExpand Up		@@ -162,6 +163,7 @@ func (r RootCmd) templateEdit() clibase.Cmd {
		AllowUserAutostop: allowUserAutostop,
		RequireActiveVersion: requireActiveVersion,
		DeprecationMessage: deprecated,
		DisableEveryoneGroupAccess: disableEveryone,
		}

		_, err = client.UpdateTemplateMeta(inv.Context(), template.ID, req)
Expand DownExpand Up		@@ -292,6 +294,13 @@ func (r RootCmd) templateEdit() clibase.Cmd {
		Value: clibase.BoolOf(&requireActiveVersion),
		Default: "false",
		},
		{
		Flag: "private",
		Description: "Disable the default behavior of granting template access to the 'everyone' group. " +
		"The template permissions must be updated to allow non-admin users to use this template.",
		Value: clibase.BoolOf(&disableEveryone),
		Default: "false",
		},
		cliui.SkipPromptOption(),
		}

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -113,7 +113,7 @@ func (RootCmd) templateInit() clibase.Cmd {
		inv.Stdout,
		pretty.Sprint(
		cliui.DefaultStyles.Code,
		"cd "+relPath+" && coder templatescreate"),
		"cd "+relPath+" && coder templatespush"),
		)
		_, _ = fmt.Fprintln(inv.Stdout, pretty.Sprint(cliui.DefaultStyles.Wrap, "\nExamples provide a starting point and are expected to be edited! 🎨"))
		return nil
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,7 +36,7 @@ func (r RootCmd) templateList() clibase.Cmd {

		if len(templates) == 0 {
		_, _ = fmt.Fprintf(inv.Stderr, "%s No templates found in %s! Create one:\n\n", Caret, color.HiWhiteString(organization.Name))
		_, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString(" $ coder templatescreate <directory>\n"))
		_, _ = fmt.Fprintln(inv.Stderr, color.HiMagentaString(" $ coder templatespush <directory>\n"))
		return nil
		}

Expand Down