working CLI

coder · deansheather · Mar 7, 2023 · Feb 8, 2023 · Feb 15, 2023 · Feb 20, 2023
commit 96fd84050f5adc41de667ec615fe248f52f0faeb
diff --git a/cli/templateedit.go b/cli/templateedit.go
@@ -2,6 +2,7 @@ package cli
 
 import (
 	"fmt"
+	"net/http"
 	"time"
 
 	"github.com/spf13/cobra"
@@ -18,6 +19,7 @@ func templateEdit() *cobra.Command {
 		description                  string
 		icon                         string
 		defaultTTL                   time.Duration
+		maxTTL                       time.Duration
 		allowUserCancelWorkspaceJobs bool
 	)
 
@@ -30,6 +32,21 @@ func templateEdit() *cobra.Command {
 			if err != nil {
 				return xerrors.Errorf("create client: %w", err)
 			}
+
+			if maxTTL != 0 {
+				entitlements, err := client.Entitlements(cmd.Context())
+				var sdkErr *codersdk.Error
+				if xerrors.As(err, &sdkErr) && sdkErr.StatusCode() == http.StatusNotFound {
+					return xerrors.Errorf("your deployment appears to be an AGPL deployment, so you cannot set --max-ttl")
+				} else if err != nil {
+					return xerrors.Errorf("get entitlements: %w", err)
+				}
+
+				if !entitlements.Features[codersdk.FeatureAdvancedTemplateScheduling].Enabled {
+					return xerrors.Errorf("your license is not entitled to use advanced template scheduling, so you cannot set --max-ttl")
+				}
+			}
+
 			organization, err := CurrentOrganization(cmd, client)
 			if err != nil {
 				return xerrors.Errorf("get current organization: %w", err)
@@ -46,6 +63,7 @@ func templateEdit() *cobra.Command {
 				Description:                  description,
 				Icon:                         icon,
 				DefaultTTLMillis:             defaultTTL.Milliseconds(),
+				MaxTTLMillis:                 maxTTL.Milliseconds(),
 				AllowUserCancelWorkspaceJobs: allowUserCancelWorkspaceJobs,
 			}
 
@@ -58,11 +76,12 @@ func templateEdit() *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVarP(&name, "name", "", "", "Edit the template name")
-	cmd.Flags().StringVarP(&displayName, "display-name", "", "", "Edit the template display name")
-	cmd.Flags().StringVarP(&description, "description", "", "", "Edit the template description")
-	cmd.Flags().StringVarP(&icon, "icon", "", "", "Edit the template icon path")
-	cmd.Flags().DurationVarP(&defaultTTL, "default-ttl", "", 0, "Edit the template default time before shutdown - workspaces created from this template to this value.")
+	cmd.Flags().StringVarP(&name, "name", "", "", "Edit the template name.")
+	cmd.Flags().StringVarP(&displayName, "display-name", "", "", "Edit the template display name.")
+	cmd.Flags().StringVarP(&description, "description", "", "", "Edit the template description.")
+	cmd.Flags().StringVarP(&icon, "icon", "", "", "Edit the template icon path.")
+	cmd.Flags().DurationVarP(&defaultTTL, "default-ttl", "", 0, "Edit the template default time before shutdown - workspaces created from this template default to this value.")
+	cmd.Flags().DurationVarP(&maxTTL, "max-ttl", "", 0, "Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.")
 	cmd.Flags().BoolVarP(&allowUserCancelWorkspaceJobs, "allow-user-cancel-workspace-jobs", "", true, "Allow users to cancel in-progress workspace jobs.")
 	cliui.AllowSkipPrompt(cmd)
 

diff --git a/cli/templateedit_test.go b/cli/templateedit_test.go
@@ -1,8 +1,17 @@
 package cli_test
 
 import (
+	"bytes"
 	"context"
+	"encoding/json"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"net/http/httputil"
+	"net/url"
 	"strconv"
+	"strings"
+	"sync/atomic"
 	"testing"
 	"time"
 
@@ -11,6 +20,7 @@ import (
 
 	"github.com/coder/coder/cli/clitest"
 	"github.com/coder/coder/coderd/coderdtest"
+	"github.com/coder/coder/coderd/httpapi"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/testutil"
 )
@@ -230,4 +240,205 @@ func TestTemplateEdit(t *testing.T) {
 		assert.Equal(t, "", updated.Icon)
 		assert.Equal(t, "", updated.DisplayName)
 	})
+	t.Run("MaxTTL", func(t *testing.T) {
+		t.Parallel()
+		t.Run("BlockedAGPL", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			cmd, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, client, root)
+
+			ctx, _ := testutil.Context(t)
+			err := cmd.ExecuteContext(ctx)
+			require.Error(t, err)
+			require.ErrorContains(t, err, "appears to be an AGPL deployment")
+
+			// Assert that the template metadata did not change.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+
+		t.Run("BlockedNotEntitled", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Make a proxy server that will return a valid entitlements
+			// response, but without advanced scheduling entitlement.
+			proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.URL.Path == "/api/v2/entitlements" {
+					res := codersdk.Entitlements{
+						Features:         map[codersdk.FeatureName]codersdk.Feature{},
+						Warnings:         []string{},
+						Errors:           []string{},
+						HasLicense:       true,
+						Trial:            true,
+						RequireTelemetry: false,
+						Experimental:     false,
+					}
+					for _, feature := range codersdk.FeatureNames {
+						res.Features[feature] = codersdk.Feature{
+							Entitlement: codersdk.EntitlementNotEntitled,
+							Enabled:     false,
+							Limit:       nil,
+							Actual:      nil,
+						}
+					}
+					httpapi.Write(r.Context(), w, http.StatusOK, res)
+					return
+				}
+
+				// Otherwise, proxy the request to the real API server.
+				httputil.NewSingleHostReverseProxy(client.URL).ServeHTTP(w, r)
+			}))
+			defer proxy.Close()
+
+			// Create a new client that uses the proxy server.
+			proxyURL, err := url.Parse(proxy.URL)
+			require.NoError(t, err)
+			proxyClient := codersdk.New(proxyURL)
+			proxyClient.SetSessionToken(client.SessionToken())
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			cmd, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, proxyClient, root)
+
+			ctx, _ := testutil.Context(t)
+			err = cmd.ExecuteContext(ctx)
+			require.Error(t, err)
+			require.ErrorContains(t, err, "license is not entitled")
+
+			// Assert that the template metadata did not change.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+		t.Run("Entitled", func(t *testing.T) {
+			t.Parallel()
+			client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+			user := coderdtest.CreateFirstUser(t, client)
+			version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+			_ = coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
+			template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
+				ctr.DefaultTTLMillis = nil
+				ctr.MaxTTLMillis = nil
+			})
+
+			// Make a proxy server that will return a valid entitlements
+			// response, including a valid advanced scheduling entitlement.
+			var updateTemplateCalled int64
+			proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.URL.Path == "/api/v2/entitlements" {
+					res := codersdk.Entitlements{
+						Features:         map[codersdk.FeatureName]codersdk.Feature{},
+						Warnings:         []string{},
+						Errors:           []string{},
+						HasLicense:       true,
+						Trial:            true,
+						RequireTelemetry: false,
+						Experimental:     false,
+					}
+					for _, feature := range codersdk.FeatureNames {
+						var one int64 = 1
+						res.Features[feature] = codersdk.Feature{
+							Entitlement: codersdk.EntitlementNotEntitled,
+							Enabled:     true,
+							Limit:       &one,
+							Actual:      &one,
+						}
+					}
+					httpapi.Write(r.Context(), w, http.StatusOK, res)
+					return
+				}
+				if strings.HasPrefix(r.URL.Path, "/api/v2/templates/") {
+					body, err := io.ReadAll(r.Body)
+					require.NoError(t, err)
+					_ = r.Body.Close()
+
+					var req codersdk.UpdateTemplateMeta
+					err = json.Unmarshal(body, &req)
+					require.NoError(t, err)
+					assert.Equal(t, time.Hour.Milliseconds(), req.MaxTTLMillis)
+
+					r.Body = io.NopCloser(bytes.NewReader(body))
+					atomic.AddInt64(&updateTemplateCalled, 1)
+					// We still want to call the real route.
+				}
+
+				// Otherwise, proxy the request to the real API server.
+				httputil.NewSingleHostReverseProxy(client.URL).ServeHTTP(w, r)
+			}))
+			defer proxy.Close()
+
+			// Create a new client that uses the proxy server.
+			proxyURL, err := url.Parse(proxy.URL)
+			require.NoError(t, err)
+			proxyClient := codersdk.New(proxyURL)
+			proxyClient.SetSessionToken(client.SessionToken())
+
+			// Test the cli command.
+			cmdArgs := []string{
+				"templates",
+				"edit",
+				template.Name,
+				"--max-ttl", "1h",
+			}
+			cmd, root := clitest.New(t, cmdArgs...)
+			clitest.SetupConfig(t, proxyClient, root)
+
+			ctx, _ := testutil.Context(t)
+			err = cmd.ExecuteContext(ctx)
+			require.NoError(t, err)
+
+			require.EqualValues(t, 1, atomic.LoadInt64(&updateTemplateCalled))
+
+			// Assert that the template metadata did not change.
+			updated, err := client.Template(context.Background(), template.ID)
+			require.NoError(t, err)
+			assert.Equal(t, template.Name, updated.Name)
+			assert.Equal(t, template.Description, updated.Description)
+			assert.Equal(t, template.Icon, updated.Icon)
+			assert.Equal(t, template.DisplayName, updated.DisplayName)
+			assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
+			assert.Equal(t, template.MaxTTLMillis, updated.MaxTTLMillis)
+		})
+	})
 }
