Commit 9ce635f7 authored by Zachary Ware's avatar Zachary Ware

Issue #18492: Allow all resources when tests are not run by regrtest.py.

This changeset also includes cleanup allowed by this behavior change.
parent f94686f6
...@@ -188,7 +188,6 @@ def get_comment_header(line): ...@@ -188,7 +188,6 @@ def get_comment_header(line):
return m.group(1) return m.group(1)
if __name__ == "__main__": if __name__ == "__main__":
from test import support; support.use_resources = ['gui']
import unittest import unittest
unittest.main('idlelib.idle_test.test_formatparagraph', unittest.main('idlelib.idle_test.test_formatparagraph',
verbosity=2, exit=False) verbosity=2, exit=False)
...@@ -100,7 +100,5 @@ class History: ...@@ -100,7 +100,5 @@ class History:
self.prefix = None self.prefix = None
if __name__ == "__main__": if __name__ == "__main__":
from test import test_support as support
support.use_resources = ['gui']
from unittest import main from unittest import main
main('idlelib.idle_test.test_idlehistory', verbosity=2, exit=False) main('idlelib.idle_test.test_idlehistory', verbosity=2, exit=False)
...@@ -229,6 +229,5 @@ def get_line_col(index): ...@@ -229,6 +229,5 @@ def get_line_col(index):
return line, col return line, col
if __name__ == "__main__": if __name__ == "__main__":
from test import test_support; test_support.use_resources = ['gui']
import unittest import unittest
unittest.main('idlelib.idle_test.test_searchengine', verbosity=2, exit=False) unittest.main('idlelib.idle_test.test_searchengine', verbosity=2, exit=False)
...@@ -26,7 +26,6 @@ Once test_xyy is written, the following should go at the end of xyy.py, ...@@ -26,7 +26,6 @@ Once test_xyy is written, the following should go at the end of xyy.py,
with xyz (lowercased) added after 'test_'. with xyz (lowercased) added after 'test_'.
--- ---
if __name__ == "__main__": if __name__ == "__main__":
from test import support; support.use_resources = ['gui']
import unittest import unittest
unittest.main('idlelib.idle_test.test_', verbosity=2, exit=False) unittest.main('idlelib.idle_test.test_', verbosity=2, exit=False)
--- ---
...@@ -34,12 +33,12 @@ if __name__ == "__main__": ...@@ -34,12 +33,12 @@ if __name__ == "__main__":
2. Gui Tests 2. Gui Tests
Gui tests need 'requires' and 'use_resources' from test.support Gui tests need 'requires' from test.support (test.test_support in 2.7). A
(test.test_support in 2.7). A test is a gui test if it creates a Tk root or test is a gui test if it creates a Tk root or master object either directly
master object either directly or indirectly by instantiating a tkinter or or indirectly by instantiating a tkinter or idle class. For the benefit of
idle class. For the benefit of buildbot machines that do not have a graphics test processes that either have no graphical environment available or are not
screen, gui tests must be 'guarded' by "requires('gui')" in a setUp allowed to use it, gui tests must be 'guarded' by "requires('gui')" in a
function or method. This will typically be setUpClass. setUp function or method. This will typically be setUpClass.
To avoid interfering with other gui tests, all gui objects must be destroyed To avoid interfering with other gui tests, all gui objects must be destroyed
and deleted by the end of the test. If a widget, such as a Tk root, is created and deleted by the end of the test. If a widget, such as a Tk root, is created
...@@ -57,11 +56,17 @@ and class attributes, also delete the widget. ...@@ -57,11 +56,17 @@ and class attributes, also delete the widget.
del cls.root del cls.root
--- ---
Support.requires('gui') returns true if it is either called in a main module Support.requires('gui') causes the test(s) it guards to be skipped if any of
(which never happens on buildbots) or if use_resources contains 'gui'. a few conditions are met:
Use_resources is set by test.regrtest but not by unittest. So when running - The tests are being run by regrtest.py, and it was started without
tests in another module with unittest, we set it ourselves, as in the xyz.py enabling the "gui" resource with the "-u" command line option.
template above. - The tests are being run on Windows by a service that is not allowed to
interact with the graphical environment.
- The tests are being run on Mac OSX in a process that cannot make a window
manager connection.
- tkinter.Tk cannot be successfully instantiated for some reason.
- test.support.use_resources has been set by something other than
regrtest.py and does not contain "gui".
Since non-gui tests always run, but gui tests only sometimes, tests of non-gui Since non-gui tests always run, but gui tests only sometimes, tests of non-gui
operations should best avoid needing a gui. Methods that make incidental use of operations should best avoid needing a gui. Methods that make incidental use of
...@@ -88,8 +93,8 @@ python -m idlelib.idle_test.test_xyz ...@@ -88,8 +93,8 @@ python -m idlelib.idle_test.test_xyz
To run all idle_test/test_*.py tests, either interactively To run all idle_test/test_*.py tests, either interactively
('>>>', with unittest imported) or from a command line, use one of the ('>>>', with unittest imported) or from a command line, use one of the
following. (Notes: unittest does not run gui tests; in 2.7, 'test ' (with the following. (Notes: in 2.7, 'test ' (with the space) is 'test.regrtest ';
space) is 'test.regrtest '; where present, -v and -ugui can be omitted.) where present, -v and -ugui can be omitted.)
>>> unittest.main('idlelib.idle_test', verbosity=2, exit=False) >>> unittest.main('idlelib.idle_test', verbosity=2, exit=False)
python -m unittest -v idlelib.idle_test python -m unittest -v idlelib.idle_test
...@@ -98,13 +103,13 @@ python -m test.test_idle ...@@ -98,13 +103,13 @@ python -m test.test_idle
The idle tests are 'discovered' by idlelib.idle_test.__init__.load_tests, The idle tests are 'discovered' by idlelib.idle_test.__init__.load_tests,
which is also imported into test.test_idle. Normally, neither file should be which is also imported into test.test_idle. Normally, neither file should be
changed when working on individual test modules. The third command runs runs changed when working on individual test modules. The third command runs
unittest indirectly through regrtest. The same happens when the entire test unittest indirectly through regrtest. The same happens when the entire test
suite is run with 'python -m test'. So that command must work for buildbots suite is run with 'python -m test'. So that command must work for buildbots
to stay green. Idle tests must not disturb the environment in a way that to stay green. Idle tests must not disturb the environment in a way that
makes other tests fail (issue 18081). makes other tests fail (issue 18081).
To run an individual Testcase or test method, extend the dotted name given to To run an individual Testcase or test method, extend the dotted name given to
unittest on the command line. (But gui tests will not this way.) unittest on the command line.
python -m unittest -v idlelib.idle_test.test_xyz.Test_case.test_meth python -m unittest -v idlelib.idle_test.test_xyz.Test_case.test_meth
...@@ -67,5 +67,4 @@ def get_tests(text=True, gui=True, packages=None): ...@@ -67,5 +67,4 @@ def get_tests(text=True, gui=True, packages=None):
yield test yield test
if __name__ == "__main__": if __name__ == "__main__":
test.test_support.use_resources = ['gui']
test.test_support.run_unittest(*get_tests()) test.test_support.run_unittest(*get_tests())
...@@ -16,5 +16,4 @@ def test_main(): ...@@ -16,5 +16,4 @@ def test_main():
test_support.run_unittest(__name__) test_support.run_unittest(__name__)
if __name__ == "__main__": if __name__ == "__main__":
test_support.use_resources = ['urlfetch']
test_main() test_main()
...@@ -2271,7 +2271,7 @@ class ContextFlags(unittest.TestCase): ...@@ -2271,7 +2271,7 @@ class ContextFlags(unittest.TestCase):
"operation raises different flags depending on flags set: " + "operation raises different flags depending on flags set: " +
"expected %s, got %s" % (expected_flags, new_flags)) "expected %s, got %s" % (expected_flags, new_flags))
def test_main(arith=False, verbose=None, todo_tests=None, debug=None): def test_main(arith=None, verbose=None, todo_tests=None, debug=None):
""" Execute the tests. """ Execute the tests.
Runs all arithmetic tests if arith is True or if the "decimal" resource Runs all arithmetic tests if arith is True or if the "decimal" resource
...@@ -2280,7 +2280,7 @@ def test_main(arith=False, verbose=None, todo_tests=None, debug=None): ...@@ -2280,7 +2280,7 @@ def test_main(arith=False, verbose=None, todo_tests=None, debug=None):
init() init()
global TEST_ALL, DEBUG global TEST_ALL, DEBUG
TEST_ALL = arith or is_resource_enabled('decimal') TEST_ALL = arith if arith is not None else is_resource_enabled('decimal')
DEBUG = debug DEBUG = debug
if todo_tests is None: if todo_tests is None:
......
...@@ -17,8 +17,4 @@ def test_main(): ...@@ -17,8 +17,4 @@ def test_main():
support.run_unittest(unittest.TestLoader().loadTestsFromModule(idletest)) support.run_unittest(unittest.TestLoader().loadTestsFromModule(idletest))
if __name__ == '__main__': if __name__ == '__main__':
# Until unittest supports resources, we emulate regrtest's -ugui
# so loaded tests run the same as if textually present here.
# If any Idle test ever needs another resource, add it to the list.
support.use_resources = ['gui'] # use_resources is initially None
unittest.main(verbosity=2, exit=False) unittest.main(verbosity=2, exit=False)
...@@ -249,5 +249,4 @@ def test_main(): ...@@ -249,5 +249,4 @@ def test_main():
if __name__ == "__main__": if __name__ == "__main__":
support.use_resources = ['network']
test_main() test_main()
...@@ -346,21 +346,17 @@ def _is_gui_available(): ...@@ -346,21 +346,17 @@ def _is_gui_available():
return _is_gui_available.result return _is_gui_available.result
def is_resource_enabled(resource): def is_resource_enabled(resource):
"""Test whether a resource is enabled. Known resources are set by """Test whether a resource is enabled.
regrtest.py."""
return use_resources is not None and resource in use_resources
def requires(resource, msg=None): Known resources are set by regrtest.py. If not running under regrtest.py,
"""Raise ResourceDenied if the specified resource is not available. all resources are assumed enabled unless use_resources has been set.
"""
return use_resources is None or resource in use_resources
If the caller's module is __main__ then automatically return True. The def requires(resource, msg=None):
possibility of False being returned occurs when regrtest.py is executing.""" """Raise ResourceDenied if the specified resource is not available."""
if resource == 'gui' and not _is_gui_available(): if resource == 'gui' and not _is_gui_available():
raise ResourceDenied(_is_gui_available.reason) raise ResourceDenied(_is_gui_available.reason)
# see if the caller's module is __main__ - if so, treat as if
# the resource was set
if sys._getframe(1).f_globals.get("__name__") == "__main__":
return
if not is_resource_enabled(resource): if not is_resource_enabled(resource):
if msg is None: if msg is None:
msg = "Use of the `%s' resource not enabled" % resource msg = "Use of the `%s' resource not enabled" % resource
......
...@@ -12,16 +12,10 @@ lib_tk_test = os.path.abspath(os.path.join(this_dir, os.path.pardir, ...@@ -12,16 +12,10 @@ lib_tk_test = os.path.abspath(os.path.join(this_dir, os.path.pardir,
with test_support.DirsOnSysPath(lib_tk_test): with test_support.DirsOnSysPath(lib_tk_test):
import runtktests import runtktests
def test_main(enable_gui=False): def test_main():
if enable_gui:
if test_support.use_resources is None:
test_support.use_resources = ['gui']
elif 'gui' not in test_support.use_resources:
test_support.use_resources.append('gui')
with test_support.DirsOnSysPath(lib_tk_test): with test_support.DirsOnSysPath(lib_tk_test):
test_support.run_unittest( test_support.run_unittest(
*runtktests.get_tests(text=False, packages=['test_tkinter'])) *runtktests.get_tests(text=False, packages=['test_tkinter']))
if __name__ == '__main__': if __name__ == '__main__':
test_main(enable_gui=True) test_main()
...@@ -22,13 +22,7 @@ except TclError, msg: ...@@ -22,13 +22,7 @@ except TclError, msg:
# assuming ttk is not available # assuming ttk is not available
raise unittest.SkipTest("ttk not available: %s" % msg) raise unittest.SkipTest("ttk not available: %s" % msg)
def test_main(enable_gui=False): def test_main():
if enable_gui:
if test_support.use_resources is None:
test_support.use_resources = ['gui']
elif 'gui' not in test_support.use_resources:
test_support.use_resources.append('gui')
with test_support.DirsOnSysPath(lib_tk_test): with test_support.DirsOnSysPath(lib_tk_test):
from test_ttk.support import get_tk_root from test_ttk.support import get_tk_root
try: try:
...@@ -38,4 +32,4 @@ def test_main(enable_gui=False): ...@@ -38,4 +32,4 @@ def test_main(enable_gui=False):
get_tk_root().destroy() get_tk_root().destroy()
if __name__ == '__main__': if __name__ == '__main__':
test_main(enable_gui=True) test_main()
...@@ -46,6 +46,9 @@ Library ...@@ -46,6 +46,9 @@ Library
Tests Tests
----- -----
- Issue #18492: All resources are now allowed when tests are not run by
regrtest.py.
- Issue #21605: Added tests for Tkinter images. - Issue #21605: Added tests for Tkinter images.
- Issue #21493: Added test for ntpath.expanduser(). Original patch by - Issue #21493: Added test for ntpath.expanduser(). Original patch by
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment