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

package/utils/request-handlers/CheApiRequestHandler.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -13,100 +13,103 @@ import { TYPES } from '../../configs/inversify.types';
 import { inject, injectable } from 'inversify';
 import { IAuthorizationHeaderHandler } from './headers/IAuthorizationHeaderHandler';
 import { Logger } from '../Logger';
-import { BaseTestConstants } from '../../constants/BaseTestConstants';
+import { BASE_TEST_CONSTANTS } from '../../constants/BASE_TEST_CONSTANTS';
 
 @injectable()
 export class CheApiRequestHandler {
+	constructor(
+		@inject(TYPES.IAuthorizationHeaderHandler)
+		private readonly headerHandler: IAuthorizationHeaderHandler
+	) {}
 
-  /**
-   * This method adds a request interceptor into axios request interceptors list and returns an ID of the interceptor
-   */
-  static enableRequestInterceptor(): number {
-    Logger.debug();
-    return axios.interceptors.request.use(request => {
-      try {
-        let request_censored: AxiosRequestConfig = JSON.parse(JSON.stringify(request));
-        if (request_censored === undefined) {
-          Logger.error('JSON.parse returned an undefined object, cannot process request');
-          return request;
-        }
-        if (request_censored.headers === undefined) {
-          Logger.warn('request does not contain any headers object');
-          return request;
-        }
-        request_censored.headers.Authorization = 'CENSORED';
-        request_censored.headers.Cookie = 'CENSORED';
-        Logger.info(`request:\n` + request_censored);
-      } catch (err) {
-        Logger.error(`request: Failed to deep clone AxiosRequestConfig:` + err);
-      }
-      return request;
-    });
-  }
+	/**
+	 * this method adds a request interceptor into axios request interceptors list and returns an ID of the interceptor
+	 */
+	static enableRequestInterceptor(): number {
+		Logger.debug();
+		return axios.interceptors.request.use((request: AxiosRequestConfig): AxiosRequestConfig => {
+			try {
+				const REQUEST_CENSORED: AxiosRequestConfig = JSON.parse(JSON.stringify(request));
+				if (REQUEST_CENSORED === undefined) {
+					Logger.error('JSON.parse returned an undefined object, cannot process request');
+					return request;
+				}
+				if (REQUEST_CENSORED.headers === undefined) {
+					Logger.warn('request does not contain any headers object');
+					return request;
+				}
+				REQUEST_CENSORED.headers.Authorization = 'CENSORED';
+				REQUEST_CENSORED.headers.Cookie = 'CENSORED';
+				Logger.info('request:\n' + JSON.stringify(REQUEST_CENSORED));
+			} catch (err) {
+				Logger.error('request: Failed to deep clone AxiosRequestConfig:' + err);
+			}
+			return request;
+		});
+	}
 
-  /**
-   * This method adds a response interceptor into axios response interceptors list and returns an ID of the interceptor
-   */
-  static enableResponseInterceptor(): number {
-    Logger.debug();
-    return axios.interceptors.response.use(response => {
-      try {
-        let response_censored: AxiosResponse = JSON.parse(JSON.stringify(response, (key, value) => {
-          switch (key) {
-            case 'request':
-              return 'CENSORED';
-            default:
-              return value;
-          }
-        }));
-        if (response_censored === undefined) {
-          Logger.error('JSON.parse returned an undefined object, cannot process response');
-          return response;
-        }
-        if (response_censored.config === undefined) {
-          Logger.warn('response does not contain any config object');
-          return response;
-        }
-        if (response_censored.config.headers === undefined) {
-          Logger.warn('response does not contain any config.headers object');
-          return response;
-        }
-        response_censored.config.headers.Authorization = 'CENSORED';
-        response_censored.config.headers.Cookie = 'CENSORED';
-        if (response_censored.data.access_token !== null) {
-          response_censored.data.access_token = 'CENSORED';
-        }
-        if (response_censored.data.refresh_token !== null) {
-          response_censored.data.refresh_token = 'CENSORED';
-        }
-        Logger.info(`response:\n` + response_censored);
-      } catch (err) {
-        Logger.error(`response: Failed to deep clone AxiosResponse:` + err);
-      }
-      return response;
-    });
-  }
+	/**
+	 * this method adds a response interceptor into axios response interceptors list and returns an ID of the interceptor
+	 */
+	static enableResponseInterceptor(): number {
+		Logger.debug();
+		return axios.interceptors.response.use((response: AxiosResponse): AxiosResponse => {
+			try {
+				const RESPONSE_CENSORED: AxiosResponse = JSON.parse(
+					JSON.stringify(response, (key, value: string): string => {
+						switch (key) {
+							case 'request':
+								return 'CENSORED';
+							default:
+								return value;
+						}
+					})
+				);
+				if (RESPONSE_CENSORED === undefined) {
+					Logger.error('JSON.parse returned an undefined object, cannot process response');
+					return response;
+				}
+				if (RESPONSE_CENSORED.config === undefined) {
+					Logger.warn('response does not contain any config object');
+					return response;
+				}
+				if (RESPONSE_CENSORED.config.headers === undefined) {
+					Logger.warn('response does not contain any config.headers object');
+					return response;
+				}
+				RESPONSE_CENSORED.config.headers.Authorization = 'CENSORED';
+				RESPONSE_CENSORED.config.headers.Cookie = 'CENSORED';
+				if (RESPONSE_CENSORED.data.access_token !== null) {
+					RESPONSE_CENSORED.data.access_token = 'CENSORED';
+				}
+				if (RESPONSE_CENSORED.data.refresh_token !== null) {
+					RESPONSE_CENSORED.data.refresh_token = 'CENSORED';
+				}
+				Logger.info('response:\n' + JSON.stringify(RESPONSE_CENSORED));
+			} catch (err) {
+				Logger.error('response: Failed to deep clone AxiosResponse:' + err);
+			}
+			return response;
+		});
+	}
 
-  constructor(@inject(TYPES.IAuthorizationHeaderHandler) private readonly headerHandler: IAuthorizationHeaderHandler) { }
+	async get(relativeUrl: string): Promise<AxiosResponse> {
+		return await axios.get(this.assembleUrl(relativeUrl), await this.headerHandler.get());
+	}
 
-  async get(relativeUrl: string): Promise<AxiosResponse> {
-    return await axios.get(this.assembleUrl(relativeUrl), await this.headerHandler.get());
-  }
+	async post(relativeUrl: string, data?: string): Promise<AxiosResponse> {
+		return await axios.post(this.assembleUrl(relativeUrl), data, await this.headerHandler.get());
+	}
 
-  async post(relativeUrl: string, data?: string | any): Promise<AxiosResponse> {
-    return await axios.post(this.assembleUrl(relativeUrl), data, await this.headerHandler.get());
-  }
+	async delete(relativeUrl: string): Promise<AxiosResponse> {
+		return await axios.delete(this.assembleUrl(relativeUrl), await this.headerHandler.get());
+	}
 
-  async delete(relativeUrl: string): Promise<AxiosResponse> {
-    return await axios.delete(this.assembleUrl(relativeUrl), await this.headerHandler.get());
-  }
-
-  async patch(relativeUrl: string, patchParams: object): Promise<AxiosResponse> {
-    return await axios.patch(this.assembleUrl(relativeUrl), patchParams, await this.headerHandler.get());
-  }
-
-  private assembleUrl(relativeUrl: string): string {
-    return `${BaseTestConstants.TS_SELENIUM_BASE_URL}/${relativeUrl}`;
-  }
+	async patch(relativeUrl: string, patchParams: object): Promise<AxiosResponse> {
+		return await axios.patch(this.assembleUrl(relativeUrl), patchParams, await this.headerHandler.get());
+	}
 
+	private assembleUrl(relativeUrl: string): string {
+		return `${BASE_TEST_CONSTANTS.TS_SELENIUM_BASE_URL}/${relativeUrl}`;
+	}
 }

