@theia/playwright 1.25.0-next.9 → 1.25.0

package/src/tests/theia-explorer-view.test.ts

@@ -0,0 +1,124 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { TheiaApp } from '../theia-app';
+import { DOT_FILES_FILTER, TheiaExplorerView } from '../theia-explorer-view';
+import { TheiaWorkspace } from '../theia-workspace';
+import test, { page } from './fixtures/theia-fixture';
+
+let app: TheiaApp;
+let explorer: TheiaExplorerView;
+
+test.describe('Theia Explorer View', () => {
+
+    test.beforeAll(async () => {
+        const ws = new TheiaWorkspace(['src/tests/resources/sample-files1']);
+        app = await TheiaApp.load(page, ws);
+        explorer = await app.openView(TheiaExplorerView);
+    });
+
+    test('should be visible and active after being opened', async () => {
+        expect(await explorer.isTabVisible()).toBe(true);
+        expect(await explorer.isDisplayed()).toBe(true);
+        expect(await explorer.isActive()).toBe(true);
+    });
+
+    test("should be opened at the left and have the title 'Explorer'", async () => {
+        expect(await explorer.isInSidePanel()).toBe(true);
+        expect(await explorer.side()).toBe('left');
+        expect(await explorer.title()).toBe('Explorer');
+    });
+
+    test('should be possible to close and reopen it', async () => {
+        await explorer.close();
+        expect(await explorer.isTabVisible()).toBe(false);
+
+        explorer = await app.openView(TheiaExplorerView);
+        expect(await explorer.isTabVisible()).toBe(true);
+        expect(await explorer.isDisplayed()).toBe(true);
+        expect(await explorer.isActive()).toBe(true);
+    });
+
+    test('should show one folder named "sampleFolder" and one file named "sample.txt"', async () => {
+        await explorer.selectTreeNode('sampleFolder');
+        expect(await explorer.isTreeNodeSelected('sampleFolder')).toBe(true);
+        const fileStatElements = await explorer.visibleFileStatNodes(DOT_FILES_FILTER);
+        expect(fileStatElements.length).toBe(2);
+
+        let file; let folder;
+        if (await fileStatElements[0].isFolder()) {
+            folder = fileStatElements[0];
+            file = fileStatElements[1];
+        } else {
+            folder = fileStatElements[1];
+            file = fileStatElements[0];
+        }
+
+        expect(await folder.label()).toBe('sampleFolder');
+        expect(await folder.isFile()).toBe(false);
+        expect(await folder.isFolder()).toBe(true);
+        expect(await file.label()).toBe('sample.txt');
+        expect(await file.isFolder()).toBe(false);
+        expect(await file.isFile()).toBe(true);
+    });
+
+    test('should provide file stat node by single path fragment "sample.txt"', async () => {
+        const file = await explorer.getFileStatNodeByLabel('sample.txt');
+        expect(await file.label()).toBe('sample.txt');
+        expect(await file.isFolder()).toBe(false);
+        expect(await file.isFile()).toBe(true);
+    });
+
+    test('should provide file stat nodes that can define whether they are collapsed or not and that can be expanded', async () => {
+        const file = await explorer.getFileStatNodeByLabel('sample.txt');
+        expect(await file.isCollapsed()).toBe(false);
+
+        const folder = await explorer.getFileStatNodeByLabel('sampleFolder');
+        expect(await folder.isCollapsed()).toBe(true);
+
+        await folder.expand();
+        expect(await folder.isCollapsed()).toBe(false);
+    });
+
+    test('should provide file stat node by path "sampleFolder/sampleFolder1/sampleFolder1-1/sampleFile1-1-1.txt"', async () => {
+        const file = await explorer.fileStatNode('sampleFolder/sampleFolder1/sampleFolder1-1/sampleFile1-1-1.txt');
+        if (!file) { throw Error('File stat node could not be retrieved by path'); }
+        expect(await file.label()).toBe('sampleFile1-1-1.txt');
+    });
+
+    test('should open context menu on "sample.txt"', async () => {
+        const file = await explorer.getFileStatNodeByLabel('sample.txt');
+        const menu = await file.openContextMenu();
+        expect(await menu.isOpen()).toBe(true);
+
+        const menuItems = await menu.visibleMenuItems();
+        expect(menuItems).toContain('Open');
+        expect(menuItems).toContain('Delete');
+        expect(menuItems).toContain('Download');
+
+        await menu.close();
+        expect(await menu.isOpen()).toBe(false);
+    });
+
+    test('should rename "sample.txt"', async () => {
+        await explorer.renameNode('sample.txt', 'sample-new.txt');
+        expect(await explorer.existsFileNode('sample-new.txt')).toBe(true);
+        await explorer.renameNode('sample-new.txt', 'sample.txt');
+        expect(await explorer.existsFileNode('sample.txt')).toBe(true);
+    });
+
+});

