fix issue616 - conftest visibility fixes. This is achieved by

refactoring how nodeid's are constructed.  They now are always
relative to the "common rootdir" of a test run which is determined by
finding a common ancestor of all testrun arguments.

--HG--
branch : issue616

Author: hpk42

CHANGELOG

@@ -1,6 +1,20 @@
 2.7.0.dev (compared to 2.6.4)
 -----------------------------
 
+- fix issue616: conftest.py files and their contained fixutres are now 
+  properly considered for visibility, independently from the exact
+  current working directory and test arguments that are used.
+  Many thanks to Eric Siegerman and his PR235 which contains 
+  systematic tests for conftest visibility and now passes.
+  This change also introduces the concept of a ``rootdir`` which
+  is printed as a new pytest header and documented in the pytest
+  customize web page.
+
+- change reporting of "diverted" tests, i.e. tests that are collected
+  in one file but actually come from another (e.g. when tests in a test class
+  come from a base class in a different file).  We now show the nodeid 
+  and indicate via a postfix the other file.
+
 - add ability to set command line options by environment variable PYTEST_ADDOPTS.
 
 - fix issue655: work around different ways that cause python2/3

_pytest/config.py

@@ -657,6 +657,12 @@ def notify_exception(self, excinfo, option=None):
                 sys.stderr.write("INTERNALERROR> %s\n" %line)
                 sys.stderr.flush()
 
+    def cwd_relative_nodeid(self, nodeid):
+        # nodeid's are relative to the rootpath, compute relative to cwd
+        if self.invocation_dir != self.rootdir:
+            fullpath = self.rootdir.join(nodeid)
+            nodeid = self.invocation_dir.bestrelpath(fullpath)
+        return nodeid
 
     @classmethod
     def fromdictargs(cls, option_dict, args):
@@ -691,14 +697,9 @@ def pytest_load_initial_conftests(self, early_config):
 
     def _initini(self, args):
         parsed_args = self._parser.parse_known_args(args)
-        if parsed_args.inifilename:
-            iniconfig = py.iniconfig.IniConfig(parsed_args.inifilename)
-            if 'pytest' in iniconfig.sections:
-                self.inicfg = iniconfig['pytest']
-            else:
-                self.inicfg = {}
-        else:
-            self.inicfg = getcfg(args, ["pytest.ini", "tox.ini", "setup.cfg"])
+        r = determine_setup(parsed_args.inifilename, parsed_args.file_or_dir)
+        self.rootdir, self.inifile, self.inicfg = r
+        self.invocation_dir = py.path.local()
         self._parser.addini('addopts', 'extra command line options', 'args')
         self._parser.addini('minversion', 'minimally required pytest version')
 
@@ -859,8 +860,58 @@ def getcfg(args, inibasenames):
                 if exists(p):
                     iniconfig = py.iniconfig.IniConfig(p)
                     if 'pytest' in iniconfig.sections:
-                        return iniconfig['pytest']
-    return {}
+                        return base, p, iniconfig['pytest']
+                    elif inibasename == "pytest.ini":
+                        # allowed to be empty
+                        return base, p, {}
+    return None, None, None
+
+
+def get_common_ancestor(args):
+    # args are what we get after early command line parsing (usually
+    # strings, but can be py.path.local objects as well)
+    common_ancestor = None
+    for arg in args:
+        if str(arg)[0] == "-":
+            continue
+        p = py.path.local(arg)
+        if common_ancestor is None:
+            common_ancestor = p
+        else:
+            if p.relto(common_ancestor) or p == common_ancestor:
+                continue
+            elif common_ancestor.relto(p):
+                common_ancestor = p
+            else:
+                shared = p.common(common_ancestor)
+                if shared is not None:
+                    common_ancestor = shared
+    if common_ancestor is None:
+        common_ancestor = py.path.local()
+    elif not common_ancestor.isdir():
+        common_ancestor = common_ancestor.dirpath()
+    return common_ancestor
+
+
+def determine_setup(inifile, args):
+    if inifile:
+        iniconfig = py.iniconfig.IniConfig(inifile)
+        try:
+            inicfg = iniconfig["pytest"]
+        except KeyError:
+            inicfg = None
+        rootdir = get_common_ancestor(args)
+    else:
+        ancestor = get_common_ancestor(args)
+        rootdir, inifile, inicfg = getcfg(
+            [ancestor], ["pytest.ini", "tox.ini", "setup.cfg"])
+        if rootdir is None:
+            for rootdir in ancestor.parts(reverse=True):
+                if rootdir.join("setup.py").exists():
+                    break
+            else:
+                rootdir = ancestor
+    return rootdir, inifile, inicfg or {}
 
 
 def setns(obj, dic):

