@eclipse-che/che-e2e 7.64.0-dev-db63138 → 7.64.0-dev-f0466d9

package/utils/Logger.ts

@@ -17,7 +17,7 @@ export abstract class Logger {
      * @param text log text
      * @param indentLevel log level
      */
-    public static error(text: string, indentLevel: number = 1) {
+    public static error(text: string, indentLevel: number = 1): void {
         this.logText(indentLevel, `[ERROR] ${text}`);
     }
 
@@ -26,7 +26,7 @@ export abstract class Logger {
      * @param text log text
      * @param indentLevel log level
      */
-    public static warn(text: string, indentLevel: number = 1) {
+    public static warn(text: string, indentLevel: number = 1): void {
         if (TestConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR') {
             return;
         }
@@ -38,7 +38,7 @@ export abstract class Logger {
      * @param text log text
      * @param indentLevel log level
      */
-    public static info(text: string, indentLevel: number = 3) {
+    public static info(text: string, indentLevel: number = 3): void {
         if (TestConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
             TestConstants.TS_SELENIUM_LOG_LEVEL === 'WARN') {
             return;
@@ -51,7 +51,7 @@ export abstract class Logger {
      * @param text log text
      * @param indentLevel log level
      */
-    public static debug(text: string, indentLevel: number = 5) {
+    public static debug(text: string, indentLevel: number = 5): void {
         if (TestConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
             TestConstants.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
             TestConstants.TS_SELENIUM_LOG_LEVEL === 'INFO') {
@@ -66,7 +66,7 @@ export abstract class Logger {
      * @param text log text
      * @param indentLevel log level
      */
-    public static trace(text: string, indentLevel: number = 6) {
+    public static trace(text: string, indentLevel: number = 6): void {
         if (TestConstants.TS_SELENIUM_LOG_LEVEL === 'ERROR' ||
             TestConstants.TS_SELENIUM_LOG_LEVEL === 'WARN' ||
             TestConstants.TS_SELENIUM_LOG_LEVEL === 'INFO' ||
@@ -76,16 +76,16 @@ export abstract class Logger {
         this.logText(indentLevel, `‣ ${text}`);
     }
 
-    private static logText(messageIndentationLevel: number, text: string) {
+    private static logText(messageIndentationLevel: number, text: string): void {
         // start group for every level
-        for (let i = 0; i < messageIndentationLevel; i++) {
+        for (let i: number = 0; i < messageIndentationLevel; i++) {
             console.group();
         }
         // print the trimmed text
         // if multiline, the message should be properly padded
         console.log(text);
         // end group for every level
-        for (let i = 0; i < messageIndentationLevel; i++) {
+        for (let i: number = 0; i < messageIndentationLevel; i++) {
             console.groupEnd();
         }
     }

package/utils/ScreenCatcher.ts

@@ -14,15 +14,16 @@ import { DriverHelper } from './DriverHelper';
 import { Sanitizer } from './Sanitizer';
 import { error } from 'selenium-webdriver';
 import { TestConstants } from '../constants/TestConstants';
+import { WriteStream } from 'fs';
 
 @injectable()
 export class ScreenCatcher {
     constructor(@inject(CLASSES.DriverHelper) private readonly driverHelper: DriverHelper,
                 @inject(CLASSES.Sanitizer) private readonly sanitizer: Sanitizer) { }
 
-    async catchMethodScreen(methodName: string, methodIndex: number, screenshotIndex: number) {
-        const executionScreenCastDir = `${TestConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencast`;
-        const executionScreenCastErrorsDir = `${TestConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencastErrors`;
+    async catchMethodScreen(methodName: string, methodIndex: number, screenshotIndex: number): Promise<void> {
+        const executionScreenCastDir: string = `${TestConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencast`;
+        const executionScreenCastErrorsDir: string = `${TestConstants.TS_SELENIUM_REPORT_FOLDER}/executionScreencastErrors`;
         const formattedMethodIndex: string = new Intl.NumberFormat('en-us', { minimumIntegerDigits: 3 }).format(methodIndex);
         const formattedScreenshotIndex: string = new Intl.NumberFormat('en-us', { minimumIntegerDigits: 5 }).format(screenshotIndex).replace(/,/g, '');
 
@@ -54,18 +55,18 @@ export class ScreenCatcher {
         }
     }
 
-    async catchScreen(screenshotPath: string) {
+    async catchScreen(screenshotPath: string): Promise<void> {
         const screenshot: string = await this.driverHelper.getDriver().takeScreenshot();
-        const screenshotStream = fs.createWriteStream(screenshotPath);
+        const screenshotStream: WriteStream = fs.createWriteStream(screenshotPath);
         screenshotStream.write(Buffer.from(screenshot, 'base64'));
         screenshotStream.end();
     }
 
-    async writeErrorLog(errorLogPath: string, err: error.IError) {
+    async writeErrorLog(errorLogPath: string, err: error.IError): Promise<void> {
         console.log(`Failed to save screenshot, additional information in the ${errorLogPath}`);
 
         if (err.stack) {
-            const screenshotStream = fs.createWriteStream(errorLogPath);
+            const screenshotStream: WriteStream = fs.createWriteStream(errorLogPath);
             screenshotStream.write(Buffer.from(err.stack, 'utf8'));
             screenshotStream.end();
         }

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

@@ -13,6 +13,7 @@ import { inject, injectable } from 'inversify';
 import { DriverHelper } from '../../DriverHelper';
 import { CLASSES } from '../../../configs/inversify.types';
 import { Logger } from '../../Logger';
+import { IWebDriverCookie } from 'selenium-webdriver';
 
 @injectable()
 export class CheMultiuserAuthorizationHeaderHandler implements IAuthorizationHeaderHandler {
@@ -22,7 +23,7 @@ export class CheMultiuserAuthorizationHeaderHandler implements IAuthorizationHea
 
     async get(): Promise<AxiosRequestConfig> {
         try {
-            let token = await this.driverHelper.getDriver().manage().getCookie('_oauth_proxy');
+            let token: IWebDriverCookie = await this.driverHelper.getDriver().manage().getCookie('_oauth_proxy');
             if (this.authorizationToken !== token.value) {
                 this.authorizationToken = token.value;
             }

package/utils/vsc/GitUtil.ts

@@ -12,9 +12,6 @@ import { injectable } from 'inversify';
 
 @injectable()
 export class GitUtil {
-
-    constructor() { }
-
     /**
      * Method extracts a test repo name from git clone https url;
      * it splits the url into string[] by "/" or ".", deletes empty elements and elements that contains just "git" word, than returns the last one;
@@ -22,7 +19,7 @@ export class GitUtil {
      * @param url git https url (which using for "git clone")
      * @return project name
      */
-    getProjectNameFromGitUrl(url: string) {
+    getProjectNameFromGitUrl(url: string): string {
         return url.split(/[\/.]/).filter((e: string) => e !== '' && e !== 'git').reverse()[0];
     }
 }

package/utils/workspace/ApiUrlResolver.ts

@@ -11,6 +11,7 @@ import { inject, injectable } from 'inversify';
 import { CLASSES } from '../../configs/inversify.types';
 import { Logger } from '../Logger';
 import { CheApiRequestHandler } from '../request-handlers/CheApiRequestHandler';
+import { AxiosResponse } from 'axios';
 
 @injectable()
 export class ApiUrlResolver {
@@ -26,7 +27,7 @@ export class ApiUrlResolver {
     }
 
     public async getWorkspacesApiUrl(): Promise<string> {
-        const namespace = await this.obtainUserNamespace();
+        const namespace: string = await this.obtainUserNamespace();
         return `${ApiUrlResolver.DASHBOARD_API_URL}/${namespace}/devworkspaces`;
     }
 
@@ -34,7 +35,7 @@ export class ApiUrlResolver {
         Logger.debug(`ApiUrlResolver.obtainUserNamespace ${this.userNamespace}`);
         if (this.userNamespace.length === 0) {
             Logger.trace(`ApiUrlResolver.obtainUserNamespace USER_NAMESPACE.length = 0, calling kubernetes API`);
-            const kubernetesResponse = await this.processRequestHandler.get(ApiUrlResolver.KUBERNETES_API_URL);
+            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}`);
             }

package/utils/workspace/TestWorkspaceUtil.ts

@@ -17,7 +17,7 @@ import { error } from 'selenium-webdriver';
 import { CheApiRequestHandler } from '../request-handlers/CheApiRequestHandler';
 import { CLASSES } from '../../configs/inversify.types';
 import { Logger } from '../Logger';
-import axios from 'axios';
+import axios, { AxiosResponse } from 'axios';
 import { ITestWorkspaceUtil } from './ITestWorkspaceUtil';
 import { ApiUrlResolver } from './ApiUrlResolver';
 
@@ -32,13 +32,13 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         @inject(CLASSES.ApiUrlResolver) private readonly apiUrlResolver: ApiUrlResolver
     ) { }
 
-    public async waitWorkspaceStatus(workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus) {
+    public async waitWorkspaceStatus(workspaceName: string, expectedWorkspaceStatus: WorkspaceStatus): Promise<void> {
         Logger.debug('TestWorkspaceUtil.waitWorkspaceStatus');
 
         let workspaceStatus: string = '';
         let expectedStatus: boolean = false;
-        for (let i = 0; i < this.attempts; i++) {
-            const response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName));
+        for (let i: number = 0; i < this.attempts; i++) {
+            const response: AxiosResponse = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName));
 
             if (response.status !== 200) {
                 throw new Error(`Can not get status of a workspace. Code: ${response.status} Data: ${response.data}`);
@@ -55,16 +55,16 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
 
         if (!expectedStatus) {
-            let waitTime = this.attempts * this.polling;
-            throw new error.TimeoutError(`The workspace was not stopped in ${waitTime} ms. Currnet status is: ${workspaceStatus}`);
+            let waitTime: number = this.attempts * this.polling;
+            throw new error.TimeoutError(`The workspace was not stopped in ${waitTime} ms. Current status is: ${workspaceStatus}`);
         }
     }
 
-    public async stopWorkspaceByName(workspaceName: string) {
+    public async stopWorkspaceByName(workspaceName: string): Promise<void> {
         Logger.debug('TestWorkspaceUtil.stopWorkspaceByName');
 
         const stopWorkspaceApiUrl: string = await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName);
-        let stopWorkspaceResponse;
+        let stopWorkspaceResponse: AxiosResponse;
 
         try {
             stopWorkspaceResponse = await this.processRequestHandler.patch(stopWorkspaceApiUrl, [{'op': 'replace', 'path': '/spec/started', 'value': false}]);
@@ -81,11 +81,11 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
     }
 
     // delete a workspace without stopping phase (similar with force deleting)
-    public async deleteWorkspaceByName(workspaceName: string) {
+    public async deleteWorkspaceByName(workspaceName: string): Promise<void> {
         Logger.debug(`TestWorkspaceUtil.deleteWorkspaceByName ${workspaceName}` );
 
         const deleteWorkspaceApiUrl: string = await this.apiUrlResolver.getWorkspaceApiUrl(workspaceName);
-        let deleteWorkspaceResponse;
+        let deleteWorkspaceResponse: AxiosResponse;
         let deleteWorkspaceStatus: boolean = false;
         try {
             deleteWorkspaceResponse = await this.processRequestHandler.delete(deleteWorkspaceApiUrl);
@@ -102,7 +102,7 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
             throw new Error(`Can not delete workspace. Code: ${deleteWorkspaceResponse.status} Data: ${deleteWorkspaceResponse.data}`);
         }
 
-        for (let i = 0; i < this.attempts; i++) {
+        for (let i: number = 0; i < this.attempts; i++) {
             try {
                 deleteWorkspaceResponse = await this.processRequestHandler.get(deleteWorkspaceApiUrl);
             } catch (error) {
@@ -114,13 +114,13 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
         }
 
         if (!deleteWorkspaceStatus) {
-            let waitTime = this.attempts * this.polling;
+            let waitTime: number = this.attempts * this.polling;
             throw new error.TimeoutError(`The workspace was not stopped in ${waitTime} ms.`);
         }
     }
 
     // stop workspace before deleting with checking stopping phase
-    public async stopAndDeleteWorkspaceByName(workspaceName: string) {
+    public async stopAndDeleteWorkspaceByName(workspaceName: string): Promise<void> {
         Logger.debug('TestWorkspaceUtil.stopAndDeleteWorkspaceByName');
 
         await this.stopWorkspaceByName(workspaceName);
@@ -128,21 +128,21 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
     }
 
     // stop all run workspaces in the namespace
-    public async stopAllRunningWorkspaces(namespace: string) {
+    public async stopAllRunningWorkspaces(namespace: string): Promise<void> {
         Logger.debug('TestWorkspaceUtil.stopAllRunProjects');
-        let response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
-        for (let i = 0; i < response.data.items.length; i++) {
+        let response: AxiosResponse = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        for (let i: number = 0; i < response.data.items.length; i++) {
             Logger.info('The project is being stopped: ' +  response.data.items[i].metadata.name);
             await this.stopWorkspaceByName(response.data.items[i].metadata.name);
         }
     }
 
     // stop all run workspaces, check statuses and remove the workspaces
-    public async stopAndDeleteAllRunningWorkspaces(namespace: string) {
+    public async stopAndDeleteAllRunningWorkspaces(namespace: string): Promise<void> {
         Logger.debug('TestWorkspaceUtil.stopAndDeleteAllRunProjects');
-        let response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        let response: AxiosResponse = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
         await this.stopAllRunningWorkspaces(namespace);
-        for (let i = 0; i < response.data.items.length; i++) {
+        for (let i: number = 0; i < response.data.items.length; i++) {
             Logger.info('The project is being deleted: ' +  response.data.items[i].metadata.name);
             await this.deleteWorkspaceByName(response.data.items[i].metadata.name);
         }
@@ -150,11 +150,11 @@ export class TestWorkspaceUtil implements ITestWorkspaceUtil {
 
     // stop all run workspaces without stopping and waiting for of 'Stopped' phase
     // similar with 'force' deleting
-    public async deleteAllWorkspaces(namespace: string) {
+    public async deleteAllWorkspaces(namespace: string): Promise<void> {
         Logger.debug('TestWorkspaceUtil.deleteAllRunProjects');
-        let response = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
+        let response: AxiosResponse = await this.processRequestHandler.get(await this.apiUrlResolver.getWorkspacesApiUrl());
 
-        for (let i = 0; i < response.data.items.length; i++) {
+        for (let i: number = 0; i < response.data.items.length; i++) {
             Logger.info('The project is being deleted .......: ' +  response.data.items[i].metadata.name);
             await this.deleteWorkspaceByName(response.data.items[i].metadata.name);
         }