Simplify tests; add skipped visualize test

Author: xeger

package.json

@@ -41,10 +41,6 @@
         "command": "syntaxTree.restart",
         "title": "Syntax Tree: Restart"
       },
-      {
-        "command": "syntaxTree.clearOutputChannel",
-        "title": "Syntax Tree: Clear Output Channel"
-      },
       {
         "command": "syntaxTree.showOutputChannel",
         "title": "Syntax Tree: Show Output Channel"

src/extension.ts

@@ -10,8 +10,9 @@ import Visualize from "./Visualize";
 const promiseExec = promisify(exec);
 
 // This object will get initialized once the language client is ready. It will
-// get set back to null when the extension is deactivated.
-let languageClient: LanguageClient | null = null;
+// get set back to null when the extension is deactivated. It is exported for
+// easier testing.
+export let languageClient: LanguageClient | null = null;
 
 // This is the expected top-level export that is called by VSCode when the
 // extension is activated.
@@ -39,7 +40,6 @@ export async function activate(context: ExtensionContext) {
     commands.registerCommand("syntaxTree.stop", stopLanguageServer),
     commands.registerCommand("syntaxTree.restart", restartLanguageServer),
     commands.registerCommand("syntaxTree.visualize", () => visualizer?.visualize()),
-    commands.registerCommand("syntaxTree.clearOutputChannel", () => outputChannel.clear()),
     commands.registerCommand("syntaxTree.showOutputChannel", () => outputChannel.show()),
     workspace.onDidChangeConfiguration(event => {
       if (event.affectsConfiguration("syntaxTree")) {

src/test/suite/automation.ts

@@ -2,20 +2,12 @@ import * as assert from 'assert';
 import * as path from 'path';
 import { TextEncoder } from 'util';
 
-import { Range, Uri, commands, window, workspace } from 'vscode';
+import { Uri, commands, window, workspace } from 'vscode';
 
 import { WORKSPACE_DIR } from './setup';
 
 export async function reset() {
   await commands.executeCommand('workbench.action.closeAllEditors');
-  await clearOutputChannel();
-
-  // Ensure output panel is closed
-  await commands.executeCommand('workbench.panel.output.focus');
-  await commands.executeCommand('workbench.action.output.toggleOutput');
-
-  // Ensure something neutral is focused
-  await commands.executeCommand('workbench.explorer.fileView.focus');
 }
 
 export async function createEditor(content: string, filename = 'test.rb') {
@@ -27,6 +19,10 @@ export async function createEditor(content: string, filename = 'test.rb') {
   return window.activeTextEditor;
 }
 
+export function findNewestEditor() {
+  return window.visibleTextEditors[window.visibleTextEditors.length - 1];
+}
+
 export function formatDocument() {
   return commands.executeCommand('editor.action.formatDocument', 'ruby-syntax-tree.vscode-syntax-tree');
 }
@@ -35,30 +31,14 @@ export function restart() {
   return commands.executeCommand('syntaxTree.restart');
 }
 
-export function clearOutputChannel() {
-  return commands.executeCommand('syntaxTree.showOutputChannel');
-}
-
-export function showOutputChannel(timeout = 15000) {
-  // TODO: make use of await commands.executeCommand('workbench.panel.output.focus'); ??
-  return new Promise<string>((c, e) => {
-    const failSauce = new Error(`No active editor change within ${timeout}ms`)
-    const timer = setTimeout(() => e(failSauce), timeout);
-    const disposable = window.onDidChangeActiveTextEditor(e => {
-      if (e) {
-        clearTimeout(timer);
-        disposable.dispose();
-        c(e.document.getText())
-      }
-    })
-    commands.executeCommand('syntaxTree.showOutputChannel');
-  })
-}
-
 export function start() {
   return commands.executeCommand('syntaxTree.start');
 }
 
 export function stop() {
   return commands.executeCommand('syntaxTree.stop');
 }
+
+export function visualize() {
+  return commands.executeCommand('syntaxTree.visualize');
+}

src/test/suite/index.test.ts

@@ -1,10 +1,9 @@
 import * as assert from 'assert';
 import { before, beforeEach } from 'mocha';
+import { State } from 'vscode-languageclient';
 
 import * as auto from './automation';
-
-// can directly import extension if needed
-// import * as myExtension from '../../extension';
+import * as extension from '../../extension';
 
 const UNFORMATTED = `class Foo; def bar; puts 'baz'; end; end`;
 
@@ -21,33 +20,38 @@ suite('Syntax Tree', () => {
   suite('lifecycle commands', () => {
     test('start', async () => {
       await auto.start();
-      const text = await auto.showOutputChannel();
-      assert.match(text, /^Starting language server/);
+      assert.notEqual(extension.languageClient, null)
+      assert.equal(extension.languageClient?.state, State.Running)
     });
 
     test('stop', async () => {
       await auto.start();
       await auto.stop();
-      const text = await auto.showOutputChannel();
-      assert.match(text, /^Stopping language server/m);
+      assert.equal(extension.languageClient, null)
     })
 
     test('restart', async () => {
       await auto.restart();
-      const text = await auto.showOutputChannel();
-      assert.match(text, /^Restarting language server/m);
-      assert.match(text, /^Stopping language server/m);
-      assert.match(text, /^Starting language server/);
+      assert.notEqual(extension.languageClient, null)
+      assert.equal(extension.languageClient?.state, State.Running)
     })
   });
 
   suite('functional commands', () => {
     before(auto.start);
 
-    test('Format Document', async () => {
+    test('format', async () => {
       const editor = await auto.createEditor(UNFORMATTED);
       await auto.formatDocument();
       assert.equal(editor.document.getText(), FORMATTED);
     });
+
+    // TODO: why does this test fail w/ assertions from prior test?!?!
+    test.skip('visualize', async () => {
+      await auto.createEditor(UNFORMATTED);
+      await auto.visualize();
+      const editor = auto.findNewestEditor();
+      assert.match(editor.document.getText(), /^\(program/);
+    })
   })
 });