Repository navigation
diagnose: inject test AnsiConsole to diagnosecmd - #2501
Merged
Merged
Conversation
Diagnostics should try and avoid using other parts of GCM, because those components may be broken in some way. For this reason, the diagnose command does not use the `IConsoleService`, which provides a wrapper around a TTY and prompting `AnsiConsole` (from Spectre.Console), nor the `IStandardStream`, which wrap the stdin, stdout, and stderr streams of the parent process. However, during unit tests of the diagnose command, our use of the static `AnsiConsole` for rich command output means the test harness gets the progress and other informational output. This is typically recommended against by most testing frameworks. Instead, we inject a `TestConsole : IAnsiConsole` into the diagnose command during unit testing. The production command gets the singleton instance of the `AnsiConsole`. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com>
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
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.
Diagnostics should try and avoid using other parts of GCM, because those components may be broken in some way. For this reason, the diagnose command does not use the
IConsoleService, which provides a wrapper around a TTY and promptingAnsiConsole(from Spectre.Console), nor theIStandardStream, which wrap the stdin, stdout, and stderr streams of the parent process.However, during unit tests of the diagnose command, our use of the static
AnsiConsolefor rich command output means the test harness gets the progress and other informational output. This is typically recommended against by most testing frameworks.Instead, we inject a
TestConsole : IAnsiConsoleinto the diagnose command during unit testing. The production command gets the singleton instance of theAnsiConsole.