@eclipse-che/che-e2e 7.62.0 → 7.63.0

package/testsLibrary/theia/LanguageServerTestsTheia.ts

@@ -1,205 +0,0 @@
-/*********************************************************************
- * Copyright (c) 2019 Red Hat, Inc.
- *
- * This program and the accompanying materials are made
- * available under the terms of the Eclipse Public License 2.0
- * which is available at https://www.eclipse.org/legal/epl-2.0/
- *
- * SPDX-License-Identifier: EPL-2.0
- **********************************************************************/
-
-import 'reflect-metadata';
-import { inject, injectable } from 'inversify';
-import { CLASSES } from '../../inversify.types';
-import { TimeoutConstants } from '../../TimeoutConstants';
-import { Editor } from '../../pageobjects/ide/theia/Editor';
-import { Ide, LeftToolbarButton } from '../../pageobjects/ide/theia/Ide';
-import { TopMenu } from '../../pageobjects/ide/theia/TopMenu';
-import { DebugView } from '../../pageobjects/ide/theia/DebugView';
-import { Key, error } from 'selenium-webdriver';
-import { Logger } from '../../utils/Logger';
-import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
-
-@injectable()
-export class LanguageServerTestsTheia {
-
-    constructor(
-        @inject(CLASSES.Editor) private readonly editor: Editor,
-        @inject(CLASSES.Ide) private readonly ide: Ide,
-        @inject(CLASSES.TopMenu) private readonly topMenu: TopMenu,
-        @inject(CLASSES.DebugView) private readonly debugView: DebugView,
-        @inject(CLASSES.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil) { }
-
-    public errorHighlighting(openedTab: string, textToWrite: string, line: number) {
-        test('Error highlighting', async () => {
-            await this.editor.type(openedTab, textToWrite, line);
-            try {
-                await this.editor.waitErrorInLine(line, openedTab);
-            } catch (err) {
-                if (!(err instanceof error.TimeoutError)) {
-                    throw err;
-                }
-            }
-            for (let i = 0; i < textToWrite.length; i++) {
-                await this.editor.performKeyCombination(openedTab, Key.BACK_SPACE);
-            }
-            await this.editor.waitErrorInLineDisappearance(line, openedTab);
-        });
-    }
-
-    public suggestionInvoking(openedTab: string, line: number, char: number, suggestionText: string) {
-        test('Suggestion invoking', async () => {
-            await this.ide.closeAllNotifications();
-            await this.editor.waitEditorAvailable(openedTab);
-            await this.editor.clickOnTab(openedTab);
-            await this.editor.waitEditorAvailable(openedTab);
-            await this.editor.waitTabFocused(openedTab);
-            await this.editor.moveCursorToLineAndChar(openedTab, line, char);
-            await this.editor.pressControlSpaceCombination(openedTab);
-            await this.editor.waitSuggestion(openedTab, suggestionText);
-        });
-    }
-
-    public autocomplete(openedTab: string, line: number, char: number, expectedText: string) {
-        test('Autocomplete', async () => {
-            await this.editor.moveCursorToLineAndChar(openedTab, line, char);
-            await this.editor.pressControlSpaceCombination(openedTab);
-            await this.editor.waitSuggestionContainer();
-            await this.editor.waitSuggestionWithScrolling(openedTab, expectedText);
-            await this.editor.waitTabWithSavedStatus(openedTab);
-        });
-    }
-
-    public waitLSInitialization(startingNote: string, alternateNote: string = '', startTimeout: number = TimeoutConstants.TS_SELENIUM_LANGUAGE_SERVER_START_TIMEOUT) {
-        test('LS initialization', async () => {
-            try {
-                await this.ide.checkLsInitializationStart(startingNote);
-            } catch (err) {
-                if (alternateNote.length === 0) {
-                    throw err;
-                }
-                if (!(err instanceof error.TimeoutError)) {
-                    throw err;
-                }
-                Logger.warn('Known flakiness has occurred https://github.com/eclipse/che/issues/17864');
-                await this.ide.waitStatusBarContains(alternateNote);
-                await this.ide.waitStatusBarTextAbsence(alternateNote, startTimeout);
-                return;
-            }
-            await this.ide.waitStatusBarTextAbsence(startingNote, startTimeout);
-            Logger.debug('Starting note successfully disappeared.');
-            if (alternateNote.length > 0) {
-                Logger.debug('AlternateNote value is set, waiting for presence and disappearance.');
-                await this.ide.waitStatusBarContains(alternateNote);
-                await this.ide.waitStatusBarTextAbsence(alternateNote, startTimeout);
-            }
-            Logger.debug('Language Server successfully initialized.');
-        });
-    }
-
-    public goToDefinition(openedFile: string, line: number, char: number, codeNavigationClassName: string, timeout: number = TimeoutConstants.TS_EDITOR_TAB_INTERACTION_TIMEOUT) {
-        test('Go to Definition', async () => {
-            try {
-                await this.editor.moveCursorToLineAndChar(openedFile, line, char);
-                await this.editor.performKeyCombination(openedFile, Key.chord(Key.CONTROL, Key.F11));
-                await this.editor.waitEditorAvailable(codeNavigationClassName, timeout);
-            } catch (err) {
-                // https://github.com/eclipse/che/issues/17411 was fixed by adding a retry
-                if (err instanceof error.TimeoutError) {
-                    Logger.warn('Code navigation (definition) didn\'t work. Trying again.');
-                    try {
-                        await this.editor.moveCursorToLineAndChar(openedFile, line, char);
-                        await this.editor.performKeyCombination(openedFile, Key.chord(Key.CONTROL, Key.F11));
-                        await this.editor.waitEditorAvailable(codeNavigationClassName, timeout);
-                    } catch (err) {
-                        Logger.error('Code navigation (definition) didn\'t work even after retrying.');
-                        throw err;
-                    }
-                } else {
-                    Logger.error('Code navigation (definition) failed with unexpected exception.');
-                    throw err;
-                }
-            }
-        });
-    }
-
-    public goToImplementations(openedFile: string, line: number, char: number, codeNavigationClassName: string, timeout: number = TimeoutConstants.TS_EDITOR_TAB_INTERACTION_TIMEOUT) {
-        test('Go to Implementations', async () => {
-            try {
-                await this.editor.moveCursorToLineAndChar(openedFile, line, char);
-                await this.editor.performKeyCombination(openedFile, Key.chord(Key.CONTROL, Key.F12));
-                await this.editor.waitEditorAvailable(codeNavigationClassName, timeout);
-            } catch (err) {
-                // https://github.com/eclipse/che/issues/17411 was fixed by adding a retry
-                if (err instanceof error.TimeoutError) {
-                    Logger.warn('Code navigation (implementations) didn\'t work. Trying again.');
-                    try {
-                        await this.editor.moveCursorToLineAndChar(openedFile, line, char);
-                        await this.editor.performKeyCombination(openedFile, Key.chord(Key.CONTROL, Key.F12));
-                        await this.editor.waitEditorAvailable(codeNavigationClassName, timeout);
-                    } catch (err) {
-                        Logger.error('Code navigation (implementations) didn\'t work even after retrying.');
-                        throw err;
-                    }
-                } else {
-                    Logger.error('Code navigation (implementations) failed with unexpected exception.');
-                    throw err;
-                }
-            }
-        });
-    }
-
-    public startAndAttachDebugger(openedFile: string) {
-        test('Open debug panel', async () => {
-            await this.editor.selectTab(openedFile);
-            await this.topMenu.selectOption('View', 'Debug');
-            await this.ide.waitLeftToolbarButton(LeftToolbarButton.Debug);
-        });
-
-        test('Run debug', async () => {
-            try {
-                await this.debugView.clickOnRunDebugButton();
-            } catch (err) {
-                // debug config is probably missing, refresh IDE and try again https://github.com/eclipse/che/issues/19887
-                await this.browserTabsUtil.refreshPage();
-                await this.ide.waitIde();
-                await this.debugView.clickOnRunDebugButton();
-            }
-        });
-    }
-
-    public startAndAttachDebuggerWithConfiguration(openedFile: string, configurationName: string) {
-        test('Open debug panel', async () => {
-            await this.editor.selectTab(openedFile);
-            await this.topMenu.selectOption('View', 'Debug');
-            await this.ide.waitLeftToolbarButton(LeftToolbarButton.Debug);
-        });
-
-        test('Run debug', async () => {
-            try {
-                await this.debugView.clickOnDebugConfigurationDropDown();
-                await this.debugView.clickOnDebugConfigurationItem(configurationName);
-                await this.debugView.clickOnRunDebugButton();
-            } catch (err) {
-                // debug config is probably missing, refresh IDE and try again https://github.com/eclipse/che/issues/19887
-                await this.browserTabsUtil.refreshPage();
-                await this.ide.waitIde();
-                await this.debugView.clickOnDebugConfigurationDropDown();
-                await this.debugView.clickOnDebugConfigurationItem(configurationName);
-                await this.debugView.clickOnRunDebugButton();
-            }
-        });
-    }
-
-    public setBreakpoint(openedFile: string, line: number) {
-        test('Activating breakpoint', async () => {
-            await this.editor.activateBreakpoint(openedFile, line);
-        });
-    }
-
-    public checkDebuggerStoppedAtBreakpoint(openedFile: string, line: number, timeout: number) {
-        test('Check that debug stopped at the breakpoint', async () => {
-            await this.editor.waitStoppedDebugBreakpoint(openedFile, line, timeout);
-        });
-    }
-}

package/testsLibrary/theia/ProjectAndFileTestsTheia.ts

@@ -1,113 +0,0 @@
-/*********************************************************************
- * Copyright (c) 2019 Red Hat, Inc.
- *
- * This program and the accompanying materials are made
- * available under the terms of the Eclipse Public License 2.0
- * which is available at https://www.eclipse.org/legal/epl-2.0/
- *
- * SPDX-License-Identifier: EPL-2.0
- **********************************************************************/
-
-import 'reflect-metadata';
-import { inject, injectable } from 'inversify';
-import { By, error } from 'selenium-webdriver';
-import { Ide } from '../../pageobjects/ide/theia/Ide';
-import { ProjectTree } from '../../pageobjects/ide/theia/ProjectTree';
-import { OpenEditors } from '../../pageobjects/ide/theia/OpenEditors';
-import { Editor } from '../../pageobjects/ide/theia/Editor';
-import { TimeoutConstants } from '../../TimeoutConstants';
-import { DriverHelper } from '../../utils/DriverHelper';
-import { CLASSES } from '../../inversify.types';
-import { Logger } from '../../utils/Logger';
-import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
-
-@injectable()
-export class ProjectAndFileTestsTheia {
-
-    constructor(
-        @inject(CLASSES.Ide) private readonly ide: Ide,
-        @inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
-        @inject(CLASSES.ProjectTree) private readonly projectTree: ProjectTree,
-        @inject(CLASSES.OpenEditors) private readonly openEditors: OpenEditors,
-        @inject(CLASSES.Editor) private readonly editor: Editor,
-        @inject(CLASSES.BrowserTabsUtil) private readonly browserTabsUtil: BrowserTabsUtil) {}
-
-        public switchBackToFirstOpenIdeTabFromLeftToRight() {
-            test('WorkspaceHandlingTests.switchBackToIdeTab', async () => {
-                let tabs = await this.driverHelper.getDriver().getAllWindowHandles();
-                Logger.trace(`WorkspaceHandlingTests.switchBackToIdeTab Found ${tabs.length} window handles, iterating...`);
-                for (let i = 0; i < tabs.length; i++) {
-                    await this.browserTabsUtil.switchToWindow(tabs[i]);
-                    try {
-                        await this.ide.waitIde(TimeoutConstants.TS_IDE_LOAD_TIMEOUT);
-                        Logger.debug(`WorkspaceHandlingTests.switchBackToIdeTab located and switched to IDE tab`);
-                        return;
-                    } catch (err) {
-                        if (err instanceof error.TimeoutError) {
-                            Logger.warn(`WorkspaceHandlingTests.switchBackToIdeTab Locator timed out, trying with another window handle.`);
-                            continue;
-                        }
-                        Logger.error(`WorkspaceHandlingTests.switchBackToIdeTab Received unexpected exception while trying to locate IDE tab:${err}`);
-                        throw err;
-                    }
-                }
-                Logger.error(`WorkspaceHandlingTests.switchBackToIdeTab Failed to locate IDE tab, out of window handles.`);
-            });
-        }
-
-    public waitWorkspaceReadiness(sampleName: string, folder: string, checkNotification: boolean = true, restartWorkspaceDialogIsExpected: boolean = false) {
-        test('Wait for workspace readiness', async () => {
-            await this.ide.waitIde(TimeoutConstants.TS_SELENIUM_START_WORKSPACE_TIMEOUT);
-
-            if (restartWorkspaceDialogIsExpected) {
-                await this.ide.clickOnCancelDialogButton();
-            }
-
-            await this.projectTree.openProjectTreeContainer();
-            if (!await this.openEditors.isExpansionToggleCollapsed()) {
-                await this.openEditors.waitAndClickExpansionToggle();
-            }
-
-            await this.projectTree.waitProjectImported(sampleName, folder);
-        });
-    }
-
-    public waitWorkspaceReadinessNoSubfolder(sampleName: string, checkNotification: boolean = true) {
-        test('Wait for workspace readiness', async () => {
-            await this.ide.waitIde(TimeoutConstants.TS_SELENIUM_START_WORKSPACE_TIMEOUT);
-            if (checkNotification) {
-                await this.ide.waitNotificationAndClickOnButton('Do you trust the authors of', 'Yes, I trust', 60_000);
-            }
-            await this.projectTree.openProjectTreeContainer();
-            if (!await this.openEditors.isExpansionToggleCollapsed()) {
-                await this.openEditors.waitAndClickExpansionToggle();
-            }
-            await this.projectTree.waitProjectImportedNoSubfolder(sampleName);
-        });
-    }
-
-    public openFile(filePath: string, fileName: string) {
-        test('Expand project and open file in editor', async () => {
-            await this.projectTree.expandPathAndOpenFile(filePath, fileName);
-            await this.editor.selectTab(fileName);
-        });
-    }
-
-    public checkFilePresence(filePath: string, timeout: number) {
-        test('Check that file is present in project', async () => {
-            await this.projectTree.waitItem(filePath, timeout);
-        });
-    }
-
-    public checkFileNotExists(filePath: string) {
-        test('Check that file is not exist in project', async () => {
-            await this.projectTree.waitItemDisappearance(filePath);
-        });
-    }
-
-    public checkProjectBranchName(branchName: string) {
-        test('Check branch name is ${}', async () => {
-            await this.driverHelper.waitVisibility(By.xpath(`//div[@id='theia-statusBar']/div//span[text()=' ${branchName}']`));
-        });
-    }
-}

package/utils/AnimationChecker.ts

@@ -1,27 +0,0 @@
-/*********************************************************************
- * Copyright (c) 2021 Red Hat, Inc.
- *
- * This program and the accompanying materials are made
- * available under the terms of the Eclipse Public License 2.0
- * which is available at https://www.eclipse.org/legal/epl-2.0/
- *
- * SPDX-License-Identifier: EPL-2.0
- **********************************************************************/
-
-import { injectable, inject } from 'inversify';
-import { CLASSES } from '../inversify.types';
-import { DriverHelper } from './DriverHelper';
-import { Logger } from './Logger';
-import { TimeoutConstants } from '../TimeoutConstants';
-
-@injectable()
-export class AnimationChecker {
-    constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
-
-    async waitDropDownAnimationEnd() {
-        Logger.debug('AnimationChecker.waitDropDownAnimationEnd');
-
-        await this.driverHelper.wait(TimeoutConstants.TS_SELENIUM_ANIMATION_END_DELAY);
-    }
-
-}

package/utils/theia/PreferencesHandlerTheia.ts

@@ -1,123 +0,0 @@
-/*********************************************************************
- * Copyright (c) 2019 Red Hat, Inc.
- *
- * This program and the accompanying materials are made
- * available under the terms of the Eclipse Public License 2.0
- * which is available at https://www.eclipse.org/legal/epl-2.0/
- *
- * SPDX-License-Identifier: EPL-2.0
- **********************************************************************/
-
-import { injectable, inject } from 'inversify';
-import { Logger } from '../Logger';
-import { CLASSES } from '../../inversify.types';
-import { CheApiRequestHandler } from '../requestHandlers/CheApiRequestHandler';
-import { Editor } from '../../pageobjects/ide/theia/Editor';
-import { QuickOpenContainer } from '../../pageobjects/ide/theia/QuickOpenContainer';
-import { TopMenu } from '../../pageobjects/ide/theia/TopMenu';
-import { Key } from 'selenium-webdriver';
-
-export enum TerminalRendererTypeTheia {
-    canvas = 'canvas',
-    dom = 'dom'
-}
-
-export enum AskForConfirmationTypeTheia {
-    never = 'never',
-    ifRquired = 'ifRequired',
-    always = 'always'
-}
-
-@injectable()
-export class PreferencesHandlerTheia {
-
-    constructor(@inject(CLASSES.CheApiRequestHandler) private readonly requestHandler: CheApiRequestHandler,
-        @inject(CLASSES.Editor) private readonly editor: Editor,
-        @inject(CLASSES.QuickOpenContainer) private readonly quickOpenContainer: QuickOpenContainer,
-        @inject(CLASSES.TopMenu) private readonly topMenu: TopMenu) {
-    }
-
-    /**
-     * Works properly only for the running workspace.
-     */
-    public async setPreferenceUsingUI(property: string, value: any) {
-        const tabTitle: string = 'settings.json';
-
-        await this.topMenu.selectOption('View', 'Find Command...');
-        await this.quickOpenContainer.typeAndSelectSuggestion('Preferences:', 'Preferences: Open Preferences (JSON)');
-
-        let editorText: string = await this.editor.getEditorVisibleText(tabTitle);
-        if (!editorText) {
-            editorText = '{}';
-        }
-        let preferences = JSON.parse(editorText);
-        preferences[property] = value;
-
-        await this.editor.deleteAllText(tabTitle);
-        await this.editor.type(tabTitle, JSON.stringify(preferences), 1);
-        await this.editor.type(tabTitle, Key.chord(Key.CONTROL, Key.SHIFT, 'i'), 1);
-    }
-
-    /**
-     * Works properly only if set before workspace startup.
-     */
-    public async setTerminalType(type: TerminalRendererTypeTheia) {
-        Logger.debug('PreferencesHandler.setTerminalToDom');
-        await this.setPreference('terminal.integrated.rendererType', type);
-    }
-
-    /**
-     *
-     * @param askForConfirmation possible values are "never", "ifRequired" and "always"
-     */
-    public async setConfirmExit(askForConfirmation: AskForConfirmationTypeTheia) {
-        Logger.debug(`PreferencesHandler.setConfirmExit to ${askForConfirmation}`);
-        await this.setPreference(`application.confirmExit`, askForConfirmation);
-    }
-
-    /**
-     * Works properly only if set before workspace startup.
-     */
-    public async setUseGoLanaguageServer() {
-        Logger.debug(`PreferencesHandler.setUseGoLanguageServer to true.`);
-        await this.setPreference('go.useLanguageServer', 'true');
-    }
-
-    /**
-     * Works properly only if set before workspace startup.
-     */
-    public async setVscodeKubernetesPluginConfig(vsKubernetesConfig: any) {
-        Logger.debug(`PreferencesHandler.setVscodeKubernetesPluginConfig`);
-        await this.setPreference('vs-kubernetes', vsKubernetesConfig);
-    }
-
-    public async setPreference(attribute: string, value: any) {
-        Logger.trace(`PreferencesHandler.setPreferences ${attribute} to ${value}`);
-        let response;
-        try {
-            response = await this.requestHandler.get('api/preferences');
-        } catch (e) {
-            Logger.error(`PreferencesHandler.setPreferences failed to get user preferences: ${e}`);
-            return;
-        }
-        let userPref = response.data;
-        try {
-            let theiaPref = JSON.parse(userPref['theia-user-preferences']);
-            theiaPref[attribute] = value;
-            userPref['theia-user-preferences'] = JSON.stringify(theiaPref);
-            await this.requestHandler.post('api/preferences', userPref);
-        } catch (e) {
-            // setting terminal before running a workspace, so no theia preferences are set
-            Logger.warn(`PreferencesHandler.setPreference could not set theia-user-preferences from api/preferences response, forcing manually.`);
-            let theiaPref = `{ "${attribute}":"${value}" }`;
-            userPref['theia-user-preferences'] = JSON.stringify(JSON.parse(theiaPref));
-            try {
-                await this.requestHandler.post('api/preferences', userPref);
-            } catch (e) {
-                Logger.error(`PreferencesHandler.setPreference failed to manually set preferences value: ${e}`);
-                return;
-            }
-        }
-        Logger.trace(`PreferencesHandler.setPreferences ${attribute} to ${value} done.`);
-    }
-}