Added support for pytest.ini configuration file #11624
Conversation
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
There was a problem hiding this comment.
Excellent! Thanks Liam. I agree with your decision to not automatically set --rootdir.
--
There's a merge conflict, so you'll need to run something like git pull upstream master. Note that it's better to avoid a rebase now that the pull request is up and has been reviewed, whereas rebasing is often nicer when you're still initially iterating locally.
Resolving merge conflicts can be tricky..let me know if it'd help to pair. Personally, I really like Pycharm to help resolve merge conflicts. I've heard good things about Git Kraken: https://www.gitkraken.com. Or you can manually fix, of course.
--
With the PR description, you can delete that auto-generated part about [ci skip-rust] and [ci skip-build-wheels].
| target = create_test_target(rule_runner, [GOOD_WITH_PRINT]) | ||
| result = run_pytest(rule_runner, target, config="[pytest]\naddopts = -s\n") | ||
| assert result.exit_code == 0 | ||
| assert "All good!" in result.stdout and "Captured" not in result.stdout |
| type=file_option, | ||
| default=None, | ||
| advanced=True, | ||
| help="Path to pytest.ini or alternative Pytest config file", |
There was a problem hiding this comment.
It'd be helpful to include the restrictions you described in the PR description, something like this maybe:
Pytest will attempt to auto-discover the config file, meaning that it should typically be an ancestor of your tests, such as in the build root. Pants will not automatically set
--rootdirfor you to force Pytest to pick up your config file, but you can manually set--rootdirin[pytest].args. Refer to https://docs.pytest.org/en/stable/customize.html#initialization-determining-rootdir-and-configfile.
When adding this, you'd want to use \n\n in between the first sentence and the next sentence. Use soft wrapping otherwise. For example:
pants/src/python/pants/option/global_options.py
Lines 822 to 825 in d44d43c
There was a problem hiding this comment.
Bump on this, as it's definitely a gotcha.
There was a problem hiding this comment.
Fixed in latest commit!
Edit - typo with commas in string and hyperlink; fixed now.
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
| default=None, | ||
| advanced=True, | ||
| help=( | ||
| "Path to pytest.ini or alternative Pytest config file.\n\n" |
There was a problem hiding this comment.
Great detailed help message!
| PathGlobs( | ||
| globs=[pytest.config] if pytest.config else [], | ||
| glob_match_error_behavior=GlobMatchErrorBehavior.error, | ||
| description_of_origin="the option `--pytest-config`", |
There was a problem hiding this comment.
People are far more likely to express this in Pants config, so I'd say maybe [pytest].config?
There was a problem hiding this comment.
Agreed, although I'm working on a PR to fix this across the board + improve the error message for unmatched glos. Currently, all the other subsystems use --pytest-config syntax so it's fine for now, and then I'll fix.
|
Thanks Liam! Made it in time for the release today :) |
Closes #11526 : this adds support for a pytest.ini config file and an associated test. Pytest does not offer support for directly specifying a path for a config file, though this can be done indirectly using
--rootdir=path, which may bring in other issues; however, this can be implemented if need be.[ci skip-rust]
[ci skip-build-wheels]