Skip to content

unittest: if FunctionTestCase is imported, the loader loads "tests" from it #84867

Closed
Closed
unittest: if FunctionTestCase is imported, the loader loads "tests" from it#84867
Labels
3.10 (EOL)end of life3.8 (EOL)end of life3.9 (EOL)end of lifetestsTests in the Lib/test dirtype-bugAn unexpected behavior, bug, or error

Description

@abetkin
abetkin
mannequin
opened on May 19, 2020
BPO 40690
Nosy @cjerdonek, @remilapeyre, @abetkin
PRs
  • bpo-40690: Check that testcase.__module__ != 'unittest.case' #20237
    		•
    Files
  • test_functiontest.py
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2020-05-19.20:17:05.761>
labels = ['3.8', 'type-bug', 'tests', '3.9', '3.10']
title = 'unittest: if FunctionTestCase is imported, the loader loads "tests" from it'
updated_at = <Date 2020-05-27.21:04:36.962>
user = 'https://github.com/abetkin'

    bugs.python.org fields:

    activity = <Date 2020-05-27.21:04:36.962>
actor = 'remi.lapeyre'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Tests']
creation = <Date 2020-05-19.20:17:05.761>
creator = 'pwtail'
dependencies = []
files = ['49196']
hgrepos = []
issue_num = 40690
keywords = ['patch']
message_count = 6.0
messages = ['369386', '369524', '369547', '369571', '369575', '370135']
nosy_count = 3.0
nosy_names = ['chris.jerdonek', 'remi.lapeyre', 'pwtail']
pr_nums = ['20237']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue40690'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

    Linked PRs

    Activity

    1. abetkin commented on May 19, 2020

      @abetkin
      abetkinmannequin
      on May 19, 2020
      MannequinAuthor

      In [2]: from unittest import FunctionTestCase

      In [3]: loader.loadTestsFromTestCase(FunctionTestCase)
      Out[3]: <unittest.suite.TestSuite tests=[<unittest.case.FunctionTestCase tec=runTest>]>

      In [4]: test = _._tests[0]; test
      Out[4]: <unittest.case.FunctionTestCase tec=runTest>

      In [5]: test._testFunc
      Out[5]: 'runTest'

      In [6]: test._testFunc.__name__
      *** AttributeError: 'str' object has no attribute '__name__'

    2. abetkin
      added
      3.8 (EOL)end of life
      3.9 (EOL)end of life
      testsTests in the Lib/test dir
      type-bugAn unexpected behavior, bug, or error
      on May 19, 2020

    3. remilapeyre commented on May 21, 2020

      @remilapeyre
      remilapeyremannequin
      on May 21, 2020
      Mannequin

      Hi Vitalii, can you give more context about why you are writing this code, what you expect it to do and why is there a bug?

    4. abetkin commented on May 21, 2020

      @abetkin
      abetkinmannequin
      on May 21, 2020
      MannequinAuthor

      If you make an import in a module with your tests

      From unittest import FunctionTestCase

      then you will have 1 extra test in that module (the imported one), moreover, that test will be broken.

    5. cjerdonek commented on May 22, 2020

      @cjerdonek
      cjerdonek
      on May 22, 2020
      Member

      then you will have 1 extra test in that module (the imported one), moreover, that test will be broken.

      If this is true, then how is anyone able to be using FunctionTestCase in their tests today? Is the feature broken?

    6. abetkin commented on May 22, 2020

      @abetkin
      abetkinmannequin
      on May 22, 2020
      MannequinAuthor

      I don't think anyone is using FunctionTestCase

    7. remilapeyre commented on May 27, 2020

      @remilapeyre
      remilapeyremannequin
      on May 27, 2020
      Mannequin

      I checked and FunctionTestCase seems to completely break the loader. The tests for FunctionTestCase in the standard library instantiate the class from inside the method of a TestCase so the loader never see them but even the simple test file I attached completely breaks:

      ✗ python3 -m unittest
      E
      ======================================================================

      Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/runpy.py", line 193, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/__main__.py", line 18, in <module>
    main(module=None)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/main.py", line 101, in __init__
    self.runTests()
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/main.py", line 271, in runTests
    self.result = testRunner.run(self.test)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/runner.py", line 183, in run
    result.printErrors()
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/runner.py", line 109, in printErrors
    self.printErrorList('ERROR', self.errors)
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/runner.py", line 115, in printErrorList
    self.stream.writeln("%s: %s" % (flavour,self.getDescription(test)))
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/runner.py", line 47, in getDescription
    return '\n'.join((str(test), doc_first_line))
  File "/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/unittest/case.py", line 1472, in __str__
    self._testFunc.__name__)
AttributeError: 'str' object has no attribute '__name__'

      I look at plenty of usages of FunctionTestCase on Github and all of them seemed to be false positive, they were copies of the unittest/test/test_functiontestcase.py file

      The patch in the attached PR is not correct thought, it only fixes one of the loader and all of them suffer from the same issue.

    8. remilapeyre
      added
      3.10 (EOL)end of life
      on May 27, 2020
    9. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    10. serhiy-storchaka
      added this to Unittest & doctest issueson May 20, 2022
    11. sobolevn
      added a commit that references this issue on Dec 24, 2022

      pythongh-84867: Do not load tests from `TestCase` and `FunctionTestCase`

      50243c0
    12. serhiy-storchaka
      added a commit that references this issue on Sep 12, 2023

      gh-84867: Do not load tests from TestCase and FunctionTestCase (GH-10…

      66d1d7e
    13. miss-islington
      added 2 commits that reference this issue on Sep 12, 2023

      pythongh-84867: Do not load tests from TestCase and FunctionTestCase (p…

      8c558f5

      pythongh-84867: Do not load tests from TestCase and FunctionTestCase (p…

      949c6f9
    14. serhiy-storchaka
      added a commit that references this issue on Sep 12, 2023

      [3.11] gh-84867: Do not load tests from TestCase and FunctionTestCase (…

      b4c1cf9
    15. vstinner
      added a commit that references this issue on Sep 13, 2023

      pythongh-84867: Do not load tests from TestCase and FunctionTestCase (p…

      5e082da
    16. Yhg1s
      added a commit that references this issue on Oct 2, 2023

      [3.12] gh-84867: Do not load tests from TestCase and FunctionTestCase (…

      2fb39f7
    17. hugovk
      closed this as completedon Jan 11, 2024
    18. github-project-automation
      moved this to Done in Unittest & doctest issueson Jan 11, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.10 (EOL)end of life3.8 (EOL)end of life3.9 (EOL)end of lifetestsTests in the Lib/test dirtype-bugAn unexpected behavior, bug, or error

      Projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions