bazel-contrib / bazel-contrib/rules_python

[gazelle] Support resolving pytest fixtures

未关闭
#2,162 2 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看
gazelle help wanted
主要语言
Starlark
星标
688
派生
721
平均合并
15 小时 7 分钟
30 天内合并 PR
76

描述

# 🚀 feature request

### Description

Gazelle should allow for the configuration and resolution of pytest fixtures. In pytest, fixtures are method parameters that are automatically discovered and injected into test functions by pytest's plugin machinery.

For example,
```
def test_foo(mocker):
mocker.patch(...)
...
```

The `mocker` keyword is a pytest fixture that is found in the `pytest_mock` pip package. Fixtures can also be provided by other targets in the workspace.

### Describe the solution you'd like

Update the gazelle plugin to find pytest fixtures and track them in addition to module dependencies.

Support resolution config for pytest fixtures through `# gazelle:python_resolve_pytest_fixture FIXTURE_NAME TARGET_LABEL` directives.

For the above example `mocker`, a directive line like below could be added to the root build file:

```
# gazelle:python_resolve_pytest_fixture mocker @pip//pytest_mock
```

Doing this would have the rules_python gazelle plugin add `@pip//pytest_mock` to any test target that has a `test_*` function that accepts an argument named `mocker`. Some additional handling will need to be done to track fixture functions that depend on other fixtures.

### Describe alternatives you've considered

I considered using `# gazelle:resolve pytest_fixture FIXTURE_NAME TARGET_LABEL`, but it would require implementing a `CrossResolver` in the gazelle extension to resolve the `pytest_fixture` language. It also feels like it goes a bit against gazelle design to have a language name in a `resolve` directive for which there isn't actually a plugin for. Keeping it all in rules_python's directive configuration seems more appropriate given that rules_python already has special handling for `conftest` files. There could be a whole pytest_fixture indexing process that would allow for automatic resolution of pytest fixtures, but having a manual override seems good enough.

A second alternative is to use `# gazelle:include_dep` lines in every test file that needs a specific fixture dependency, but this is a bit of a pain to maintain.

贡献指南

打开贡献指南

调研方向

Start with the Gazelle plugin's existing special handling for conftest files and trace how module dependencies are tracked. Define how python_resolve_pytest_fixture directives map fixture names to targets, including fixtures that depend on other fixtures. Done means test targets receive the configured fixture dependencies, with resolution behavior covered for the mocker example and nested fixtures.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
build-system, testing-qa
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。