package/utils/request-handlers/headers/CheMultiuserAuthorizationHeaderHandler.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -14,29 +14,40 @@ import { DriverHelper } from '../../DriverHelper';
 import { CLASSES } from '../../../configs/inversify.types';
 import { Logger } from '../../Logger';
 import { IWebDriverCookie } from 'selenium-webdriver';
-import { BaseTestConstants, Platform } from '../../../constants/BaseTestConstants';
+import { BASE_TEST_CONSTANTS, Platform } from '../../../constants/BASE_TEST_CONSTANTS';
 
 @injectable()
 export class CheMultiuserAuthorizationHeaderHandler implements IAuthorizationHeaderHandler {
-  private authorizationToken: string = '';
-  private readonly cookiesType: string = BaseTestConstants.TS_PLATFORM === Platform.OPENSHIFT ? '_oauth_proxy' : '_oauth2_proxy';
+	private authorizationToken: string = '';
+	private readonly cookiesType: string = BASE_TEST_CONSTANTS.TS_PLATFORM === Platform.OPENSHIFT ? '_oauth_proxy' : '_oauth2_proxy';
 
-  constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper) { }
+	constructor(
+		@inject(CLASSES.DriverHelper)
+		private readonly driverHelper: DriverHelper
+	) {}
 
-  async get(): Promise<AxiosRequestConfig> {
-    try {
-      let token: IWebDriverCookie = await this.driverHelper.getDriver().manage().getCookie(this.cookiesType);
-      if (this.authorizationToken !== token.value) {
-        this.authorizationToken = token.value;
-      }
-    } catch (err) {
-      if (this.authorizationToken.length > 0) {
-        Logger.warn(`could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. Using stored value.`);
-      } else {
-        throw new Error(`Could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. No stored token present!`);
-      }
-    }
+	async get(): Promise<AxiosRequestConfig> {
+		try {
+			const token: IWebDriverCookie = await this.driverHelper.getDriver().manage().getCookie(this.cookiesType);
+			if (this.authorizationToken !== token.value) {
+				this.authorizationToken = token.value;
+			}
+		} catch (err) {
+			if (this.authorizationToken.length > 0) {
+				Logger.warn(
+					'could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. Using stored value.'
+				);
+			} else {
+				throw new Error(
+					'Could not obtain _oauth_proxy cookie from chromedriver, browser session may have been killed. No stored token present!'
+				);
+			}
+		}
 
-    return { headers: { 'cookie': `${this.cookiesType}=${this.authorizationToken}` } };
-  }
+		return {
+			headers: {
+				cookie: `${this.cookiesType}=${this.authorizationToken}`
+			}
+		};
+	}
 }

