coder · Apr 20, 2023
diff --git a/‎cli/cliui/output.go
Lines changed: 32 additions & 0 deletions b/‎cli/cliui/output.go
Lines changed: 32 additions & 0 deletions
diff --git a/‎cli/templateedit_test.go
Lines changed: 5 additions & 3 deletions b/‎cli/templateedit_test.go
Lines changed: 5 additions & 3 deletions
diff --git a/‎coderd/apidoc/docs.go
Lines changed: 98 additions & 0 deletions b/‎coderd/apidoc/docs.go
Lines changed: 98 additions & 0 deletions
diff --git a/‎coderd/apidoc/swagger.json
Lines changed: 88 additions & 0 deletions b/‎coderd/apidoc/swagger.json
Lines changed: 88 additions & 0 deletions
@@ -192,3 +192,35 @@ func (textFormat) AttachOptions(_ *clibase.OptionSet) {}
 func (textFormat) Format(_ context.Context, data any) (string, error) {
 	return fmt.Sprintf("%s", data), nil
 }
+
+// DataChangeFormat allows manipulating the data passed to an output format.
+// This is because sometimes the data needs to be manipulated before it can be
+// passed to the output format.
+// For example, you may want to pass something different to the text formatter
+// than what you pass to the json formatter.
+type DataChangeFormat struct {
+	format OutputFormat
+	change func(data any) (any, error)
+}
+
+// ChangeFormatterData allows manipulating the data passed to an output
+// format.
+func ChangeFormatterData(format OutputFormat, change func(data any) (any, error)) *DataChangeFormat {
+	return &DataChangeFormat{format: format, change: change}
+}
+
+func (d *DataChangeFormat) ID() string {
+	return d.format.ID()
+}
+
+func (d *DataChangeFormat) AttachOptions(opts *clibase.OptionSet) {
+	d.format.AttachOptions(opts)
+}
+
+func (d *DataChangeFormat) Format(ctx context.Context, data any) (string, error) {
+	newData, err := d.change(data)
+	if err != nil {
+		return "", err
+	}
+	return d.format.Format(ctx, newData)
+}
@@ -167,11 +167,13 @@ func TestTemplateEdit(t *testing.T) {
 
 		// Test the cli command.
 		displayName := "New Display Name 789"
+		description := "New Description ABC"
 		icon := "/icons/new-icon.png"
 		cmdArgs := []string{
 			"templates",
 			"edit",
 			template.Name,
+			"--description", description,
 			"--display-name", displayName,
 			"--icon", icon,
 		}
@@ -186,8 +188,8 @@ func TestTemplateEdit(t *testing.T) {
 		// Assert that the template metadata changed.
 		updated, err := client.Template(context.Background(), template.ID)
 		require.NoError(t, err)
-		assert.Equal(t, template.Name, updated.Name)             // doesn't change
-		assert.Equal(t, initialDescription, updated.Description) // doesn't change
+		assert.Equal(t, template.Name, updated.Name) // doesn't change
+		assert.Equal(t, description, updated.Description)
 		assert.Equal(t, displayName, updated.DisplayName)
 		assert.Equal(t, icon, updated.Icon)
 	})
@@ -234,9 +236,9 @@ func TestTemplateEdit(t *testing.T) {
 		require.NoError(t, err)
 		// Properties don't change
 		assert.Equal(t, template.Name, updated.Name)
-		assert.Equal(t, template.Description, updated.Description)
 		// These properties are removed, as the API considers it as "delete" request
 		// See: https://github.com/coder/coder/issues/5066
+		assert.Equal(t, "", updated.Description)
 		assert.Equal(t, "", updated.Icon)
 		assert.Equal(t, "", updated.DisplayName)
 	})