@eclipse-che/che-e2e 7.74.0-dev-1d09cb7 → 7.74.0-dev-aace77a

package/utils/IContextParams.ts

@@ -0,0 +1,26 @@
+/** *******************************************************************
+ * copyright (c) 2023 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
+ **********************************************************************/
+
+export interface IContextParams {
+	devfilePath?: string | undefined;
+	devfileUrl?: string | undefined;
+	devfileContent?: string | undefined;
+	outputFile?: string | undefined;
+	editorPath?: string | undefined;
+	editorContent?: string | undefined;
+	editorEntry?: string | undefined;
+	pluginRegistryUrl?: string | undefined;
+	projects?: {
+		name: string;
+		location: string;
+	}[];
+	injectDefaultComponent?: string | undefined;
+	defaultComponentImage?: string | undefined;
+}

package/utils/IKubernetesCommandLineToolsExecutor.ts

@@ -0,0 +1,42 @@
+/** *******************************************************************
+ * copyright (c) 2023 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 { ShellString } from 'shelljs';
+
+export interface IKubernetesCommandLineToolsExecutor {
+	loginToOcp(): void;
+
+	getContainerName(): string;
+
+	getWorkspacePodName(): string;
+
+	deleteDevWorkspace(): void;
+
+	applyAndWaitDevWorkspace(yamlConfiguration: string): ShellString;
+
+	executeCommand(commandToExecute: string, container: string): ShellString;
+
+	applyYamlConfigurationAsStringOutput(yamlConfiguration: string): ShellString;
+
+	applyYamlConfigurationAsFile(pathToFile: string): void;
+
+	getDevWorkspaceYamlConfiguration(): ShellString;
+
+	waitDevWorkspace(timeout: number): ShellString;
+
+	createProject(projectName: string): void;
+
+	deleteProject(projectName: string): void;
+
+	getPodAndContainerNames(): void;
+
+	isUserLoggedIn(user: string): boolean;
+
+	getServerUrl(): string;
+}

package/utils/KubernetesCommandLineToolsExecutor.ts

@@ -1,190 +1,238 @@
+/** *******************************************************************
+ * copyright (c) 2023 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 { echo, exec, ShellString } from 'shelljs';
 import { Logger } from './Logger';
 import { ShellExecutor } from './ShellExecutor';
 import * as path from 'path';
-import { APITestConstants, KubernetesCommandLineTool } from '../constants/APITestConstants';
-import { BaseTestConstants } from '../constants/BaseTestConstants';
-import { OAuthConstants } from '../constants/OAuthConstants';
-
-export class KubernetesCommandLineToolsExecutor extends ShellExecutor {
-  private static container: string;
-  private static pod: string;
-  private readonly namespace: string;
-  private readonly workspaceName: string | undefined;
-  private readonly KUBERNETES_COMMAND_LINE_TOOL: string =
-    APITestConstants.TS_API_TEST_KUBERNETES_COMMAND_LINE_TOOL;
-
-  constructor(_workspaceName?: string, _namespace?: string) {
-    super();
-    this.workspaceName = _workspaceName;
-    this.namespace = this.setNamespace(_namespace);
-  }
-
-  get getWorkspaceName(): string {
-    return <string>this.workspaceName;
-  }
-
-  get getNamespace(): string {
-    return this.namespace;
-  }
-
-  // login to Openshift cluster with username and password
-  loginToOcp(): void {
-    if (this.KUBERNETES_COMMAND_LINE_TOOL === KubernetesCommandLineTool.OC) {
-      Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - login to the "OC" client.`);
-      const url: string = this.getServerUrl();
-      if (this.isUserLoggedIn()) {
-        Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - user already logged`);
-      } else {
-        Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - login ${url}, ${OAuthConstants.TS_SELENIUM_OCP_USERNAME}`);
-        exec(`oc login --server=${url} -u=${OAuthConstants.TS_SELENIUM_OCP_USERNAME} -p=${OAuthConstants.TS_SELENIUM_OCP_PASSWORD} --insecure-skip-tls-verify`);
-      }
-    } else {
-      Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - doesn't support login command`);
-    }
-  }
-
-  getContainerName(): string {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - get container name.`);
-    const output: ShellString = ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} get ${KubernetesCommandLineToolsExecutor.pod} -o jsonpath='{.spec.containers[*].name}' -n ${this.namespace}`);
-    echo('\n');
-    return output.stderr ? output.stderr : output.stdout;
-  }
-
-  getWorkspacePodName(): string {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - get workspace pod name.`);
-    const output: ShellString = ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} get pod -l controller.devfile.io/devworkspace_name=${this.workspaceName} -n ${this.namespace} -o name`);
-    return output.stderr ? output.stderr : output.stdout.replace('\n', '');
-  }
-
-  deleteDevWorkspace(): void {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - delete '${this.workspaceName}' workspace`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} patch dw ${this.workspaceName} -n ${this.namespace} -p '{ "metadata": { "finalizers": null }}' --type merge || true`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} delete dw ${this.workspaceName} -n ${this.namespace} || true`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} delete dwt ${BaseTestConstants.TS_SELENIUM_EDITOR}-${this.workspaceName} -n ${this.namespace} || true`);
-  }
-
-  applyAndWaitDevWorkspace(yamlConfiguration: string): ShellString {
-    if (this.KUBERNETES_COMMAND_LINE_TOOL === KubernetesCommandLineTool.KUBECTL) {
-      this.createNamespace();
-    }
-    this.applyYamlConfigurationAsStringOutput(yamlConfiguration);
-    return this.waitDevWorkspace();
-  }
-
-  executeCommand(
-    commandToExecute: string,
-    container: string = KubernetesCommandLineToolsExecutor.container): ShellString {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL}`);
-    return ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} exec -i ${KubernetesCommandLineToolsExecutor.pod} -n ${this.namespace} -c ${container} -- sh -c '${commandToExecute}'`);
-  }
-
-  applyYamlConfigurationAsStringOutput(yamlConfiguration: string): ShellString {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL}`);
-    return ShellExecutor.execWithLog(`cat <<EOF | ${this.KUBERNETES_COMMAND_LINE_TOOL} apply -n ${this.namespace} -f - \n` +
-      yamlConfiguration +
-      '\n' +
-      'EOF');
-  }
-
-  applyYamlConfigurationAsFile(pathToFile: string): void {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL}`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} apply -n ${this.namespace} -f "${path.resolve(pathToFile)}"`);
-  }
-
-  getDevWorkspaceYamlConfiguration(): ShellString {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL}`);
-    return ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} get dw ${this.workspaceName} -n ${this.namespace} -o yaml`);
-  }
-
-  waitDevWorkspace(timeout: number = 360): ShellString {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - wait till workspace ready.`);
-    const output: ShellString = ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} wait -n ${this.namespace} --for=condition=Ready dw ${this.workspaceName} --timeout=${timeout}s`);
-    this.getPodAndContainerNames();
-    return output;
-  }
-
-  createNamespace(): void {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - create namespace "${this.namespace}".`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} create namespace ${this.namespace}`);
-  }
-
-  createProject(projectName: string): void {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - create new project "${projectName}".`);
-    ShellExecutor.execWithLog(
-      `${this.KUBERNETES_COMMAND_LINE_TOOL} new-project ${projectName} -n ${this.namespace}`
-    );
-  }
-
-  deleteProject(projectName: string): void {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - delete "${projectName}".`);
-    ShellExecutor.execWithLog(`${this.KUBERNETES_COMMAND_LINE_TOOL} delete project ${projectName} -n ${this.namespace}`);
-  }
-
-  private getPodAndContainerNames(): void {
-    KubernetesCommandLineToolsExecutor.pod = this.getWorkspacePodName();
-    KubernetesCommandLineToolsExecutor.container = this.getContainerName();
-  }
-
-  private isUserLoggedIn(): boolean {
-    const whoamiCommandOutput: ShellString = ShellExecutor.execWithLog('oc whoami && oc whoami --show-server=true');
-
-    return (
-      whoamiCommandOutput.stdout.includes(OAuthConstants.TS_SELENIUM_OCP_USERNAME) && whoamiCommandOutput.stdout.includes(this.getServerUrl()));
-  }
-
-  private setNamespace(_namespace: string | undefined): string {
-    _namespace =
-      _namespace !== undefined
-        ? _namespace
-        : BaseTestConstants.TS_SELENIUM_BASE_URL.includes('devspaces')
-          ? OAuthConstants.TS_SELENIUM_OCP_USERNAME + '-devspaces'
-          : BaseTestConstants.TS_SELENIUM_BASE_URL.includes('che')
-            ? OAuthConstants.TS_SELENIUM_OCP_USERNAME + '-che'
-            : 'default';
-    return _namespace;
-  }
-
-  private getServerUrl(): string {
-    Logger.debug(`${this.KUBERNETES_COMMAND_LINE_TOOL} - get server api url.`);
-    return (BaseTestConstants.TS_SELENIUM_BASE_URL.replace('devspaces.apps', 'api') + ':6443');
-  }
+import { API_TEST_CONSTANTS, KubernetesCommandLineTool } from '../constants/API_TEST_CONSTANTS';
+import { BASE_TEST_CONSTANTS } from '../constants/BASE_TEST_CONSTANTS';
+import { OAUTH_CONSTANTS } from '../constants/OAUTH_CONSTANTS';
+import { IKubernetesCommandLineToolsExecutor } from './IKubernetesCommandLineToolsExecutor';
+import { inject, injectable } from 'inversify';
+import { CLASSES } from '../configs/inversify.types';
+
+@injectable()
+export class KubernetesCommandLineToolsExecutor implements IKubernetesCommandLineToolsExecutor {
+	private static container: string;
+	private static pod: string;
+	private readonly kubernetesCommandLineTool: string;
+	protected _namespace: string | undefined;
+	protected _workspaceName: string | undefined;
+
+	constructor(
+		@inject(CLASSES.ShellExecutor)
+		protected readonly shellExecutor: ShellExecutor
+	) {
+		this.kubernetesCommandLineTool = API_TEST_CONSTANTS.TS_API_TEST_KUBERNETES_COMMAND_LINE_TOOL;
+	}
+
+	set namespace(value: string | undefined) {
+		this._namespace = value;
+	}
+
+	set workspaceName(value: string | undefined) {
+		this._workspaceName = value;
+	}
+
+	get workspaceName(): string | undefined {
+		return this._workspaceName;
+	}
+
+	get namespace(): string | undefined {
+		this._namespace =
+			this._namespace !== undefined
+				? this._namespace
+				: BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL.includes('devspaces')
+				? OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME + '-devspaces'
+				: BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL.includes('che')
+				? OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME + '-che'
+				: 'default';
+		return this._namespace;
+	}
+
+	// login to Openshift cluster with username and password
+	loginToOcp(user: string = OAUTH_CONSTANTS.TS_SELENIUM_OCP_USERNAME, password: string = OAUTH_CONSTANTS.TS_SELENIUM_OCP_PASSWORD): void {
+		if (this.kubernetesCommandLineTool === KubernetesCommandLineTool.OC) {
+			Logger.debug(`${this.kubernetesCommandLineTool} - login to the "OC" client.`);
+			const url: string = this.getServerUrl();
+			if (this.isUserLoggedIn(user)) {
+				Logger.debug(`${this.kubernetesCommandLineTool} - user already logged`);
+			} else {
+				Logger.debug(`${this.kubernetesCommandLineTool} - login ${url}, ${user}`);
+				exec(`oc login --server=${url} -u=${user} -p=${password} --insecure-skip-tls-verify`);
+			}
+		} else {
+			Logger.debug(`${this.kubernetesCommandLineTool} - doesn't support login command`);
+		}
+	}
+
+	getContainerName(): string {
+		Logger.debug(`${this.kubernetesCommandLineTool} - get container name.`);
+
+		const output: ShellString = this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} get ${KubernetesCommandLineToolsExecutor.pod} -o jsonpath='{.spec.containers[*].name}' -n ${this.namespace}`
+		);
+		echo('\n');
+		return output.stderr ? output.stderr : output.stdout;
+	}
+
+	getWorkspacePodName(): string {
+		Logger.debug(`${this.kubernetesCommandLineTool} - get workspace pod name.`);
+
+		const output: ShellString = this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} get pod -l controller.devfile.io/devworkspace_name=${this.workspaceName} -n ${this.namespace} -o name`
+		);
+		return output.stderr ? output.stderr : output.stdout.replace('\n', '');
+	}
+
+	deleteDevWorkspace(): void {
+		Logger.debug(`${this.kubernetesCommandLineTool} - delete '${this.workspaceName}' workspace`);
+
+		this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} patch dw ${this.workspaceName} -n ${this.namespace} -p '{ "metadata": { "finalizers": null }}' --type merge || true`
+		);
+		this.shellExecutor.executeCommand(`${this.kubernetesCommandLineTool} delete dw ${this.workspaceName} -n ${this.namespace} || true`);
+		this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} delete dwt ${BASE_TEST_CONSTANTS.TS_SELENIUM_EDITOR}-${this.workspaceName} -n ${this.namespace} || true`
+		);
+	}
+
+	applyAndWaitDevWorkspace(yamlConfiguration: string): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		if (this.kubernetesCommandLineTool === KubernetesCommandLineTool.KUBECTL) {
+			this.createNamespace();
+		}
+		this.applyYamlConfigurationAsStringOutput(yamlConfiguration);
+		return this.waitDevWorkspace();
+	}
+
+	executeCommand(commandToExecute: string, container: string = KubernetesCommandLineToolsExecutor.container): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		return this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} exec -i ${KubernetesCommandLineToolsExecutor.pod} -n ${this.namespace} -c ${container} -- sh -c '${commandToExecute}'`
+		);
+	}
+
+	applyYamlConfigurationAsStringOutput(yamlConfiguration: string): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		return this.shellExecutor.executeCommand(
+			`cat <<EOF | ${this.kubernetesCommandLineTool} apply -n ${this.namespace} -f - \n` + yamlConfiguration + '\n' + 'EOF'
+		);
+	}
+
+	applyWithoutNamespace(yamlConfiguration: string): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		return this.shellExecutor.executeCommand(
+			`cat <<EOF | ${this.kubernetesCommandLineTool} apply -f - \n` + yamlConfiguration + '\n' + 'EOF'
+		);
+	}
+
+	applyYamlConfigurationAsFile(pathToFile: string): void {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		this.shellExecutor.executeCommand(`${this.kubernetesCommandLineTool} apply -n ${this.namespace} -f "${path.resolve(pathToFile)}"`);
+	}
+
+	getDevWorkspaceYamlConfiguration(): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		return this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} get dw ${this.workspaceName} -n ${this.namespace} -o yaml`
+		);
+	}
+
+	waitDevWorkspace(timeout: number = 360): ShellString {
+		Logger.debug(`${this.kubernetesCommandLineTool} - wait till workspace ready.`);
+
+		const output: ShellString = this.shellExecutor.executeCommand(
+			`${this.kubernetesCommandLineTool} wait -n ${this.namespace} --for=condition=Ready dw ${this.workspaceName} --timeout=${timeout}s`
+		);
+		this.getPodAndContainerNames();
+		return output;
+	}
+
+	createNamespace(): void {
+		Logger.debug(`${this.kubernetesCommandLineTool} - create namespace "${this.namespace}".`);
+
+		this.shellExecutor.executeCommand(`${this.kubernetesCommandLineTool} create namespace ${this.namespace}`);
+	}
+
+	createProject(projectName: string): void {
+		Logger.debug(`${this.kubernetesCommandLineTool} - create new project "${projectName}".`);
+
+		this.shellExecutor.executeCommand(`${this.kubernetesCommandLineTool} new-project ${projectName} -n ${this.namespace}`);
+	}
+
+	deleteProject(projectName: string): void {
+		Logger.debug(`${this.kubernetesCommandLineTool} - delete "${projectName}".`);
+
+		this.shellExecutor.executeCommand(`${this.kubernetesCommandLineTool} delete project ${projectName} -n ${this.namespace}`);
+	}
+
+	getPodAndContainerNames(): void {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		KubernetesCommandLineToolsExecutor.pod = this.getWorkspacePodName();
+		KubernetesCommandLineToolsExecutor.container = this.getContainerName();
+	}
+
+	/**
+	 * @param userName
+	 */
+	isUserLoggedIn(userName: string): boolean {
+		Logger.debug(`${this.kubernetesCommandLineTool}`);
+
+		const whoamiCommandOutput: ShellString = this.shellExecutor.executeCommand('oc whoami && oc whoami --show-server=true');
+
+		return whoamiCommandOutput.stdout.includes(userName) && whoamiCommandOutput.stdout.includes(this.getServerUrl());
+	}
+
+	getServerUrl(): string {
+		Logger.debug(`${this.kubernetesCommandLineTool} - get server api url.`);
+
+		return BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL.replace('devspaces.apps', 'api') + ':6443';
+	}
 }
 
