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

fix(test): mock get_vcs correctly #809

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

abn
Copy link
Member

@abn abn commented Jan 7, 2025

Previously, the test suite relied on the test environment to be the same as that of a developer and hence implicitly providing a git boundary. This allowed for certain test cases using fixtures to fail when tests are run from the release sdist. This change mocks get_vcs to ensure that these cases pass as expected.

Resolves: python-poetry/poetry#9967

Summary by Sourcery

Tests:

  • Mock get_vcs to ensure that test cases using fixtures pass as expected when tests are run from the release sdist.

@abn abn requested a review from a team January 7, 2025 02:36
Copy link

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This pull request mocks the get_vcs function to resolve an issue where test fixtures were failing when tests were run from the release sdist. This ensures that the test suite no longer relies on the test environment being the same as a developer's environment, which implicitly provided a git boundary.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Mock the get_vcs function.
  • Added a new fixture with_mocked_get_vcs that mocks the Git.run method and the get_vcs function itself.
  • The Git.run method is mocked to return a specific string.
  • The get_vcs function is mocked to return a Git object.
tests/conftest.py
Disable global mocking of get_vcs in tests/vcs/test_vcs.py.
  • Added a new fixture with_mocked_get_vcs that overrides the global mock and does nothing, effectively disabling the mock for these specific tests.
tests/vcs/test_vcs.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @abn - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@abn abn enabled auto-merge (rebase) January 7, 2025 11:08
Previously, the test suite relied on the test environment to be the same
as that of a developer and hence implicitly providing a git boundary.
This allowed for certain test cases using fixtures to fail when tests
are run from the release sdist. This change mocks `get_vcs` to ensure
that these cases pass as expected.

Resolves: python-poetry/poetry#9967
@abn abn merged commit 5e5ae74 into python-poetry:main Jan 7, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

poetry-core 2.0.0: three tests fails
2 participants