@theia/playwright 1.23.0-next.26

package/src/theia-explorer-view.ts

@@ -0,0 +1,229 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { ElementHandle } from '@playwright/test';
+import { TheiaApp } from './theia-app';
+import { TheiaDialog } from './theia-dialog';
+import { TheiaMenuItem } from './theia-menu-item';
+import { TheiaRenameDialog } from './theia-rename-dialog';
+import { TheiaTreeNode } from './theia-tree-node';
+import { TheiaView } from './theia-view';
+import { elementContainsClass, normalizeId } from './util';
+
+const TheiaExplorerViewData = {
+    tabSelector: '#shell-tab-explorer-view-container',
+    viewSelector: '#explorer-view-container--files',
+    viewName: 'Explorer'
+};
+
+export class TheiaExplorerFileStatNode extends TheiaTreeNode {
+
+    constructor(protected elementHandle: ElementHandle<SVGElement | HTMLElement>, protected explorerView: TheiaExplorerView) {
+        super(elementHandle, explorerView.app);
+    }
+
+    async absolutePath(): Promise<string | null> {
+        return this.elementHandle.getAttribute('title');
+    }
+
+    async isFile(): Promise<boolean> {
+        return ! await this.isFolder();
+    }
+
+    async isFolder(): Promise<boolean> {
+        return elementContainsClass(this.elementHandle, 'theia-DirNode');
+    }
+
+    async getMenuItemByNamePath(...names: string[]): Promise<TheiaMenuItem> {
+        const contextMenu = await this.openContextMenu();
+        const menuItem = await contextMenu.menuItemByNamePath(...names);
+        if (!menuItem) { throw Error('MenuItem could not be retrieved by path'); }
+        return menuItem;
+    }
+
+}
+
+export type TheiaExplorerFileStatNodePredicate = (node: TheiaExplorerFileStatNode) => Promise<boolean>;
+export const DOT_FILES_FILTER: TheiaExplorerFileStatNodePredicate = async node => {
+    const label = await node.label();
+    return label ? !label.startsWith('.') : true;
+};
+
+export class TheiaExplorerView extends TheiaView {
+
+    constructor(public app: TheiaApp) {
+        super(TheiaExplorerViewData, app);
+    }
+
+    async activate(): Promise<void> {
+        await super.activate();
+        const viewElement = await this.viewElement();
+        await viewElement?.waitForSelector('.theia-TreeContainer');
+    }
+
+    async refresh(): Promise<void> {
+        await this.clickButton('__explorer-view-container_title:navigator.refresh');
+    }
+
+    async collapseAll(): Promise<void> {
+        await this.clickButton('__explorer-view-container_title:navigator.collapse.all');
+    }
+
+    protected async clickButton(id: string): Promise<void> {
+        await this.activate();
+        const viewElement = await this.viewElement();
+        const button = await viewElement?.waitForSelector(`#${normalizeId(id)}`);
+        await button?.click();
+    }
+
+    async visibleFileStatNodes(filterPredicate: TheiaExplorerFileStatNodePredicate = (_ => Promise.resolve(true))): Promise<TheiaExplorerFileStatNode[]> {
+        const viewElement = await this.viewElement();
+        const handles = await viewElement?.$$('.theia-FileStatNode');
+        if (handles) {
+            const nodes = handles.map(handle => new TheiaExplorerFileStatNode(handle, this));
+            const filteredNodes = [];
+            for (const node of nodes) {
+                if ((await filterPredicate(node)) === true) {
+                    filteredNodes.push(node);
+                }
+            }
+            return filteredNodes;
+        }
+        return [];
+    }
+
+    async getFileStatNodeByLabel(label: string): Promise<TheiaExplorerFileStatNode> {
+        const file = await this.fileStatNode(label);
+        if (!file) { throw Error('File stat node could not be retrieved by path fragments'); }
+        return file;
+    }
+
+    async fileStatNode(filePath: string): Promise<TheiaExplorerFileStatNode | undefined> {
+        return this.fileStatNodeBySegments(...filePath.split('/'));
+    }
+
+    async fileStatNodeBySegments(...pathFragments: string[]): Promise<TheiaExplorerFileStatNode | undefined> {
+        await super.activate();
+        const viewElement = await this.viewElement();
+
+        let currentTreeNode = undefined;
+        let fragmentsSoFar = '';
+        for (let index = 0; index < pathFragments.length; index++) {
+            const fragment = pathFragments[index];
+            fragmentsSoFar += index !== 0 ? '/' : '';
+            fragmentsSoFar += fragment;
+
+            const selector = this.treeNodeSelector(fragmentsSoFar);
+            const nextTreeNode = await viewElement?.waitForSelector(selector, { state: 'visible' });
+            if (!nextTreeNode) {
+                throw new Error(`Tree node '${selector}' not found in explorer`);
+            }
+            currentTreeNode = new TheiaExplorerFileStatNode(nextTreeNode, this);
+            if (index < pathFragments.length - 1 && await currentTreeNode.isCollapsed()) {
+                await currentTreeNode.expand();
+            }
+        }
+
+        return currentTreeNode;
+    }
+
+    async selectTreeNode(filePath: string): Promise<void> {
+        await this.activate();
+        const treeNode = await this.page.waitForSelector(this.treeNodeSelector(filePath));
+        if (await this.isTreeNodeSelected(filePath)) {
+            await treeNode.focus();
+        } else {
+            await treeNode.click({ modifiers: ['Control'] });
+        }
+    }
+
+    async isTreeNodeSelected(filePath: string): Promise<boolean> {
+        const treeNode = await this.page.waitForSelector(this.treeNodeSelector(filePath));
+        return elementContainsClass(treeNode, 'theia-mod-selected');
+    }
+
+    protected treeNodeSelector(filePath: string): string {
+        return `.theia-FileStatNode:has(#${normalizeId(this.treeNodeId(filePath))})`;
+    }
+
+    protected treeNodeId(filePath: string): string {
+        const workspacePath = this.app.workspace.path;
+        return `${workspacePath}:${workspacePath}/${filePath}`;
+    }
+
+    async clickContextMenuItem(file: string, path: string[]): Promise<void> {
+        await this.activate();
+        const fileStatNode = await this.fileStatNode(file);
+        if (!fileStatNode) { throw Error('File stat node could not be retrieved by path fragments'); }
+        const menuItem = await fileStatNode.getMenuItemByNamePath(...path);
+        await menuItem.click();
+    }
+
+    protected async existsNode(path: string, isDirectory: boolean): Promise<boolean> {
+        const fileStatNode = await this.fileStatNode(path);
+        if (!fileStatNode) {
+            return false;
+        }
+        if (isDirectory) {
+            if (!await fileStatNode.isFolder()) {
+                throw Error(`FileStatNode for '${path}' is not a directory!`);
+            }
+        } else {
+            if (!await fileStatNode.isFile()) {
+                throw Error(`FileStatNode for '${path}' is not a file!`);
+            }
+        }
+        return true;
+    }
+
+    async existsFileNode(path: string): Promise<boolean> {
+        return this.existsNode(path, false);
+    }
+
+    async existsDirectoryNode(path: string): Promise<boolean> {
+        return this.existsNode(path, true);
+    }
+
+    async getNumberOfVisibleNodes(): Promise<number> {
+        await this.activate();
+        await this.app.quickCommandPalette.type('Refresh in Explorer');
+        await this.app.quickCommandPalette.trigger('File: Refresh in Explorer');
+        const fileStatElements = await this.visibleFileStatNodes(DOT_FILES_FILTER);
+        return fileStatElements.length;
+    }
+
+    async deleteNode(path: string, confirm = true): Promise<void> {
+        await this.activate();
+        await this.clickContextMenuItem(path, ['Delete']);
+
+        const confirmDialog = new TheiaDialog(this.app);
+        await confirmDialog.waitForVisible();
+        confirm ? await confirmDialog.clickMainButton() : await confirmDialog.clickSecondaryButton();
+        await confirmDialog.waitForClosed();
+    }
+
+    async renameNode(path: string, newName: string, confirm = true): Promise<void> {
+        await this.activate();
+        await this.clickContextMenuItem(path, ['Rename']);
+
+        const renameDialog = new TheiaRenameDialog(this.app);
+        await renameDialog.waitForVisible();
+        await renameDialog.enterNewName(newName);
+        confirm ? await renameDialog.confirm() : await renameDialog.close();
+        await renameDialog.waitForClosed();
+    }
+
+}