package/utils/request-handlers/headers/IAuthorizationHeaderHandler.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -11,5 +11,5 @@
 import { AxiosRequestConfig } from 'axios';
 
 export interface IAuthorizationHeaderHandler {
-  get(): Promise<AxiosRequestConfig>;
+	get(): Promise<AxiosRequestConfig>;
 }

package/utils/workspace/ApiUrlResolver.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -15,33 +15,38 @@ import { AxiosResponse } from 'axios';
 
 @injectable()
 export class ApiUrlResolver {
-  private static readonly DASHBOARD_API_URL: string = 'dashboard/api/namespace';
-  private static readonly KUBERNETES_API_URL: string = 'api/kubernetes/namespace';
+	private static readonly DASHBOARD_API_URL: string = 'dashboard/api/namespace';
+	private static readonly KUBERNETES_API_URL: string = 'api/kubernetes/namespace';
 
-  private userNamespace: string = '';
+	private userNamespace: string = '';
 
-  constructor(@inject(CLASSES.CheApiRequestHandler) private readonly processRequestHandler: CheApiRequestHandler) {}
+	constructor(
+		@inject(CLASSES.CheApiRequestHandler)
+		private readonly processRequestHandler: CheApiRequestHandler
+	) {}
 
-  async getWorkspaceApiUrl(workspaceName: string): Promise<string> {
-    return `${await this.getWorkspacesApiUrl()}/${workspaceName}`;
-  }
+	async getWorkspaceApiUrl(workspaceName: string): Promise<string> {
+		return `${await this.getWorkspacesApiUrl()}/${workspaceName}`;
+	}
 
-  async getWorkspacesApiUrl(): Promise<string> {
-    const namespace: string = await this.obtainUserNamespace();
-    return `${ApiUrlResolver.DASHBOARD_API_URL}/${namespace}/devworkspaces`;
-  }
+	async getWorkspacesApiUrl(): Promise<string> {
+		const namespace: string = await this.obtainUserNamespace();
+		return `${ApiUrlResolver.DASHBOARD_API_URL}/${namespace}/devworkspaces`;
+	}
 
-  private async obtainUserNamespace(): Promise<string> {
-    Logger.debug(`${this.userNamespace}`);
-    if (this.userNamespace.length === 0) {
-      Logger.trace(`USER_NAMESPACE.length = 0, calling kubernetes API`);
-      const kubernetesResponse: AxiosResponse = await this.processRequestHandler.get(ApiUrlResolver.KUBERNETES_API_URL);
-      if (kubernetesResponse.status !== 200) {
-        throw new Error(`Cannot get user namespace from kubernetes API. Code: ${kubernetesResponse.status} Data: ${kubernetesResponse.data}`);
-      }
-      this.userNamespace = kubernetesResponse.data[0].name;
-      Logger.debug(`kubeapi success: ${this.userNamespace}`);
-    }
-    return this.userNamespace;
-  }
+	private async obtainUserNamespace(): Promise<string> {
+		Logger.debug(`${this.userNamespace}`);
+		if (this.userNamespace.length === 0) {
+			Logger.trace('USER_NAMESPACE.length = 0, calling kubernetes API');
+			const kubernetesResponse: AxiosResponse = await this.processRequestHandler.get(ApiUrlResolver.KUBERNETES_API_URL);
+			if (kubernetesResponse.status !== 200) {
+				throw new Error(
+					`Cannot get user namespace from kubernetes API. Code: ${kubernetesResponse.status} Data: ${kubernetesResponse.data}`
+				);
+			}
+			this.userNamespace = kubernetesResponse.data[0].name;
+			Logger.debug(`kubeapi success: ${this.userNamespace}`);
+		}
+		return this.userNamespace;
+	}
 }

