Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
31e59aa7
Commit
31e59aa7
authored
May 15, 2016
by
Terry Jan Reedy
Browse files
Options
Browse Files
Download
Plain Diff
Merge with 3.5
parents
c85dd85f
af7cf6d2
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
62 additions
and
53 deletions
+62
-53
Lib/idlelib/idle_test/README.txt
Lib/idlelib/idle_test/README.txt
+62
-53
No files found.
Lib/idlelib/idle_test/README.txt
View file @
31e59aa7
...
@@ -2,12 +2,12 @@ README FOR IDLE TESTS IN IDLELIB.IDLE_TEST
...
@@ -2,12 +2,12 @@ README FOR IDLE TESTS IN IDLELIB.IDLE_TEST
0. Quick Start
0. Quick Start
Automated unit tests were added in
2.7 for Python 2.x and
3.3 for Python 3.x.
Automated unit tests were added in 3.3 for Python 3.x.
To run the tests from a command line:
To run the tests from a command line:
python -m test.test_idle
python -m test.test_idle
Human-mediated tests were added later in
2.7 and in
3.4.
Human-mediated tests were added later in 3.4.
python -m idlelib.idle_test.htest
python -m idlelib.idle_test.htest
...
@@ -15,9 +15,10 @@ python -m idlelib.idle_test.htest
...
@@ -15,9 +15,10 @@ python -m idlelib.idle_test.htest
1. Test Files
1. Test Files
The idle directory, idlelib, has over 60 xyz.py files. The idle_test
The idle directory, idlelib, has over 60 xyz.py files. The idle_test
subdirectory should contain a test_xyz.py for each, where 'xyz' is lowercased
subdirectory should contain a test_xyz.py for each, where 'xyz' is
even if xyz.py is not. Here is a possible template, with the blanks after after
lowercased even if xyz.py is not. Here is a possible template, with the
'.' and 'as', and before and after '_' to be filled in.
blanks after after '.' and 'as', and before and after '_' to be filled
in.
import unittest
import unittest
from test.support import requires
from test.support import requires
...
@@ -30,9 +31,9 @@ class _Test(unittest.TestCase):
...
@@ -30,9 +31,9 @@ class _Test(unittest.TestCase):
if __name__ == '__main__':
if __name__ == '__main__':
unittest.main(verbosity=2)
unittest.main(verbosity=2)
Add the following at the end of xyy.py, with the appropriate name added
after
Add the following at the end of xyy.py, with the appropriate name added
'test_'. Some files already have something like this for htest. If so, insert
after 'test_'. Some files already have something like this for htest.
the import and unittest.main lines before the htest lines.
If so, insert
the import and unittest.main lines before the htest lines.
if __name__ == "__main__":
if __name__ == "__main__":
import unittest
import unittest
...
@@ -42,18 +43,25 @@ if __name__ == "__main__":
...
@@ -42,18 +43,25 @@ if __name__ == "__main__":
2. GUI Tests
2. GUI Tests
When run as part of the Python test suite, Idle gui tests need to run
When run as part of the Python test suite, Idle GUI tests need to run
test.support.requires('gui') (test.test_support in 2.7). A test is a gui test
test.support.requires('gui'). A test is a GUI test if it creates a
if it creates a Tk root or master object either directly or indirectly by
tkinter.Tk root or master object either directly or indirectly by
instantiating a tkinter or idle class. For the benefit of test processes that
instantiating a tkinter or idle class. GUI tests cannot run in test
either have no graphical environment available or are not allowed to use it, gui
processes that either have no graphical environment available or are not
tests must be 'guarded' by "requires('gui')" in a setUp function or method.
allowed to use it.
This will typically be setUpClass.
To avoid interfering with other gui tests, all gui objects must be destroyed and
To guard a module consisting entirely of GUI tests, start with
deleted by the end of the test. Widgets, such as a Tk root, created in a setUpX
function, should be destroyed in the corresponding tearDownX. Module and class
from test.support import requires
widget attributes should also be deleted..
requires('gui')
To guard a test class, put "requires('gui')" in its setUpClass function.
To avoid interfering with other GUI tests, all GUI objects must be
destroyed and deleted by the end of the test. Widgets, such as a Tk
root, created in a setUpX function, should be destroyed in the
corresponding tearDownX. Module and class widget attributes should also
be deleted.
@classmethod
@classmethod
def setUpClass(cls):
def setUpClass(cls):
...
@@ -69,37 +77,38 @@ widget attributes should also be deleted..
...
@@ -69,37 +77,38 @@ widget attributes should also be deleted..
Requires('gui') causes the test(s) it guards to be skipped if any of
Requires('gui') causes the test(s) it guards to be skipped if any of
a few conditions are met:
a few conditions are met:
- The tests are being run by regrtest.py, and it was started without
enabling
- The tests are being run by regrtest.py, and it was started without
the "gui" resource with the "-u" command line option.
enabling
the "gui" resource with the "-u" command line option.
- The tests are being run on Windows by a service that is not allowed
to
- The tests are being run on Windows by a service that is not allowed
interact with the graphical environment.
to
interact with the graphical environment.
- The tests are being run on Mac OSX in a process that cannot make a
window
- The tests are being run on Mac OSX in a process that cannot make a
manager connection.
window
manager connection.
- tkinter.Tk cannot be successfully instantiated for some reason.
- tkinter.Tk cannot be successfully instantiated for some reason.
- test.support.use_resources has been set by something other than
- test.support.use_resources has been set by something other than
regrtest.py and does not contain "gui".
regrtest.py and does not contain "gui".
Tests of non-gui operations should avoid creating tk widgets. Incidental uses of
Tests of non-GUI operations should avoid creating tk widgets. Incidental
tk variables and messageboxes can be replaced by the mock classes in
uses of tk variables and messageboxes can be replaced by the mock
idle_test/mock_tk.py. The mock text handles some uses of the tk Text widget.
classes in idle_test/mock_tk.py. The mock text handles some uses of the
tk Text widget.
3. Running Unit Tests
3. Running Unit Tests
Assume that xyz.py and test_xyz.py both end with a unittest.main() call.
Assume that xyz.py and test_xyz.py both end with a unittest.main() call.
Running either from an Idle editor runs all tests in the test_xyz file
with the
Running either from an Idle editor runs all tests in the test_xyz file
version of Python running Idle. Test output appears in the Shell window. T
he
with the version of Python running Idle. Test output appears in t
he
'verbosity=2' option lists all test methods in the file, which is appropriat
e
Shell window. The 'verbosity=2' option lists all test methods in th
e
when developing tests. The 'exit=False' option is needed in xyx.py files when an
file, which is appropriate when developing tests. The 'exit=False'
htest follows.
option is needed in xyx.py files when an
htest follows.
The following command lines also run all test methods, including
The following command lines also run all test methods, including
gui tests, in test_xyz.py. (Both '-m idlelib' and '-m idlelib.idle'
start
gui tests, in test_xyz.py. (Both '-m idlelib' and '-m idlelib.idle'
Idle and so cannot run tests.)
start
Idle and so cannot run tests.)
python -m idlelib.xyz
python -m idlelib.xyz
python -m idlelib.idle_test.test_xyz
python -m idlelib.idle_test.test_xyz
...
@@ -109,35 +118,35 @@ The following runs all idle_test/test_*.py tests interactively.
...
@@ -109,35 +118,35 @@ The following runs all idle_test/test_*.py tests interactively.
>>> import unittest
>>> import unittest
>>> unittest.main('idlelib.idle_test', verbosity=2)
>>> unittest.main('idlelib.idle_test', verbosity=2)
The following run all Idle tests at a command line. Option '-v' is the same as
The following run all Idle tests at a command line. Option '-v' is the
'verbosity=2'. (For 2.7, replace 'test' in the second line with
same as 'verbosity=2'.
'test.regrtest'.)
python -m unittest -v idlelib.idle_test
python -m unittest -v idlelib.idle_test
python -m test -v -ugui test_idle
python -m test -v -ugui test_idle
python -m test.test_idle
python -m test.test_idle
The idle tests are 'discovered' by idlelib.idle_test.__init__.load_tests,
The idle tests are 'discovered' by
which is also imported into test.test_idle. Normally, neither file should be
idlelib.idle_test.__init__.load_tests, which is also imported into
changed when working on individual test modules. The third command runs
test.test_idle. Normally, neither file should be changed when working on
unittest indirectly through regrtest. The same happens when the entire test
individual test modules. The third command runs unittest indirectly
suite is run with 'python -m test'. So that command must work for buildbots
through regrtest. The same happens when the entire test suite is run
to stay green. Idle tests must not disturb the environment in a way that
with 'python -m test'. So that command must work for buildbots to stay
makes other tests fail (issue 18081).
green. Idle tests must not disturb the environment in a way that 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
unittest on the command line.
given to
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
4. Human-mediated Tests
4. Human-mediated Tests
Human-mediated tests are widget tests that cannot be automated but need
human
Human-mediated tests are widget tests that cannot be automated but need
verification. They are contained in idlelib/idle_test/htest.py, which has
human verification. They are contained in idlelib/idle_test/htest.py,
instructions. (Some modules need an auxiliary function, identified with # htest
which has instructions. (Some modules need an auxiliary function,
# on the header line.) The set is about complete, though some tests need
identified with "# htest # on the header line.) The set is about
improvement. To run all htests, run the htest file from an editor or from
the
complete, though some tests need improvement. To run all htests, run
the
command line with:
htest file from an editor or from the
command line with:
python -m idlelib.idle_test.htest
python -m idlelib.idle_test.htest
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment