@auxcode/auxta 1.3.24-beta.6 → 1.3.25

package/README.md

@@ -1,93 +1,93 @@
-# AuxTA
-
-## Implementing
-
-The main thing is a `scenario`.
-
-`Scenarios` consts of `steps.
-
-### Clicking
-
-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`
-
-auxta.clickByText `TO BE FIXED BY GEORGE TO ADD THE WAIT FOR SELECTOR WHICH IS MISSING`
-
-auxta.clickByXPath
-
-auxta.clickByClass
-
-auxta.click() `THINK TO MAKE` `TODO`
-
-waitforseelctorbytext `depreciated`
-
-### Working with Tab
-
-...
-
-### 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
-
-* Create a main function that calls the run() function which starts all tests
-* Create a function for each test that calls the `auxtaPuppeteer.run(event, callback, featureName, scenarioName)` function
-
-## Puppeteer
-
-https://pptr.dev
-
-https://github.com/puppeteer/puppeteer
-
-## Install
-
-npm i
-
-## Setup
-
-```
-{
-  # All background functions that will be run, listed
-  "suitesList": [
-    "{filename}-background"
-  ],
-  # The tested site's url
-  "baseURL": "https://{sitename}/",
-  # The url where the tests are ran
-  "testsURL": "https://{sitename}/",
-  # The organization's name
-  "organization": "string",
-  # The digital product's name
-  "digitalProduct": "bedrijfsfinanciering.com",
-  # Max timeout in milliseconds
-  # Default 1000
-  "timeout": 1000,
-  # The credentials of the user that uploads the tests to the site
-  "email": "string",
-  "password": "string",
-  "token": "string"
-  # Screen width and height used in the testing
-  # Allows testing from mobile devices screens
-  "screenWidth": 1920,
-  "screenHeight": 1080,
-}
-
-```
+# AuxTA
+
+## Implementing
+
+The main thing is a `scenario`.
+
+`Scenarios` consts of `steps.
+
+### Clicking
+
+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`
+
+auxta.clickByText `TO BE FIXED BY GEORGE TO ADD THE WAIT FOR SELECTOR WHICH IS MISSING`
+
+auxta.clickByXPath
+
+auxta.clickByClass
+
+auxta.click() `THINK TO MAKE` `TODO`
+
+waitforseelctorbytext `depreciated`
+
+### Working with Tab
+
+...
+
+### 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
+
+* Create a main function that calls the run() function which starts all tests
+* Create a function for each test that calls the `auxtaPuppeteer.run(event, callback, featureName, scenarioName)` function
+
+## Puppeteer
+
+https://pptr.dev
+
+https://github.com/puppeteer/puppeteer
+
+## Install
+
+npm i
+
+## Setup
+
+```
+{
+  # All background functions that will be run, listed
+  "suitesList": [
+    "{filename}-background"
+  ],
+  # The tested site's url
+  "baseURL": "https://{sitename}/",
+  # The url where the tests are ran
+  "testsURL": "https://{sitename}/",
+  # The organization's name
+  "organization": "string",
+  # The digital product's name
+  "digitalProduct": "bedrijfsfinanciering.com",
+  # Max timeout in milliseconds
+  # Default 1000
+  "timeout": 1000,
+  # The credentials of the user that uploads the tests to the site
+  "email": "string",
+  "password": "string",
+  "token": "string"
+  # Screen width and height used in the testing
+  # Allows testing from mobile devices screens
+  "screenWidth": 1920,
+  "screenHeight": 1080,
+}
+
+```

package/build/cjs/AuxTA.d.ts

