@auxcode/auxta 0.1.4 → 0.1.8

package/package.json

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

package/src/AuxTA.ts

@@ -1,8 +1,8 @@
 import puppeteer, { Puppeteer } from "./puppeteer/puppeteer";
-import f, { FunctionHelper } from "./macros/helpers/code.helper";
+import { FunctionHelper } from "./macros/helpers/code.helper";
 import path from "path";
 import fs from "fs";
-import { StepStatusEnum } from "./auxta/enums/step-status.enum";
+import StepStatusEnum from "./auxta/enums/step-status.enum";
 import { UploadModel } from "./auxta/models/upload.model";
 import * as dotenv from "dotenv";
 import { config, setupConfig } from "./auxta/configs/config";
@@ -11,13 +11,13 @@ import { createEmptyReport } from "./auxta/services/report.service";
 
 dotenv.config();
 
-class AuxTA {
+class AuxTA extends FunctionHelper {
     public puppeteer: Puppeteer = puppeteer;
-    public functions: FunctionHelper = f;
 
     private readonly uploadModel: UploadModel;
 
     constructor() {
+        super();
         let file;
         try {
             //todo find a better way to load the file
@@ -50,7 +50,7 @@ class AuxTA {
     }
 
     public async run(event: any) {
-        const model = this.getUploadModel();
+        const model = this.uploadModel;
         let token: string = event.queryStringParameters.token;
         let reportId: string | undefined = event.queryStringParameters.reportId;
         if (token !== config.token) return {statusCode: 401, message: 'Unauthorized'}
@@ -72,7 +72,4 @@ export const StepStatus = StepStatusEnum;
 
 const auxta: AuxTA = new AuxTA();
 
-export const auxtaRun = auxta.run;
-export const auxtaFunc = auxta.functions;
-
 export default auxta;

package/src/auxta/enums/step-status.enum.ts

@@ -4,3 +4,4 @@ export enum StepStatusEnum {
     SKIPPED = 'skipped',
     SUGGESTION = 'suggestion',
 }
+export default StepStatusEnum;

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

@@ -10,7 +10,7 @@ import {
 } from '../services/report.service';
 import { startSuite } from '../utilities/start-suite.helper';
 import { StepStatusEnum } from "../enums/step-status.enum";
-import UploadModel from "../models/upload.model";
+import { UploadModel } from "../models/upload.model";
 
 export async function AfterEach(body: any, featureName: string, scenarioName: string, statusCode: number, screenshotBuffer: Buffer, errMessage?: string) {
     let isFinal: boolean = false;

package/src/auxta/models/upload.model.ts

@@ -48,5 +48,3 @@ export class UploadModel {
         return this._environment;
     }
 }
-
-export default UploadModel;

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

@@ -1,7 +1,7 @@
 import axios from "axios";
 import { Step } from "./log.service";
 import { config } from "../configs/config";
-import UploadModel from "../models/upload.model";
+import { UploadModel } from "../models/upload.model";
 
 export interface Feature {
     featureId: string,

package/src/auxta/utilities/screenshot.helper.ts

@@ -1,7 +1,8 @@
-import { auxtaPuppeteer } from "../../AuxTA";
+import puppeteer  from "../../puppeteer/puppeteer";
 
 export async function captureScreenshot() {
-    const pages = await auxtaPuppeteer.defaultPage.browser().pages();
+    const pages = await puppeteer.defaultPage.browser().pages();
+    if (!pages.length) throw `Browser is closed`;
     const lastPage = pages[pages.length - 1];
 
     const screenshotBuffer = await lastPage.screenshot({
@@ -9,7 +10,7 @@ export async function captureScreenshot() {
             encoding: 'binary'
         }
     );
-    if (Buffer.isBuffer(screenshotBuffer)) 
+    if (Buffer.isBuffer(screenshotBuffer))
         return screenshotBuffer;
     else throw `Failed to capture buffer screenshot`;
 }

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

@@ -3,7 +3,7 @@ import puppeteer from "../../puppeteer/puppeteer";
 import { StepStatusEnum } from "../../auxta/enums/step-status.enum";
 
 export class FunctionHelper {
-    public readonly timeout: number = Number(process.env.AUXTA_TIMEOUT);
+    public readonly defaultTimeout: number = Number(process.env.AUXTA_TIMEOUT);
 
     public log(keyword: string, name: string, status: StepStatusEnum){
         log.push(keyword, name, status)
@@ -12,26 +12,27 @@ export class FunctionHelper {
     public suggest(name: string){
         log.addSuggestion(name)
     }
+
+    private getEscapedText(text: string){
+        const splitedQuotes = text.replace(/'/g, `', "'", '`)
+        return `concat('${splitedQuotes}', '')`;
+    }
     
     public async clickByText(selector: string, text: string, page = puppeteer.defaultPage) {
-        await page.waitForTimeout(this.timeout);
-        const splitedQuotes = text.replace(/'/g, `', "'", '`)
-        const escapedText = `concat('${splitedQuotes}', '')`;
-        const [linkHandlers] = await page.$x(`//${selector}[. = ${escapedText}]`);
+        await page.waitForTimeout(this.defaultTimeout);
+        const [linkHandlers] = await page.$x(`//${selector}[. = ${this.getEscapedText(text)}]`);
 
         if (linkHandlers) {
-            log.push('And', `I click ${selector} with text ${text}`, StepStatusEnum.PASSED);
+            log.push('And', `I click on the ${text} ${selector}`, StepStatusEnum.PASSED);
             await linkHandlers.click();
         } else {
-            log.push('And', `I click ${selector} with text ${text}`, StepStatusEnum.FAILED);
+            log.push('And', `I click on the ${text} ${selector}`, StepStatusEnum.FAILED);
             throw new Error(`Link not found: ${text}`);
         }
     }
 
     public async waitForSelectorWithText(selector: string, text: string) {
-        const splitedQuotes = text.replace(/'/g, `', "'", '`)
-        const escapedText = `concat('${splitedQuotes}', '')`;
-        const linkHandlers = await puppeteer.defaultPage.$x(`//${selector}[. = ${escapedText}]`);
+        const linkHandlers = await puppeteer.defaultPage.$x(`//${selector}[. = ${this.getEscapedText(text)}]`);
         if (linkHandlers.length > 0) {
             log.push('And', `I checked for ${text} and found it.`, StepStatusEnum.PASSED);
             return true;
@@ -43,16 +44,23 @@ export class FunctionHelper {
 
     public async goto(page: string) {
         await puppeteer.defaultPage.goto(page);
+        log.push('And', `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);
     }
 
     public async waitForNetwork() {
         await puppeteer.defaultPage.waitForNetworkIdle();
     }
 
+    public async timeout(timeout = this.defaultTimeout) {
+        await puppeteer.defaultPage.waitForTimeout(timeout);
+    }
+
     /**
      * Waiting for selector with timeout 60000
      *
@@ -63,7 +71,7 @@ export class FunctionHelper {
      * @param page
      */
 
-    public async waitForSelector(option: string, selector: string, time: number = this.timeout, page = puppeteer.defaultPage) {
+    public async waitForSelector(option: string, selector: string, time: number = this.defaultTimeout, page = puppeteer.defaultPage) {
         await page.waitForSelector(selector, {
             [option]: true,
             timeout: time
@@ -71,17 +79,19 @@ export class FunctionHelper {
     }
 
     public async click(className: string, page = puppeteer.defaultPage) {
-        await page.waitForTimeout(this.timeout);
+        await page.waitForTimeout(this.defaultTimeout);
+        const elementName = await puppeteer.defaultPage.$eval(className, (e) => e.textContent);
         await page.click(className);
+        log.push('Then', `I click on ${elementName}`, StepStatusEnum.PASSED);
     }
 
     public async urlContains(selector: string) {
         const url = puppeteer.defaultPage.url();
         if (!url.includes(selector)) {
-            await log.push('And', `I am on the ${selector} page`, StepStatusEnum.FAILED);
+            log.push('And', `I am on the ${selector} page`, StepStatusEnum.FAILED);
             throw new Error(`I am not at the ${selector} page`)
         }
-        await log.push('And', `I am on the ${selector} page`, StepStatusEnum.PASSED);
+        log.push('And', `I am on the ${selector} page`, StepStatusEnum.PASSED);
     }
 
 }

package/src/puppeteer/puppeteer.ts

@@ -6,6 +6,8 @@ import auxta from "../AuxTA";
 import { StepStatusEnum } from "../auxta/enums/step-status.enum";
 import { UploadModel } from "../auxta/models/upload.model";
 import puppeteer_core from 'puppeteer-core';
+import { config } from "./../auxta/configs/config";
+
 
 export class Puppeteer {
     public defaultPage!: puppeteer_core.Page;
@@ -21,15 +23,13 @@ export class Puppeteer {
                 '--disable-dev-shm-usage',
                 '--single-process'
             ],
-            defaultViewport: chromium.defaultViewport,
+            defaultViewport: null,
             // Return back to headless for commit
             headless: process.env.ENVIRONMENT == 'LOCAL' ? false : chromium.headless
         });
         this.defaultPage = (await this.browser.pages())[0];
-        await this.defaultPage.setViewport({
-            width: 1440,
-            height: 900
-        });
+        await this.defaultPage.goto(config.baseURL)
+        await this.defaultPage.waitForNetworkIdle();
     }
 
     public async close() {