test(agent): use afero for motd tests to allow parallel execution #8329
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
mafredri
commented
Jul 5, 2023
| return test.banner, nil | ||
| } | ||
| client.mu.Unlock() | ||
| time.Sleep(updateInterval) | ||
| <-ready | ||
| <-ready // Wait for two updates to ensure the value has propagated. |
There was a problem hiding this comment.
Review: This is the race fix, if we only wait for one ready, the service banner may not yet be stored in the agents atomic pointer.
There was a problem hiding this comment.
Ahh good find! Thank you for fixing!
code-asher
approved these changes
Jul 5, 2023
| @@ -466,50 +467,51 @@ func TestAgent_Session_TTY_QuietLogin(t *testing.T) { | |||
| } | |||
|
|
|||
| wantNotMOTD := "Welcome to your Coder workspace!" | |||
| wantServiceBanner := "Service banner text goes here" | |||
| wantMaybeServiceBanner := "Service banner text goes here" | |||
There was a problem hiding this comment.
👍 I like the use of maybe; I wish I had thought of that.
| return test.banner, nil | ||
| } | ||
| client.mu.Unlock() | ||
| time.Sleep(updateInterval) | ||
| <-ready | ||
| <-ready // Wait for two updates to ensure the value has propagated. |
There was a problem hiding this comment.
Ahh good find! Thank you for fixing!
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR uses
afero.Fsto read mtod so that test can be run in parallel. A small race-issue is also fixed in the motd update test where we didn't have a guarantee that the service banner value had propagated yet.Before:
After (additionally, these 10s are available for parallel execution of other tests):