Tests showing up in Installed Plugins list

[Thijs Triemstra]

The about page shows trac test-related plugins being installed. Can these be omitted?

[Ryan J Ollos]

On more than one occasion over the past few weeks I've also noticed these entries showing up as plugins on Plugin Admin panel, but I'm not able to reproduce the issue at the moment.

I've seen two similar cases previously,

• ​http://svn.apache.org/viewvc?view=revision&revision=1502757
• ​http://svn.apache.org/viewvc?view=revision&revision=1513214

However, for this case I think those files should be excluded because of the parameter in setup.py: packages = find_packages(exclude=['*.tests']),.

[Jun Omae]

Reproduced on 1.0-stable branch. Also, I just found non-tests code imports trac.tests.compat. After the patch, the issue went away in my environment.

trac/mimeview/pygments.py

@@ -20 +20 @@
 from trac.env import ISystemInfoProvider
 from trac.mimeview.api import IHTMLPreviewRenderer, Mimeview
 from trac.prefs import IPreferencePanelProvider
-from trac.tests import compat
 from trac.util import get_pkginfo
 from trac.util.datefmt import http_date, localtz
 from trac.util.translation import _

[Thijs Triemstra]

Also noticed that and was confused for a while why Pygments stopped working.

[Ryan J Ollos]

That was an error in [12078/branches/1.0-stable/trac/mimeview/pygments.py]. Thanks for spotting it Jun. I'm not sure how I managed to do something so stupid! The import should go in branches/1.0-stable/trac/mimeview/tests/pygments.py​ because assertIsNone is used there.

[Ryan J Ollos]

I see now why I missed this when testing. When a module does not have from trac.tests import compat, but utilizes a method that is added by the compat module, in Python 2.5.6 execution of the module will fail. Removing from trac.tests import compat from trac/web/tests/chrome.py results in:

PYTHONPATH=. python ./trac/web/tests/href.py
..EEE
======================================================================
ERROR: Build URLs with an empty base.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "./trac/web/tests/href.py", line 77, in test_empty_base
    self.assertIn(
AttributeError: 'HrefTestCase' object has no attribute 'assertIn'

However, executing the module using the -m switch, it succeeds even with the missing import:

PYTHONPATH=. python -m trac.web.tests.href
SKIP: validation of XHTML output in functional tests (no lxml installed)
.....
----------------------------------------------------------------------
Ran 5 tests in 0.004s

OK

As noted in comment:4:ticket:11284, I couldn't get the Pygments module to execute by passing the path, so I had to use the -m switch.

Any idea why execution using the -m switch the tests pass even when a required import is missing? It seems like trac.util.compat is being magically imported somehow.

[Jun Omae]

As noted in comment:4:ticket:11284, I couldn't get the Pygments module to execute by passing the path, so I had to use the -m switch.

If a file is specified in command line, the directory of the file will be added at start of sys.path. Therefore, pygments module in site-packages is hidden on trac.mimeview.tests.pygments.

When using -m option, the current directory will be added at start of sys.path.

Any idea why execution using the -m switch the tests pass even when a required import is missing? It seems like trac.util.compat is being magically imported somehow.

The -m option searches sys.path for the specified module and execute __main__ of the module. The specified module will be imported. Passing the file path, it will not be imported.

As a result, if -m option, it will load the modules which trac.web.tests.href depends, e.g. trac, trac.tests, etc….

$ git checkout 1.0-stable
Switched to branch '1.0-stable'
$ PYTHONPATH=. ~/venv/py25/bin/python -v -m trac.web.tests.href -h 2>&1 | egrep 'import trac\.(tests\.compat|web\.tests\.href)'
import trac.tests.compat # precompiled from trac/tests/compat.pyc
import trac.web.tests.href # from trac/web/tests/href.py
$ PYTHONPATH=. ~/venv/py25/bin/python -v trac/web/tests/href.py -h 2>&1 | egrep 'import trac\.(tests\.compat|web\.tests\.href)'
import trac.tests.compat # precompiled from /home/jun66j5/src/trac/edgewall/git/trac/tests/compat.pyc

See ​1. Command line and environment — Python v2.7.5 documentation.

[Ryan J Ollos]

Fixed on 1.0-stable in [12115] and merged to trunk in [12116].

[Ryan J Ollos]

Replying to jomae:

As noted in comment:4:ticket:11284, I couldn't get the Pygments module to execute by passing the path, so I had to use the -m switch.

If a file is specified in command line, the directory of the file will be added at start of sys.path. Therefore, pygments module in site-packages is hidden on trac.mimeview.tests.pygments.

When using -m option, the current directory will be added at start of sys.path.

I can confirm executing with the -v flag, in which the following is shown:

import pygments # precompiled from /home/user/Workspace/tracdev/teo-rjollos.git/trac/mimeview/tests/pygments.pyc

That makes me consider that it might be better if the Makefile used the -m flag rather than python $(test) $(testopts)​. One downside to specifying a module rather than a path is that the Makefile's test= argument wouldn't be tab-completed on the command line. I also haven't evaluated how testopts might be affected by the change.

[Jun Omae]

That makes me consider that it might be better if the Makefile used the -m flag rather than python $(test) $(testopts)​. One downside to specifying a module rather than a path is that the Makefile's test= argument wouldn't be tab-completed on the command line. I also haven't evaluated how testopts might be affected by the change.

If value of the test argument doesn't exist as a file, automatically add -m option. What do you think?

Before the patch, we can explicitly pass -m option to the test argument, e.g. make test='-m trac.web.tests.href'.

Makefile

@@ -126 +126 @@
 
 ifdef test
 all: status
-       python $(test) $(testopts)
+       $(if $(wildcard $(test)), \
+           python $(test) $(testopts), \
+           python -m $(test) $(testopts))
 else
 all: help
 endif
@@ -378 +380 @@
 
 ifdef test
 test-coverage:
-       coverage run $(test) $(testopts)
+       $(if $(wildcard $(test)), \
+           coverage run $(test) $(testopts), \
+           coverage run -m $(test) $(testopts))
 else
 test-coverage: unit-test-coverage functional-test-coverage
 endif

[Ryan J Ollos]

Replying to jomae:

If value of the test argument doesn't exist as a file, automatically add -m option. What do you think?

That works well. It would be great to push the change.

Places I know of where this behavior could be documented include: TracDev/UnitTests, tags/trac-1.0.1/doc/dev/testing-intro.rst​ and the help section of Makefile.