@theia/playwright 1.23.0-next.26

package/src/theia-preference-view.ts

@@ -0,0 +1,226 @@
+/********************************************************************************
+ * 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 { TheiaView } from './theia-view';
+
+const TheiaSettingsViewData = {
+    tabSelector: '#shell-tab-settings_widget',
+    viewSelector: '#settings_widget'
+};
+
+export const PreferenceIds = {
+    Explorer: {
+        AutoReveal: 'explorer.autoReveal'
+    },
+    DiffEditor: {
+        MaxComputationTime: 'diffEditor.maxComputationTime'
+    }
+};
+
+export const DefaultPreferences = {
+    Explorer: {
+        AutoReveal: {
+            Enabled: true
+        }
+    },
+    DiffEditor: {
+        MaxComputationTime: '5000'
+    }
+};
+
+export enum TheiaPreferenceScope {
+    User = 'User',
+    Workspace = 'Workspace'
+}
+
+export class TheiaPreferenceView extends TheiaView {
+    public customTimeout?: number;
+
+    constructor(app: TheiaApp) {
+        super(TheiaSettingsViewData, app);
+    }
+
+    async open(preferenceScope = TheiaPreferenceScope.Workspace): Promise<TheiaView> {
+        await this.app.quickCommandPalette.trigger('Preferences: Open Settings (UI)');
+        await this.waitForVisible();
+        await this.openPreferenceScope(preferenceScope);
+        return this;
+    }
+
+    protected getScopeSelector(scope: TheiaPreferenceScope): string {
+        return `li.preferences-scope-tab div.p-TabBar-tabLabel:has-text("${scope}")`;
+    }
+
+    async openPreferenceScope(scope: TheiaPreferenceScope): Promise<void> {
+        await this.activate();
+        const scopeTab = await this.page.waitForSelector(this.getScopeSelector(scope));
+        await scopeTab.click();
+    }
+
+    async getBooleanPreferenceById(preferenceId: string): Promise<boolean> {
+        const element = await this.findPreferenceEditorById(preferenceId);
+        return element.isChecked();
+    }
+
+    async getBooleanPreferenceByPath(sectionTitle: string, name: string): Promise<boolean> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.getBooleanPreferenceById(preferenceId);
+    }
+
+    async setBooleanPreferenceById(preferenceId: string, value: boolean): Promise<void> {
+        const element = await this.findPreferenceEditorById(preferenceId);
+        return value ? element.check() : element.uncheck();
+    }
+
+    async setBooleanPreferenceByPath(sectionTitle: string, name: string, value: boolean): Promise<void> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.setBooleanPreferenceById(preferenceId, value);
+    }
+
+    async getStringPreferenceById(preferenceId: string): Promise<string> {
+        const element = await this.findPreferenceEditorById(preferenceId);
+        return element.evaluate(e => (e as HTMLInputElement).value);
+    }
+
+    async getStringPreferenceByPath(sectionTitle: string, name: string): Promise<string> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.getStringPreferenceById(preferenceId);
+    }
+
+    async setStringPreferenceById(preferenceId: string, value: string): Promise<void> {
+        const element = await this.findPreferenceEditorById(preferenceId);
+        return element.fill(value);
+    }
+
+    async setStringPreferenceByPath(sectionTitle: string, name: string, value: string): Promise<void> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.setStringPreferenceById(preferenceId, value);
+    }
+
+    async waitForModified(preferenceId: string): Promise<void> {
+        await this.activate();
+        const viewElement = await this.viewElement();
+        await viewElement?.waitForSelector(`${this.getPreferenceGutterSelector(preferenceId)}.theia-mod-item-modified`, { timeout: this.customTimeout });
+    }
+
+    async resetStringPreferenceById(preferenceId: string): Promise<void> {
+        const resetPreferenceButton = await this.findPreferenceResetButton(preferenceId);
+        if (!resetPreferenceButton) {
+            // preference not modified
+            return;
+        }
+        const previousValue = await this.getStringPreferenceById(preferenceId);
+        const selector = this.getPreferenceEditorSelector(preferenceId);
+        const done = await resetPreferenceButton.click();
+        await this.page.waitForFunction(data => {
+            const element = document.querySelector(data.selector);
+            if (!element) {
+                throw new Error(`Could not find preference element with id "${data.preferenceId}"`);
+            }
+            const value = (element as HTMLInputElement).value;
+            return value !== data.previousValue;
+        }, { preferenceId, selector, previousValue, done }, { timeout: this.customTimeout });
+    }
+
+    async resetStringPreferenceByPath(sectionTitle: string, name: string): Promise<void> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.resetStringPreferenceById(preferenceId);
+    }
+
+    async resetBooleanPreferenceById(preferenceId: string): Promise<void> {
+        const resetPreferenceButton = await this.findPreferenceResetButton(preferenceId);
+        if (!resetPreferenceButton) {
+            // preference not modified
+            return;
+        }
+        const previousValue = await this.getBooleanPreferenceById(preferenceId);
+        const selector = this.getPreferenceEditorSelector(preferenceId);
+        const done = await resetPreferenceButton.click();
+        await this.page.waitForFunction(data => {
+            const element = document.querySelector(data.selector);
+            if (!element) {
+                throw new Error(`Could not find preference element with id "${data.preferenceId}"`);
+            }
+            const value = (element as HTMLInputElement).checked;
+            return value !== data.previousValue;
+        }, { preferenceId, selector, previousValue, done }, { timeout: this.customTimeout });
+    }
+
+    async resetBooleanPreferenceByPath(sectionTitle: string, name: string): Promise<void> {
+        const preferenceId = await this.findPreferenceId(sectionTitle, name);
+        return this.resetBooleanPreferenceById(preferenceId);
+    }
+
+    private async findPreferenceId(sectionTitle: string, name: string): Promise<string> {
+        const viewElement = await this.viewElement();
+        const sectionElement = await viewElement?.$(`xpath=//li[contains(@class, 'settings-section-title') and text() = '${sectionTitle}']/..`);
+
+        const firstPreferenceAfterSection = await sectionElement?.$(`xpath=following-sibling::li[div/text() = '${name}'][1]`);
+        const preferenceId = await firstPreferenceAfterSection?.getAttribute('data-pref-id');
+        if (!preferenceId) {
+            throw new Error(`Could not find preference id for "${sectionTitle}" > (...) > "${name}"`);
+        }
+        return preferenceId;
+    }
+
+    private async findPreferenceEditorById(preferenceId: string): Promise<ElementHandle<SVGElement | HTMLElement>> {
+        const viewElement = await this.viewElement();
+        const element = await viewElement?.waitForSelector(this.getPreferenceEditorSelector(preferenceId), { timeout: this.customTimeout });
+        if (!element) {
+            throw new Error(`Could not find element with preference id "${preferenceId}"`);
+        }
+        return element;
+    }
+
+    private getPreferenceSelector(preferenceId: string): string {
+        return `li[data-pref-id="${preferenceId}"]`;
+    }
+
+    private getPreferenceEditorSelector(preferenceId: string): string {
+        return `${this.getPreferenceSelector(preferenceId)} input`;
+    }
+
+    private getPreferenceGutterSelector(preferenceId: string): string {
+        return `${this.getPreferenceSelector(preferenceId)} .pref-context-gutter`;
+    }
+
+    private async findPreferenceResetButton(preferenceId: string): Promise<ElementHandle<SVGElement | HTMLElement> | undefined> {
+        await this.activate();
+        const viewElement = await this.viewElement();
+        const gutter = await viewElement?.waitForSelector(`${this.getPreferenceGutterSelector(preferenceId)}`, { timeout: this.customTimeout });
+        if (!gutter) {
+            throw new Error(`Could not determine modified state for element with preference id "${preferenceId}"`);
+        }
+        const isModified = await gutter.evaluate(e => e.classList.contains('theia-mod-item-modified'));
+        if (!isModified) {
+            return undefined;
+        }
+
+        const settingsContextMenuBtn = await viewElement?.waitForSelector(`${this.getPreferenceSelector(preferenceId)} .settings-context-menu-btn`);
+        if (!settingsContextMenuBtn) {
+            throw new Error(`Could not find context menu button for element with preference id "${preferenceId}"`);
+        }
+        await settingsContextMenuBtn.click();
+        const resetPreferenceButton = await this.page.waitForSelector('li[data-command="preferences:reset"]');
+        if (!resetPreferenceButton) {
+            throw new Error(`Could not find menu entry to reset preference with id "${preferenceId}"`);
+        }
+        return resetPreferenceButton;
+    }
+
+}

package/src/theia-problem-indicator.ts

@@ -0,0 +1,44 @@
+/********************************************************************************
+ * 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 { TheiaStatusIndicator } from './theia-status-indicator';
+
+const PROBLEM_ICON = 'codicon-error';
+
+export class TheiaProblemIndicator extends TheiaStatusIndicator {
+
+    async isVisible(): Promise<boolean> {
+        const handle = await super.getElementHandleByIcon(PROBLEM_ICON);
+        return !!handle && handle.isVisible();
+    }
+
+    async numberOfProblems(): Promise<number> {
+        const spans = await this.getSpans();
+        return spans ? +await spans[1].innerText() : -1;
+    }
+
+    async numberOfWarnings(): Promise<number> {
+        const spans = await this.getSpans();
+        return spans ? +await spans[3].innerText() : -1;
+    }
+
+    protected async getSpans(): Promise<ElementHandle[] | undefined> {
+        const handle = await super.getElementHandleByIcon(PROBLEM_ICON);
+        return handle?.$$('span');
+    }
+
+}

package/src/theia-problem-view.ts

@@ -0,0 +1,30 @@
+/********************************************************************************
+ * 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 { TheiaView } from './theia-view';
+
+const TheiaProblemsViewData = {
+    tabSelector: '#shell-tab-problems',
+    viewSelector: '#problems',
+    viewName: 'Problems'
+};
+
+export class TheiaProblemsView extends TheiaView {
+    constructor(app: TheiaApp) {
+        super(TheiaProblemsViewData, app);
+    }
+}

package/src/theia-quick-command-palette.ts

@@ -0,0 +1,75 @@
+/********************************************************************************
+ * 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 { TheiaPageObject } from './theia-page-object';
+import { USER_KEY_TYPING_DELAY } from './util';
+
+export class TheiaQuickCommandPalette extends TheiaPageObject {
+
+    selector = '.quick-input-widget';
+
+    async open(): Promise<void> {
+        await this.page.keyboard.press('Control+Shift+p');
+        await this.page.waitForSelector(this.selector);
+    }
+
+    async isOpen(): Promise<boolean> {
+        try {
+            await this.page.waitForSelector(this.selector, { timeout: 5000 });
+        } catch (err) {
+            return false;
+        }
+        return true;
+    }
+
+    async trigger(...commandName: string[]): Promise<void> {
+        for (const command of commandName) {
+            await this.triggerSingleCommand(command);
+        }
+    }
+
+    protected async triggerSingleCommand(commandName: string): Promise<void> {
+        if (!await this.isOpen()) {
+            this.open();
+        }
+        let selected = await this.selectedCommand();
+        while (!(await selected?.getAttribute('aria-label') === commandName)) {
+            await this.page.keyboard.press('ArrowDown');
+            selected = await this.selectedCommand();
+        }
+        await this.page.keyboard.press('Enter');
+    }
+
+    async type(command: string): Promise<void> {
+        if (!await this.isOpen()) {
+            this.open();
+        }
+        const input = await this.page.waitForSelector(`${this.selector} .monaco-inputbox .input`);
+        if (input != null) {
+            await input.focus();
+            await input.type(command, { delay: USER_KEY_TYPING_DELAY });
+        }
+    }
+
+    protected async selectedCommand(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        const command = await this.page.waitForSelector(this.selector);
+        if (!command) {
+            throw new Error('No selected command found!');
+        }
+        return command.$('.monaco-list-row.focused');
+    }
+}

package/src/theia-rename-dialog.ts

@@ -0,0 +1,36 @@
+/********************************************************************************
+ * 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 { TheiaDialog } from './theia-dialog';
+import { USER_KEY_TYPING_DELAY } from './util';
+
+export class TheiaRenameDialog extends TheiaDialog {
+
+    async enterNewName(newName: string): Promise<void> {
+        const inputField = await this.page.waitForSelector(`${this.blockSelector} .theia-input`);
+        await inputField.press('Control+a');
+        await inputField.type(newName, { delay: USER_KEY_TYPING_DELAY });
+        await this.page.waitForTimeout(USER_KEY_TYPING_DELAY);
+    }
+
+    async confirm(): Promise<void> {
+        if (!await this.validationResult()) {
+            throw new Error(`Unexpected validation error in TheiaRenameDialog: '${await this.getValidationText()}`);
+        }
+        await this.clickMainButton();
+    }
+
+}

package/src/theia-status-bar.ts

@@ -0,0 +1,44 @@
+/********************************************************************************
+ * 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 { TheiaPageObject } from './theia-page-object';
+import { TheiaStatusIndicator } from './theia-status-indicator';
+
+export class TheiaStatusBar extends TheiaPageObject {
+
+    selector = 'div#theia-statusBar';
+
+    protected async statusBarElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.$(this.selector);
+    }
+
+    async statusIndicator<T extends TheiaStatusIndicator>(statusIndicatorFactory: { new(app: TheiaApp): T }): Promise<T> {
+        return new statusIndicatorFactory(this.app);
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'visible' });
+    }
+
+    async isVisible(): Promise<boolean> {
+        const statusBar = await this.statusBarElementHandle();
+        return !!statusBar && statusBar.isVisible();
+    }
+
+}

package/src/theia-status-indicator.ts

@@ -0,0 +1,79 @@
+/********************************************************************************
+ * 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 { TheiaPageObject } from './theia-page-object';
+
+export class TheiaStatusIndicator extends TheiaPageObject {
+
+    protected elementSpanSelector = '#theia-statusBar .element span';
+
+    protected async getElementHandle(): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        return this.page.$(this.elementSpanSelector);
+    }
+
+    async waitForVisible(): Promise<void> {
+        await this.page.waitForSelector(this.elementSpanSelector);
+    }
+
+    protected getSelectorByTitle(title: string): string {
+        return `.element[title="${title}"]`;
+    }
+
+    async getElementHandleByTitle(title: string): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        // Fetch element via title in case status elements exist without a dedicated Codicon icon
+        return this.page.$(this.getSelectorByTitle(title));
+    }
+
+    protected getSelectorByIcon(icon: string): string {
+        return `${this.elementSpanSelector}.codicon.${icon}`;
+    }
+
+    async getElementHandleByIcon(iconClass: string | string[], titleContain = ''): Promise<ElementHandle<SVGElement | HTMLElement> | null> {
+        const icons = Array.isArray(iconClass) ? iconClass : [iconClass];
+        for (const icon of icons) {
+            const span = await this.page.$(this.getSelectorByIcon(icon));
+            if (span) {
+                const parent = await span.$('..');
+                if (titleContain === '') {
+                    return parent;
+                } else {
+                    const parentTitle = await parent?.getAttribute('title');
+                    if (parentTitle?.includes(titleContain)) { return parent; }
+                }
+            }
+        }
+        throw new Error('Cannot find indicator');
+    }
+
+    async waitForVisibleByTitle(title: string, waitForDetached = false): Promise<void> {
+        await this.page.waitForSelector(this.getSelectorByTitle(title), waitForDetached ? { state: 'detached' } : {});
+    }
+
+    async waitForVisibleByIcon(icon: string, waitForDetached = false): Promise<void> {
+        await this.page.waitForSelector(this.getSelectorByIcon(icon), waitForDetached ? { state: 'detached' } : {});
+    }
+
+    async isVisible(icon: string | string[], titleContain = ''): Promise<boolean> {
+        try {
+            const element = await this.getElementHandleByIcon(icon, titleContain);
+            return !!element && element.isVisible();
+        } catch (err) {
+            return false;
+        }
+    }
+
+}