@auxcode/auxta 0.1.10 → 0.2.2

package/README.md

@@ -36,9 +36,13 @@ npm i
   # Default 1000
   "timeout": 1000,
   # The credentials of the user that uploads the tests to the site
-  "email": "",
-  "password": "",
-  "token": ""
+  "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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auxcode/auxta",
-  "version": "0.1.10",
+  "version": "0.2.2",
   "description": "",
   "main": "src/AuxTA.ts",
   "scripts": {

package/src/AuxTA.ts

@@ -20,27 +20,19 @@ class AuxTA extends FunctionHelper {
         super();
         let file;
         try {
-            //todo find a better way to load the file
             let currentDir = ""
             while (true) {
                 file = path.join(__dirname, currentDir, "auxta.json");
-                try {
-                    fs.accessSync(file, fs.constants.R_OK | fs.constants.W_OK)
-                    break;
-                } catch {
-                    console.log("Current dir: ", file)
-                    console.log("Files: ")
-                    const files = fs.readdirSync(path.join(__dirname, currentDir));
-                    files.forEach(file => {
-                        console.log("- " + file);
-                    });
+                if (!fs.existsSync(file)) {
                     currentDir += "../"
-                    if (currentDir.length >= 50) {
+                    if (currentDir.length >= 30) {
                         console.log("auxta.json file not found!")
                         process.exit(1);
                         return;
                     }
+                    continue;
                 }
+                break;
             }
             const jsonConfig = JSON.parse(fs.readFileSync(file).toString());
             try {

package/src/auxta/configs/config.ts

@@ -16,6 +16,8 @@ export function setupConfig(jsonConfig: any) {
     if (!jsonConfig.suitesList) throw new Error("suitesList");
     config.suitesList = jsonConfig.suitesList;
     if (jsonConfig.timeout) config.timeout = jsonConfig.timeout;
+    if (jsonConfig.screenWidth) config.screenWidth = jsonConfig.screenWidth;
+    if (jsonConfig.screenHeight) config.screenHeight = jsonConfig.screenHeight;
 }
 
 export let config = {
@@ -26,7 +28,9 @@ export let config = {
     netlifyPath: "",
     digitalProduct: "",
     token: "",
-    timeout: 1000,
+    screenWidth: 1920,
+    screenHeight: 1080,
+    timeout: 10000,
     suitesList: [],
     auxtaCredentials: {
         email: "",

package/src/auxta/hooks/report.hook.ts

@@ -12,7 +12,7 @@ import { startSuite } from '../utilities/start-suite.helper';
 import { StepStatusEnum } from "../enums/step-status.enum";
 import { UploadModel } from "../models/upload.model";
 
-export async function AfterEach(body: any, featureName: string, scenarioName: string, statusCode: number, screenshotBuffer: Buffer, errMessage?: string) {
+export async function onTestEnd(body: any, featureName: string, scenarioName: string, statusCode: number, screenshotBuffer: Buffer, errMessage?: object) {
     let isFinal: boolean = false;
     if (process.env.ENVIRONMENT == "LIVE") {
         console.log('asc ' + errMessage);

package/src/auxta/services/report.service.ts

@@ -66,7 +66,7 @@ export async function createEmptyReport(body: any): Promise<string> {
     )).data.reportId;
 }
 
-export async function uploadScenario(stepLog: Step[], scenarioName: string, screenshot?: Buffer, errMessage?: string) {
+export async function uploadScenario(stepLog: Step[], scenarioName: string, screenshot?: Buffer, errMessage?: object) {
     let scenarios = [];
     let token = await auth();
     let lastStep = stepLog[stepLog.length - 1];

package/src/macros/helpers/code.helper.ts

@@ -1,9 +1,10 @@
 import log from "../../auxta/services/log.service";
 import puppeteer from "../../puppeteer/puppeteer";
 import { StepStatusEnum } from "../../auxta/enums/step-status.enum";
+import { config } from "../../auxta/configs/config";
 
 export class FunctionHelper {
-    public readonly defaultTimeout: number = Number(process.env.AUXTA_TIMEOUT);
+    public readonly defaultTimeout: number = config.timeout;
 
     public log(keyword: string, name: string, status: StepStatusEnum){
         log.push(keyword, name, status)
@@ -22,39 +23,49 @@ export class FunctionHelper {
         await page.waitForTimeout(this.defaultTimeout);
         const [linkHandlers] = await page.$x(`//${selector}[. = ${this.getEscapedText(text)}]`);
 
+        const message = `I click on the ${text} ${selector}`;
         if (linkHandlers) {
-            log.push('And', `I click on the ${text} ${selector}`, StepStatusEnum.PASSED);
+            log.push('Then', message, StepStatusEnum.PASSED);
             await linkHandlers.click();
         } else {
-            log.push('And', `I click on the ${text} ${selector}`, StepStatusEnum.FAILED);
+            log.push('Then', message, StepStatusEnum.FAILED);
             throw new Error(`Link not found: ${text}`);
         }
     }
 
     public async waitForSelectorWithText(selector: string, text: string) {
         const linkHandlers = await puppeteer.defaultPage.$x(`//${selector}[. = ${this.getEscapedText(text)}]`);
+        const message = `I check for ${text}`;
         if (linkHandlers.length > 0) {
-            log.push('And', `I checked for ${text} and found it.`, StepStatusEnum.PASSED);
+            log.push('And', message, StepStatusEnum.PASSED);
             return true;
         } else {
-            log.push('And', `I checked for ${text} and found it.`, StepStatusEnum.FAILED);
+            log.push('And', message, StepStatusEnum.FAILED);
             throw new Error(`Link not found: ${text}`);
         }
     }
 
     public async goto(page: string) {
         await puppeteer.defaultPage.goto(page);
-        log.push('And', `I go to the ${page} page`, StepStatusEnum.PASSED);
+        log.push('Then', `I go to the ${page} page`, StepStatusEnum.PASSED);
     }
 
     public async type(field: string, value: string) {
         await puppeteer.defaultPage.type(field, value);
-        const elementName = await puppeteer.defaultPage.$eval(field, (e) => e.textContent);
-        log.push('And', `I type '${value}' into the ${elementName} field`, StepStatusEnum.PASSED);
+        let elementName = await puppeteer.defaultPage.$eval(field, (e) => e.textContent);
+        if (!elementName || elementName === ' ') elementName = field;
+        log.push('Then', `I type '${value}' into the ${elementName} field`, StepStatusEnum.PASSED);
     }
 
     public async waitForNetwork() {
-        await puppeteer.defaultPage.waitForNetworkIdle();
+        let message = 'I wait for the page to load'
+        try{
+            await puppeteer.defaultPage.waitForNetworkIdle();
+            log.push('Then', message, StepStatusEnum.PASSED);
+        } catch (e){
+            log.push('Then', message, StepStatusEnum.FAILED);
+            throw new Error(message)
+        }
     }
 
     public async timeout(timeout = this.defaultTimeout) {
@@ -72,26 +83,35 @@ export class FunctionHelper {
      */
 
     public async waitForSelector(option: string, selector: string, time: number = this.defaultTimeout, page = puppeteer.defaultPage) {
-        await page.waitForSelector(selector, {
-            [option]: true,
-            timeout: time
-        });
+        const message = `I check for the ${selector} element to be ${option}`;
+        try{
+            await page.waitForSelector(selector, {
+                [option]: true,
+                timeout: time
+            });
+        } catch (e){
+            log.push('And', message, StepStatusEnum.FAILED);
+            throw new Error(message)
+        }
+        log.push('And', message, StepStatusEnum.PASSED);
     }
 
     public async click(className: string, page = puppeteer.defaultPage) {
         await page.waitForTimeout(this.defaultTimeout);
-        const elementName = await puppeteer.defaultPage.$eval(className, (e) => e.textContent);
+        let elementName = await puppeteer.defaultPage.$eval(className, (e) => e.textContent);
+        if (!elementName || elementName === ' ') elementName = className;
         await page.click(className);
         log.push('Then', `I click on ${elementName}`, StepStatusEnum.PASSED);
     }
 
     public async urlContains(selector: string) {
         const url = puppeteer.defaultPage.url();
+        let message = `I am on the ${selector} page`
         if (!url.includes(selector)) {
-            log.push('And', `I am on the ${selector} page`, StepStatusEnum.FAILED);
+            log.push('And', message, StepStatusEnum.FAILED);
             throw new Error(`I am not at the ${selector} page`)
         }
-        log.push('And', `I am on the ${selector} page`, StepStatusEnum.PASSED);
+        log.push('And', message, StepStatusEnum.PASSED);
     }
 
 }

package/src/puppeteer/puppeteer.ts

@@ -1,7 +1,7 @@
 import chromium from 'chrome-aws-lambda';
 import log from "../auxta/services/log.service";
 import { captureScreenshot } from "../auxta/utilities/screenshot.helper";
-import { AfterEach } from "../auxta/hooks/report.hook";
+import { onTestEnd } from "../auxta/hooks/report.hook";
 import auxta from "../AuxTA";
 import { StepStatusEnum } from "../auxta/enums/step-status.enum";
 import { UploadModel } from "../auxta/models/upload.model";
@@ -14,17 +14,23 @@ export class Puppeteer {
     private browser!: puppeteer_core.Browser;
 
     public async startBrowser() {
+        let args = [
+            '--start-maximized',
+            '--no-sandbox',
+            '--disable-setuid-sandbox',
+            '--disable-dev-shm-usage',
+            '--single-process'
+        ];
+        if (process.env.ENVIRONMENT != 'LOCAL')
+            args.push(`--window-size=${config.screenWidth},${config.screenHeight}`)
         this.browser = await chromium.puppeteer.launch({
             executablePath: process.env.NODE_ENV !== 'production' ? undefined : await chromium.executablePath,
-            args: [
-                '--start-maximized',
-                '--no-sandbox',
-                '--disable-setuid-sandbox',
-                '--disable-dev-shm-usage',
-                '--single-process'
-            ],
-            defaultViewport: null,
-            // Return back to headless for commit
+            args,
+            defaultViewport: process.env.ENVIRONMENT == 'LOCAL' ? null : {
+                width: config.screenWidth,
+                height: config.screenHeight
+            },
+            // Return back to headless for netlify
             headless: process.env.ENVIRONMENT == 'LOCAL' ? false : chromium.headless
         });
         this.defaultPage = (await this.browser.pages())[0];
@@ -47,9 +53,17 @@ export class Puppeteer {
         let errMessage: string | undefined;
         let statusCode: number = 200;
 
+        let consoleStack = [];
         try {
             await log.push('When', `Starting puppeteer process`, StepStatusEnum.PASSED);
             await this.startBrowser()
+            await this.defaultPage.on('console', message =>
+                consoleStack.push(`${message.type().substr(0, 3).toUpperCase()} ${message.text()}`))
+                .on('pageerror', ({ message }) => consoleStack.push(message))
+                .on('response', response =>
+                    consoleStack.push(`${response.status()} ${response.url()}`))
+                .on('requestfailed', request =>
+                    consoleStack.push(`${request.failure().errorText} ${request.url()}`))
             await callback(event)
             screenshotBuffer = await captureScreenshot();
             await log.push('When', `Finished puppeteer process`, StepStatusEnum.PASSED);
@@ -60,9 +74,14 @@ export class Puppeteer {
             screenshotBuffer = await captureScreenshot();
             await log.push('When', `Finished puppeteer process`, StepStatusEnum.FAILED);
         }
+        let url = this.defaultPage.url();
         if (close) await this.close();
+        log.clear();
 
-        await AfterEach(uploadModel, featureName, scenarioName, statusCode, screenshotBuffer, errMessage);
+        await onTestEnd(uploadModel, featureName, scenarioName, statusCode, screenshotBuffer, !errMessage ? undefined : {
+            currentPageUrl: url,
+            error: errMessage
+        });
     }
 
     private static setupHeader(event: any, uploadModel: UploadModel) {