_pytest/main.py

@@ -457,9 +457,7 @@ def __init__(self, fspath, parent=None, config=None, session=None):
         self.fspath = fspath
 
     def _makeid(self):
-        if self == self.session:
-            return "."
-        relpath = self.session.fspath.bestrelpath(self.fspath)
+        relpath = self.fspath.relto(self.config.rootdir)
         if os.sep != "/":
             relpath = relpath.replace(os.sep, "/")
         return relpath
@@ -510,7 +508,7 @@ class Interrupted(KeyboardInterrupt):
         __module__ = 'builtins' # for py3
 
     def __init__(self, config):
-        FSCollector.__init__(self, py.path.local(), parent=None,
+        FSCollector.__init__(self, config.rootdir, parent=None,
                              config=config, session=self)
         self.config.pluginmanager.register(self, name="session", prepend=True)
         self._testsfailed = 0
@@ -520,6 +518,9 @@ def __init__(self, config):
         self.startdir = py.path.local()
         self._fs2hookproxy = {}
 
+    def _makeid(self):
+        return ""
+
     def pytest_collectstart(self):
         if self.shouldstop:
             raise self.Interrupted(self.shouldstop)
@@ -663,7 +664,7 @@ def _parsearg(self, arg):
             arg = self._tryconvertpyarg(arg)
         parts = str(arg).split("::")
         relpath = parts[0].replace("/", os.sep)
-        path = self.fspath.join(relpath, abs=True)
+        path = self.config.invocation_dir.join(relpath, abs=True)
         if not path.check():
             if self.config.option.pyargs:
                 msg = "file or package not found: "

_pytest/pytester.py

@@ -306,9 +306,8 @@ def getnode(self, config, arg):
         session = Session(config)
         assert '::' not in str(arg)
         p = py.path.local(arg)
-        x = session.fspath.bestrelpath(p)
         config.hook.pytest_sessionstart(session=session)
-        res = session.perform_collect([x], genitems=False)[0]
+        res = session.perform_collect([str(p)], genitems=False)[0]
         config.hook.pytest_sessionfinish(session=session, exitstatus=EXIT_OK)
         return res
 
@@ -395,8 +394,7 @@ def ensure_unconfigure():
     def parseconfigure(self, *args):
         config = self.parseconfig(*args)
         config.do_configure()
-        self.request.addfinalizer(lambda:
-        config.do_unconfigure())
+        self.request.addfinalizer(config.do_unconfigure)
         return config
 
     def getitem(self,  source, funcname="test_func"):

_pytest/python.py

@@ -1653,11 +1653,9 @@ def pytest_plugin_registered(self, plugin):
             # what fixtures are visible for particular tests (as denoted
             # by their test id)
             if p.basename.startswith("conftest.py"):
-                nodeid = self.session.fspath.bestrelpath(p.dirpath())
+                nodeid = p.dirpath().relto(self.config.rootdir)
                 if p.sep != "/":
                     nodeid = nodeid.replace(p.sep, "/")
-                if nodeid == ".":
-                    nodeid = ""
         self.parsefactories(plugin, nodeid)
         self._seenplugins.add(plugin)
 

_pytest/skipping.py

@@ -218,14 +218,14 @@ def show_simple(terminalreporter, lines, stat, format):
     failed = terminalreporter.stats.get(stat)
     if failed:
         for rep in failed:
-            pos = rep.nodeid
-            lines.append(format %(pos, ))
+            pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid)
+            lines.append(format %(pos,))
 
 def show_xfailed(terminalreporter, lines):
     xfailed = terminalreporter.stats.get("xfailed")
     if xfailed:
         for rep in xfailed:
-            pos = rep.nodeid
+            pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid)
             reason = rep.wasxfail
             lines.append("XFAIL %s" % (pos,))
             if reason:
@@ -235,7 +235,7 @@ def show_xpassed(terminalreporter, lines):
     xpassed = terminalreporter.stats.get("xpassed")
     if xpassed:
         for rep in xpassed:
-            pos = rep.nodeid
+            pos = terminalreporter.config.cwd_relative_nodeid(rep.nodeid)
             reason = rep.wasxfail
             lines.append("XPASS %s %s" %(pos, reason))
 

_pytest/terminal.py

@@ -95,7 +95,7 @@ def __init__(self, config, file=None):
         self._numcollected = 0
 
         self.stats = {}
-        self.startdir = self.curdir = py.path.local()
+        self.startdir = py.path.local()
         if file is None:
             file = sys.stdout
         self._tw = self.writer = py.io.TerminalWriter(file)
@@ -111,12 +111,12 @@ def hasopt(self, char):
         char = {'xfailed': 'x', 'skipped': 's'}.get(char, char)
         return char in self.reportchars
 
