Sidebar support

CHANGELOG.md

@@ -6,6 +6,7 @@ Bug-fixes within the same version aren't needed
 ## Master
 
 * Prevent ANSI escape codes from appearing in test messages - seanpoulter
+* Added preliminary support for test sidebar - gstamac
 * Your message here - name
 
 -->

__mocks__/vscode.ts

@@ -39,6 +39,8 @@ const commands = {
   executeCommand: jest.fn(),
 }
 
+const TreeItem = jest.fn()
+
 export {
   languages,
   StatusBarAlignment,
@@ -51,4 +53,5 @@ export {
   DiagnosticSeverity,
   debug,
   commands,
+  TreeItem,
 }

package.json

@@ -44,6 +44,14 @@
         "path": "./syntaxes/jest-snapshot.tmLanguage"
       }
     ],
+    "views": {
+      "test": [
+        {
+          "id": "jest",
+          "name": "Jest"
+        }
+      ]
+    },
     "configuration": {
       "type": "object",
       "title": "Jest configuration",
@@ -118,6 +126,16 @@
           "type": "boolean",
           "default": false
         },
+        "jest.showFilesInSidebar": {
+          "description": "Show filenames in sidebar tree view",
+          "type": "boolean",
+          "default": true
+        },
+        "jest.autoExpandSidebar": {
+          "description": "Automatically expand tests in sidebar tree view",
+          "type": "boolean",
+          "default": true
+        },
         "jest.debugMode": {
           "description": "Enable debug mode to diagnose plugin issues. (see developer console)",
           "type": "boolean",
@@ -204,7 +222,7 @@
   },
   "scripts": {
     "precommit": "lint-staged",
-    "ci": "yarn lint && yarn test --coverage",
+    "ci": "yarn lint && yarn test --coverage --maxWorkers=4",
     "clean-out": "rimraf ./out",
     "vscode:prepublish": "yarn clean-out && tsc -p ./tsconfig.publish.json",
     "compile": "tsc -watch -p ./tsconfig.publish.json",

src/JestExt.ts

@@ -21,6 +21,7 @@ import { hasDocument, isOpenInMultipleEditors } from './editor'
 import { CoverageOverlay } from './Coverage/CoverageOverlay'
 import { JestProcess, JestProcessManager } from './JestProcessManagement'
 import { isWatchNotSupported, WatchMode } from './Jest'
+import { JestTreeProvider } from './SideBar/JestTreeProvider'
 import * as messaging from './messaging'
 
 export class JestExt {
@@ -34,6 +35,8 @@ export class JestExt {
   public debugCodeLensProvider: DebugCodeLensProvider
   debugConfigurationProvider: DebugConfigurationProvider
 
+  sidebarProvider: JestTreeProvider
+
   // So you can read what's going on
   private channel: vscode.OutputChannel
 
@@ -83,6 +86,8 @@ export class JestExt {
     )
     this.debugConfigurationProvider = new DebugConfigurationProvider()
 
+    this.sidebarProvider = new JestTreeProvider(this.testResultProvider, context, pluginSettings.sidebar)
+
     this.jestProcessManager = new JestProcessManager({
       projectWorkspace: workspace,
       runAllTestsFirstInWatchMode: this.pluginSettings.runAllTestsFirst,
@@ -364,6 +369,8 @@ export class JestExt {
     const statusList = this.testResultProvider.updateTestResults(normalizedData)
     updateDiagnostics(statusList, this.failDiagnostics)
 
+    this.sidebarProvider.refresh(data)
+
     const failedFileCount = failedSuiteCount(this.failDiagnostics)
     if (failedFileCount <= 0 && normalizedData.success) {
       status.success()
@@ -423,6 +430,12 @@ export class JestExt {
     }
   }
 
+  public showTest = async (fileName: string, line: number) => {
+    const textRange = new vscode.Range(line, 0, line, 0)
+    const doc = await vscode.workspace.openTextDocument(fileName)
+    await vscode.window.showTextDocument(doc, { selection: textRange })
+  }
+
   onDidCloseTextDocument(document: vscode.TextDocument) {
     this.removeCachedTestResults(document)
     this.removeCachedDecorationTypes(document)

src/Settings/index.ts

@@ -17,6 +17,10 @@ export interface IPluginSettings {
   showCoverageOnLoad: boolean
   coverageFormatter: string
   debugMode?: boolean
+  sidebar: {
+    showFiles: boolean
+    autoExpand: boolean
+  }
 }
 
 export function isDefaultPathToJest(str) {

src/SideBar/JestTreeNode.ts

@@ -0,0 +1,160 @@
+import * as vscode from 'vscode'
+import { TestResultFile, TestResultSuite, TestResultTest } from './TestResultTree'
+import { extensionName } from '../appGlobals'
+
+export type NodeStatus = 'unknown' | 'passed' | 'failed' | 'skipped'
+
+export class JestTreeNode extends vscode.TreeItem {
+  constructor(
+    label: string,
+    public readonly children: JestTreeNode[],
+    context: SidebarContext,
+    public contextValue: string = '',
+    public readonly status: NodeStatus = 'unknown'
+  ) {
+    super(label, children.length > 0 ? context.getTreeItemCollapsibleState() : vscode.TreeItemCollapsibleState.None)
+
+    if (this.status === 'unknown') {
+      this.status = this.calculateStatus()
+    }
+
+    this.iconPath = context.getIconPath(this.status)
+  }
+
+  get tooltip(): string {
+    return this.terseTooltip
+  }
+
+  get terseTooltip(): string {
+    if (this.children.length > 0) {
+      return this.children.map(c => `${this.label} > ` + c.terseTooltip.replace(/\n/g, `\n${this.label} > `)).join('\n')
+    }
+    const prettyStatus = this.status.charAt(0).toUpperCase() + this.status.toLowerCase().slice(1)
+    return `${this.label} ● ${prettyStatus}`
+  }
+
+  calculateStatus(): NodeStatus {
+    if (this.children.length > 0) {
+      if (this.children.find(c => c.status === 'failed')) {
+        return 'failed'
+      }
+      if (this.children.find(c => c.status === 'skipped')) {
+        return 'skipped'
+      }
+      if (!this.children.find(c => c.status !== 'passed')) {
+        return 'passed'
+      }
+    }
+
+    return 'unknown'
+  }
+}
+
+export class JestTreeNodeForTest extends JestTreeNode {
+  constructor(private test: TestResultTest, context: SidebarContext) {
+    super(test.name, [], context, 'test', convertTestStatus(test.status))
+  }
+
+  get tooltip(): string {
+    if (this.test.failureMessages.length > 0) {
+      return `${this.terseTooltip}\n\n${this.test.failureMessages.join('\n')}`
+    }
+    return this.terseTooltip
+  }
+
+  get command(): vscode.Command {
+    return {
+      title: 'Show test',
+      command: `${extensionName}.show-test`,
+      arguments: [this.test.filename, this.test.line],
+    }
+    // codeLens.command = {
+    //   arguments: [codeLens.fileName, escapeRegExp(codeLens.testName)],
+    //   command: `${extensionName}.run-test`,
+    //   title: 'Debug',
+    // }
+  }
+}
+
+export interface ISidebarSettings {
+  showFiles: boolean
+  autoExpand: boolean
+}
+
+export class SidebarContext {
+  showFiles: boolean
+  autoExpand: boolean
+
+  constructor(private extensionContext: vscode.ExtensionContext, private settings: ISidebarSettings) {
+    this.showFiles = settings.showFiles
+    this.autoExpand = settings.autoExpand
+  }
+
+  getTreeItemCollapsibleState() {
+    return this.settings.autoExpand
+      ? vscode.TreeItemCollapsibleState.Expanded
+      : vscode.TreeItemCollapsibleState.Collapsed
+  }
+
+  getIconPath(iconColor: string) {
+    return {
+      light: this.extensionContext.asAbsolutePath('./src/SideBar/light-' + iconColor + '.svg'),
+      dark: this.extensionContext.asAbsolutePath('./src/SideBar/dark-' + iconColor + '.svg'),
+    }
+  }
+}
+
+function convertTestStatus(testStatus: 'failed' | 'passed' | 'pending'): NodeStatus {
+  return testStatus === 'pending' ? 'skipped' : testStatus
+}
+
+export function generateTree(files: undefined | TestResultFile[], context: SidebarContext): JestTreeNode {
+  const rootNode = new JestTreeNode(
+    'Tests',
+    files === undefined ? [] : getNodesFromFiles(files, context),
+    context,
+    'root'
+  )
+  rootNode.collapsibleState = vscode.TreeItemCollapsibleState.Expanded
+  return rootNode
+}
+
+function getNodesFromFiles(files: TestResultFile[], context: SidebarContext): JestTreeNode[] {
+  return [].concat(...files.map(f => getNodesFromFile(f, context)))
+}
+
+function getNodesFromFile(file: TestResultFile, context: SidebarContext): JestTreeNode[] {
+  if (context.showFiles) {
+    return [new JestTreeNode(cleanFilename(file.name), getNodesFromSuite(file.suite, context), context, 'file')]
+  } else {
+    if (file.suite.tests.length === 0) {
+      return getNodesFromSuite(file.suite, context)
+    } else {
+      return file.suite.suites
+        .map(s => new JestTreeNode(s.name, getNodesFromSuite(s, context), context, 'suite'))
+        .concat([
+          new JestTreeNode(
+            cleanFilename(file.name),
+            file.suite.tests.map(t => new JestTreeNodeForTest(t, context)),
+            context,
+            'file'
+          ),
+        ])
+    }
+  }
+}
+
+function cleanFilename(filename: string): string {
+  const file = vscode.Uri.file(filename)
+  const folder = vscode.workspace.getWorkspaceFolder(file)
+  if (folder && folder.uri && file.path.toLowerCase().startsWith(folder.uri.path.toLowerCase())) {
+    return file.path.substring(folder.uri.path.length + 1)
+  }
+  return filename
+}
+
+function getNodesFromSuite(suite: TestResultSuite, context: SidebarContext): JestTreeNode[] {
+  return suite.suites
+    .map(s => new JestTreeNode(s.name, getNodesFromSuite(s, context), context, 'suite'))
+    .concat(suite.tests.map(t => new JestTreeNodeForTest(t, context)))
+}

src/SideBar/JestTreeProvider.ts

@@ -0,0 +1,59 @@
+import * as vscode from 'vscode'
+import { JestTotalResults, JestFileResults } from 'jest-editor-support'
+import { JestTreeNode, SidebarContext, ISidebarSettings, generateTree } from './JestTreeNode'
+import { TestResultFile } from './TestResultTree'
+import { TestResultProvider } from '../TestResults'
+
+export class JestTreeProvider implements vscode.TreeDataProvider<JestTreeNode> {
+  private _onDidChangeTreeData: vscode.EventEmitter<JestTreeNode | undefined> = new vscode.EventEmitter<
+    JestTreeNode | undefined
+  >()
+  readonly onDidChangeTreeData: vscode.Event<JestTreeNode | undefined> = this._onDidChangeTreeData.event
+
+  private context: SidebarContext
+  private rootNode: JestTreeNode
+
+  constructor(
+    private testResultProvider: TestResultProvider,
+    extensionContext: vscode.ExtensionContext,
+    settings: ISidebarSettings
+  ) {
+    this.context = new SidebarContext(extensionContext, settings)
+    this.rootNode = generateTree(undefined, this.context)
+  }
+
+  refresh(data: JestTotalResults): void {
+    this.loadTestResults(data)
+    this._onDidChangeTreeData.fire()
+  }
+
+  getTreeItem(element: JestTreeNode): vscode.TreeItem {
+    return element
+  }
+
+  getChildren(element?: JestTreeNode): JestTreeNode[] {
+    if (!element) {
+      return this.getRootElements()
+    } else {
+      return this.getElementChildren(element)
+    }
+  }
+
+  private loadTestResults(data: JestTotalResults) {
+    const testFiles = data.testResults.map(r => this.loadTestResultsForFile(r))
+    this.rootNode = generateTree(testFiles, this.context)
+  }
+
+  private loadTestResultsForFile(data: JestFileResults): TestResultFile {
+    const parsedResults = this.testResultProvider.getResults(data.name)
+    return new TestResultFile(data, parsedResults)
+  }
+
+  private getRootElements(): JestTreeNode[] {
+    return [this.rootNode]
+  }
+
+  private getElementChildren(node: JestTreeNode): JestTreeNode[] {
+    return node.children
+  }
+}