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

Skip test_autobahn if python_on_whales is missing #10597

Merged
merged 1 commit into from
Mar 20, 2025

Conversation

AMDmi3
Copy link
Contributor

@AMDmi3 AMDmi3 commented Mar 18, 2025

What do these changes do?

Docker (and therefore python_on_whales) is not portable and would be missing on e.g. BSD systems.
Instead of failing if python_on_whales cannot be imported, just skip tests which require it.

Are there changes in behavior for the user?

Not really, unless they run tests on BSD, in which case tests should no longer fail.

Is it a substantial burden for the maintainers to support this?

Not really.

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

@AMDmi3 AMDmi3 requested a review from asvetlov as a code owner March 18, 2025 17:53
Copy link

codspeed-hq bot commented Mar 18, 2025

CodSpeed Performance Report

Merging #10597 will not alter performance

Comparing AMDmi3:patch-1 (5d4a7be) with master (1b96586)

Summary

✅ 47 untouched benchmarks

Copy link

codecov bot commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (1b96586) to head (5d4a7be).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #10597      +/-   ##
==========================================
- Coverage   98.71%   98.70%   -0.01%     
==========================================
  Files         125      125              
  Lines       37366    37368       +2     
  Branches     2064     2064              
==========================================
- Hits        36884    36883       -1     
- Misses        335      338       +3     
  Partials      147      147              
Flag Coverage Δ
CI-GHA 98.58% <100.00%> (-0.01%) ⬇️
OS-Linux 98.24% <100.00%> (-0.01%) ⬇️
OS-Windows 96.18% <100.00%> (-0.01%) ⬇️
OS-macOS 97.36% <100.00%> (-0.01%) ⬇️
Py-3.10.11 97.27% <100.00%> (-0.01%) ⬇️
Py-3.10.16 97.81% <100.00%> (+<0.01%) ⬆️
Py-3.11.11 97.89% <100.00%> (+0.04%) ⬆️
Py-3.11.9 97.35% <100.00%> (+<0.01%) ⬆️
Py-3.12.9 98.35% <100.00%> (+<0.01%) ⬆️
Py-3.13.2 98.34% <100.00%> (-0.01%) ⬇️
Py-3.9.13 97.15% <100.00%> (-0.01%) ⬇️
Py-3.9.21 97.68% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 84.34% <100.00%> (-1.26%) ⬇️
VM-macos 97.36% <100.00%> (-0.01%) ⬇️
VM-ubuntu 98.24% <100.00%> (-0.01%) ⬇️
VM-windows 96.18% <100.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Dreamsorcerer Dreamsorcerer added the backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot label Mar 18, 2025
@Dreamsorcerer
Copy link
Member

codecov has dropped. Maybe the current tests don't have python-on-whales installed?

@Dreamsorcerer
Copy link
Member

Definitely appears to be in the requirements file, so not sure if that change is working correctly.

@AMDmi3
Copy link
Contributor Author

AMDmi3 commented Mar 19, 2025

Is there anything which should be done on my side?

@Dreamsorcerer
Copy link
Member

Well, the PR needs to work correctly. i.e. The tests still need to run in our CI.
I'm not sure what is going wrong, but it certainly looks like it's not running the tests anymore.

Docker (and therefore python_on_whales) is not portable and would be missing on e.g. BSD systems. Don't fail tests in that case.
@AMDmi3
Copy link
Contributor Author

AMDmi3 commented Mar 19, 2025

I think I've figured it out.

@Dreamsorcerer Dreamsorcerer added the bot:chronographer:skip This PR does not need to include a change note label Mar 19, 2025
@Dreamsorcerer Dreamsorcerer merged commit 01b2a86 into aio-libs:master Mar 20, 2025
41 checks passed
Copy link
Contributor

patchback bot commented Mar 20, 2025

Backport to 3.12: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 01b2a86 on top of patchback/backports/3.12/01b2a86a6f9e768b24ca3c6f880defe8b895af65/pr-10597

Backporting merged PR #10597 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.12/01b2a86a6f9e768b24ca3c6f880defe8b895af65/pr-10597 upstream/3.12
  4. Now, cherry-pick PR Skip test_autobahn if python_on_whales is missing #10597 contents into that branch:
    $ git cherry-pick -x 01b2a86a6f9e768b24ca3c6f880defe8b895af65
    If it'll yell at you with something like fatal: Commit 01b2a86a6f9e768b24ca3c6f880defe8b895af65 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 01b2a86a6f9e768b24ca3c6f880defe8b895af65
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Skip test_autobahn if python_on_whales is missing #10597 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.12/01b2a86a6f9e768b24ca3c6f880defe8b895af65/pr-10597
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@Dreamsorcerer
Copy link
Member

If you could handle the backport as per the instructions above, that'd be great.

AMDmi3 added a commit to AMDmi3/aiohttp that referenced this pull request Mar 20, 2025
@AMDmi3
Copy link
Contributor Author

AMDmi3 commented Mar 20, 2025

If you could handle the backport as per the instructions above, that'd be great.

See #10614. Does it make sense to also backport it to 3.11?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants