jupyterlab/ui-tests/tests/util.ts

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

import { galata, test } from '@jupyterlab/galata';

const menuPaths = [
  'Edit',
  'View',
  'Run',
  'Kernel',
  'Tabs',
  'Settings',
  'Settings>JupyterLab Theme',
  'Settings>Language',
  'Settings>Console Run Keystroke',
  'Settings>Text Editor Key Map',
  'Settings>Text Editor Theme',
  'Settings>Text Editor Indentation',
  'Settings>Terminal Theme',
  'Help'
];

const sidebarIds: galata.SidebarTabId[] = [
  'filebrowser',
  'jp-property-inspector',
  'jp-running-sessions',
  'table-of-contents',
  'extensionmanager.main-view'
];

// eslint-disable-next-line jest/no-export
export function runMenuOpenTest(): void {
  menuPaths.forEach(menuPath => {
    test(`Open menu item ${menuPath}`, async () => {
      await galata.menu.open(menuPath);
      expect(await galata.menu.isOpen(menuPath)).toBeTruthy();

      const imageName = `opened-menu-${menuPath}`;
      const menu = await galata.menu.getOpenMenu();
      await galata.capture.screenshot(imageName, menu);
      expect(await galata.capture.compareScreenshot(imageName)).toBe('same');
    });
  });

  test('Close all menus', async () => {
    await galata.menu.closeAll();
    await expect(galata.menu.isAnyOpen()).resolves.toEqual(false);
  });
}

// eslint-disable-next-line jest/no-export
export function runSidebarOpenTest(): void {
  sidebarIds.forEach(sidebarId => {
    test(`Open Sidebar tab ${sidebarId}`, async () => {
      await galata.sidebar.openTab(sidebarId);
      expect(await galata.sidebar.isTabOpen(sidebarId)).toBeTruthy();

      const imageName = `opened-sidebar-${sidebarId}`;
      const position = await galata.sidebar.getTabPosition(sidebarId);
      const sidebar = await galata.sidebar.getContentPanel(position);
      await galata.capture.screenshot(imageName, sidebar);
      expect(await galata.capture.compareScreenshot(imageName)).toBe('same');
    });
  });

  test('Open file browser tab', async () => {
    await galata.sidebar.openTab('filebrowser');
    await expect(galata.sidebar.isTabOpen('filebrowser')).resolves.toEqual(
      true
    );
  });
}