package/src/theia-main-menu.ts

@@ -0,0 +1,54 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { ElementHandle } from '@playwright/test';
+
+import { TheiaMenu } from './theia-menu';
+import { TheiaPageObject } from './theia-page-object';
+import { normalizeId, toTextContentArray } from './util';
+
+export class TheiaMainMenu extends TheiaMenu {
+    selector = '.p-Menu.p-MenuBar-menu';
+}
+
+export class TheiaMenuBar extends TheiaPageObject {
+
+    async openMenu(menuName: string): Promise<TheiaMainMenu> {
+        const menuBarItem = await this.menuBarItem(menuName);
+        const mainMenu = new TheiaMainMenu(this.app);
+        if (await mainMenu.isOpen()) {
+            await menuBarItem?.hover();
+        } else {
+            await menuBarItem?.click();
+        }
+        mainMenu.waitForVisible();
+        return mainMenu;
+    }
+
+    async visibleMenuBarItems(): Promise<string[]> {
+        const items = await this.page.$$(this.menuBarItemSelector());
+        return toTextContentArray(items);
+    }
+
+    protected menuBarItem(label = ''): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.waitForSelector(this.menuBarItemSelector(label));
+    }
+
+    protected menuBarItemSelector(label = ''): string {
+        return `${normalizeId('#theia:menubar')} .p-MenuBar-itemLabel >> text=${label}`;
+    }
+
+}

