Fix discovery of PyTests with packages inbetween folders

Fixes microsoft#3936

Author: Flamefire

news/2 Fixes/3936.md

@@ -0,0 +1 @@
+Fix discovery of PyTest tests when package folders are inbetween regular test folders (thanks [Alexander Grund](https://github.com/Flamefire))

src/client/unittests/pytest/services/parserService.ts

@@ -30,27 +30,33 @@ export class TestsParser implements ITestsParser {
 
         let haveErrors = false;
 
-        let packagePrefix: string = '';
+        const packages: { indent: number; packagePrefix: string }[] = [];
         content.split(/\r?\n/g).forEach((line, index, lines) => {
             if (options.token && options.token.isCancellationRequested) {
                 return;
             }
 
             const trimmedLine: string = line.trim();
 
-            if (trimmedLine.startsWith('<Package \'')) {
+            if (trimmedLine.startsWith('<Package \'') || trimmedLine.startsWith('<Module \'') || index === lines.length - 1) {
+                let packagePrefix : string = '';
+                if (packages.length > 0) {
+                    packagePrefix = packages[packages.length - 1].packagePrefix;
+                }
                 // Process the previous lines.
                 this.parsePyTestModuleCollectionResult(options.cwd, logOutputLines, testFiles, parentNodes, packagePrefix);
+                let indent = line.indexOf('<');
+                while (packages.length > 0 && packages[packages.length - 1].indent >= indent) {
+                    packages.pop();
+                }
                 logOutputLines = [''];
-
-                packagePrefix = this.extractPackageName(trimmedLine, options.cwd);
+                if (trimmedLine.startsWith('<Package \'')) {
+                    indent = line.indexOf('<');
+                    packagePrefix = this.extractPackageName(trimmedLine, options.cwd);
+                    packages.push({indent: indent, packagePrefix: packagePrefix});
+                }
             }
 
-            if (trimmedLine.startsWith('<Module \'') || index === lines.length - 1) {
-                // Process the previous lines.
-                this.parsePyTestModuleCollectionResult(options.cwd, logOutputLines, testFiles, parentNodes, packagePrefix);
-                logOutputLines = [''];
-            }
             if (errorLine.test(line)) {
                 haveErrors = true;
                 logOutputLines = [''];

src/test/unittests/pytest/pytest_unittest_parser_data.ts

@@ -1383,5 +1383,32 @@ export const pytestScenarioData: PytestDiscoveryScenario[] =
                 "",
                 "======================== no tests ran in 0.36 seconds ========================="
             ]
+        },
+        {
+            pytest_version_spec: ">= 3.7",
+            platform: PytestDataPlatformType.NonWindows,
+            description: "With package inbetween.",
+            rootdir: "/home/user/test/pytest_scenario",
+            test_functions: [
+                "aTest/test_upper.py::test_upper_cmd",
+                "bPackage/testPackage.py::test_package",
+                "zTest/test_lower.py::test_lower_cmd"
+            ],
+            functionCount: 3,
+            stdout: [
+                "============================= test session starts =============================",
+                "platform win32 -- Python 3.7.0, pytest-3.7.4, py-1.6.0, pluggy-0.7.1",
+                "rootdir: /home/user/test/pytest_scenario, inifile:",
+                "collected 3 items",
+                "<Module 'aTest/test_upper.py'>",
+                "  <Function 'test_upper_cmd'>",
+                "<Package '/home/user/test/pytest_scenario/bPackage'>",
+                "  <Module 'testPackage.py'>",
+                "    <Function 'test_package'>",
+                "<Module 'zTest/test_lower.py'>",
+                "  <Function 'test_lower_cmd'>",
+                "",
+                "======================== no tests ran in 0.36 seconds ========================="
+            ]
         }
     ];