@eclipse-che/che-e2e 7.106.0-next-5d2b584 → 7.106.0-next-45f4fb4

package/specs/miscellaneous/VsixInstallationDisableTest.spec.ts

@@ -0,0 +1,243 @@
+/** *******************************************************************
+ * copyright (c) 2025 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 { e2eContainer } from '../../configs/inversify.config';
+import { CLASSES, TYPES } from '../../configs/inversify.types';
+import { expect } from 'chai';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { WorkspaceHandlingTests } from '../../tests-library/WorkspaceHandlingTests';
+import { ProjectAndFileTests } from '../../tests-library/ProjectAndFileTests';
+import { LoginTests } from '../../tests-library/LoginTests';
+import { registerRunningWorkspace } from '../MochaHooks';
+
+import { KubernetesCommandLineToolsExecutor } from '../../utils/KubernetesCommandLineToolsExecutor';
+import { ShellExecutor } from '../../utils/ShellExecutor';
+import { ITestWorkspaceUtil } from '../../utils/workspace/ITestWorkspaceUtil';
+
+import { Dashboard } from '../../pageobjects/dashboard/Dashboard';
+import { NotificationHandler } from '../../pageobjects/ide/NotificationHandler';
+import { CommandPalette } from '../../pageobjects/ide/CommandPalette';
+import { ExtensionsView } from '../../pageobjects/ide/ExtensionsView';
+import { ExplorerView } from '../../pageobjects/ide/ExplorerView';
+
+import { DriverHelper } from '../../utils/DriverHelper';
+import { BrowserTabsUtil } from '../../utils/BrowserTabsUtil';
+import { BASE_TEST_CONSTANTS } from '../../constants/BASE_TEST_CONSTANTS';
+import { Logger } from '../../utils/Logger';
+
+suite(`Verify VSIX installation can be disabled via configuration ${BASE_TEST_CONSTANTS.TEST_ENVIRONMENT}`, function (): void {
+	const workspaceHandlingTests: WorkspaceHandlingTests = e2eContainer.get(CLASSES.WorkspaceHandlingTests);
+	const projectAndFileTests: ProjectAndFileTests = e2eContainer.get(CLASSES.ProjectAndFileTests);
+	const loginTests: LoginTests = e2eContainer.get(CLASSES.LoginTests);
+	const kubernetesCommandLineToolsExecutor: KubernetesCommandLineToolsExecutor = e2eContainer.get(
+		CLASSES.KubernetesCommandLineToolsExecutor
+	);
+	const shellExecutor: ShellExecutor = e2eContainer.get(CLASSES.ShellExecutor);
+	const testWorkspaceUtil: ITestWorkspaceUtil = e2eContainer.get(TYPES.WorkspaceUtil);
+	const dashboard: Dashboard = e2eContainer.get(CLASSES.Dashboard);
+	const driverHelper: DriverHelper = e2eContainer.get(CLASSES.DriverHelper);
+	const browserTabsUtil: BrowserTabsUtil = e2eContainer.get(CLASSES.BrowserTabsUtil);
+	const notificationHandler: NotificationHandler = e2eContainer.get(CLASSES.NotificationHandler);
+	const commandPalette: CommandPalette = e2eContainer.get(CLASSES.CommandPalette);
+	const extensionsView: ExtensionsView = e2eContainer.get(CLASSES.ExtensionsView);
+	const explorerView: ExplorerView = e2eContainer.get(CLASSES.ExplorerView);
+
+	const TEST_REPO_URL: string = 'https://github.com/crw-qe/web-nodejs-sample-with-disabled-vsix/tree/install-from-vsix-disabled-7-100';
+	const RESOURCES_PATH: string = path.join(__dirname, '../../../resources');
+	const DEFAULT_EXTENSIONS: string[] = ['YAML'];
+	const VSIX_FILE_NAME: string = 'redhat.vscode-yaml-1.17.0.vsix';
+
+	const CONFIG_MAP_NAMES: { VSIX_CONFIG: string; DEFAULT_EXTENSIONS: string } = {
+		VSIX_CONFIG: 'vscode-editor-configurations',
+		DEFAULT_EXTENSIONS: 'default-extensions'
+	};
+	const CONFIG_MAP_NAMESPACES: { VSIX_CONFIG: string; DEFAULT_EXTENSIONS: string } = {
+		VSIX_CONFIG: 'openshift-devspaces',
+		DEFAULT_EXTENSIONS: 'admin-devspaces'
+	};
+	const CONFIG_FILES: { ENABLE_VSIX: string; DEFAULT_EXTENSIONS: string; DISABLE_VSIX: string } = {
+		DISABLE_VSIX: 'configmap-disable-vsix-installation.yaml',
+		ENABLE_VSIX: 'configmap-enable-vsix-installation.yaml',
+		DEFAULT_EXTENSIONS: 'default-extensions-configmap.yaml'
+	};
+
+	let workspaceName: string = '';
+
+	function applyConfigMap(configFileName: string): void {
+		const configPath: string = path.join(RESOURCES_PATH, configFileName);
+		const configContent: string = fs.readFileSync(configPath, 'utf8');
+		shellExecutor.executeCommand(`oc apply -f - <<EOF\n${configContent}\nEOF`);
+	}
+
+	function cleanupConfigMaps(): void {
+		Logger.debug(`Deleting ConfigMap ${CONFIG_MAP_NAMES.VSIX_CONFIG} from namespace ${CONFIG_MAP_NAMESPACES.VSIX_CONFIG}`);
+		shellExecutor.executeCommand(
+			`oc delete configmap ${CONFIG_MAP_NAMES.VSIX_CONFIG} -n ${CONFIG_MAP_NAMESPACES.VSIX_CONFIG} --ignore-not-found=true`
+		);
+
+		Logger.debug(
+			`Deleting ConfigMap ${CONFIG_MAP_NAMES.DEFAULT_EXTENSIONS} from namespace ${CONFIG_MAP_NAMESPACES.DEFAULT_EXTENSIONS}`
+		);
+		shellExecutor.executeCommand(
+			`oc delete configmap ${CONFIG_MAP_NAMES.DEFAULT_EXTENSIONS} -n ${CONFIG_MAP_NAMESPACES.DEFAULT_EXTENSIONS} --ignore-not-found=true`
+		);
+	}
+
+	// ========== Test Execution ==========
+
+	suiteSetup('Login to cluster and setup initial state', function (): void {
+		kubernetesCommandLineToolsExecutor.loginToOcp();
+		cleanupConfigMaps();
+	});
+
+	suiteSetup('Login to application', async function (): Promise<void> {
+		await loginTests.loginIntoChe();
+	});
+
+	test('Apply ConfigMaps that disable VSIX and set default extensions', function (): void {
+		applyConfigMap(CONFIG_FILES.DISABLE_VSIX);
+		applyConfigMap(CONFIG_FILES.DEFAULT_EXTENSIONS);
+	});
+
+	test('Create and open workspace from Git repository', async function (): Promise<void> {
+		await workspaceHandlingTests.createAndOpenWorkspaceFromGitRepository(TEST_REPO_URL);
+		await workspaceHandlingTests.obtainWorkspaceNameFromStartingPage();
+		workspaceName = WorkspaceHandlingTests.getWorkspaceName();
+		registerRunningWorkspace(workspaceName);
+	});
+
+	test('Wait workspace readiness', async function (): Promise<void> {
+		await projectAndFileTests.waitWorkspaceReadinessForCheCodeEditor();
+	});
+
+	test('Verify VSIX disabled notifications', async function (): Promise<void> {
+		const hasDisableNotification: boolean = await notificationHandler.checkForNotification('install from vsix command is disabled');
+		expect(hasDisableNotification).to.be.true;
+	});
+
+	test('Perform trust author dialog', async function (): Promise<void> {
+		await projectAndFileTests.performTrustAuthorDialog();
+	});
+
+	test('Verify VSIX installation is disabled in UI and extensions are not installed', async function (): Promise<void> {
+		// check Command Palette
+		await commandPalette.openCommandPalette();
+		await commandPalette.searchCommand('Install from VSIX');
+		const commandAvailable: boolean = await commandPalette.isCommandVisible('Extensions: Install from VSIX...');
+		await commandPalette.closeCommandPalette();
+		expect(commandAvailable).to.equal(false, 'Command Palette should not contain Install from VSIX command');
+
+		// check Extensions view menu
+		await extensionsView.openExtensionsView();
+		await extensionsView.openMoreActionsMenu();
+		const extensionMenuAvailable: boolean = await extensionsView.isMoreActionsMenuItemVisible('Install from VSIX');
+		await extensionsView.closeMoreActionsMenu();
+		expect(extensionMenuAvailable).to.equal(false, 'Extensions view should not contain Install from VSIX action');
+
+		// check Explorer context menu
+		await explorerView.openFileContextMenu(VSIX_FILE_NAME);
+		const contextMenuAvailable: boolean = await explorerView.isContextMenuItemVisible('Install Extension VSIX');
+		await explorerView.closeContextMenu();
+		expect(contextMenuAvailable).to.equal(false, 'Explorer context menu should not contain Install Extension VSIX action');
+
+		// verify default extensions are not auto-installed
+		await extensionsView.openExtensionsView();
+		const installedExtensions: string[] = await extensionsView.getInstalledExtensionNames();
+
+		Logger.debug(`Found installed extensions: ${installedExtensions.join(', ')}`);
+
+		for (const extensionName of DEFAULT_EXTENSIONS) {
+			const isInstalled: boolean = installedExtensions.some((installed: string): boolean =>
+				installed.toLowerCase().includes(extensionName.toLowerCase())
+			);
+			expect(isInstalled).to.equal(false, `Default VSIX extension "${extensionName}" should not be auto-installed`);
+		}
+	});
+
+	test('Enable VSIX installation and create new workspace', async function (): Promise<void> {
+		// clean up current workspace
+		await dashboard.openDashboard();
+		await testWorkspaceUtil.deleteWorkspaceByName(workspaceName);
+		registerRunningWorkspace('');
+
+		// apply ConfigMaps that enable VSIX and set default extensions
+		applyConfigMap(CONFIG_FILES.ENABLE_VSIX);
+		applyConfigMap(CONFIG_FILES.DEFAULT_EXTENSIONS);
+
+		Logger.info('Waiting for new ConfigMap settings to take effect...');
+		await driverHelper.wait(30000);
+
+		// create new workspace
+		await workspaceHandlingTests.createAndOpenWorkspaceFromGitRepository(TEST_REPO_URL);
+		await workspaceHandlingTests.obtainWorkspaceNameFromStartingPage();
+		workspaceName = WorkspaceHandlingTests.getWorkspaceName();
+		registerRunningWorkspace(workspaceName);
+	});
+
+	test('Wait workspace readiness', async function (): Promise<void> {
+		await projectAndFileTests.waitWorkspaceReadinessForCheCodeEditor();
+	});
+
+	test('Verify default extension installation success notifications', async function (): Promise<void> {
+		const hasSuccessNotification: boolean = await notificationHandler.checkForNotification('Completed installing extension');
+		expect(hasSuccessNotification).to.be.true;
+	});
+
+	test('Perform trust author dialog', async function (): Promise<void> {
+		await projectAndFileTests.performTrustAuthorDialog();
+	});
+
+	test('Verify VSIX installation is enabled in UI and extensions are installed', async function (): Promise<void> {
+		// check Command Palette
+		await commandPalette.openCommandPalette();
+		await commandPalette.searchCommand('Install from VSIX');
+		const commandAvailable: boolean = await commandPalette.isCommandVisible('Extensions: Install from VSIX...');
+		await commandPalette.closeCommandPalette();
+		expect(commandAvailable).to.equal(true, 'Command Palette should contain Install from VSIX command');
+
+		// check Extensions view menu
+		await extensionsView.openExtensionsView();
+		await extensionsView.openMoreActionsMenu();
+		const extensionMenuAvailable: boolean = await extensionsView.isMoreActionsMenuItemVisible('Install from VSIX');
+		await extensionsView.closeMoreActionsMenu();
+		expect(extensionMenuAvailable).to.equal(true, 'Extensions view should contain Install from VSIX action');
+
+		// check Explorer context menu
+		await explorerView.openFileContextMenu(VSIX_FILE_NAME);
+		const contextMenuAvailable: boolean = await explorerView.isContextMenuItemVisible('Install Extension VSIX');
+		await explorerView.closeContextMenu();
+		expect(contextMenuAvailable).to.equal(true, 'Explorer context menu should contain Install Extension VSIX action');
+
+		// verify default extensions are auto-installed when VSIX enabled
+		await extensionsView.openExtensionsView();
+		const installedExtensions: string[] = await extensionsView.getInstalledExtensionNames();
+
+		Logger.debug(`Found installed extensions: ${installedExtensions.join(', ')}`);
+
+		for (const extensionName of DEFAULT_EXTENSIONS) {
+			const isInstalled: boolean = installedExtensions.some((installed: string): boolean =>
+				installed.toLowerCase().includes(extensionName.toLowerCase())
+			);
+			expect(isInstalled).to.equal(true, `Default VSIX extension "${extensionName}" should be auto-installed`);
+		}
+	});
+
+	suiteTeardown('Clean up ConfigMaps and workspace', async function (): Promise<void> {
+		cleanupConfigMaps();
+		await dashboard.openDashboard();
+		await browserTabsUtil.closeAllTabsExceptCurrent();
+		await testWorkspaceUtil.stopAndDeleteWorkspaceByName(workspaceName);
+		registerRunningWorkspace('');
+		Logger.info('Cleanup completed');
+	});
+});

package/utils/DevWorkspaceConfigurationHelper.ts

@@ -15,6 +15,7 @@ import * as axios from 'axios';
 import { Logger } from './Logger';
 import { ShellExecutor } from './ShellExecutor';
 import { API_TEST_CONSTANTS } from '../constants/API_TEST_CONSTANTS';
+import { BASE_TEST_CONSTANTS } from '../constants/BASE_TEST_CONSTANTS';
 import { injectable } from 'inversify';
 import { IContextParams } from './IContextParams';
 import { e2eContainer } from '../configs/inversify.config';
@@ -69,7 +70,9 @@ export class DevWorkspaceConfigurationHelper {
 			axios.default as any
 		);
 
-		this.patchDevWorkspaceConfigWithStorageTypeAttribute(devfileContext);
+		if (BASE_TEST_CONSTANTS.TESTING_APPLICATION_NAME() === 'devspaces') {
+			this.addMissedDevWorkspaceConfigAttributes(devfileContext);
+		}
 
 		return devfileContext;
 	}
@@ -104,26 +107,20 @@ export class DevWorkspaceConfigurationHelper {
 		return content;
 	}
 
-	patchDevWorkspaceConfigWithBuildContainerAttribute(devfileContextDevWorkspace: any): void {
-		Logger.debug();
-		devfileContextDevWorkspace.spec.template.attributes = YAML.parse(`
-                    controller.devfile.io/devworkspace-config:
-                      name: devworkspace-config
-                      namespace: openshift-devspaces
-                    controller.devfile.io/scc: container-build
-                    controller.devfile.io/storage-type: per-user`);
-	}
-
 	/**
-	 * add storage type attribute to fix issue CRW-8922.
+	 * add missed attributes to fix issues CRW-8922, CRW-9187.
 	 */
-	patchDevWorkspaceConfigWithStorageTypeAttribute(
+	addMissedDevWorkspaceConfigAttributes(
 		devfileContextDevWorkspace: DevfileContext,
-		storageType: string = API_TEST_CONSTANTS.TS_API_TEST_STORAGE_TYPE
+		storageType: string | undefined = API_TEST_CONSTANTS.TS_API_TEST_STORAGE_TYPE
 	): void {
 		Logger.debug();
 		devfileContextDevWorkspace.devWorkspace?.spec?.template &&
 			(devfileContextDevWorkspace.devWorkspace.spec.template.attributes = YAML.parse(`
-					controller.devfile.io/storage-type: ${storageType}`));
+                    controller.devfile.io/devworkspace-config:
+                      name: devworkspace-config
+                      namespace: openshift-devspaces
+                    controller.devfile.io/scc: container-build
+                    controller.devfile.io/storage-type: ${storageType}`));
 	}
 }