- Notifications
You must be signed in to change notification settings - Fork928
feat(cli): create workspace using parameters from existing workspace#10604
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
Show all changes
10 commits Select commitHold shift + click to select a range
3979b41 CopyParameters -first version
mtojek487424d make gen
mtojek925c812 Use resolver
mtojekf0bb47e Improve
mtojek4c9c77e Fix default
mtojekc5f8ee9 make gen
mtojek4deaad0 WIP
mtojekf966294 CLI test
mtojek5861631 copy-parameters-from
mtojek0162795 Fix: use right template version
mtojekFile 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
58 changes: 51 additions & 7 deletionscli/create.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
118 changes: 118 additions & 0 deletionscli/create_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 |
|---|---|---|
| @@ -416,6 +416,124 @@ func TestCreateWithRichParameters(t *testing.T) { | ||
| assert.ErrorContains(t, err, "parameter \""+wrongFirstParameterName+"\" is not present in the template") | ||
| assert.ErrorContains(t, err, "Did you mean: "+firstParameterName) | ||
| }) | ||
| t.Run("CopyParameters", func(t *testing.T) { | ||
| t.Parallel() | ||
| client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true}) | ||
| owner := coderdtest.CreateFirstUser(t, client) | ||
| member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) | ||
| version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, echoResponses) | ||
mtojek marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID) | ||
| // Firstly, create a regular workspace using template with parameters. | ||
| inv, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "-y", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. NB: we now havedbfake.WorkspaceWithAgent if you want to speed things up There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 😢 🎺 | ||
| "--parameter", fmt.Sprintf("%s=%s", firstParameterName, firstParameterValue), | ||
| "--parameter", fmt.Sprintf("%s=%s", secondParameterName, secondParameterValue), | ||
| "--parameter", fmt.Sprintf("%s=%s", immutableParameterName, immutableParameterValue)) | ||
| clitest.SetupConfig(t, member, root) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| inv.Stdout = pty.Output() | ||
| inv.Stderr = pty.Output() | ||
| err := inv.Run() | ||
| require.NoError(t, err, "can't create first workspace") | ||
| // Secondly, create a new workspace using parameters from the previous workspace. | ||
| const otherWorkspace = "other-workspace" | ||
| inv, root = clitest.New(t, "create", "--copy-parameters-from", "my-workspace", otherWorkspace, "-y") | ||
| clitest.SetupConfig(t, member, root) | ||
| pty = ptytest.New(t).Attach(inv) | ||
| inv.Stdout = pty.Output() | ||
| inv.Stderr = pty.Output() | ||
| err = inv.Run() | ||
| require.NoError(t, err, "can't create a workspace based on the source workspace") | ||
| // Verify if the new workspace uses expected parameters. | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{ | ||
| Name: otherWorkspace, | ||
| }) | ||
| require.NoError(t, err, "can't list available workspaces") | ||
| require.Len(t, workspaces.Workspaces, 1) | ||
| otherWorkspaceLatestBuild := workspaces.Workspaces[0].LatestBuild | ||
| buildParameters, err := client.WorkspaceBuildParameters(ctx, otherWorkspaceLatestBuild.ID) | ||
| require.NoError(t, err) | ||
| require.Len(t, buildParameters, 3) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: firstParameterName, Value: firstParameterValue}) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: secondParameterName, Value: secondParameterValue}) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: immutableParameterName, Value: immutableParameterValue}) | ||
| }) | ||
| t.Run("CopyParametersFromNotUpdatedWorkspace", func(t *testing.T) { | ||
| t.Parallel() | ||
| client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true}) | ||
| owner := coderdtest.CreateFirstUser(t, client) | ||
| member, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) | ||
| version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, echoResponses) | ||
| coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID) | ||
| template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID) | ||
| // Firstly, create a regular workspace using template with parameters. | ||
| inv, root := clitest.New(t, "create", "my-workspace", "--template", template.Name, "-y", | ||
| "--parameter", fmt.Sprintf("%s=%s", firstParameterName, firstParameterValue), | ||
| "--parameter", fmt.Sprintf("%s=%s", secondParameterName, secondParameterValue), | ||
| "--parameter", fmt.Sprintf("%s=%s", immutableParameterName, immutableParameterValue)) | ||
| clitest.SetupConfig(t, member, root) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| inv.Stdout = pty.Output() | ||
| inv.Stderr = pty.Output() | ||
| err := inv.Run() | ||
| require.NoError(t, err, "can't create first workspace") | ||
| // Secondly, update the template to the newer version. | ||
| version2 := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, prepareEchoResponses([]*proto.RichParameter{ | ||
| {Name: "third_parameter", Type: "string", DefaultValue: "not-relevant"}, | ||
| }), func(ctvr *codersdk.CreateTemplateVersionRequest) { | ||
| ctvr.TemplateID = template.ID | ||
| }) | ||
| coderdtest.AwaitTemplateVersionJobCompleted(t, client, version2.ID) | ||
| coderdtest.UpdateActiveTemplateVersion(t, client, template.ID, version2.ID) | ||
| // Thirdly, create a new workspace using parameters from the previous workspace. | ||
| const otherWorkspace = "other-workspace" | ||
| inv, root = clitest.New(t, "create", "--copy-parameters-from", "my-workspace", otherWorkspace, "-y") | ||
| clitest.SetupConfig(t, member, root) | ||
| pty = ptytest.New(t).Attach(inv) | ||
| inv.Stdout = pty.Output() | ||
| inv.Stderr = pty.Output() | ||
| err = inv.Run() | ||
| require.NoError(t, err, "can't create a workspace based on the source workspace") | ||
| // Verify if the new workspace uses expected parameters. | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort) | ||
| defer cancel() | ||
| workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{ | ||
| Name: otherWorkspace, | ||
| }) | ||
| require.NoError(t, err, "can't list available workspaces") | ||
| require.Len(t, workspaces.Workspaces, 1) | ||
| otherWorkspaceLatestBuild := workspaces.Workspaces[0].LatestBuild | ||
| require.Equal(t, version.ID, otherWorkspaceLatestBuild.TemplateVersionID) | ||
| buildParameters, err := client.WorkspaceBuildParameters(ctx, otherWorkspaceLatestBuild.ID) | ||
| require.NoError(t, err) | ||
| require.Len(t, buildParameters, 3) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: firstParameterName, Value: firstParameterValue}) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: secondParameterName, Value: secondParameterValue}) | ||
| require.Contains(t, buildParameters, codersdk.WorkspaceBuildParameter{Name: immutableParameterName, Value: immutableParameterValue}) | ||
| }) | ||
| } | ||
| func TestCreateValidateRichParameters(t *testing.T) { | ||
33 changes: 32 additions & 1 deletioncli/parameterresolver.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
3 changes: 3 additions & 0 deletionscli/testdata/coder_create_--help.golden
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
9 changes: 9 additions & 0 deletionsdocs/cli/create.md
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
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.