Merge pull request #80 from dannymcgee/organize-tests-by-labels-ignor…

…e-directory-structure

Fix #79 | Add "Flatten Tests in Explorer" option

package.json

@@ -127,6 +127,13 @@
           "type": "boolean",
           "default": true
         },
+        "jestTestExplorer.flattenExplorer": {
+          "description": "When true, tests in the Test Explorer will be grouped only by `describe` labels instead of file/folder structure.",
+          "scope": "resource",
+          "title": "Flatten Tests in Explorer",
+          "type": "boolean",
+          "default": false
+        },
         "jestTestExplorer.featureToggles": {
           "description": "A list of feature toggles to enable experimental features.",
           "scope": "window",

src/adapter.ts

@@ -4,19 +4,22 @@ import {
   RetireEvent,
   TestAdapter,
   TestEvent,
+  TestInfo,
   TestLoadFinishedEvent,
   TestLoadStartedEvent,
   TestRunFinishedEvent,
   TestRunStartedEvent,
   TestSuiteEvent,
+  TestSuiteInfo,
 } from "vscode-test-adapter-api";
 import { Log } from "vscode-test-adapter-util";
+import { EXTENSION_CONFIGURATION_NAME } from './constants';
 import { emitTestCompleteRootNode, emitTestRunningRootNode } from "./helpers/emitTestCompleteRootNode";
 import { filterTree } from "./helpers/filterTree";
 import { mapIdToString, mapStringToId } from "./helpers/idMaps";
 import { mapJestTestResultsToTestEvents } from "./helpers/mapJestTestResultsToTestEvents";
 import { mapTestIdsToTestFilter } from "./helpers/mapTestIdsToTestFilter";
-import { mapWorkspaceRootToSuite } from "./helpers/mapTreeToSuite";
+import { flatMapWorkspaceRootToSuite, mapWorkspaceRootToSuite } from "./helpers/mapTreeToSuite";
 import mergeRuntimeResults from "./helpers/mergeRuntimeResults";
 import { createWorkspaceRootNode, ProjectRootNode, WorkspaceRootNode } from "./helpers/tree";
 import JestManager, { JestTestAdapterOptions } from "./JestManager";
@@ -88,7 +91,17 @@ export default class JestTestAdapter implements TestAdapter {
 
       const state = await this.projectManager.getTestState();
       this.tree = state.suite;
-      const suite = mapWorkspaceRootToSuite(this.tree);
+
+      const flattenExplorer = vscode.workspace
+        .getConfiguration(EXTENSION_CONFIGURATION_NAME, null)
+        .get<boolean>("flattenExplorer", false);
+
+      const suite = flattenExplorer
+        ? flatMapWorkspaceRootToSuite(this.tree)
+        : mapWorkspaceRootToSuite(this.tree);
+
+      this.log.info("Results:");
+      this.logSuite(suite);
 
       this.testsEmitter.fire({ suite, type: "finished" });
     } catch (error) {
@@ -221,7 +234,14 @@ export default class JestTestAdapter implements TestAdapter {
       this.testsEmitter.fire({ type: "started" });
 
       this.tree = event.suite;
-      const suite = mapWorkspaceRootToSuite(this.tree);
+
+      const flattenExplorer = vscode.workspace
+        .getConfiguration(EXTENSION_CONFIGURATION_NAME, null)
+        .get<boolean>("flattenExplorer", false);
+
+      const suite = flattenExplorer
+        ? flatMapWorkspaceRootToSuite(this.tree)
+        : mapWorkspaceRootToSuite(this.tree);
 
       switch (event.type) {
         case "projectAdded":
@@ -262,4 +282,21 @@ export default class JestTestAdapter implements TestAdapter {
   private retireAllTests() {
     this.retireEmitter.fire({});
   }
+
+  private logSuite(suiteOrTest?: TestSuiteInfo|TestInfo, depth: number = 0): void {
+    if (_.isNil(suiteOrTest)) { return; }
+
+    const indent = (inDepth: number): string => Array(inDepth).fill("  ").join("");
+
+    if (suiteOrTest.label) {
+      this.log.info(`${indent(depth)}${suiteOrTest.label} (${suiteOrTest.type})`);
+    }
+
+    const suite = suiteOrTest as TestSuiteInfo;
+    if (suite.children?.length > 0) {
+      for (const child of suite.children) {
+        this.logSuite(child, depth + 1);
+      }
+    }
+  }
 }

src/helpers/mapTreeToSuite.ts

@@ -7,6 +7,8 @@ import {
   FileNode,
   FileWithParseErrorNode,
   FolderNode,
+  isFolderNode,
+  isProjectRootNode,
   ProjectRootNode,
   TestNode,
   WorkspaceRootNode,
@@ -39,6 +41,57 @@ const mapWorkspaceRootToSuite = (rootNode: WorkspaceRootNode): TestSuiteInfo | u
   };
 };
 
+const flatMapWorkspaceRootToSuite = ({ projects, id, label }: WorkspaceRootNode): TestSuiteInfo | undefined => {
+  if (!projects.length) {
+    return undefined;
+  }
+
+  const suite = projects.reduce<TestSuiteInfo>((results, project) => {
+    // Get an array of only the describe blocks in the current project.
+    const describeBlocks = findDescribeBlocksInNode(project);
+
+    // Map the describe blocks to a tree of suites, nested suites, and tests.
+    const currentChildren = describeBlocks.map(mapDescribeBlockToTestSuite);
+
+    // Merge this project's suites into the results.
+    const children = results.children.concat(currentChildren);
+
+    return { ...results, children };
+  }, {
+    children: [],
+    id,
+    label,
+    type: "suite",
+  });
+
+  // If the final children array is empty, return undefined to prevent the empty project from appearing in the list.
+  if (suite.children.length === 0) {
+    return undefined;
+  }
+
+  return suite;
+};
+
+/**
+ * Recursively performs a deep search of the given node, returning a flat array of DescribeNodes
+ *
+ * @param node The node to begin searching
+ * @param results Accumulated results so far (only relevant for recursive iterations)
+ */
+const findDescribeBlocksInNode = (
+  node: ProjectRootNode | FolderNode | FileNode | FileWithParseErrorNode,
+  results: DescribeNode[] = [],
+): DescribeNode[] => {
+  if (isProjectRootNode(node) || isFolderNode(node)) {
+    const describesInFolders = _.flatMap(node.folders, (folder) => findDescribeBlocksInNode(folder, results));
+    const describesInFiles = _.flatMap(node.files, (file) => findDescribeBlocksInNode(file, results));
+
+    return describesInFolders.concat(describesInFiles).concat(results);
+  } else {
+    return node.describeBlocks.concat(results);
+  }
+};
+
 const shouldHideEmptyProjects = () =>
   vscode.workspace.getConfiguration(EXTENSION_CONFIGURATION_NAME, null).get<boolean>("hideEmptyProjects") ?? true;
 
@@ -100,4 +153,4 @@ const mapTestToTestInfo = (test: TestNode): TestInfo => ({
   type: "test",
 });
 
-export { mapWorkspaceRootToSuite, mapFileNodeToTestSuite, mapDescribeBlockToTestSuite, mapTestToTestInfo };
+export { mapWorkspaceRootToSuite, mapFileNodeToTestSuite, mapDescribeBlockToTestSuite, mapTestToTestInfo, flatMapWorkspaceRootToSuite };

src/helpers/tree.ts

@@ -79,6 +79,14 @@ export interface NodeVisitor {
   visitTestNode: (test: TestNode) => void;
 }
 
+export const isProjectRootNode = (node: { type: string }): node is ProjectRootNode => {
+  return node.type === "projectRootNode";
+}
+
+export const isFolderNode = (node: { type: string }): node is FolderNode => {
+  return node.type === "folder";
+}
+
 export const createWorkspaceRootNode = (): WorkspaceRootNode => {
   return {
     id: "root",