@auxcode/auxta 1.3.19-beta.8 → 1.3.19

package/README.md

@@ -1,6 +1,6 @@
 # AuxTA
 
-## Implement
+## Implementing
 
 The main thing is a `scenario`.
 
@@ -10,7 +10,7 @@ The main thing is a `scenario`.
 
 All clicks wait for the selector by default and timeout w/ the standard timeout unless different is specified.
 
-`timeout` It is recommended to have a standard timeout for the whole scenario and not to define spefici. `TODO` 
+`timeout` It is recommended to have a standard timeout for the whole scenario and not to define spefici. `TODO`
 
 auxta.clickByText `TO BE FIXED BY GEORGE TO ADD THE WAIT FOR SELECTOR WHICH IS MISSING`
 
@@ -20,7 +20,27 @@ auxta.clickByClass
 
 auxta.click() `THINK TO MAKE` `TODO`
 
-waitforseelctorbytext `depreciated` 
+waitforseelctorbytext `depreciated`
+
+### Complex Workflows
+
+#### Email
+
+* (AuxTA) We do some action on the website.
+* (Website) Sends an email to the email address of the user who did the action.
+* (AuxTA) Should check that that the email was correctly sent. So we check:
+  * `auxta.checkMail(_from_name_, _from_email_, _subject_, _body_text_)`
+    * The email login is in the main config of the test suite.
+      * email
+      * API TOKEN
+    * For the moment we do it synchroneous (AuxTA waits for the email).
+    * The email must be newser than the time of the action on the Website.
+    * Must be _from_name_ (substring)
+    * Must be _from_email_ (substring)
+    * Must have _subject_ (substring)
+    * Must cotnain _body_text_ (substring)
+    * Quality of Service, if the email does not arrive w/in eg. 5 minutes we return an error w/ timeout.
+* * `auxta.clickInMail(_from_name_, _from_email_, _subject_, _click_on_)`
 
 ## Running
 

package/build/cjs/AuxTA.d.ts

@@ -2,10 +2,11 @@ import { Puppeteer } from "./puppeteer/puppeteer";
 import { FunctionHelper } from "./macros/helpers/code.helper";
 import StatusOfStep from "./auxta/enums/status-of.step";
 import { UploadModel } from "./auxta/models/upload.model";
