test: DH-20440: DHE e2e tests - Support for grizzly servers (#282)

DH-20440: DHE e2e tests - support for testing grizzly servers from local
machine.
- Creates settings for given server

> Note: only supports grizzly servers that only have basic login
configured. Follow up PRs to add support for:
> - selecting auth type 
> - worker creation dialog required for gplus
> - CI

### Testing
- Checkout this PR
- npm i
- Run tests
   ```sh
npm run test:e2e -- --coreplus
https://qa-grizzly-java17-cluster-infra-1.int.illumon.com:8000/
   ```

Author: bmingles

.github/workflows/e2e.yml

@@ -18,7 +18,7 @@ jobs:
           cache: 'npm'
       - run: npm ci
       - name: Run end-to-end tests
-        run: xvfb-run npm run test:e2e
+        run: xvfb-run npm run test:e2e:docker
       - name: Upload Screenshots as Artifact
         if: ${{ always() }}
         uses: actions/upload-artifact@v4

.gitignore

@@ -6,6 +6,7 @@ node_modules
 .DS_Store
 e2e-testing/.resources
 e2e-testing/.test-extensions
+e2e-testing/test-ws/.vscode/settings.json
 test-reports/
 tsconfig.tsbuildinfo
 .env*.local

e2e-testing/src/mocharc.ts

@@ -2,9 +2,13 @@ import { MochaOptions } from 'vscode-extension-tester';
 
 const options: MochaOptions = {
   timeout: 30000,
-  reporter: 'mocha-ctrf-json-reporter',
+  slow: 20000,
+  reporter: 'mocha-multi-reporters',
   reporterOptions: {
-    outputDir: 'test-reports',
+    reporterEnabled: 'spec, mocha-ctrf-json-reporter',
+    mochaCtrfJsonReporterReporterOptions: {
+      outputDir: 'test-reports',
+    },
   },
 };
 

e2e-testing/src/pageObjects/EditorViewExtended.ts

@@ -182,7 +182,7 @@ export class EditorViewExtended extends EditorView {
 
     await tab.select();
 
-    return new WebViewExtended(group).wait();
+    return new WebViewExtended(group).waitForStable();
   }
 
   /**

e2e-testing/src/specs/panels.spec.ts

@@ -1,8 +1,8 @@
-import { Workbench } from 'vscode-extension-tester';
 import { EditorViewExtended } from '../pageObjects';
 import {
+  connectToServer,
+  executeCommandWithRetry,
   expectDeepEqualArray,
-  openFileResources,
   runDhFileCodeLens,
   setup,
   SIMPLE_TICKING3_PY,
@@ -50,10 +50,9 @@ const expectedTabs = {
 
 describe('Panels Tests', () => {
   before(async () => {
-    const explorerView = await setup();
-    await openFileResources(SIMPLE_TICKING3_PY.path);
-    await explorerView?.closeView();
-    await new Workbench().executeCommand('View: Split Editor Down');
+    await setup(SIMPLE_TICKING3_PY.path);
+    await connectToServer();
+    await executeCommandWithRetry('View: Split Editor Down');
   });
 
   after(async () => {
@@ -207,7 +206,7 @@ describe('Panels Tests', () => {
     await step(7, 'Move tab to new group', async stepLabel => {
       await editorView.openWebView('t3', 2);
 
-      await new Workbench().executeCommand('View: Move Editor into Next Group');
+      await executeCommandWithRetry('View: Move Editor into Next Group');
 
       const editorGroupsData = await editorView.getEditorGroupsData();
       expectDeepEqualArray(

e2e-testing/src/specs/statusBar.spec.ts

@@ -1,42 +1,33 @@
+import { InputBox } from 'vscode-extension-tester';
 import {
-  InputBox,
-  QuickPickItem,
-  StatusBar,
-  VSBrowser,
-} from 'vscode-extension-tester';
-import {
+  getDhStatusBarItem,
+  getServerItems,
   getSidebarViewItem,
-  openFileResources,
   setup,
   SIMPLE_TICKING3_PY,
   SIMPLE_TICKING_MD,
   step,
   teardown,
   TEST_GROOVY,
   TEST_TXT,
+  waitForServerConnection,
 } from '../util';
 import { EditorViewExtended } from '../pageObjects';
 import { assert } from 'chai';
-import { SERVER_TITLE, STATUS_BAR_TITLE, VIEW_NAME } from '../util/constants';
+import { VIEW_NAME } from '../util/constants';
 
 describe('Status Bar Tests', () => {
   let editorView: EditorViewExtended;
-  let statusBar: StatusBar;
 
   before(async () => {
-    const explorerView = await setup();
-
-    await openFileResources(
+    await setup(
       SIMPLE_TICKING_MD.path,
       SIMPLE_TICKING3_PY.path,
       TEST_GROOVY.path,
       TEST_TXT.path
     );
 
-    await explorerView?.closeView();
-
     editorView = new EditorViewExtended();
-    statusBar = new StatusBar();
   });
 
   after(async () => {
@@ -55,14 +46,12 @@ describe('Status Bar Tests', () => {
     ] as const) {
       await step(s, fileName, async stepLabel => {
         await editorView.openTextEditor(fileName);
-        const statusBarItem = await statusBar.getItem(
-          'plug  Deephaven: Disconnected'
-        );
+        const statusBarItem = await getDhStatusBarItem();
 
         if (isVisible) {
-          assert.isDefined(statusBarItem, stepLabel);
+          assert.isNotNull(statusBarItem, stepLabel);
         } else {
-          assert.isUndefined(statusBarItem, stepLabel);
+          assert.isNull(statusBarItem, stepLabel);
         }
       });
     }
@@ -71,41 +60,26 @@ describe('Status Bar Tests', () => {
   it('should connect to server on click', async () => {
     await editorView.openTextEditor(SIMPLE_TICKING3_PY.name);
 
-    await step(1, 'Click Deephaven status bar item', async () => {
-      const statusBarItem = await statusBar.getItem(
-        STATUS_BAR_TITLE.disconnected
-      );
-      assert.isDefined(statusBarItem);
+    await step(1, 'Click Deephaven status bar item', async stepLabel => {
+      const statusBarItem = await getDhStatusBarItem();
+      assert.isNotNull(statusBarItem, stepLabel);
       await statusBarItem.click();
     });
 
     await step(2, 'Select connection', async () => {
       const input = await InputBox.create();
-      const qpItem = new QuickPickItem(0, input);
-      await qpItem.click();
+      await input.selectQuickPick(0);
 
-      // We could call `ViewControl.openView` to ensure DH view is opened, but we
-      // want to test it opens automatically when a connection is initiated. The
-      // 500ms sleep matches the timeout that `ViewControl.openView` uses but
-      // without attempting to open the view.
-      await VSBrowser.instance.driver.sleep(500);
+      await waitForServerConnection();
     });
 
-    step(3, 'Verify server node', async stepLabel => {
-      const localhost1000Item = await getSidebarViewItem(
-        VIEW_NAME.servers,
-        SERVER_TITLE
-      );
+    await step(3, 'Verify server node', async stepLabel => {
+      const [serverItem] = await getServerItems();
 
-      assert.isDefined(localhost1000Item, stepLabel);
-      assert.equal(
-        await localhost1000Item.getText(),
-        `${SERVER_TITLE}(1)`,
-        stepLabel
-      );
+      assert.isDefined(serverItem, stepLabel);
     });
 
-    step(4, 'Verify connection node', async stepLabel => {
+    await step(4, 'Verify connection node', async stepLabel => {
       const simpleTickingEditor = await getSidebarViewItem(
         VIEW_NAME.connections,
         SIMPLE_TICKING3_PY.name

e2e-testing/src/util/constants.ts

@@ -1,6 +1,5 @@
-export const SERVER_TITLE = 'localhost:10000';
-
 export const STATUS_BAR_TITLE = {
+  connectedPrefix: 'vm-connect  DHC:',
   disconnected: 'plug  Deephaven: Disconnected',
 } as const;
 

e2e-testing/src/util/lifeCycle.ts

@@ -1,26 +1,34 @@
+import { EditorView } from 'vscode-extension-tester';
 import {
-  ActivityBar,
-  EditorView,
-  type ViewControl,
-} from 'vscode-extension-tester';
-import { disconnectFromServer, getElementOrNull } from './testUtils';
-import { SERVER_TITLE } from './constants';
+  getElementOrNull,
+  openFileResources,
+  openActivityBarView,
+  disconnectFromServers,
+  closeActivityBarView,
+} from './testUtils';
 import { locators } from './locators';
 
 /**
  * Setup before running test suite.
  */
-export async function setup(): Promise<ViewControl | undefined> {
-  const chatCloseButton = await getElementOrNull(locators.chatCloseButton);
-  await chatCloseButton?.click();
+export async function setup(
+  ...initialFilePaths: [string, ...string[]]
+): Promise<void> {
+  try {
+    const chatCloseButton = await getElementOrNull(locators.chatCloseButton);
+    await chatCloseButton?.click();
+  } catch {
+    // Chat button not found or not interactable - continue anyway
+  }
 
-  const explorer = await new ActivityBar().getViewControl('Explorer');
+  // Need to open a file before login since an active editor is required for
+  // Deephaven: Select Connection command to work
+  await openFileResources(...initialFilePaths);
 
-  if (!(await explorer?.isSelected())) {
-    await explorer?.openView();
-  }
+  // Ensure Deephaven extension is activated by opening the Deephaven view
+  await openActivityBarView('Deephaven');
 
-  return explorer;
+  await closeActivityBarView('Deephaven');
 }
 
 /**
@@ -30,6 +38,9 @@ export async function teardown(): Promise<void> {
   await new EditorView().closeAllEditors();
 
   try {
-    await disconnectFromServer(SERVER_TITLE);
-  } catch {}
+    await disconnectFromServers();
+  } catch (err) {
+    // eslint-disable-next-line no-console
+    console.error('Error during disconnectFromServers:', err);
+  }
 }

e2e-testing/src/util/locators.ts

@@ -1,6 +1,11 @@
 import { By } from 'vscode-extension-tester';
 
 export const locators = {
+  /** Locator for an active connection icon */
+  activeConnection: By.css(
+    '.custom-view-tree-node-item-icon.codicon.codicon-vm-connect'
+  ),
+
   /**
    * Locator for side panel close button so we can close the Copilot chat. Note
    * that the button is always present, but parent div gets `empty` class when
@@ -10,6 +15,11 @@ export const locators = {
     '.auxiliarybar:not(.empty) a[aria-label^="Hide Secondary Side Bar"]'
   ),
 
+  /** Locator for a connected server icon */
+  connectedServerIcon: By.css(
+    '.custom-view-tree-node-item-icon.codicon.codicon-circle-large-filled'
+  ),
+
   irisGrid: By.css('.iris-grid'),
 
   /** Locator for the containing div of a WebView */