- Notifications
You must be signed in to change notification settings - Fork926
feat: test parameter immutability validation#18583
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
Draft
Emyrk wants to merge4 commits intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
+74 −4
Conversation
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
Emyrk commentedJun 25, 2025
Comment on lines +355 to +388
| t.Run("ImmutableChangeValue", func(t *testing.T) { | ||
| // Ok this is a weird test to document how things are working. | ||
| // What if a parameter flips it's immutability based on a value? | ||
| // The current behavior is to source immutability from the previous build. | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| // Start with a new template that has 1 parameter that is immutable | ||
| immutable, _ := coderdtest.DynamicParameterTemplate(t, templateAdmin, orgID, coderdtest.DynamicParameterTemplateParams{ | ||
| MainTF: string(must(os.ReadFile("testdata/parameters/dynamicimmutable/main.tf"))), | ||
| }) | ||
| // Create the workspace with the immutable parameter | ||
| wrk, err := templateAdmin.CreateUserWorkspace(ctx, codersdk.Me, codersdk.CreateWorkspaceRequest{ | ||
| TemplateID: immutable.ID, | ||
| Name: coderdtest.RandomUsername(t), | ||
| RichParameterValues: []codersdk.WorkspaceBuildParameter{ | ||
| {Name: "isimmutable", Value: "true"}, | ||
| {Name: "immutable", Value: "coder"}, | ||
| }, | ||
| }) | ||
| require.NoError(t, err) | ||
| coderdtest.AwaitWorkspaceBuildJobCompleted(t, templateAdmin, wrk.LatestBuild.ID) | ||
| // Try new values | ||
| _, err = templateAdmin.CreateWorkspaceBuild(ctx, wrk.ID, codersdk.CreateWorkspaceBuildRequest{ | ||
| Transition: codersdk.WorkspaceTransitionStart, | ||
| RichParameterValues: []codersdk.WorkspaceBuildParameter{ | ||
| {Name: "isimmutable", Value: "false"}, | ||
| {Name: "immutable", Value: "not-coder"}, | ||
| }, | ||
| }) | ||
| require.ErrorContains(t, err, `Previously immutable parameter changed`) | ||
| }) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The test
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
1 participant
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.
What should happen in this situation. A template where the parameter
isimmutablesets the mutability ofimmutable.Terraform:
Trivial Case:
isimmutable = true&immutable = "bar"immutable = fooImmutability source from the past
isimmutable = true&immutable = "bar"immutable = foo&isimmutable = falseEither it:
isimmutableWAS immutable on the previous buildisimmutableis nowmutablefrom the new param