sys.path in tests contains system directories

[nyb]

BPO	1674555
Nosy	@loewis, @doko42, @ncoghlan, @orsenthil, @pitrou, @devdanzin, @carljm, @merwok, @bitdancer, @ericsnowcurrently, @vadmium, @serhiy-storchaka
Files	make_test_S.patch python-2.7-issue1674555.patch python-3.2-issue1674555.patch python-3.3-issue1674555.patch python-3.4-issue1674555.patch python-2.7-issue1674555.v2.patch

^{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 2007-03-06.01:37:07.000>
labels = ['type-bug', 'tests', 'build']
title = 'sys.path in tests contains system directories'
updated_at = <Date 2020-01-10.20:53:49.123>
user = 'https://bugs.python.org/nyb'

bugs.python.org fields:

activity = <Date 2020-01-10.20:53:49.123>
actor = 'brett.cannon'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Build', 'Tests']
creation = <Date 2007-03-06.01:37:07.000>
creator = 'nyb'
dependencies = []
files = ['20207', '28504', '28505', '28506', '28507', '42868']
hgrepos = []
issue_num = 1674555
keywords = ['patch']
message_count = 19.0
messages = ['31436', '84675', '107216', '124889', '124972', '124993', '125202', '125209', '125215', '125220', '125221', '125224', '127337', '132212', '136552', '179125', '221992', '222012', '265666']
nosy_count = 16.0
nosy_names = ['loewis', 'doko', 'ncoghlan', 'orsenthil', 'pitrou', 'nyb', 'ajaksu2', 'dugan', 'carljm', 'eric.araujo', 'Arfrever', 'r.david.murray', 'eli.bendersky', 'eric.snow', 'martin.panter', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue1674555'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

[nyb]

While trying to debug a testsuite crash, I discovered that a faulty module from the system wide directories was being picked up. The module in question was sgmlop.so, which was being imported by Lib/xmlrpclib.py. (BTW isn't it considered bad form for a module within the Python distribution to load a third party module?)

In my opinion, the main issue here is that while testing a Python build, no out-of-tree modules should be able to be imported in any case, in order to avoid pollution of the testing environment. Yet AFAICT, there is no place where the sys.path is manipulated to remove the out-of-tree directories. I believe that the proper thing to do would be to allow only the build tree module directories in the search path.

Any comments/patches would be appreciated.

Best Regards,

Theodoros Kalamatianos

[devdanzin]

Theodoros,
Can you provide a short script that reproduces this?

[Arfrever]

I noticed the same problem in many tests.
E.g. test___all__ fails when pyxml is installed.

[bitdancer]

One way to "fix" this would be to have make test run the tests with -j1 and pass in the -S and -s flags, and then have regrtest special case test_site and remove those flags for the run of that single test.

An interesting facet of this proposal in that it actually isolates the tests better. But it will also slow down the test suite run a bit. Since the tests are already run twice by make test, that may not matter all that much (that is, it's a start-the-run-and-walk-away situation anyway).

Note that all tests except test_trace currently pass with -S -s.

[bitdancer]

Here is a proof of concept patch if anyone wants to play with it. Note that a higher value could be used for the j option; multiple threads help even on uniprocessor systems since a bunch of the tests spend time waiting around.

The patch removes the '-l' option from the make test run. I'm not sure that matters, since we do our best to fix memory leaks before shipping a release, and we don't use make test to do our leak testing (as far as I know).

I'm not sure this is an appropriate solution, so I won't apply this unless I get some favorable votes from committers and/or packagers.

One interesting thing is that several additional tests show up as altering the execution environment when run this way. That bears investigation at some point, but is an orthogonal issue.

As noted, test_trace does not pass, but only one test within it fails, so that ought to be easy enough to fix. Also note that this "fix" would only be applicable to 3.2 and 2.7.

[loewis]

I find the solution (running every test in a subprocess) a bit too drastic for the problem. How about a modified approach: run regrtest with -S, and have it create a subprocess for test_site only?

[Arfrever]

Apparently this patch isn't sufficient for test___all__.
Please create empty _xmlplus directory (without __init__.py) in site-packages directory appropriate for given sys.prefix (e.g. /usr/lib/python3.2/site-packages/_xmlplus for sys.prefix='/usr').

The output of make test contains:
LD_LIBRARY_PATH=/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102: ./python -Wd -E -bb -S -s ./Lib/test/regrtest.py -j1
== CPython 3.2b2+ (py3k:87612, Jan 3 2011, 18:30:27) [GCC 4.4.5]
== Linux-2.6.34-tuxonice-r8-AFTA-x86_64-Intel-R-_Pentium-R-Dual_CPU_T2390@_1.86GHz-with-gentoo-2.0.1 little-endian
== /var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/build/test_python_2301
[ 1/349] test_grammar
[ 2/349] test_opcodes
[ 3/349] test_dict
[ 4/349] test_builtin
[ 5/349] test_exceptions
[ 6/349] test_types
[ 7/349] test_unittest
[ 8/349] test_doctest

[ 9/349] test_doctest2

[ 10/349] test___all__

Warning -- sys.path was modified by test___all__
test test___all__ failed -- Traceback (most recent call last):
  File "/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/Lib/test/test___all__.py", line 101, in test_all
    self.check_all(modname)
  File "/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/Lib/test/test___all__.py", line 28, in check_all
    raise FailedImport(modname)
  File "/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/Lib/contextlib.py", line 35, in __exit__
    next(self.gen)
  File "/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/Lib/test/support.py", line 623, in _filterwarnings
    raise AssertionError("unhandled warning %s" % reraise[0])
AssertionError: unhandled warning {message : ImportWarning("Not importing directory '/usr/lib/python3.2/site-packages/_xmlplus': missing __init__.py",), category : 'ImportWarning', filename : '/var/tmp/portage/dev-lang/python-3.2_pre20110102/work/python-3.2_pre20110102/Lib/xml/__init__.py', lineno : 26, line : None}
[ 11/349] test___future__
[ 12/349] test__locale
[ 13/349] test_abc