+import { AuxGoogleAuth } from "./macros/helpers/AuxGoogleAuth";
 declare class AuxTA extends FunctionHelper {
     puppeteer: Puppeteer;
     aux2fa: import("./macros/helpers/Aux2faAuth").Aux2faAuth;
-    googleAuth: import("./macros/helpers/GoogleAuthHelper").GoogleAuthHelper;
+    google: typeof AuxGoogleAuth;
     config: {
         auxtaURL: string;
         baseURL: string;
@@ -18,6 +19,7 @@ declare class AuxTA extends FunctionHelper {
         screenHeight: number;
         timeout: number;
         suitesList: never[];
+        googleEmail: string;
         auxtaCredentials: {
             email: string;
             password: string;

package/build/cjs/AuxTA.js

@@ -47,14 +47,14 @@ const config_1 = require("./auxta/configs/config");
 const start_suite_helper_1 = require("./auxta/utilities/start-suite.helper");
 const report_service_1 = require("./auxta/services/report.service");
 const Aux2faAuth_1 = __importDefault(require("./macros/helpers/Aux2faAuth"));
-const GoogleAuthHelper_1 = __importDefault(require("./macros/helpers/GoogleAuthHelper"));
+const AuxGoogleAuth_1 = require("./macros/helpers/AuxGoogleAuth");
 dotenv.config();
 class AuxTA extends code_helper_1.FunctionHelper {
     constructor() {
         super();
         this.puppeteer = puppeteer_1.default;
         this.aux2fa = Aux2faAuth_1.default;
-        this.googleAuth = GoogleAuthHelper_1.default;
+        this.google = AuxGoogleAuth_1.AuxGoogleAuth;
         this.config = config_1.config;
         let file;
         if (!process.env.RPA) {

package/build/cjs/auxta/configs/config.d.ts

@@ -10,6 +10,7 @@ export declare function setupConfig(jsonConfig: any): {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;
@@ -27,6 +28,7 @@ export declare function setupOverrideConfig(overrideConfig: any): {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;
@@ -44,6 +46,7 @@ export declare let config: {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;

package/build/cjs/auxta/configs/config.js

@@ -23,6 +23,7 @@ function setupConfig(jsonConfig) {
     if (!jsonConfig.suitesList)
         throw new Error("suitesList");
     exports.config.suitesList = jsonConfig.suitesList;
+    exports.config.googleEmail = jsonConfig.googleEmail;
     if (jsonConfig.timeout)
         exports.config.timeout = jsonConfig.timeout;
     if (jsonConfig.screenWidth)
@@ -56,6 +57,7 @@ exports.config = {
     screenHeight: 1080,
     timeout: 60000,
     suitesList: [],
+    googleEmail: "",
     auxtaCredentials: {
         email: "",
         password: "",

package/build/cjs/macros/helpers/AuxGoogleAuth.d.ts

@@ -0,0 +1,13 @@
+import googleType = require("googleapis");
+export declare class AuxGoogleAuth {
+    private static _oAuth2Client;
+    private static credentialsJson;
+    static get oAuth2Client(): googleType.Auth.OAuth2Client;
+    static get googleClient(): googleType.GoogleApis;
+    static get gmailClient(): googleType.gmail_v1.Gmail;
+    static setup(): Promise<void>;
+    private static authorize;
+    private static getNewToken;
+}
+declare const _default: AuxGoogleAuth;
+export default _default;

package/build/cjs/macros/helpers/{GoogleAuthHelper.js → AuxGoogleAuth.js}

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GoogleAuthHelper = void 0;
+exports.AuxGoogleAuth = void 0;
 const fs = require('fs');
 const readline = require('readline');
 const { google } = require("googleapis");
@@ -24,39 +24,25 @@ const SCOPES = [
     'https://www.googleapis.com/auth/gmail.modify',
     'https://www.googleapis.com/auth/gmail.compose',
     'https://www.googleapis.com/auth/gmail.readonly',
-    'https://www.googleapis.com/auth/gmail.metadata',
     'https://www.googleapis.com/auth/gmail.insert',
 ];
 const TOKEN_PATH = 'token.json';
-class GoogleAuthHelper {
-    constructor() {
-        this.credentialsJson = {
-            "installed": {
-                "client_id": "120362272213-usevfijf76jj5nsr502i2lai6nu71oq8.apps.googleusercontent.com",
-                "project_id": "auxta-library",
-                "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-                "token_uri": "https://oauth2.googleapis.com/token",
-                "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-                "client_secret": "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",
-                "redirect_uris": ["https://auxcode.com"]
-            }
-        };
-    }
-    get oAuth2Client() {
+class AuxGoogleAuth {
+    static get oAuth2Client() {
         return this._oAuth2Client;
     }
-    get googleClient() {
+    static get googleClient() {
         return google;
     }
-    get gmailClient() {
+    static get gmailClient() {
         return google.gmail({ version: 'v1', auth: this._oAuth2Client });
     }
-    setup() {
+    static setup() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.authorize(this.credentialsJson);
         });
     }
-    authorize(credentials) {
+    static authorize(credentials) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client_secret, client_id, redirect_uris } = credentials.installed;
             const oAuth2Client = new google.auth.OAuth2(client_id, client_secret, redirect_uris[0]);
@@ -74,7 +60,7 @@ class GoogleAuthHelper {
             }
         });
     }
-    getNewToken(oAuth2Client) {
+    static getNewToken(oAuth2Client) {
         return __awaiter(this, void 0, void 0, function* () {
             const authUrl = oAuth2Client.generateAuthUrl({
                 access_type: 'offline',
@@ -103,5 +89,16 @@ class GoogleAuthHelper {
         });
     }
 }
-exports.GoogleAuthHelper = GoogleAuthHelper;
-exports.default = new GoogleAuthHelper();
+exports.AuxGoogleAuth = AuxGoogleAuth;
+AuxGoogleAuth.credentialsJson = {
+    "installed": {
+        "client_id": "120362272213-usevfijf76jj5nsr502i2lai6nu71oq8.apps.googleusercontent.com",
+        "project_id": "auxta-library",
+        "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+        "token_uri": "https://oauth2.googleapis.com/token",
+        "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+        "client_secret": "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",
+        "redirect_uris": ["https://auxcode.com"]
+    }
+};
+exports.default = new AuxGoogleAuth();

package/build/cjs/macros/helpers/code.helper.d.ts

@@ -16,6 +16,8 @@ export declare class FunctionHelper extends ExtendDefaultPage {
     clickAndWaitForPageToBeCreated(selector: string, page?: import("puppeteer").Page): Promise<void>;
     closeLastPage(page?: import("puppeteer").Page): Promise<void>;
     microsoftLogin(button: string, email: string, password: string): Promise<void>;
+    clickInMail(from_name: string, from_email: string, subject: string): Promise<boolean>;
+    private getHeader;
 }
 declare const _default: FunctionHelper;
 export default _default;

package/build/cjs/macros/helpers/code.helper.js

@@ -19,6 +19,8 @@ const status_of_step_1 = require("../../auxta/enums/status-of.step");
 const AuxTA_1 = require("../../AuxTA");
 const extend_default_page_1 = require("./extend-default-page");
 const puppeteer_2 = require("puppeteer");
+const AuxGoogleAuth_1 = require("./AuxGoogleAuth");
+const config_1 = require("../../auxta/configs/config");
 class FunctionHelper extends extend_default_page_1.ExtendDefaultPage {
     log(keyword, name, status) {
         log_service_1.default.push(keyword, name, status);
@@ -187,6 +189,48 @@ class FunctionHelper extends extend_default_page_1.ExtendDefaultPage {
             yield loginPage.waitForNetworkIdle();
         });
     }
+    clickInMail(from_name, from_email, subject) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield AuxGoogleAuth_1.AuxGoogleAuth.setup();
+            const res = yield AuxGoogleAuth_1.AuxGoogleAuth.gmailClient.users.messages.list({
+                userId: config_1.config.googleEmail,
+                maxResults: 3
+            });
+            const messagesIds = res.data.messages;
+            if (!messagesIds || messagesIds.length === 0) {
+                throw new Error('No messagesIds found.');
+            }
+            let timeoutCount = 12000;
+            yield this.timeout(12000);
+            while (timeoutCount <= 60000) {
+                for (const messageId of messagesIds) {
+                    if (messageId.id) {
+                        const message = yield AuxGoogleAuth_1.AuxGoogleAuth.gmailClient.users.messages.get({ userId: config_1.config.googleEmail, id: messageId.id.toString(), format: 'FULL' });
+                        if (message.data.payload) {
+                            const message_sender = this.getHeader('from', message.data.payload.headers);
+                            const message_subject = this.getHeader('subject', message.data.payload.headers);
+                            if (message_sender.includes(from_email) && message_sender.includes(from_name.toLocaleLowerCase()) && message_subject.includes(subject.toLocaleLowerCase())) {
+                                yield this.log('Then', `Email from: ${from_name} ${from_email} with subject: ${subject} is found`, AuxTA_1.StepStatus.PASSED);
+                                return true;
+                            }
+                        }
+                        break;
+                    }
+                }
+                yield this.timeout(12000);
+                timeoutCount += 12000;
+            }
+            yield this.log('Then', `Email from: ${from_name} ${from_email} with subject: ${subject} is found`, AuxTA_1.StepStatus.PASSED);
+            throw new Error(`Email from: ${from_name} ${from_email} with subject: ${subject} is found`);
+        });
+    }
+    getHeader(value, headers) {
+        for (const header of headers) {
+            if (header.name.toLocaleLowerCase() === value.toLocaleLowerCase()) {
+                return header.value.toLocaleLowerCase();
+            }
+        }
+    }
 }
 exports.FunctionHelper = FunctionHelper;
 exports.default = new FunctionHelper();

package/build/esm/AuxTA.d.ts

@@ -2,10 +2,11 @@ import { Puppeteer } from "./puppeteer/puppeteer";
 import { FunctionHelper } from "./macros/helpers/code.helper";
 import StatusOfStep from "./auxta/enums/status-of.step";
 import { UploadModel } from "./auxta/models/upload.model";
+import { AuxGoogleAuth } from "./macros/helpers/AuxGoogleAuth";
 declare class AuxTA extends FunctionHelper {
     puppeteer: Puppeteer;
     aux2fa: import("./macros/helpers/Aux2faAuth").Aux2faAuth;
-    googleAuth: import("./macros/helpers/GoogleAuthHelper").GoogleAuthHelper;
+    google: typeof AuxGoogleAuth;
     config: {
         auxtaURL: string;
         baseURL: string;
@@ -18,6 +19,7 @@ declare class AuxTA extends FunctionHelper {
         screenHeight: number;
         timeout: number;
         suitesList: never[];
+        googleEmail: string;
         auxtaCredentials: {
             email: string;
             password: string;

package/build/esm/AuxTA.js

@@ -18,14 +18,14 @@ import { setupConfig, config as c, setupOverrideConfig } from "./auxta/configs/c
 import { startSuite } from "./auxta/utilities/start-suite.helper";
 import { createEmptyReport } from "./auxta/services/report.service";
 import Aux2faAuth from "./macros/helpers/Aux2faAuth";
-import GoogleAuthHelper from "./macros/helpers/GoogleAuthHelper";
+import { AuxGoogleAuth } from "./macros/helpers/AuxGoogleAuth";
 dotenv.config();
 class AuxTA extends FunctionHelper {
     constructor() {
         super();
         this.puppeteer = puppeteer;
         this.aux2fa = Aux2faAuth;
-        this.googleAuth = GoogleAuthHelper;
+        this.google = AuxGoogleAuth;
         this.config = c;
         let file;
         if (!process.env.RPA) {

package/build/esm/auxta/configs/config.d.ts

@@ -10,6 +10,7 @@ export declare function setupConfig(jsonConfig: any): {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;
@@ -27,6 +28,7 @@ export declare function setupOverrideConfig(overrideConfig: any): {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;
@@ -44,6 +46,7 @@ export declare let config: {
     screenHeight: number;
     timeout: number;
     suitesList: never[];
+    googleEmail: string;
     auxtaCredentials: {
         email: string;
         password: string;

package/build/esm/auxta/configs/config.js

@@ -20,6 +20,7 @@ export function setupConfig(jsonConfig) {
     if (!jsonConfig.suitesList)
         throw new Error("suitesList");
     config.suitesList = jsonConfig.suitesList;
+    config.googleEmail = jsonConfig.googleEmail;
     if (jsonConfig.timeout)
         config.timeout = jsonConfig.timeout;
     if (jsonConfig.screenWidth)
@@ -51,6 +52,7 @@ export let config = {
     screenHeight: 1080,
     timeout: 60000,
     suitesList: [],
+    googleEmail: "",
     auxtaCredentials: {
         email: "",
         password: "",

package/build/esm/macros/helpers/AuxGoogleAuth.d.ts

@@ -0,0 +1,13 @@
+import googleType = require("googleapis");
+export declare class AuxGoogleAuth {
+    private static _oAuth2Client;
+    private static credentialsJson;
+    static get oAuth2Client(): googleType.Auth.OAuth2Client;
+    static get googleClient(): googleType.GoogleApis;
+    static get gmailClient(): googleType.gmail_v1.Gmail;
+    static setup(): Promise<void>;
+    private static authorize;
+    private static getNewToken;
+}
+declare const _default: AuxGoogleAuth;
+export default _default;

package/build/esm/macros/helpers/{GoogleAuthHelper.js → AuxGoogleAuth.js}

@@ -21,39 +21,25 @@ const SCOPES = [
     'https://www.googleapis.com/auth/gmail.modify',
     'https://www.googleapis.com/auth/gmail.compose',
     'https://www.googleapis.com/auth/gmail.readonly',
-    'https://www.googleapis.com/auth/gmail.metadata',
     'https://www.googleapis.com/auth/gmail.insert',
 ];
 const TOKEN_PATH = 'token.json';
-export class GoogleAuthHelper {
-    constructor() {
-        this.credentialsJson = {
-            "installed": {
-                "client_id": "120362272213-usevfijf76jj5nsr502i2lai6nu71oq8.apps.googleusercontent.com",
-                "project_id": "auxta-library",
-                "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-                "token_uri": "https://oauth2.googleapis.com/token",
-                "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-                "client_secret": "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",
-                "redirect_uris": ["https://auxcode.com"]
-            }
-        };
-    }
-    get oAuth2Client() {
+export class AuxGoogleAuth {
+    static get oAuth2Client() {
         return this._oAuth2Client;
     }
-    get googleClient() {
+    static get googleClient() {
         return google;
     }
-    get gmailClient() {
+    static get gmailClient() {
         return google.gmail({ version: 'v1', auth: this._oAuth2Client });
     }
-    setup() {
+    static setup() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.authorize(this.credentialsJson);
         });
     }
-    authorize(credentials) {
+    static authorize(credentials) {
         return __awaiter(this, void 0, void 0, function* () {
             const { client_secret, client_id, redirect_uris } = credentials.installed;
             const oAuth2Client = new google.auth.OAuth2(client_id, client_secret, redirect_uris[0]);
@@ -71,7 +57,7 @@ export class GoogleAuthHelper {
             }
         });
     }
-    getNewToken(oAuth2Client) {
+    static getNewToken(oAuth2Client) {
         return __awaiter(this, void 0, void 0, function* () {
             const authUrl = oAuth2Client.generateAuthUrl({
                 access_type: 'offline',
@@ -100,4 +86,15 @@ export class GoogleAuthHelper {
         });
     }
 }
-export default new GoogleAuthHelper();
+AuxGoogleAuth.credentialsJson = {
+    "installed": {
+        "client_id": "120362272213-usevfijf76jj5nsr502i2lai6nu71oq8.apps.googleusercontent.com",
+        "project_id": "auxta-library",
+        "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+        "token_uri": "https://oauth2.googleapis.com/token",
+        "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+        "client_secret": "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",
+        "redirect_uris": ["https://auxcode.com"]
+    }
+};
+export default new AuxGoogleAuth();

package/build/esm/macros/helpers/code.helper.d.ts

@@ -16,6 +16,8 @@ export declare class FunctionHelper extends ExtendDefaultPage {
     clickAndWaitForPageToBeCreated(selector: string, page?: import("puppeteer").Page): Promise<void>;
     closeLastPage(page?: import("puppeteer").Page): Promise<void>;
     microsoftLogin(button: string, email: string, password: string): Promise<void>;
+    clickInMail(from_name: string, from_email: string, subject: string): Promise<boolean>;
+    private getHeader;
 }
 declare const _default: FunctionHelper;
 export default _default;

package/build/esm/macros/helpers/code.helper.js

@@ -13,6 +13,8 @@ import { StatusOfStep } from "../../auxta/enums/status-of.step";
 import { StepStatus } from "../../AuxTA";
 import { ExtendDefaultPage } from "./extend-default-page";
 import { KnownDevices } from "puppeteer";
+import { AuxGoogleAuth } from "./AuxGoogleAuth";
+import { config } from "../../auxta/configs/config";
 export class FunctionHelper extends ExtendDefaultPage {
     log(keyword, name, status) {
         log.push(keyword, name, status);
@@ -181,5 +183,47 @@ export class FunctionHelper extends ExtendDefaultPage {
             yield loginPage.waitForNetworkIdle();
         });
     }
+    clickInMail(from_name, from_email, subject) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield AuxGoogleAuth.setup();
+            const res = yield AuxGoogleAuth.gmailClient.users.messages.list({
+                userId: config.googleEmail,
+                maxResults: 3
+            });
+            const messagesIds = res.data.messages;
+            if (!messagesIds || messagesIds.length === 0) {
+                throw new Error('No messagesIds found.');
+            }
+            let timeoutCount = 12000;
+            yield this.timeout(12000);
+            while (timeoutCount <= 60000) {
+                for (const messageId of messagesIds) {
+                    if (messageId.id) {
+                        const message = yield AuxGoogleAuth.gmailClient.users.messages.get({ userId: config.googleEmail, id: messageId.id.toString(), format: 'FULL' });
+                        if (message.data.payload) {
+                            const message_sender = this.getHeader('from', message.data.payload.headers);
+                            const message_subject = this.getHeader('subject', message.data.payload.headers);
+                            if (message_sender.includes(from_email) && message_sender.includes(from_name.toLocaleLowerCase()) && message_subject.includes(subject.toLocaleLowerCase())) {
+                                yield this.log('Then', `Email from: ${from_name} ${from_email} with subject: ${subject} is found`, StepStatus.PASSED);
+                                return true;
+                            }
+                        }
+                        break;
+                    }
+                }
+                yield this.timeout(12000);
+                timeoutCount += 12000;
+            }
+            yield this.log('Then', `Email from: ${from_name} ${from_email} with subject: ${subject} is found`, StepStatus.PASSED);
+            throw new Error(`Email from: ${from_name} ${from_email} with subject: ${subject} is found`);
+        });
+    }
+    getHeader(value, headers) {
+        for (const header of headers) {
+            if (header.name.toLocaleLowerCase() === value.toLocaleLowerCase()) {
+                return header.value.toLocaleLowerCase();
+            }
+        }
+    }
 }
 export default new FunctionHelper();