package/utils/workspace/ITestWorkspaceUtil.ts

@@ -1,5 +1,5 @@
-/*********************************************************************
- * Copyright (c) 2019-2023 Red Hat, Inc.
+/** *******************************************************************
+ * copyright (c) 2019-2023 Red Hat, Inc.
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -11,33 +11,33 @@
 import { WorkspaceStatus } from './WorkspaceStatus';
 
 export interface ITestWorkspaceUtil {
-  waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus): void;
-
-  stopWorkspaceByName(workspaceName: string): void;
-
-  /**
-   * Delete a workspace without stopping phase (similar with force deleting)
-   */
-  deleteWorkspaceByName(workspaceName: string): void;
-
-  /**
-   * Stop workspace before deleting with checking stopping phase
-   */
-  stopAndDeleteWorkspaceByName(workspaceName: string): void;
-
-  /**
-   * Stop all run workspaces in the namespace
-   */
-  stopAllRunningWorkspaces(namespace: string): void;
-
-  /**
-   * Stop all run workspaces, check statused and remove the workspaces
-   */
-  stopAndDeleteAllRunningWorkspaces(namespace: string): void;
-
-  /**
-   * Stop all run workspaces without stopping and waiting for of 'Stopped' phase
-   * Similar with 'force' deleting
-   */
-  deleteAllWorkspaces(namespace: string): void;
+	waitWorkspaceStatus(namespace: string, workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus): void;
+
+	stopWorkspaceByName(workspaceName: string): void;
+
+	/**
+	 * delete a workspace without stopping phase (similar with force deleting)
+	 */
+	deleteWorkspaceByName(workspaceName: string): void;
+
+	/**
+	 * stop workspace before deleting with checking stopping phase
+	 */
+	stopAndDeleteWorkspaceByName(workspaceName: string): void;
+
+	/**
+	 * stop all run workspaces in the namespace
+	 */
+	stopAllRunningWorkspaces(namespace: string): void;
+
+	/**
+	 * stop all run workspaces, check statused and remove the workspaces
+	 */
+	stopAndDeleteAllRunningWorkspaces(namespace: string): void;
+
+	/**
+	 * stop all run workspaces without stopping and waiting for of 'Stopped' phase
+	 * Similar with 'force' deleting
+	 */
+	deleteAllWorkspaces(namespace: string): void;
 }