Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use python imports to identify fixtures (part 6/6) #5706

Merged
merged 3 commits into from
Aug 18, 2022

Conversation

cognifloyd
Copy link
Member

@cognifloyd cognifloyd commented Aug 11, 2022

Background

I'm working towards introducing pants. Eventually I would like to use pants to run tests to take advantage of the fine-grained per-file caching of results that accounts for dependencies by python files (pants infers the deps by reading the python files).

In order to use the fine-grained caching, Pants needs to know which tests rely on which fixtures. We could add extra metadata to tie the tests to the fixtures, but that would be an additional maintenance burden that will become out-of-date. We can also include all fixtures for all tests, but then we don't benefit from the fine-grained per-file caching. However, pants can already infer dependencies based on python imports, so that is what this PR (and several follow-up PRs) takes advantage of.

Overview

This PR does the following:

  • turn every fixture into an importable python module with an __init__.py.
  • add a fixture.py file in each fixture that uses the fixturesloader utils (where helpful) to identify itself with PATH and NAME vars.
  • in every test that uses a given fixture, import PATH and/or NAME vars from that fixture.

This PR focuses on the last couple fixtures.

Statistics

Changes Summary (mostly in st2reactor with a little in the winrm_runner):

  • 1 line updated in changelog
  • 5 copies of fixture.py (each has 13 lines of copyright/license header): 16*5=+80 lines
    • some of these are actually __init__.py when that made more sense for a directory of fixtures
  • -11 +17 lines changed in test files to use the new fixture vars.
    We may find need to address additional fixtures in the future, but this is the end of this series of PRs.

@cognifloyd cognifloyd added this to the 3.8.0 milestone Aug 11, 2022
@cognifloyd cognifloyd self-assigned this Aug 11, 2022
@pull-request-size pull-request-size bot added the size/XXL PR that changes 1000+ lines. You should absolutely split your PR into several. label Aug 11, 2022
@cognifloyd cognifloyd changed the title Use python imports to identify fixtures (part 6) Use python imports to identify fixtures (part 6/6) Aug 11, 2022
@cognifloyd cognifloyd changed the base branch from master to fixtures-loading-5 August 11, 2022 22:28
@pull-request-size pull-request-size bot added size/L PR that changes 100-499 lines. Requires some effort to review. and removed size/XXL PR that changes 1000+ lines. You should absolutely split your PR into several. labels Aug 11, 2022
@cognifloyd cognifloyd requested a review from rush-skills August 12, 2022 15:48
Copy link
Member

@rush-skills rush-skills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -22,7 +22,7 @@
from winrm_runner import winrm_ps_script_runner
from winrm_runner.winrm_base import WinRmBaseRunner

FIXTURES_PATH = os.path.join(os.path.dirname(__file__), "fixtures")
from .fixtures import FIXTURES_PATH
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the . necessary here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively we might be able to use this:

Suggested change
from .fixtures import FIXTURES_PATH
from tests.unit.fixtures import FIXTURES_PATH

Relative import was simpler. But I'm fine either way.

Base automatically changed from fixtures-loading-5 to master August 17, 2022 22:36
@cognifloyd cognifloyd requested a review from a team August 17, 2022 22:49
@cognifloyd cognifloyd marked this pull request as ready for review August 17, 2022 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement maintenance pantsbuild refactor size/L PR that changes 100-499 lines. Requires some effort to review. tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants