- Notifications
You must be signed in to change notification settings - Fork913
fix(coderd): avoid fetching extra parameters for a preset#16642
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletionscoderd/presets.go
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
152 changes: 111 additions & 41 deletionscoderd/presets_test.go
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 |
|---|---|---|
| @@ -17,58 +17,128 @@ import ( | ||
| func TestTemplateVersionPresets(t *testing.T) { | ||
| t.Parallel() | ||
| testCases := []struct { | ||
| name string | ||
| presets []codersdk.Preset | ||
| }{ | ||
| { | ||
| name: "no presets", | ||
| presets: []codersdk.Preset{}, | ||
| }, | ||
| { | ||
| name: "single preset with parameters", | ||
| presets: []codersdk.Preset{ | ||
| { | ||
| Name: "My Preset", | ||
| Parameters: []codersdk.PresetParameter{ | ||
| { | ||
| Name: "preset_param1", | ||
| Value: "A1B2C3", | ||
| }, | ||
| { | ||
| Name: "preset_param2", | ||
| Value: "D4E5F6", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "multiple presets with overlapping parameters", | ||
SasSwart marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| presets: []codersdk.Preset{ | ||
| { | ||
| Name: "Preset 1", | ||
| Parameters: []codersdk.PresetParameter{ | ||
| { | ||
| Name: "shared_param", | ||
| Value: "value1", | ||
| }, | ||
| { | ||
| Name: "unique_param1", | ||
| Value: "unique1", | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Name: "Preset 2", | ||
| Parameters: []codersdk.PresetParameter{ | ||
| { | ||
| Name: "shared_param", | ||
| Value: "value2", | ||
| }, | ||
| { | ||
| Name: "unique_param2", | ||
| Value: "unique2", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| for _, tc := range testCases { | ||
| tc := tc | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| 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) | ||
| // Insert all presets for this test case | ||
| for _, givenPreset := range tc.presets { | ||
| dbPreset, err := db.InsertPreset(provisionerCtx, database.InsertPresetParams{ | ||
| Name: givenPreset.Name, | ||
| TemplateVersionID: version.ID, | ||
| }) | ||
| require.NoError(t, err) | ||
| if len(givenPreset.Parameters) > 0 { | ||
| var presetParameterNames []string | ||
| var presetParameterValues []string | ||
| for _, presetParameter := range givenPreset.Parameters { | ||
| presetParameterNames = append(presetParameterNames, presetParameter.Name) | ||
| presetParameterValues = append(presetParameterValues, presetParameter.Value) | ||
| } | ||
| _, err = db.InsertPresetParameters(provisionerCtx, database.InsertPresetParametersParams{ | ||
| TemplateVersionPresetID: dbPreset.ID, | ||
| Names: presetParameterNames, | ||
| Values: presetParameterValues, | ||
| }) | ||
| require.NoError(t, err) | ||
| } | ||
| } | ||
| userSubject, _, err := httpmw.UserRBACSubject(ctx, db, user.UserID, rbac.ScopeAll) | ||
| require.NoError(t, err) | ||
| userCtx := dbauthz.As(ctx, userSubject) | ||
| gotPresets, err := client.TemplateVersionPresets(userCtx, version.ID) | ||
| require.NoError(t, err) | ||
| require.Equal(t, len(tc.presets), len(gotPresets)) | ||
| for _, expectedPreset := range tc.presets { | ||
| found := false | ||
| for _, gotPreset := range gotPresets { | ||
| if gotPreset.Name == expectedPreset.Name { | ||
| found = true | ||
| // verify not only that we get the right number of parameters, but that we get the right parameters | ||
| // This ensures that we don't get extra parameters from other presets | ||
| require.Equal(t, len(expectedPreset.Parameters), len(gotPreset.Parameters)) | ||
| for _, expectedParam := range expectedPreset.Parameters { | ||
| require.Contains(t, gotPreset.Parameters, expectedParam) | ||
| } | ||
| break | ||
| } | ||
| } | ||
| require.True(t, found, "Expected preset %s not found in results", expectedPreset.Name) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.