console: Make settle() indicate success/failure #1404
Conversation
This file contains 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This code adds a simple return value to the settle() call which is useful in scenarios where a command or key sequence needs to be sent to quiet large amounts of console spam (for example linux kernel dmesg). In such cases this action may have to be retried multiple times and it's good to get an indication from settle() whether the console has really settled or a timeout has been reached.
This code is currently used in our deployment, before the change settle() does not have a return value at all therefore this change should not introduce regressions. The testsuite has been run with the change applied without any tests failing.
No changes to the documentation have been performed as the API of ConsoleExpectMixin is not documented there in detail.
Checklist