@@ -1,60 +1,61 @@
-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;
-    google: typeof AuxGoogleAuth;
-    config: {
-        auxtaURL: string;
-        baseURL: string;
-        siteURL: string;
-        organization: string;
-        netlifyPath: string;
-        digitalProduct: string;
-        token: string;
-        screenWidth: number;
-        screenHeight: number;
-        timeout: number;
-        suitesList: never[];
-        googleEmail: string;
-        auxtaCredentials: {
-            email: string;
-            password: string;
-        };
-    };
-    private readonly uploadModel;
-    constructor();
-    run(event: any, overrideConfig?: any): Promise<{
-        nextSuites?: undefined;
-        reportId?: undefined;
-        currentSuite?: undefined;
-        retries?: undefined;
-    } | {
-        nextSuites: string[];
-        reportId: string | undefined;
-        currentSuite: string | undefined;
-        retries: string;
-    }>;
-    private changeModelData;
-    startBrowser(event: any, callback: any, feature: string, scenario: string, overrideConfig?: any, singleFeature?: boolean, fileName?: string): Promise<{
-        nextSuites?: undefined;
-        reportId?: undefined;
-        currentSuite?: undefined;
-        retries?: undefined;
-    } | {
-        nextSuites: string[];
-        reportId: string | undefined;
-        currentSuite: string | undefined;
-        retries: string;
-    } | {
-        statusCode: number;
-    } | undefined>;
-    startBrowserRPA(event: any, callback: any, baseURL: string, fileName?: string): Promise<any>;
-    getUploadModel(): UploadModel;
-}
-export declare const StepStatus: typeof StatusOfStep;
-declare const auxta: AuxTA;
-export default auxta;
+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;
+    google: typeof AuxGoogleAuth;
+    config: {
+        auxtaURL: string;
+        baseURL: string;
+        siteURL: string;
+        organization: string;
+        netlifyPath: string;
+        digitalProduct: string;
+        token: string;
+        screenWidth: number;
+        screenHeight: number;
+        timeout: number;
+        suitesList: never[];
+        googleEmail: string;
+        auxtaCredentials: {
+            email: string;
+            password: string;
+        };
+    };
+    email: import("./macros/helpers/emailHelper").EmailHelper;
+    private readonly uploadModel;
+    constructor();
+    run(event: any, overrideConfig?: any): Promise<{
+        nextSuites?: undefined;
+        reportId?: undefined;
+        currentSuite?: undefined;
+        retries?: undefined;
+    } | {
+        nextSuites: string[];
+        reportId: string | undefined;
+        currentSuite: string | undefined;
+        retries: string;
+    }>;
+    private changeModelData;
+    startBrowser(event: any, callback: any, feature: string, scenario: string, overrideConfig?: any, singleFeature?: boolean, fileName?: string): Promise<{
+        nextSuites?: undefined;
+        reportId?: undefined;
+        currentSuite?: undefined;
+        retries?: undefined;
+    } | {
+        nextSuites: string[];
+        reportId: string | undefined;
+        currentSuite: string | undefined;
+        retries: string;
+    } | {
+        statusCode: number;
+    } | undefined>;
+    startBrowserRPA(event: any, callback: any, baseURL: string, fileName?: string): Promise<any>;
+    getUploadModel(): UploadModel;
+}
+export declare const StepStatus: typeof StatusOfStep;
+declare const auxta: AuxTA;
+export default auxta;

package/build/cjs/AuxTA.js