package/src/tests/theia-main-menu.test.ts

@@ -0,0 +1,89 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { OSUtil } from '../util';
+import { TheiaApp } from '../theia-app';
+import { TheiaMenuBar } from '../theia-main-menu';
+import test, { page } from './fixtures/theia-fixture';
+
+let menuBar: TheiaMenuBar;
+
+test.describe('Theia Main Menu', () => {
+
+    test.beforeAll(async () => {
+        const app = await TheiaApp.load(page);
+        menuBar = app.menuBar;
+    });
+
+    test('should show the main menu bar', async () => {
+        const menuBarItems = await menuBar.visibleMenuBarItems();
+        expect(menuBarItems).toContain('File');
+        expect(menuBarItems).toContain('Edit');
+        expect(menuBarItems).toContain('Help');
+    });
+
+    test("should open main menu 'File'", async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        expect(await mainMenu.isOpen()).toBe(true);
+    });
+
+    test("should show the menu items 'New File' and 'New Folder'", async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        const menuItems = await mainMenu.visibleMenuItems();
+        expect(menuItems).toContain('New File');
+        expect(menuItems).toContain('New Folder');
+    });
+
+    test("should return menu item by name 'New File'", async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        const menuItem = await mainMenu.menuItemByName('New File');
+        expect(menuItem).toBeDefined();
+
+        const label = await menuItem?.label();
+        expect(label).toBe('New File');
+
+        const shortCut = await menuItem?.shortCut();
+        expect(shortCut).toBe(OSUtil.isMacOS ? 'N' : 'Alt+N');
+
+        const hasSubmenu = await menuItem?.hasSubmenu();
+        expect(hasSubmenu).toBe(false);
+    });
+
+    test('should detect whether menu item has submenu', async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        const newFileItem = await mainMenu.menuItemByName('New File');
+        const settingsItem = await mainMenu.menuItemByName('Preferences');
+
+        expect(await newFileItem?.hasSubmenu()).toBe(false);
+        expect(await settingsItem?.hasSubmenu()).toBe(true);
+    });
+
+    test('should be able to show menu item in submenu by path', async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        const openPreferencesItem = await mainMenu.menuItemByNamePath('Preferences', 'Open Settings (UI)');
+
+        const label = await openPreferencesItem?.label();
+        expect(label).toBe('Open Settings (UI)');
+    });
+
+    test('should close main menu', async () => {
+        const mainMenu = await menuBar.openMenu('File');
+        await mainMenu.close();
+        expect(await mainMenu.isOpen()).toBe(false);
+    });
+
+});

package/src/tests/theia-preference-view.test.ts