package/src/theia-menu-item.ts

@@ -0,0 +1,62 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { ElementHandle } from '@playwright/test';
+
+import { textContent } from './util';
+
+export class TheiaMenuItem {
+
+    constructor(protected element: ElementHandle<SVGElement | HTMLElement>) { }
+
+    protected labelElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
+        return this.element.waitForSelector('.p-Menu-itemLabel');
+    }
+
+    protected shortCutElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement>> {
+        return this.element.waitForSelector('.p-Menu-itemShortcut');
+    }
+
+    async label(): Promise<string | undefined> {
+        return textContent(this.labelElementHandle());
+    }
+
+    async shortCut(): Promise<string | undefined> {
+        return textContent(this.shortCutElementHandle());
+    }
+
+    async hasSubmenu(): Promise<boolean> {
+        return (await this.element.getAttribute('data-type')) === 'submenu';
+    }
+
+    async isEnabled(): Promise<boolean> {
+        const classAttribute = (await this.element.getAttribute('class'));
+        if (classAttribute === undefined || classAttribute === null) {
+            return false;
+        }
+        return !classAttribute.includes('p-mod-disabled');
+    }
+
+    async click(): Promise<void> {
+        return this.element.waitForSelector('.p-Menu-itemLabel')
+            .then(labelElement => labelElement.click({ position: { x: 10, y: 10 } }));
+    }
+
+    async hover(): Promise<void> {
+        return this.element.hover();
+    }
+
+}

package/src/theia-menu.ts

@@ -0,0 +1,96 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { ElementHandle } from '@playwright/test';
+
+import { TheiaMenuItem } from './theia-menu-item';
+import { TheiaPageObject } from './theia-page-object';
+import { isDefined } from './util';
+
+export class TheiaMenu extends TheiaPageObject {
+
+    selector = '.p-Menu';
+
+    protected async menuElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.$(this.selector);
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'visible' });
+    }
+
+    async isOpen(): Promise<boolean> {
+        const menu = await this.menuElementHandle();
+        return !!menu && menu.isVisible();
+    }
+
+    async close(): Promise<void> {
+        if (!await this.isOpen()) {
+            return;
+        }
+        await this.page.mouse.click(0, 0);
+        await this.page.waitForSelector(this.selector, { state: 'detached' });
+    }
+
+    async menuItems(): Promise<TheiaMenuItem[]> {
+        const menuHandle = await this.menuElementHandle();
+        if (!menuHandle) {
+            return [];
+        }
+        const items = await menuHandle.$$('.p-Menu-content .p-Menu-item');
+        return items.map(element => new TheiaMenuItem(element));
+    }
+
+    async clickMenuItem(name: string): Promise<void> {
+        return (await this.page.waitForSelector(this.menuItemSelector(name))).click();
+    }
+
+    async menuItemByName(name: string): Promise<TheiaMenuItem | undefined> {
+        const menuItems = await this.menuItems();
+        for (const item of menuItems) {
+            const label = await item.label();
+            if (label === name) {
+                return item;
+            }
+        }
+        return undefined;
+    }
+
+    async menuItemByNamePath(...names: string[]): Promise<TheiaMenuItem | undefined> {
+        let item;
+        for (let index = 0; index < names.length; index++) {
+            item = await this.page.waitForSelector(this.menuItemSelector(names[index]), { state: 'visible' });
+            await item.hover();
+        }
+
+        const menuItemHandle = await item?.$('xpath=..');
+        if (menuItemHandle) {
+            return new TheiaMenuItem(menuItemHandle);
+        }
+        return undefined;
+    }
+
+    protected menuItemSelector(label = ''): string {
+        return `.p-Menu-content .p-Menu-itemLabel >> text=${label}`;
+    }
+
+    async visibleMenuItems(): Promise<string[]> {
+        const menuItems = await this.menuItems();
+        const labels = await Promise.all(menuItems.map(item => item.label()));
+        return labels.filter(isDefined);
+    }
+
+}

