Skip to content

fix: prompt when parameter options are incompatible #9247

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.

Sign up for GitHub

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 13 commits into from
Aug 23, 2023
Merged

fix: prompt when parameter options are incompatible #9247

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
33214f5
Correct backend error
mtojek Aug 22, 2023
e831d24
Unable:
mtojek Aug 22, 2023
e5421c4
site: ask for changed parameter option
mtojek Aug 22, 2023
349c6ca
wip: do not ask for required immutables on update
mtojek Aug 22, 2023
0da0b47
test: ParameterOptionChanged
mtojek Aug 22, 2023
1c64cfe
extra test
mtojek Aug 22, 2023
1e41500
Prompt for changed parameter option
mtojek Aug 22, 2023
8cf4b15
cleanup
mtojek Aug 22, 2023
0635b5c
WIP
mtojek Aug 22, 2023
80249a5
Merge branch 'main' into 9163-cleanup-errors
mtojek Aug 23, 2023
e617d16
After merge
mtojek Aug 23, 2023
75d0f41
use enableReinitialize
mtojek Aug 23, 2023
c03a581
Add test for disappeared option
mtojek Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
test: ParameterOptionChanged
  • Loading branch information
@mtojek
mtojek committed Aug 22, 2023
commit 0da0b47095f3f2e0785ec7a49ff2dee913843ef3
61 changes: 60 additions & 1 deletion cli/update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,12 +593,71 @@ func TestUpdateValidateRichParameters(t *testing.T) {
assert.NoError(t, err)
}()

pty.ExpectMatch("Planning workspace...")
<-doneChan
})

t.Run("ParameterOptionChanged", func(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a test case where the chosen template parameter disappears completely?

e.g. before: { 1st, 2nd, 3rd }, after: { 1st, 3rd, 4th }

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added!

t.Parallel()

// Create template and workspace
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
user := coderdtest.CreateFirstUser(t, client)

templateParameters := []*proto.RichParameter{
{Name: stringParameterName, Type: "string", Mutable: true, Required: true, Options: []*proto.RichParameterOption{
{Name: "First option", Description: "This is first option", Value: "1st"},
{Name: "Second option", Description: "This is second option", Value: "2nd"},
{Name: "Third option", Description: "This is third option", Value: "3rd"},
}},
}
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(templateParameters))
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)

inv, root := clitest.New(t, "create", "my-workspace", "--yes", "--template", template.Name, "--parameter", fmt.Sprintf("%s=%s", stringParameterName, "2nd"))
clitest.SetupConfig(t, client, root)
err := inv.Run()
require.NoError(t, err)

// Update template
updatedTemplateParameters := []*proto.RichParameter{
{Name: stringParameterName, Type: "string", Mutable: true, Required: true, Options: []*proto.RichParameterOption{
{Name: "first_option", Description: "This is first option", Value: "1"},
{Name: "second_option", Description: "This is second option", Value: "2"},
{Name: "third_option", Description: "This is third option", Value: "3"},
}},
}

updatedVersion := coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, prepareEchoResponses(updatedTemplateParameters), template.ID)
coderdtest.AwaitTemplateVersionJob(t, client, updatedVersion.ID)
err = client.UpdateActiveTemplateVersion(context.Background(), template.ID, codersdk.UpdateActiveTemplateVersion{
ID: updatedVersion.ID,
})
require.NoError(t, err)

// Update the workspace
inv, root = clitest.New(t, "update", "my-workspace")
clitest.SetupConfig(t, client, root)
doneChan := make(chan struct{})
pty := ptytest.New(t).Attach(inv)
go func() {
defer close(doneChan)
err := inv.Run()
assert.NoError(t, err)
}()

matches := []string{
"Planning workspace...", "",
"aaaa", "",
}
for i := 0; i < len(matches); i += 2 {
match := matches[i]
value := matches[i+1]
pty.ExpectMatch(match)

if value != "" {
pty.WriteLine(value)
}
}
<-doneChan
})
Expand Down