-export namespace KubernetesCommandLineToolsExecutor {
-  export class ContainerTerminal extends KubernetesCommandLineToolsExecutor {
-    constructor(cluster: KubernetesCommandLineToolsExecutor) {
-      super(cluster.getWorkspaceName, cluster.getNamespace);
-    }
-
-    ls(path: string = ''): ShellString {
-      return this.executeCommand('ls ' + path);
-    }
-
-    pwd(): ShellString {
-      return this.executeCommand('pwd');
-    }
-
-    cd(path: string): ShellString {
-      return this.executeCommand('cd ' + path);
-    }
-
-    gitClone(repository: string): ShellString {
-      return this.executeCommand('git clone ' + repository);
-    }
-
-    removeFolder(path: string): ShellString {
-      return this.executeCommand('rm -rf ' + path);
-    }
-
-    getEnvValue(envName: string): string {
-      envName = envName.replace(/[${}]/g, '');
-      const output: ShellString = this.executeCommand(`env | grep ${envName}`);
-      return output.stderr
-        ? output.stderr
-        : output.stdout
-          .substring(output.stdout.lastIndexOf('=') + 1)
-          .replace('\n', '');
-    }
-  }
+@injectable()
+export class ContainerTerminal extends KubernetesCommandLineToolsExecutor {
+	constructor(
+		@inject(CLASSES.ShellExecutor)
+		readonly shellExecutor: ShellExecutor,
+		@inject(CLASSES.KubernetesCommandLineToolsExecutor)
+		readonly cluster: KubernetesCommandLineToolsExecutor
+	) {
+		super(shellExecutor);
+	}
+
+	ls(path: string = ''): ShellString {
+		return this.shellExecutor.executeCommand('ls ' + path);
+	}
+
+	pwd(): ShellString {
+		return this.shellExecutor.executeCommand('pwd');
+	}
+
+	cd(path: string): ShellString {
+		return this.shellExecutor.executeCommand('cd ' + path);
+	}
+
+	gitClone(repository: string): ShellString {
+		return this.shellExecutor.executeCommand('git clone ' + repository);
+	}
+
+	removeFolder(path: string): ShellString {
+		return this.shellExecutor.executeCommand('rm -rf ' + path);
+	}
 }