fix(tests): mock PromptSession to prevent console error #851
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
The tests in
tests/test_cli.py
andtests/test_cli_migration.py
were failing with the following error:This error occurs because the
prompt_toolkit
library expects a Windows console but findxterm-256color
instead. This happens when running tests in an environment that doesn't have a proper console buffer. This issue occurs in Windows GitHub runners when the runner iswindows-latest
.Root Cause
The
PromptSession
class from theprompt_toolkit
library attempts to create a console application, which fails in environments without a proper console buffer, leading to theNoConsoleScreenBufferError
.Fix
To resolve this issue, the
PromptSession
class is mocked during the tests to avoid initialization. This prevents theNoConsoleScreenBufferError
from occurring.Testing
tests/test_cli.py
andtests/test_cli_migration.py
pass successfully in both local and CI.Related Issue(s)
prompt-toolkit/python-prompt-toolkit#406
Checklist