-
Notifications
You must be signed in to change notification settings - Fork 955
feat(coderd): add support for presets to the coder API #16526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
dcf47ab
feat(coderd): add support for presets to the coder API
SasSwart e4b5f0d
fix test
SasSwart 212e536
consolidate preset API endpoints
SasSwart 2579887
remove todos
SasSwart 341c2b4
simplify
SasSwart 4fa6674
make -B gen
SasSwart c31ee7b
fix test
SasSwart ce2956d
generate ids for presets by default
SasSwart 63b5770
fix test
SasSwart ce013a5
improve test
SasSwart 22eb048
Merge remote-tracking branch 'origin/main' into jjs/presets-api
SasSwart af4eb7f
make -B gen
SasSwart File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
SasSwart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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() | ||
SasSwart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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) | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.