diff --git a/cli/testdata/coder_templates_edit_--help.golden b/cli/testdata/coder_templates_edit_--help.golden
@@ -7,12 +7,17 @@ Flags:
       --allow-user-cancel-workspace-jobs   Allow users to cancel in-progress workspace jobs.
                                            (default true)
       --default-ttl duration               Edit the template default time before shutdown -
-                                           workspaces created from this template to this value.
-      --description string                 Edit the template description
-      --display-name string                Edit the template display name
+                                           workspaces created from this template default to
+                                           this value.
+      --description string                 Edit the template description.
+      --display-name string                Edit the template display name.
   -h, --help                               help for edit
-      --icon string                        Edit the template icon path
-      --name string                        Edit the template name
+      --icon string                        Edit the template icon path.
+      --max-ttl duration                   Edit the template maximum time before shutdown -
+                                           workspaces created from this template must shutdown
+                                           within the given duration after starting. This is
+                                           an enterprise-only feature.
+      --name string                        Edit the template name.
   -y, --yes                                Bypass prompts
 
 Global Flags:

diff --git a/site/src/pages/CreateTemplatePage/CreateTemplateForm.tsx b/site/src/pages/CreateTemplatePage/CreateTemplateForm.tsx
@@ -50,7 +50,10 @@ const defaultInitialValues: CreateTemplateData = {
   parameter_values_by_name: undefined,
 }
 
-const getInitialValues = (canSetMaxTTL: boolean, starterTemplate?: TemplateExample) => {
+const getInitialValues = (
+  canSetMaxTTL: boolean,
+  starterTemplate?: TemplateExample,
+) => {
   let initialValues = defaultInitialValues
   if (!canSetMaxTTL) {
     initialValues = {
@@ -97,7 +100,8 @@ export const CreateTemplateForm: FC<CreateTemplateFormProps> = ({
   const styles = useStyles()
   const formFooterStyles = useFormFooterStyles()
   const { entitlements } = useDashboard()
-  const canSetMaxTTL = entitlements.features["advanced_template_scheduling"].enabled
+  const canSetMaxTTL =
+    entitlements.features["advanced_template_scheduling"].enabled
 
   const form = useFormik<CreateTemplateData>({
     initialValues: getInitialValues(canSetMaxTTL, starterTemplate),