- Notifications
You must be signed in to change notification settings - Fork927
fix: wait for prompt on rich param CLI test#15406
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
103 changes: 57 additions & 46 deletionscli/update_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 |
|---|---|---|
| @@ -323,7 +323,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace", "--always-prompt") | ||
| inv = inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -333,18 +335,16 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| assert.NoError(t, err) | ||
| }() | ||
| pty.ExpectMatch(stringParameterName) | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
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. I understand the rationale behind proposing this matcher. However, I'm a bit surprised to observe that stdin isn't buffered when input arrives prematurely. Is this the intended behavior, or are you exploring different matcher configurations to address the issue? 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. It's a good point. I looked into this more and there is a race in I'll separately work on a fix for this ^^ I still think this PR is an improvement: in many cases the explicit matches are fewer lines than the looping construct, and are closer to the timing a human would have. It also prevents these tests from deadlocking on failure via the bare 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. I agree, mitigating the risk of deadlocks is certainly valuable here. As for the explicit matchers, I also find them preferable from a readability standpoint; they make the intent clear and reduce ambiguity, allowing developers to quickly grasp the expected input without needing to infer it. | ||
| pty.WriteLine("$$") | ||
| pty.ExpectMatch("does not match") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("") | ||
| pty.ExpectMatch("does not match") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("abc") | ||
| _ = testutil.RequireRecvCtx(ctx, t, doneChan) | ||
| }) | ||
| t.Run("ValidateNumber", func(t *testing.T) { | ||
| @@ -369,7 +369,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace", "--always-prompt") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -379,21 +381,16 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| assert.NoError(t, err) | ||
| }() | ||
| pty.ExpectMatch(numberParameterName) | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("12") | ||
| pty.ExpectMatch("is more than the maximum") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("") | ||
| pty.ExpectMatch("is not a number") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("8") | ||
| _ = testutil.RequireRecvCtx(ctx, t, doneChan) | ||
| }) | ||
| t.Run("ValidateBool", func(t *testing.T) { | ||
| @@ -418,7 +415,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace", "--always-prompt") | ||
| inv = inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -428,18 +427,16 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| assert.NoError(t, err) | ||
| }() | ||
| pty.ExpectMatch(boolParameterName) | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("cat") | ||
| pty.ExpectMatch("boolean value can be either \"true\" or \"false\"") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("") | ||
| pty.ExpectMatch("boolean value can be either \"true\" or \"false\"") | ||
| pty.ExpectMatch("> Enter a value (default: \"\"): ") | ||
| pty.WriteLine("false") | ||
| _ = testutil.RequireRecvCtx(ctx, t, doneChan) | ||
| }) | ||
| t.Run("RequiredParameterAdded", func(t *testing.T) { | ||
| @@ -485,7 +482,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -508,7 +507,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| pty.WriteLine(value) | ||
| } | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("OptionalParameterAdded", func(t *testing.T) { | ||
| @@ -555,7 +554,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -566,7 +567,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| }() | ||
| pty.ExpectMatch("Planning workspace...") | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("ParameterOptionChanged", func(t *testing.T) { | ||
| @@ -612,7 +613,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -636,7 +639,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| } | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("ParameterOptionDisappeared", func(t *testing.T) { | ||
| @@ -683,7 +686,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -707,7 +712,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| } | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("ParameterOptionFailsMonotonicValidation", func(t *testing.T) { | ||
| @@ -739,7 +744,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace", "--always-prompt=true") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| @@ -762,7 +769,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| pty.ExpectMatch(match) | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("ImmutableRequiredParameterExists_MutableRequiredParameterAdded", func(t *testing.T) { | ||
| @@ -804,7 +811,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -828,7 +837,7 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| } | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| t.Run("MutableRequiredParameterExists_ImmutableRequiredParameterAdded", func(t *testing.T) { | ||
| @@ -874,7 +883,9 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| require.NoError(t, err) | ||
| // Update the workspace | ||
| ctx := testutil.Context(t, testutil.WaitLong) | ||
| inv, root = clitest.New(t, "update", "my-workspace") | ||
| inv.WithContext(ctx) | ||
| clitest.SetupConfig(t, member, root) | ||
| doneChan := make(chan struct{}) | ||
| pty := ptytest.New(t).Attach(inv) | ||
| @@ -898,6 +909,6 @@ func TestUpdateValidateRichParameters(t *testing.T) { | ||
| } | ||
| } | ||
| _ = testutil.RequireRecvCtx(ctx, t,doneChan) | ||
| }) | ||
| } | ||
2 changes: 1 addition & 1 deletionpty/ptytest/ptytest.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 |
|---|---|---|
| @@ -198,7 +198,7 @@ func (e *outExpecter) expectMatcherFunc(ctx context.Context, str string, fn func | ||
| e.fatalf("read error", "%v (wanted %q; got %q)", err, str, buffer.String()) | ||
| return "" | ||
| } | ||
| e.logf("matched %q = %q", str, buffer.String()) | ||
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. this can be misleading, since we don't strip the the string of ANSI codes when matching. | ||
| return buffer.String() | ||
| } | ||
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.