-    def write_fspath_result(self, fspath, res):
+    def write_fspath_result(self, nodeid, res):
+        fspath = self.config.rootdir.join(nodeid.split("::")[0])
         if fspath != self.currentfspath:
             self.currentfspath = fspath
-            #fspath = self.startdir.bestrelpath(fspath)
+            fspath = self.startdir.bestrelpath(fspath)
             self._tw.line()
-            #relpath = self.startdir.bestrelpath(fspath)
             self._tw.write(fspath + " ")
         self._tw.write(res)
 
@@ -182,12 +182,12 @@ def pytest_deselected(self, items):
     def pytest_runtest_logstart(self, nodeid, location):
         # ensure that the path is printed before the
         # 1st test of a module starts running
-        fspath = nodeid.split("::")[0]
         if self.showlongtestinfo:
-            line = self._locationline(fspath, *location)
+            line = self._locationline(nodeid, *location)
             self.write_ensure_prefix(line, "")
         elif self.showfspath:
-            self.write_fspath_result(fspath, "")
+            fsid = nodeid.split("::")[0]
+            self.write_fspath_result(fsid, "")
 
     def pytest_runtest_logreport(self, report):
         rep = report
@@ -200,7 +200,7 @@ def pytest_runtest_logreport(self, report):
             return
         if self.verbosity <= 0:
             if not hasattr(rep, 'node') and self.showfspath:
-                self.write_fspath_result(rep.fspath, letter)
+                self.write_fspath_result(rep.nodeid, letter)
             else:
                 self._tw.write(letter)
         else:
@@ -213,7 +213,7 @@ def pytest_runtest_logreport(self, report):
                     markup = {'red':True}
                 elif rep.skipped:
                     markup = {'yellow':True}
-            line = self._locationline(str(rep.fspath), *rep.location)
+            line = self._locationline(rep.nodeid, *rep.location)
             if not hasattr(rep, 'node'):
                 self.write_ensure_prefix(line, word, **markup)
                 #self._tw.write(word, **markup)
@@ -237,7 +237,7 @@ def pytest_collectreport(self, report):
         items = [x for x in report.result if isinstance(x, pytest.Item)]
         self._numcollected += len(items)
         if self.hasmarkup:
-            #self.write_fspath_result(report.fspath, 'E')
+            #self.write_fspath_result(report.nodeid, 'E')
             self.report_collect()
 
     def report_collect(self, final=False):
@@ -288,6 +288,10 @@ def pytest_sessionstart(self, session):
             self.write_line(line)
 
     def pytest_report_header(self, config):
+        inifile = ""
+        if config.inifile:
+            inifile = config.rootdir.bestrelpath(config.inifile)
+        lines = ["rootdir: %s, inifile: %s" %(config.rootdir, inifile)]
         plugininfo = config.pluginmanager._plugin_distinfo
         if plugininfo:
             l = []
@@ -296,7 +300,8 @@ def pytest_report_header(self, config):
                 if name.startswith("pytest-"):
                     name = name[7:]
                 l.append(name)
-            return "plugins: %s" % ", ".join(l)
+            lines.append("plugins: %s" % ", ".join(l))
+        return lines
 
     def pytest_collection_finish(self, session):
         if self.config.option.collectonly:
@@ -378,19 +383,24 @@ def _report_keyboardinterrupt(self):
             else:
                 excrepr.reprcrash.toterminal(self._tw)
 
-    def _locationline(self, collect_fspath, fspath, lineno, domain):
+    def _locationline(self, nodeid, fspath, lineno, domain):
+        def mkrel(nodeid):
+            line = self.config.cwd_relative_nodeid(nodeid)
+            if domain and line.endswith(domain):
+                line = line[:-len(domain)]
+                l = domain.split("[")
+                l[0] = l[0].replace('.', '::')  # don't replace '.' in params
+                line += "[".join(l)
+            return line
         # collect_fspath comes from testid which has a "/"-normalized path
-        if fspath and fspath.replace("\\", "/") != collect_fspath:
-            fspath = "%s <- %s" % (collect_fspath, fspath)
+
         if fspath:
-            line = str(fspath)
-            if domain:
-                split = str(domain).split('[')
-                split[0] = split[0].replace('.', '::')  # don't replace '.' in params
-                line += "::" + '['.join(split)
+            res = mkrel(nodeid).replace("::()", "")  # parens-normalization
+            if nodeid.split("::")[0] != fspath.replace("\\", "/"):
+                res += " <- " + self.startdir.bestrelpath(fspath)
         else:
-            line = "[location]"
-        return line + " "
+            res = "[location]"
+        return res + " "
 
     def _getfailureheadline(self, rep):
         if hasattr(rep, 'location'):