feat(coderd): add support for presets to the coder API

coder · SasSwart · Feb 12, 2025 · Feb 11, 2025 · Feb 11, 2025 · Feb 12, 2025
commit dcf47ab30d3a38b274d461f3e8f73e4961eed35d
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -1057,6 +1057,10 @@ func New(options *Options) *API {
 			r.Get("/rich-parameters", api.templateVersionRichParameters)
 			r.Get("/external-auth", api.templateVersionExternalAuth)
 			r.Get("/variables", api.templateVersionVariables)
+			r.Route("/presets", func(r chi.Router) {
+				r.Get("/", api.templateVersionPresets)
+				r.Get("/parameters", api.templateVersionPresetParameters)
+			})
 			r.Get("/resources", api.templateVersionResources)
 			r.Get("/logs", api.templateVersionLogs)
 			r.Route("/dry-run", func(r chi.Router) {

diff --git a/coderd/presets.go b/coderd/presets.go
@@ -0,0 +1,77 @@
+package coderd
+
+import (
+	"net/http"
+
+	"github.com/coder/coder/v2/coderd/httpapi"
+	"github.com/coder/coder/v2/coderd/httpmw"
+	"github.com/coder/coder/v2/codersdk"
+)
+
+// @Summary Get template version presets
+// @ID get-template-version-presets
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Templates
+// @Param templateversion path string true "Template version ID" format(uuid)
+// @Success 200 {array} codersdk.Preset
+// @Router /templateversions/{templateversion}/presets [get]
+func (api *API) templateVersionPresets(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	templateVersion := httpmw.TemplateVersionParam(r)
+
+	presets, err := api.Database.GetPresetsByTemplateVersionID(ctx, templateVersion.ID)
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching template version presets.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	var res []codersdk.Preset
+	for _, preset := range presets {
+		res = append(res, codersdk.Preset{
+			ID:   preset.ID,
+			Name: preset.Name,
+		})
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, res)
+}
+
+// @Summary Get template version preset parameters
+// @ID get-template-version-preset-parameters
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Templates
+// @Param templateversion path string true "Template version ID" format(uuid)
+// @Success 200 {array} codersdk.PresetParameter
+// @Router /templateversions/{templateversion}/presets/parameters [get]
+func (api *API) templateVersionPresetParameters(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	templateVersion := httpmw.TemplateVersionParam(r)
+
+	// TODO (sasswart): Test case: what if a user tries to read presets or preset parameters from a different org?
+	// TODO (sasswart): Do a prelim auth check here.
+
+	presetParams, err := api.Database.GetPresetParametersByTemplateVersionID(ctx, templateVersion.ID)
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching template version presets.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	var res []codersdk.PresetParameter
+	for _, presetParam := range presetParams {
+		res = append(res, codersdk.PresetParameter{
+			PresetID: presetParam.TemplateVersionPresetID,
+			Name:     presetParam.Name,
+			Value:    presetParam.Value,
+		})
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, res)
+}
diff --git a/coderd/presets_test.go b/coderd/presets_test.go
@@ -0,0 +1,56 @@
+package coderd_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/v2/coderd/coderdtest"
+	"github.com/coder/coder/v2/coderd/database"
+	"github.com/coder/coder/v2/coderd/database/dbauthz"
+	"github.com/coder/coder/v2/coderd/httpmw"
+	"github.com/coder/coder/v2/coderd/rbac"
+)
+
+func TestTemplateVersionPresets(t *testing.T) {
+	t.Parallel()
+
+	ctx := context.Background()
+
+	client, db := coderdtest.NewWithDatabase(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
+	user := coderdtest.CreateFirstUser(t, client)
+	version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
+
+	// nolint:gocritic // This is a test
+	provisionerCtx := dbauthz.AsProvisionerd(ctx)
+
+	preset, err := db.InsertPreset(provisionerCtx, database.InsertPresetParams{
+		Name:              "My Preset",
+		TemplateVersionID: version.ID,
+	})
+	require.NoError(t, err)
+	_, err = db.InsertPresetParameters(provisionerCtx, database.InsertPresetParametersParams{
+		TemplateVersionPresetID: preset.ID,
+		Names:                   []string{"preset_param1", "preset_param2"},
+		Values:                  []string{"A1B2C3", "D4E5F6"},
+	})
+	require.NoError(t, err)
+
+	userSubject, _, err := httpmw.UserRBACSubject(ctx, db, user.UserID, rbac.ScopeAll)
+	require.NoError(t, err)
+	userCtx := dbauthz.As(ctx, userSubject)
+
+	presets, err := client.TemplateVersionPresets(userCtx, version.ID)
+	require.NoError(t, err)
+	require.Equal(t, 1, len(presets))
+	require.Equal(t, "My Preset", presets[0].Name)
+
+	presetParams, err := client.TemplateVersionPresetParameters(userCtx, version.ID)
+	require.NoError(t, err)
+	require.Equal(t, 2, len(presetParams))
+	require.Equal(t, "preset_param1", presetParams[0].Name)
+	require.Equal(t, "A1B2C3", presetParams[0].Value)
+	require.Equal(t, "preset_param2", presetParams[1].Name)
+	require.Equal(t, "D4E5F6", presetParams[1].Value)
+}