bazel-contrib / bazel-contrib/rules_python

[gazelle] Support resolving pytest fixtures

Open
#2,162 2 comments 3 reactions 0 assignees View on GitHub
gazelle help wanted
Dominant language
Starlark
Stars
688
Forks
721
Avg merge
14h 49m
Merged PRs (30d)
81

Description

# 🚀 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.