package/src/theia-notification-indicator.ts

@@ -0,0 +1,49 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { TheiaStatusIndicator } from './theia-status-indicator';
+
+const NOTIFICATION_ICON = 'codicon-bell';
+const NOTIFICATION_DOT_ICON = 'codicon-bell-dot';
+const NOTIFICATION_ICONS = [NOTIFICATION_ICON, NOTIFICATION_DOT_ICON];
+
+export class TheiaNotificationIndicator extends TheiaStatusIndicator {
+
+    protected get title(): string {
+        return 'Notification';
+    }
+
+    async isVisible(): Promise<boolean> {
+        return super.isVisible(NOTIFICATION_ICONS, this.title);
+    }
+
+    async hasNotifications(): Promise<boolean> {
+        return super.isVisible(NOTIFICATION_DOT_ICON, this.title);
+    }
+
+    async waitForVisible(expectNotifications = false): Promise<void> {
+        await super.waitForVisibleByIcon(expectNotifications ? NOTIFICATION_DOT_ICON : NOTIFICATION_ICON);
+    }
+
+    async toggleOverlay(): Promise<void> {
+        const hasNotifications = await this.hasNotifications();
+        const element = await this.getElementHandleByIcon(hasNotifications ? NOTIFICATION_DOT_ICON : NOTIFICATION_ICON, this.title);
+        if (element) {
+            await element.click();
+        }
+    }
+
+}

package/src/theia-notification-overlay.ts

@@ -0,0 +1,94 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { TheiaApp } from './theia-app';
+import { TheiaNotificationIndicator } from './theia-notification-indicator';
+import { TheiaPageObject } from './theia-page-object';
+
+export class TheiaNotificationOverlay extends TheiaPageObject {
+
+    protected readonly HEADER_NOTIFICATIONS = 'NOTIFICATIONS';
+    protected readonly HEADER_NO_NOTIFICATIONS = 'NO NEW NOTIFICATIONS';
+
+    constructor(public app: TheiaApp, protected notificationIndicator: TheiaNotificationIndicator) {
+        super(app);
+    }
+
+    protected get selector(): string {
+        return '.theia-notifications-overlay';
+    }
+
+    protected get containerSelector(): string {
+        return `${this.selector} .theia-notifications-container.theia-notification-center`;
+    }
+
+    protected get titleSelector(): string {
+        return `${this.containerSelector} .theia-notification-center-header-title`;
+    }
+
+    async isVisible(): Promise<boolean> {
+        const element = await this.page.$(`${this.containerSelector}.open`);
+        return element ? element.isVisible() : false;
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(`${this.containerSelector}.open`);
+    }
+
+    async activate(): Promise<void> {
+        if (!await this.isVisible()) {
+            await this.notificationIndicator.toggleOverlay();
+        }
+        await this.waitForVisible();
+    }
+
+    async toggle(): Promise<void> {
+        await this.app.quickCommandPalette.type('Toggle Notifications');
+        await this.app.quickCommandPalette.trigger('Notifications: Toggle Notifications');
+    }
+
+    protected entrySelector(entryText: string): string {
+        return `${this.containerSelector} .theia-notification-message span:has-text("${entryText}")`;
+    }
+
+    async waitForEntry(entryText: string): Promise<void> {
+        await this.activate();
+        await this.page.waitForSelector(this.entrySelector(entryText));
+    }
+
+    async waitForEntryDetached(entryText: string): Promise<void> {
+        await this.activate();
+        await this.page.waitForSelector(this.entrySelector(entryText), { state: 'detached' });
+    }
+
+    async isEntryVisible(entryText: string): Promise<boolean> {
+        await this.activate();
+        const element = await this.page.$(this.entrySelector(entryText));
+        return !!element && element.isVisible();
+    }
+
+    protected get clearAllButtonSelector(): string {
+        return this.selector + ' .theia-notification-center-header ul > li.codicon.codicon-clear-all';
+    }
+
+    async clearAllNotifications(): Promise<void> {
+        await this.activate();
+        const element = await this.page.waitForSelector(this.clearAllButtonSelector);
+        await element.click();
+        await this.notificationIndicator.waitForVisible(false /* expectNotifications */);
+    }
+
+}

package/src/theia-page-object.ts

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * Copyright (C) 2021 logi.cals GmbH, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { Page } from '@playwright/test';
+
+import { TheiaApp } from './theia-app';
+
+export abstract class TheiaPageObject {
+
+    constructor(public app: TheiaApp) { }
+
+    get page(): Page {
+        return this.app.page;
+    }
+
+}