Add pytest-instafail package#1402
Conversation
It doesn't hurt, and may help catch future problems.
It's not relevant to this PR.
There was a problem hiding this comment.
Code Review
This pull request updates the functional testing documentation in CONTRIBUTING.md with additional pytest options and adds the pytest-instafail dependency to the development environment files. Feedback indicates that pytest-max-compat.env.txt was compiled without the correct constraint file, leading to a noisy diff where constraint references were removed. Recompiling this requirements file with the proper constraint settings is recommended to maintain a clean change history.
| # via | ||
| # -c dev_tools/requirements/max_compat/dev.env.txt | ||
| # tensorflow-docs | ||
| # via tensorflow-docs |
There was a problem hiding this comment.
The compilation of pytest-max-compat.env.txt appears to have been run without the constraint file -c dev_tools/requirements/max_compat/dev.env.txt. This has resulted in a massive, noisy diff where the constraint references are removed from the # via comments of almost all packages.
Please recompile this requirements file using the correct constraint file to keep the settings functionally equivalent to the original and maintain a clean change history.
# via
# -c dev_tools/requirements/max_compat/dev.env.txt
# tensorflow-docs
References
- When migrating configuration, keep the settings functionally equivalent to the original to maintain a clean change history. Address known issues in the configuration in a separate change.
This adds the package
pytest-instafailto the requirements for the development environment, so that we can inform people how to use the--instafailto learn about failures immediately. The built-in pytest option-xand--instafailwork in complementary fashion:pytest -xmakes it stop on first failure (and subsequent tests are not executed);pytest --instafailmakes it print failures immediately, but continue execution.Along with that, this PR adds more helpful test info to
CONTRIBUTING.md.