Fix test collection from packages mixed with directories. #3768 and #3789

[jonozzz]

This should fix the issue but I still can't find a better fix. See the comment in the code.

What happens is: the files and directories are marked as duplicates when the Session starts collection even though they're not turned into nodes right away (the package nodes will do that later). Ideally is that when Session finds a Package it should stop recursing and move on.

[coveralls]

Coverage increased (+0.07%) to 92.542% when pulling abae60c on jonozzz:fix-3768 into 4d8903f on pytest-dev:master.

[nicoddemus]

I'm a little puzzled by the need to handle duplicated paths in Package.collect.

But we really need tests that replicate #3768 and #3789 to prove the patch works and avoid regressions in the future. Please do let me know if you have trouble with the tests. 👍

[nicoddemus]

Yeah this does not really seem necessary, main.pytest_ignore_collect already seems to do the exactly same thing anyway.

[jonozzz]

Initially I copy/pasted the Package class from Session because they both serve very similar functions, and then realized not everything was needed.

[nicoddemus]

Strange, I expect main.pytest_ignore_collect to handle this properly already:

pytest/src/_pytest/main.py

Lines 261 to 284 in 4d8903f

	def pytest_ignore_collect(path, config):
	ignore_paths = config._getconftest_pathlist("collect_ignore", path=path.dirpath())
	ignore_paths = ignore_paths or []
	excludeopt = config.getoption("ignore")
	if excludeopt:
	ignore_paths.extend([py.path.local(x) for x in excludeopt])
	if py.path.local(path) in ignore_paths:
	return True
	allow_in_venv = config.getoption("collect_in_virtualenv")
	if _in_venv(path) and not allow_in_venv:
	return True
	# Skip duplicate paths.
	keepduplicates = config.getoption("keepduplicates")
	duplicate_paths = config.pluginmanager._duplicatepaths
	if not keepduplicates:
	if path in duplicate_paths:
	return True
	else:
	duplicate_paths.add(path)
	return False

If pytest_ignore_collect sees the same path twice, it should ignore the collection when see the path the second time, which would not trigger a new Package item to be collected.

[jonozzz]

The problem is it sees that some modules were already "collected" (at Session level) via the recurse() method. Then when the package goes and tries to collect its children and turn them into nodes it can't because they look like duplicates. Wrong! My first reaction was to try to stop marking them as duplicates at Session level, but everything is so tangled up that I can't find a cleaner way.

[blueyed]

JFI: I've moved it in #4241.

[nicoddemus]

Just FYI, you could have created the actual files in testing/example_scripts and copied the whole directory here like the code above this function does.

The idea is that it is easier to execute the test using pytest as normal during testing/debugging. 😉

This is fine as is, just thought I would mention this for the future. 👍

[nicoddemus]

LGTM! Took the liberty of committing the missing changelog entries. 👍