@auxcode/auxta 1.3.19-beta.9 → 1.3.20

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/macros/helpers/AuxGoogleAuth.js

@@ -24,7 +24,6 @@ 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';

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,7 @@ 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");
 class FunctionHelper extends extend_default_page_1.ExtendDefaultPage {
     log(keyword, name, status) {
         log_service_1.default.push(keyword, name, status);
@@ -187,6 +188,52 @@ 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: "me",
+                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: "me",
+                            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/macros/helpers/AuxGoogleAuth.js

@@ -21,7 +21,6 @@ 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';

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,7 @@ 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";
 export class FunctionHelper extends ExtendDefaultPage {
     log(keyword, name, status) {
         log.push(keyword, name, status);
@@ -181,5 +182,51 @@ 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: "me",
+                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: "me",
+                            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();