Change readme to use python command instead of pytest to run unit tests #20867
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
brianjlai
approved these changes
Dec 23, 2022
This was referenced Jan 6, 2023
This was referenced Jan 6, 2023
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.
Depending on your setup, when following the guide in the readme to set up a local python venv, the
pytestalias might still point to a global binary which is not running in the venv.This causes the tests to fail in surprising ways (e.g. because dependencies are not installed in the global python environment but are present in the local venv).
As the
pythonalias is definitely pointing to environment which has the dependencies of the cdk installed, this PR changes the readme to run unit tests usingpython -m pytestinstead.