Change the output format of the pytest adapter. (#4732)

(for #4035)

We are moving to a relatively flat format that captures parent "nodes", in addition to tests. The new format looks like this:

```json
[{
    "rootid": ".",
    "root": "/x/y/z",
    "parents": [{
        "id": "./test_spam.py",
        "kind": "file",
        "name": "test_spam.py",
        "parentid": "."
    }, {
        "id": "./test_spam.py::SpamTests",
        "kind": "suite",
        "name": "SpamTests",
        "parentid": "./test_spam.py"
    },
    "tests" [{
        "id": "./test_spam.py::test_all",
        "name": "test_all",
        "source": "test_spam.py:11",
        "markers": ["skip", "expected-failure"],
        "parentid": "./test_spam.py"
    }, {
        "id": "./test_spam.py::SpamTests::test_spam1",
        "name": "test_spam1",
        "source": "test_spam.py:23",
        "markers": ["skip"],
        "parentid": "./test_spam.py::SpamTests"
    }]
```

This also fixes a couple of bugs that I found while working on the change.

Author: ericsnowcurrently

pythonFiles/testing_tools/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.

pythonFiles/testing_tools/adapter/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.

pythonFiles/testing_tools/adapter/__main__.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from __future__ import absolute_import
 
 import argparse
@@ -7,10 +10,6 @@
 from .errors import UnsupportedToolError, UnsupportedCommandError
 
 
-# Set this to True to pretty-print the output.
-DEBUG=False
-#DEBUG=True
-
 TOOLS = {
     'pytest': {
         '_add_subparser': pytest.add_cli_subparser,
@@ -22,6 +21,7 @@
     }
 
 
+
 def parse_args(
         argv=sys.argv[1:],
         prog=sys.argv[0],
@@ -40,6 +40,9 @@ def parse_args(
     # Add "run" and "debug" subcommands when ready.
     for cmdname in ['discover']:
         sub = cmdsubs.add_parser(cmdname)
+        if cmdname == 'discover':
+            sub.add_argument('--simple', action='store_true')
+            sub.add_argument('--show-pytest', action='store_true')
         subsubs = sub.add_subparsers(dest='tool')
         for toolname in sorted(TOOLS):
             try:
@@ -55,6 +58,14 @@ def parse_args(
     cmd = ns.pop('cmd')
     if not cmd:
         parser.error('missing command')
+    if cmd == 'discover':
+        if '--simple' in toolargs:
+            toolargs.remove('--simple')
+            ns['simple'] = True
+        if '--show-pytest' in toolargs:
+            toolargs.remove('--show-pytest')
+            ns['show_pytest'] = True
+
     tool = ns.pop('tool')
     if not tool:
         parser.error('missing tool')
@@ -75,8 +86,11 @@ def main(toolname, cmdname, subargs, toolargs,
     except KeyError:
         raise UnsupportedCommandError(cmdname)
 
-    result = run(toolargs, **subargs)
-    report_result(result, debug=DEBUG)
+    parents, result = run(toolargs, **subargs)
+    report_result(result, parents,
+                  debug=('-v' in toolargs or '--verbose' in toolargs),
+                  **subargs
+                  )
 
 
 if __name__ == '__main__':

pythonFiles/testing_tools/adapter/errors.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 
 class UnsupportedToolError(ValueError):
     def __init__(self, tool):

pythonFiles/testing_tools/adapter/info.py

@@ -1,9 +1,114 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from collections import namedtuple
 
 
 class TestPath(namedtuple('TestPath', 'root relfile func sub')):
     """Where to find a single test."""
 
+    def __new__(cls, root, relfile, func, sub=None):
+        self = super(TestPath, cls).__new__(
+                cls,
+                str(root) if root else None,
+                str(relfile) if relfile else None,
+                str(func) if func else None,
+                [str(s) for s in sub] if sub else None,
+                )
+        return self
+
+    def __init__(self, *args, **kwargs):
+        if self.root is None:
+            raise TypeError('missing id')
+        if self.relfile is None:
+            raise TypeError('missing kind')
+        # self.func may be None (e.g. for doctests).
+        # self.sub may be None.
+
+
+class ParentInfo(namedtuple('ParentInfo', 'id kind name root parentid')):
+
+    KINDS = ('folder', 'file', 'suite', 'function', 'subtest')
+
+    def __new__(cls, id, kind, name, root=None, parentid=None):
+        self = super(ParentInfo, cls).__new__(
+                cls,
+                str(id) if id else None,
+                str(kind) if kind else None,
+                str(name) if name else None,
+                str(root) if root else None,
+                str(parentid) if parentid else None,
+                )
+        return self
+
+    def __init__(self, *args, **kwargs):
+        if self.id is None:
+            raise TypeError('missing id')
+        if self.kind is None:
+            raise TypeError('missing kind')
+        if self.kind not in self.KINDS:
+            raise ValueError('unsupported kind {!r}'.format(self.kind))
+        if self.name is None:
+            raise TypeError('missing name')
+        if self.root is None:
+            if self.parentid is not None or self.kind != 'folder':
+                raise TypeError('missing root')
+        elif self.parentid is None:
+            raise TypeError('missing parentid')
+
 
-class TestInfo(namedtuple('TestInfo', 'id name path lineno markers')):
+class TestInfo(namedtuple('TestInfo', 'id name path source markers parentid kind')):
     """Info for a single test."""
+
+    MARKERS = ('skip', 'skip-if', 'expected-failure')
+    KINDS = ('function', 'doctest')
+
+    def __new__(cls, id, name, path, source, markers, parentid, kind='function'):
+        self = super(TestInfo, cls).__new__(
+                cls,
+                str(id) if id else None,
+                str(name) if name else None,
+                path or None,
+                str(source) if source else None,
+                [str(marker) for marker in markers or ()],
+                str(parentid) if parentid else None,
+                str(kind) if kind else None,
+                )
+        return self
+
+    def __init__(self, *args, **kwargs):
+        if self.id is None:
+            raise TypeError('missing id')
+        if self.name is None:
+            raise TypeError('missing name')
+        if self.path is None:
+            raise TypeError('missing path')
+        if self.source is None:
+            raise TypeError('missing source')
+        else:
+            srcfile, _, lineno = self.source.rpartition(':')
+            if not srcfile or not lineno or int(lineno) < 0:
+                raise ValueError('bad source {!r}'.format(self.source))
+        if self.markers:
+            badmarkers = [m for m in self.markers if m not in self.MARKERS]
+            if badmarkers:
+                raise ValueError('unsupported markers {!r}'.format(badmarkers))
+        if self.parentid is None:
+            raise TypeError('missing parentid')
+        if self.kind is None:
+            raise TypeError('missing kind')
+        elif self.kind not in self.KINDS:
+            raise ValueError('unsupported kind {!r}'.format(self.kind))
+
+
+    @property
+    def root(self):
+        return self.path.root
+
+    @property
+    def srcfile(self):
+        return self.source.rpartition(':')[0]
+
+    @property
+    def lineno(self):
+        return int(self.source.rpartition(':')[-1])