@@ -1,150 +1,152 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StepStatus = void 0;
-const puppeteer_1 = __importDefault(require("./puppeteer/puppeteer"));
-const code_helper_1 = require("./macros/helpers/code.helper");
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const status_of_step_1 = __importDefault(require("./auxta/enums/status-of.step"));
-const upload_model_1 = require("./auxta/models/upload.model");
-const dotenv = __importStar(require("dotenv"));
-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 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.google = AuxGoogleAuth_1.AuxGoogleAuth;
-        this.config = config_1.config;
-        let file;
-        if (!process.env.RPA) {
-            try {
-                let currentDir = "";
-                while (true) {
-                    file = path_1.default.join(__dirname, currentDir, "auxta.json");
-                    if (!fs_1.default.existsSync(file)) {
-                        currentDir += "../";
-                        if (currentDir.length >= 30) {
-                            console.log("auxta.json file not found!");
-                            process.exit(1);
-                            return;
-                        }
-                        continue;
-                    }
-                    break;
-                }
-                const jsonConfig = JSON.parse(fs_1.default.readFileSync(file).toString());
-                try {
-                    this.config = (0, config_1.setupConfig)(jsonConfig);
-                }
-                catch (e) {
-                    console.log("Missing field in auxta.json:", e);
-                }
-                this.uploadModel = new upload_model_1.UploadModel(jsonConfig.organization, jsonConfig.baseURL, jsonConfig.digitalProduct, jsonConfig.environment);
-            }
-            catch (e) {
-                console.log("Missing or corrupted config: auxta.json. Searching in location:", file);
-                console.log(e);
-                process.exit(1);
-            }
-        }
-        else {
-            this.uploadModel = new upload_model_1.UploadModel('', '', '', '');
-        }
-    }
-    run(event, overrideConfig) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.changeModelData(overrideConfig);
-            let reportId;
-            try {
-                if (event.reportId) {
-                    reportId = event.reportId;
-                }
-            }
-            catch (e) {
-                reportId = undefined;
-            }
-            const suites = this.config.suitesList.slice(0);
-            return (0, start_suite_helper_1.startSuite)(suites, reportId || (yield (0, report_service_1.createEmptyReport)(this.uploadModel)));
-        });
-    }
-    changeModelData(overrideConfig) {
-        if (overrideConfig) {
-            if (overrideConfig.digitalProduct)
-                this.uploadModel.digitalProduct = overrideConfig.digitalProduct;
-            if (overrideConfig.environment)
-                this.uploadModel.environment = overrideConfig.environment;
-            if (overrideConfig.baseURL)
-                this.uploadModel.baseUrl = overrideConfig.baseURL;
-            this.config = (0, config_1.setupOverrideConfig)(overrideConfig);
-        }
-    }
-    startBrowser(event, callback, feature, scenario, overrideConfig, singleFeature = false, fileName = '') {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.changeModelData(overrideConfig);
-            if (singleFeature && process.env.ENVIRONMENT !== 'LOCAL') {
-                this.uploadModel.reportId = yield (0, report_service_1.createEmptyReport)(this.uploadModel);
-                this.uploadModel.currentSuite = fileName;
-                this.uploadModel.nextSuites = [];
-            }
-            return this.puppeteer.run(event, callback, feature, scenario);
-        });
-    }
-    startBrowserRPA(event, callback, baseURL, fileName = '') {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.changeModelData({
-                baseURL: baseURL,
-                environment: '',
-                digitalProduct: ''
-            });
-            this.uploadModel.currentSuite = fileName;
-            return this.puppeteer.runRPA(event, callback);
-        });
-    }
-    getUploadModel() {
-        return this.uploadModel;
-    }
-}
-exports.StepStatus = status_of_step_1.default;
-const auxta = new AuxTA();
-exports.default = auxta;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StepStatus = void 0;
+const puppeteer_1 = __importDefault(require("./puppeteer/puppeteer"));
+const code_helper_1 = require("./macros/helpers/code.helper");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const status_of_step_1 = __importDefault(require("./auxta/enums/status-of.step"));
+const upload_model_1 = require("./auxta/models/upload.model");
+const dotenv = __importStar(require("dotenv"));
+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 AuxGoogleAuth_1 = require("./macros/helpers/AuxGoogleAuth");
+const emailHelper_1 = __importDefault(require("./macros/helpers/emailHelper"));
+dotenv.config();
+class AuxTA extends code_helper_1.FunctionHelper {
+    constructor() {
+        super();
+        this.puppeteer = puppeteer_1.default;
+        this.aux2fa = Aux2faAuth_1.default;
+        this.google = AuxGoogleAuth_1.AuxGoogleAuth;
+        this.config = config_1.config;
+        this.email = emailHelper_1.default;
+        let file;
+        if (!process.env.RPA) {
+            try {
+                let currentDir = "";
+                while (true) {
+                    file = path_1.default.join(__dirname, currentDir, "auxta.json");
+                    if (!fs_1.default.existsSync(file)) {
+                        currentDir += "../";
+                        if (currentDir.length >= 30) {
+                            console.log("auxta.json file not found!");
+                            process.exit(1);
+                            return;
+                        }
+                        continue;
+                    }
+                    break;
+                }
+                const jsonConfig = JSON.parse(fs_1.default.readFileSync(file).toString());
+                try {
+                    this.config = (0, config_1.setupConfig)(jsonConfig);
+                }
+                catch (e) {
+                    console.log("Missing field in auxta.json:", e);
+                }
+                this.uploadModel = new upload_model_1.UploadModel(jsonConfig.organization, jsonConfig.baseURL, jsonConfig.digitalProduct, jsonConfig.environment);
+            }
+            catch (e) {
+                console.log("Missing or corrupted config: auxta.json. Searching in location:", file);
+                console.log(e);
+                process.exit(1);
+            }
+        }
+        else {
+            this.uploadModel = new upload_model_1.UploadModel('', '', '', '');
+        }
+    }
+    run(event, overrideConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.changeModelData(overrideConfig);
+            let reportId;
+            try {
+                if (event.reportId) {
+                    reportId = event.reportId;
+                }
+            }
+            catch (e) {
+                reportId = undefined;
+            }
+            const suites = this.config.suitesList.slice(0);
+            return (0, start_suite_helper_1.startSuite)(suites, reportId || (yield (0, report_service_1.createEmptyReport)(this.uploadModel)));
+        });
+    }
+    changeModelData(overrideConfig) {
+        if (overrideConfig) {
+            if (overrideConfig.digitalProduct)
+                this.uploadModel.digitalProduct = overrideConfig.digitalProduct;
+            if (overrideConfig.environment)
+                this.uploadModel.environment = overrideConfig.environment;
+            if (overrideConfig.baseURL)
+                this.uploadModel.baseUrl = overrideConfig.baseURL;
+            this.config = (0, config_1.setupOverrideConfig)(overrideConfig);
+        }
+    }
+    startBrowser(event, callback, feature, scenario, overrideConfig, singleFeature = false, fileName = '') {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.changeModelData(overrideConfig);
+            if (singleFeature && process.env.ENVIRONMENT !== 'LOCAL') {
+                this.uploadModel.reportId = yield (0, report_service_1.createEmptyReport)(this.uploadModel);
+                this.uploadModel.currentSuite = fileName;
+                this.uploadModel.nextSuites = [];
+            }
+            return this.puppeteer.run(event, callback, feature, scenario);
+        });
+    }
+    startBrowserRPA(event, callback, baseURL, fileName = '') {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.changeModelData({
+                baseURL: baseURL,
+                environment: '',
+                digitalProduct: ''
+            });
+            this.uploadModel.currentSuite = fileName;
+            return this.puppeteer.runRPA(event, callback);
+        });
+    }
+    getUploadModel() {
+        return this.uploadModel;
+    }
+}
+exports.StepStatus = status_of_step_1.default;
+const auxta = new AuxTA();
+exports.default = auxta;