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

Suppress pytest warnings due to test util classes #3660

Merged
merged 3 commits into from May 10, 2019

Conversation

@cxong
Copy link
Contributor

commented Mar 22, 2019

What do these changes do?

We are using pytest; by default it collects tests in:

  • files that are named test_*.py
  • classes that are named Test*

Unfortunately this matches the TestServer/TestClient classes in aiohttp. Since they have __init__() methods they won't break tests, but there will be warnings:

<path>/site-packages/aiohttp/test_utils.py:128
  <path>/site-packages/aiohttp/test_utils.py:128: PytestWarning: cannot collect test class 'TestServer' because it has a __init__ constructor
    class TestServer(BaseTestServer):

<path>/site-packages/aiohttp/test_utils.py:152
  <path>/site-packages/aiohttp/test_utils.py:152: PytestWarning: cannot collect test class 'TestClient' because it has a __init__ constructor
    class TestClient:

-- Docs: https://docs.pytest.org/en/latest/warnings.html

The easiest way would be to exclude these tests from pytest collection via __test__ = False. See https://stackoverflow.com/q/24614851/2038264

Are there changes in behavior for the user?

N/A

Related issue number

N/A

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_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@cxong cxong requested a review from asvetlov as a code owner Mar 22, 2019

cxong added 2 commits Mar 22, 2019

@cxong cxong requested a review from webknjaz as a code owner Mar 22, 2019

@codecov-io

This comment has been minimized.

Copy link

commented Mar 22, 2019

Codecov Report

Merging #3660 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #3660      +/-   ##
=========================================
+ Coverage    97.9%   97.9%   +<.01%     
=========================================
  Files          43      43              
  Lines        8556    8558       +2     
  Branches     1376    1376              
=========================================
+ Hits         8377    8379       +2     
  Misses         74      74              
  Partials      105     105
Impacted Files Coverage Δ
aiohttp/test_utils.py 99.35% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7345ffb...a1406bd. Read the comment docs.

1 similar comment
@codecov-io

This comment has been minimized.

Copy link

commented Mar 22, 2019

Codecov Report

Merging #3660 into master will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #3660      +/-   ##
=========================================
+ Coverage    97.9%   97.9%   +<.01%     
=========================================
  Files          43      43              
  Lines        8556    8558       +2     
  Branches     1376    1376              
=========================================
+ Hits         8377    8379       +2     
  Misses         74      74              
  Partials      105     105
Impacted Files Coverage Δ
aiohttp/test_utils.py 99.35% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7345ffb...a1406bd. Read the comment docs.

@asvetlov

This comment has been minimized.

Copy link
Member

commented May 10, 2019

Cool!
I used to think that we have to rename these classes to avoid conflicts.
If __test__ = False solves the issue I happy to accept the PR!

@asvetlov asvetlov merged commit e6cbce3 into aio-libs:master May 10, 2019

4 of 5 checks passed

license/cla Contributor License Agreement is not signed yet.
Details
Travis CI - Pull Request Build Passed
Details
WIP Ready for review
Details
codecov/patch 100% of diff hit (target 97.9%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
asvetlov added a commit that referenced this pull request May 10, 2019
[3.5] Suppress pytest warnings due to test util classes (#3660)
(cherry picked from commit e6cbce3)

Co-authored-by: Cong <congusbongus@gmail.com>
asvetlov added a commit that referenced this pull request May 11, 2019
[3.5] Suppress pytest warnings due to test util classes (#3660) (#3754)
(cherry picked from commit e6cbce3)

Co-authored-by: Cong <congusbongus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.