@@ -0,0 +1,93 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { TheiaApp } from '../theia-app';
+import { DefaultPreferences, PreferenceIds, TheiaPreferenceView } from '../theia-preference-view';
+import test, { page } from './fixtures/theia-fixture';
+
+let app: TheiaApp;
+
+test.describe('Preference View', () => {
+
+    test.beforeAll(async () => {
+        app = await TheiaApp.load(page);
+    });
+
+    test('should be visible and active after being opened', async () => {
+        const preferenceView = await app.openPreferences(TheiaPreferenceView);
+        expect(await preferenceView.isTabVisible()).toBe(true);
+        expect(await preferenceView.isDisplayed()).toBe(true);
+        expect(await preferenceView.isActive()).toBe(true);
+    });
+
+    test('should be able to read, set, and reset String preferences', async () => {
+        const preferences = await app.openPreferences(TheiaPreferenceView);
+        const preferenceId = PreferenceIds.DiffEditor.MaxComputationTime;
+
+        await preferences.resetStringPreferenceById(preferenceId);
+        expect(await preferences.getStringPreferenceById(preferenceId)).toBe(DefaultPreferences.DiffEditor.MaxComputationTime);
+
+        await preferences.setStringPreferenceById(preferenceId, '8000');
+        await preferences.waitForModified(preferenceId);
+        expect(await preferences.getStringPreferenceById(preferenceId)).toBe('8000');
+
+        await preferences.resetStringPreferenceById(preferenceId);
+        expect(await preferences.getStringPreferenceById(preferenceId)).toBe(DefaultPreferences.DiffEditor.MaxComputationTime);
+    });
+
+    test('should be able to read, set, and reset Boolean preferences', async () => {
+        const preferences = await app.openPreferences(TheiaPreferenceView);
+        const preferenceId = PreferenceIds.Explorer.AutoReveal;
+
+        await preferences.resetBooleanPreferenceById(preferenceId);
+        expect(await preferences.getBooleanPreferenceById(preferenceId)).toBe(DefaultPreferences.Explorer.AutoReveal.Enabled);
+
+        await preferences.setBooleanPreferenceById(preferenceId, false);
+        await preferences.waitForModified(preferenceId);
+        expect(await preferences.getBooleanPreferenceById(preferenceId)).toBe(false);
+
+        await preferences.resetBooleanPreferenceById(preferenceId);
+        expect(await preferences.getBooleanPreferenceById(preferenceId)).toBe(DefaultPreferences.Explorer.AutoReveal.Enabled);
+    });
+
+    test('should throw an error if we try to read, set, or reset a non-existing preference', async () => {
+        const preferences = await app.openPreferences(TheiaPreferenceView);
+
+        preferences.customTimeout = 500;
+        try {
+            await expect(preferences.getBooleanPreferenceById('no.a.real.preference')).rejects.toThrowError();
+            await expect(preferences.setBooleanPreferenceById('no.a.real.preference', true)).rejects.toThrowError();
+            await expect(preferences.resetBooleanPreferenceById('no.a.real.preference')).rejects.toThrowError();
+
+            await expect(preferences.getStringPreferenceById('no.a.real.preference')).rejects.toThrowError();
+            await expect(preferences.setStringPreferenceById('no.a.real.preference', 'a')).rejects.toThrowError();
+            await expect(preferences.resetStringPreferenceById('no.a.real.preference')).rejects.toThrowError();
+        } finally {
+            preferences.customTimeout = undefined;
+        }
+    });
+
+    test('should throw an error if we try to read, or set a preference with the wrong type', async () => {
+        const preferences = await app.openPreferences(TheiaPreferenceView);
+        const stringPreference = PreferenceIds.DiffEditor.MaxComputationTime;
+        const booleanPreference = PreferenceIds.Explorer.AutoReveal;
+
+        await expect(preferences.getBooleanPreferenceById(stringPreference)).rejects.toThrowError();
+        await expect(preferences.setBooleanPreferenceById(stringPreference, true)).rejects.toThrowError();
+        await expect(preferences.setStringPreferenceById(booleanPreference, 'true')).rejects.toThrowError();
+    });
+});

package/src/tests/theia-problems-view.test.ts

@@ -0,0 +1,60 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { TheiaApp } from '../theia-app';
+import { TheiaProblemsView } from '../theia-problem-view';
+import test, { page } from './fixtures/theia-fixture';
+
+let app: TheiaApp;
+
+test.describe('Theia Problems View', () => {
+
+    test.beforeAll(async () => {
+        app = await TheiaApp.load(page);
+    });
+
+    test('should be visible and active after being opened', async () => {
+        const problemsView = await app.openView(TheiaProblemsView);
+        expect(await problemsView.isTabVisible()).toBe(true);
+        expect(await problemsView.isDisplayed()).toBe(true);
+        expect(await problemsView.isActive()).toBe(true);
+    });
+
+    test("should be opened at the bottom and have the title 'Problems'", async () => {
+        const problemsView = await app.openView(TheiaProblemsView);
+        expect(await problemsView.isInSidePanel()).toBe(false);
+        expect(await problemsView.side()).toBe('bottom');
+        expect(await problemsView.title()).toBe('Problems');
+    });
+
+    test('should be closable', async () => {
+        const problemsView = await app.openView(TheiaProblemsView);
+        expect(await problemsView.isClosable()).toBe(true);
+
+        await problemsView.close();
+        expect(await problemsView.isTabVisible()).toBe(false);
+        expect(await problemsView.isDisplayed()).toBe(false);
+        expect(await problemsView.isActive()).toBe(false);
+    });
+
+    test("should not throw an error if 'close' is called twice", async () => {
+        const problemsView = await app.openView(TheiaProblemsView);
+        await problemsView.close();
+        await problemsView.close();
+    });
+
+});

package/src/tests/theia-quick-command.test.ts

@@ -0,0 +1,61 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { TheiaAboutDialog } from '../theia-about-dialog';
+import { TheiaApp } from '../theia-app';
+import { TheiaExplorerView } from '../theia-explorer-view';
+import { TheiaQuickCommandPalette } from '../theia-quick-command-palette';
+import test, { page } from './fixtures/theia-fixture';
+
+let app: TheiaApp;
+let quickCommand: TheiaQuickCommandPalette;
+
+test.describe('Theia Quick Command', () => {
+
+    test.beforeAll(async () => {
+        app = await TheiaApp.load(page);
+        quickCommand = app.quickCommandPalette;
+    });
+
+    test('should show quick command palette', async () => {
+        await quickCommand.open();
+        expect(await quickCommand.isOpen()).toBe(true);
+    });
+
+    test('should trigger \'About\' command after typing', async () => {
+        await quickCommand.type('About');
+        await quickCommand.trigger('About');
+        expect(await quickCommand.isOpen()).toBe(false);
+        const aboutDialog = new TheiaAboutDialog(app);
+        expect(await aboutDialog.isVisible()).toBe(true);
+        await aboutDialog.close();
+        expect(await aboutDialog.isVisible()).toBe(false);
+
+        await quickCommand.type('Select All');
+        await quickCommand.trigger('Select All');
+        expect(await quickCommand.isOpen()).toBe(false);
+    });
+
+    test('should trigger \'Toggle Explorer View\' command after typing', async () => {
+        await quickCommand.type('Toggle Explorer');
+        await quickCommand.trigger('Toggle Explorer View');
+        expect(await quickCommand.isOpen()).toBe(false);
+        const explorerView = new TheiaExplorerView(app);
+        expect(await explorerView.isDisplayed()).toBe(true);
+    });
+
+});

package/src/tests/theia-sample-app.test.ts

@@ -0,0 +1,92 @@
+// *****************************************************************************
+// Copyright (C) 2022 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 { expect } from '@playwright/test';
+import test, { page } from './fixtures/theia-fixture';
+import { TheiaPageObject } from '../theia-page-object';
+
+class TheiaSampleToolbar extends TheiaPageObject {
+    protected selector = '#main-toolbar';
+
+    async show(): Promise<void> {
+        if (!await this.isShown()) {
+            await this.toggle();
+        }
+    }
+
+    async toggle(): Promise<void> {
+        const isShown = await this.isShown();
+        const viewMenu = await this.app.menuBar.openMenu('View');
+        await viewMenu.clickMenuItem('Toggle Toolbar');
+        isShown ? await this.waitUntilHidden() : await this.waitUntilShown();
+    }
+
+    async waitUntilHidden(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'hidden' });
+    }
+
+    async waitUntilShown(): Promise<void> {
+        await this.page.waitForSelector(this.selector, { state: 'visible' });
+    }
+
+    async isShown(): Promise<boolean> {
+        const toolbar = await this.page.$(this.selector);
+        return !!toolbar && toolbar.isVisible();
+    }
+}
+
+class TheiaSampleApp extends TheiaApp {
+    protected toolbar = new TheiaSampleToolbar(this);
+
+    override async waitForInitialized(): Promise<void> {
+        await this.toolbar.show();
+    }
+
+    async toggleToolbar(): Promise<void> {
+        await this.toolbar.toggle();
+    }
+
+    async isToolbarVisible(): Promise<boolean> {
+        return this.toolbar.isShown();
+    }
+}
+
+let app: TheiaSampleApp;
+
+test.describe('Theia Sample Application', () => {
+
+    test('should load', async () => {
+        app = await TheiaApp.loadApp(page, TheiaSampleApp);
+    });
+
+    test('should start with visible toolbar', async () => {
+        expect(await app.isToolbarVisible()).toBe(true);
+    });
+
+    test('should toggle toolbar', async () => {
+        await app.toggleToolbar();
+        expect(await app.isToolbarVisible()).toBe(false);
+
+        await app.toggleToolbar();
+        expect(await app.isToolbarVisible()).toBe(true);
+
+        await app.toggleToolbar();
+        expect(await app.isToolbarVisible()).toBe(false);
+    });
+
+});

package/src/tests/theia-status-bar.test.ts

@@ -0,0 +1,47 @@
+// *****************************************************************************
+// 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 { expect } from '@playwright/test';
+import { TheiaApp } from '../theia-app';
+import { TheiaNotificationIndicator } from '../theia-notification-indicator';
+import { TheiaProblemIndicator } from '../theia-problem-indicator';
+import { TheiaStatusBar } from '../theia-status-bar';
+import { TheiaToggleBottomIndicator } from '../theia-toggle-bottom-indicator';
+import test, { page } from './fixtures/theia-fixture';
+
+let statusBar: TheiaStatusBar;
+
+test.describe('Theia Status Bar', () => {
+
+    test.beforeAll(async () => {
+        const app = await TheiaApp.load(page);
+        statusBar = app.statusBar;
+    });
+
+    test('should show status bar', async () => {
+        expect(await statusBar.isVisible()).toBe(true);
+    });
+
+    test('should contain status bar elements', async () => {
+        const problemIndicator = await statusBar.statusIndicator(TheiaProblemIndicator);
+        const notificationIndicator = await statusBar.statusIndicator(TheiaNotificationIndicator);
+        const toggleBottomIndicator = await statusBar.statusIndicator(TheiaToggleBottomIndicator);
+        expect(await problemIndicator.isVisible()).toBe(true);
+        expect(await notificationIndicator.isVisible()).toBe(true);
+        expect(await toggleBottomIndicator.isVisible()).toBe(true);
+    });
+
+});