froth-webdriverio-framework 3.0.89 → 3.0.90

package/{config → froth_configs}/commonconfig.js

@@ -1,11 +1,11 @@
-const setAllDetails = require("./setallDatailinBuffer")
+const path = require('path');
 const { LocalStorage } = require('node-localstorage');
 global.BUFFER = new LocalStorage('./storage');
-const path = require('path');
-const exeDetails = require("../api/getexecutionDetails")
-const getBSSessionDetails = require("../api/browsersatckSessionInfo").getBSSessionDetails;
+const setAllDetails = require("./setallDatailinBuffer")
+const exeDetails = require("../froth_api_calls/getexecutionDetails")
+const getBSSessionDetails = require("../froth_api_calls/browsersatckSessionInfo").getBSSessionDetails;
 const { fail } = require("assert");
-const isBrowserStackEnabled = process.env.BROWSERSTACK;
+//const isBrowserStackEnabled = process.env.BROWSERSTACK;
 let starttime;
 let endtime;
 
@@ -14,32 +14,43 @@ const commonconfig = {
 
 
     onPrepare: async function (capabilities, specs) {
-        try{
-        // This code runs before the test suite starts
-        await setAllDetails.setEnvVariables();
-        await setAllDetails.setLoginToken();
-        await setAllDetails.setExecutionDetails();
-        //  await setAllDetails.setIntegrationsDetails();
-        await setAllDetails.setSuiteDetails();
-        await setAllDetails.setTestDataDetails();
-        // console.log(JSON.stringify(capabilities))
-        //  console.log("ALL JSON DATA in env variable :" + JSON.stringify(process.env));
-        }catch(e){
-            console.log("====> Error in onPrepare:",e);
+        try {
+            console.log('====> This is the onPrepare hook');
+            // This code runs before the test suite starts
+            await setAllDetails.setEnvVariables();
+            await setAllDetails.setLoginToken();
+            const getExeDetails = await setAllDetails.setExecutionDetails();
+
+            //  await setAllDetails.setIntegrationsDetails();
+            await setAllDetails.setSuiteDetails();
+            await setAllDetails.setTestDataDetails();
+            console.log("on prepare:", JSON.stringify(capabilities))
+            //  console.log("ALL JSON DATA in env variable :" + JSON.stringify(process.env));
+        } catch (e) {
+            console.log("====> Error in onPrepare:", e);
 
         }
     },
 
 
-    beforeSession: async function (config, capabilities,specs ) {
+    beforeSession: async function (config, capabilities, specs) {
         console.log('====> This is the beforesession hook');
         // Perform any setup or pre-test actions here
-       // console.log("Capabilities:", capabilities);
-        console.log("Specs:", specs.length);
-        const specdat=specs
-        console.log("specdat:", specdat);
-        console.log("length:", specdat.length);
-       // console.log("Config:", config);
+        // console.log("Capabilities:", capabilities);
+
+        console.log("specdat:", specs);
+        console.log("length:", specs.length);
+
+        if (process.env.PLATFORM === 'browserstack') {
+            /// console.log("capabilities:", capabilities);
+            capabilities.app = process.env.BROWSERSTACK_APP_PATH;
+            capabilities.browserstackLocal = process.env.BROWSERSTACK_LOCAL;
+            if (process.env.MEDIA_FILES)
+                capabilities['browserstack.uploadMedia'] = process.env.MEDIA_FILES;
+
+            console.log(`Running tests on after app,bslocal,mediafiles: ${capabilities}`);
+        }
+
     },
     /**
      * Gets executed before the suite starts (in Mocha/Jasmine only).
@@ -51,10 +62,9 @@ const commonconfig = {
 
             starttime = new Date().getTime();
 
-            if (isBrowserStackEnabled) {
-                console.log("BrowserStack is enabled");
+            if (process.env.PLATFORM === 'browserstack')
                 await getBSSessionDetails(process.env.BS_SESSION_TYPE, process.env.BROWSERSTACK_USERNAME, process.env.BROWSERSTACK_ACCESS_KEY);
-            }
+
             const resultdetails = {};
             exeDetails.updateExecuitonDetails(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"), resultdetails)
 
@@ -108,7 +118,7 @@ const commonconfig = {
             // scriptresult = "FAILED"
         }
         let scriptid = BUFFER.getItem(fileName.replace(".js", ""))
-        let script_platform = BUFFER.getItem(fileName.replace(".js", "")+"_PLATFORM")
+        let script_platform = BUFFER.getItem(fileName.replace(".js", "") + "_PLATFORM")
 
         await exeDetails.updateScriptExecutionStatus(
             BUFFER.getItem("ORGANISATION_DOMAIN_URL"),
@@ -151,7 +161,7 @@ const commonconfig = {
     afterSession: async function (config, capabilities, specs) {
         console.log('====> This is the aftersession hook');
         // Perform any cleanup or post-test actions here
-        console.log("Capabilities:", capabilities);
+        // console.log("Capabilities:", capabilities);
         console.log("Specs:", specs);
         console.log("Config:", config);
 
@@ -159,7 +169,7 @@ const commonconfig = {
         let totalDuration = endtime - starttime;
         console.log("====> Total Duration in after session based on start time and end time:" + totalDuration);
 
-        if (isBrowserStackEnabled)
+        if (process.env.PLATFORM === 'browserstack')
             await getBSSessionDetails(process.env.BS_SESSION_TYPE, process.env.BROWSERSTACK_USERNAME, process.env.BROWSERSTACK_ACCESS_KEY);
 
         const resultdetails = {}
@@ -175,7 +185,7 @@ const commonconfig = {
     },
 
     onComplete: async function (exitCode, config, capabilities, results) {
-        
+
         console.log('====> This is the onComplete hook', results);
 
         console.log('====> Test Results Summary ');

package/{config → froth_configs}/setallDatailinBuffer.js

@@ -1,8 +1,8 @@
-const getLoginToken = require("../api/loginapi");
-const exeDetails = require("../api/getexecutionDetails")
-//const getintegrationdetails = require("../api/getintegrationDetails");
-const getSuiteDetails = require("../api/getsuiteDetails");
-const getDataById = require("../api/readTestdata");
+const getLoginToken = require("../froth_api_calls/loginapi");
+const exeDetails = require("../froth_api_calls/getexecutionDetails")
+//const getintegrationdetails = require("../froth_api_calls/getintegrationDetails");
+const getSuiteDetails = require("../froth_api_calls/getsuiteDetails");
+const getDataById = require("../froth_api_calls/readTestdata");
 
 
 async function generateBuildNumber() {
@@ -64,6 +64,9 @@ async function setExecutionDetails() {
   try {
     const getExeDetails = await exeDetails.getExecuitonDetails(BUFFER.getItem("ORGANISATION_DOMAIN_URL"), BUFFER.getItem("FROTH_LOGIN_TOKEN"), BUFFER.getItem("FROTH_EXECUTION_ID"));
     BUFFER.setItem("AUTOMATION_SUITE_ID", getExeDetails.automation_suite_id);
+    BUFFER.setItem("BROWSERSTACK_LOCAL", getExeDetails.browser_stack_local);
+    BUFFER.setItem("BROWSERSTACK_APP_PATH", getExeDetails.app_url);
+    BUFFER.setItem("MEDIA_FILES", getExeDetails.mediaurls);
 
   } catch (error) {
     //    console.error('Error in main function:', error);

package/froth_configs/wdio.common.conf.js

@@ -0,0 +1,66 @@
+const deepmerge = require('deepmerge')
+const fs = require('fs');
+const yaml = require('js-yaml');
+const path = require('path');
+const commonconfig = require('./commonconfig');
+
+// Select platform at runtime
+const PLATFORM = process.env.PLATFORM || 'browserstack';
+const configFile = PLATFORM === 'browserstack' ? './ymls/browserstack/' + process.env.YML_NAME : './ymls/saucelab/' + process.env.YML_NAME;
+console.log('PLATFORM:', PLATFORM);
+// Load YAML file
+const capabilities = yaml.load(fs.readFileSync(path.join(path.resolve(process.cwd(),configFile)), 'utf8'));
+const SUITE_FILE = path.resolve(process.cwd(), process.env.SUITE);
+
+console.log('SUITE_FILE:', SUITE_FILE);
+
+capabilities.buildName = process.env.BROWSERSTACK_BUILD_NAME;
+
+
+if (PLATFORM === 'browserstack') {
+    process.env.BROWSERSTACK_USERNAME = capabilities.userName;
+    process.env.BROWSERSTACK_ACCESS_KEY = capabilities.accessKey;
+    console.log('capabilities.platformName:', capabilities.platformName);
+    process.env.BS_SESSION_TYPE = capabilities.platformName === 'android' || capabilities.platformName === 'ios' ? 'app-automate' : 'automate';
+
+}
+
+exports.config = deepmerge(commonconfig,
+
+    {
+        user: capabilities.userName,
+        key: capabilities.accessKey,
+        // debug: true,
+        // execArgv: ['--inspect-brk'],
+        services: PLATFORM === 'browserstack'
+            ? ['browserstack']
+            : PLATFORM === 'saucelabs'
+                ? ['sauce']
+                : [],
+
+        //runner: 'local',
+        specs: require(SUITE_FILE).tests,
+
+        maxInstances: 1,
+        capabilities: [capabilities],
+
+        logLevel: 'info',
+        coloredLogs: true,
+        screenshotPath: './errorShots/',
+        bail: 0,
+        //baseUrl: 'https://example.com',
+        waitforTimeout: 90000,
+        connectionRetryTimeout: 90000,
+        connectionRetryCount: 3,
+
+        framework: 'mocha',
+        reporters: ['spec'],
+        maxInstances: 10,
+        updateJob: false,
+        mochaOpts: {
+            ui: 'bdd',
+            timeout: 300000
+        }
+    });
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "froth-webdriverio-framework",
-  "version": "3.0.89",
+  "version": "3.0.90",
   "readme": "WebdriverIO Integration",
   "description": "WebdriverIO and BrowserStack App Automate",
   "license": "MIT",
@@ -31,21 +31,20 @@
     "@wdio/local-runner": "^9.0.9",
     "@wdio/mocha-framework": "^8.36.1",
     "@wdio/spec-reporter": "^8.36.1",
-    "appium": "^1.22.3",
-    "appium-uiautomator2-driver": "^2.2.0",
+    "appium": "^2.15.0",
+    "appium-uiautomator2-driver": "^4.0.1",
     "assert": "^2.1.0",
     "axios": "^1.7.7",
     "browserstack-local": "^1.5.5",
     "chai": "^5.1.1",
-    "crypto": "^1.0.1",
     "crypto-js": "^4.2.0",
     "deepmerge": "^4.3.1",
     "form-data": "^4.0.0",
+    "fs": "^0.0.1-security",
+    "js-yaml": "^4.1.0",
     "mysql2": "^3.10.2",
     "node-fetch": "^3.3.2",
     "node-localstorage": "^3.0.5",
-    "pg": "^8.12.0",
-    "pg-promise": "^11.9.0",
     "randexp": "^0.5.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"

package/.github/workflows/main.yml

@@ -1,23 +0,0 @@
-name: npm_package
-
-on:
-  workflow_dispatch:
-
-jobs:
-  release:
-    name: release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: '12.x'
-          registry-url: https://registry.npmjs.org
-      
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
-

package/commonMethods/swipe.js

@@ -1,59 +0,0 @@
-async function swipeleft(selector, xoffset, speedinsec) {
-    try {
-        console.log('Swiping left');
-
-        if (xoffset == null) {
-            driver.swipeLeft(selector, speedinsec);
-        } else {
-            driver.swipeLeft(selector, xoffset, speedinsec);
-        }
-    } catch (error) {
-        console.error(error.message);
-    }
-
-}
-
-async function swiperight(selector, xoffset, speedinsec) {
-    try {
-        console.log('Swiping right');
-
-        if (xoffset == null) {
-            driver.swipeRight(selector, speedinsec);
-        } else {
-            driver.swipeRight(selector, xoffset, speedinsec);
-        }
-    } catch (error) {
-        console.error(error.message);
-    }
-
-}
-
-async function swipeup(selector, yoffset, speedinsec) {
-    try {
-        console.log('Swiping up');
-
-        if (yoffset == null) {
-            driver.swipeUp(selector, speedinsec);
-        } else {
-            driver.swipeUp(selector, yoffset, speedinsec);
-        }
-    } catch (error) {
-        console.error(error.message);
-    }
-}
-
-async function swipedown(selector, yoffset, speedinsec) {
-    try {
-        console.log('Swiping down');
-
-        if (yoffset == null) {
-            driver.swipeDown(selector, speedinsec);
-        } else {
-            driver.swipeDown(selector, yoffset, speedinsec);
-        }
-    } catch (error) {
-        console.error(error.message);
-    }
-}
-
-module.exports = { swipeleft, swipedown, swiperight, swipeup };

package/config/android.conf.js

@@ -1,49 +0,0 @@
-const deepmerge = require('deepmerge')
-process.env.BROWSERSTACK = true;
-const commonmobileconfig = require('./common.mobile.conf');
-
-const androidConfig = deepmerge.all([commonmobileconfig, {
-  services: [
-    [
-      'browserstack',
-      {
-        //  testObservability: true,
-        // buildName: "ANDROID BUILD",
-        // buildIdentifier: "ANDROID BUILD_" + process.env.BUILD_NUMBER,
-        browserstackLocal: process.env.BROWSERSTACK_LOCAL || false,
-        opts: {
-          forcelocal: false
-        },
-        app: process.env.BROWSERSTACK_APP_PATH
-      }
-    ]
-  ],
-
-  capabilities: [{
-    'bstack:options': {
-      projectName: process.env.PROJECTNAME || "roboticodigital",
-
-      deviceName: process.env.DEVICENAME || 'Samsung Galaxy S23 Ultra',
-      platformVersion: process.env.OSVERSION || '13.0',
-      platformName: 'android',
-      interactiveDebugging: true,
-      buildName: process.env.BROWSERSTACK_BUILD_NAME || 'Android_Build',
-      networkLogs: "true",
-      debug: "true",
-      appProfiling: "true",
-      //enableCameraImageInjection: true,
-     // enableCameraVideoInjection: true,
-      deviceOrientation: process.env.DEVICENAME.toLowerCase().includes('tab') ? 'landscape' : 'portrait',
-    }
-  }],
-  before: function (capabilities, specs) {
-    process.env.BS_SESSION_TYPE = "app-automate";
-  },
-
-}]);
-
-
-
-module.exports = androidConfig;
-
-

package/config/api.conf.bs.js

@@ -1,76 +0,0 @@
-const deepmerge = require('deepmerge')
-const commonmobileconfig = require('./common.mobile.conf');
-
-const apiconfig = deepmerge.all([commonmobileconfig, {
-
-
-    services: [
-        ['browserstack', {
-
-            browserstackLocal: process.env.BROWSERSTACK_LOCAL || false,
-            opts: {
-                forcelocal: false,
-                // localIdentifier: "webdriverio-appium"
-            },
-
-        }]
-    ],
-    // ====================
-    // Capabilities
-    // ====================
-    capabilities: [
-        {
-            'bstack:options': {
-                projectName: process.env.PROJECTNAME || "roboticodigital",
-
-                browserName: process.env.BROWSERSTACK_BROWSER || 'chrome', // Choose the browser you want to test
-                browserVersion: process.env.BROWSERSTACK_BROWSER_VERSION || '129', // Specify the browser version
-                os: 'Windows', // Specify the operating system
-                os_version: '10', // Specify the operating system version
-                interactiveDebugging: true,
-                buildName: process.env.BROWSERSTACK_BUILD_NAME || 'WEB_Build',
-                networkLogs: "true",
-                debug: "true",
-            }
-        },
-        // Add more capabilities for other browsers or devices as needed
-    ],
-
-    // ====================
-    // Test Configurations
-    // ====================
-    // logLevel: 'info', // Set the log level
-    // bail: 0, // Set to 1 to stop the test suite after the first test failure
-    // baseUrl: '', // Specify the base URL of your application
-    // waitforTimeout: 90000, // Set the timeout for all waitFor* commands
-    // connectionRetryTimeout: 90000, // Set the timeout in milliseconds for test retries
-    // connectionRetryCount: 2, // Set the number of times to retry the entire spec file
-
-    // ====================
-    // Framework
-    // ====================
-    // framework: 'mocha', // Use the Mocha framework
-    // reporters: ['spec'
-
-    // ], // Use the spec reporter
-
-    // ====================
-    // Hooks
-    // ====================
-    before: function (capabilities, specs) {
-        browser.maximizeWindow()
-        process.env.BS_SESSION_TYPE = "automate";
-    },
-
-
-
-    // // ====================
-    // // Mocha Options
-    // // ====================
-    // mochaOpts: {
-    //     ui: 'bdd', // Set the test interface to BDD
-    //     timeout: 90000, // Set the timeout for test cases in milliseconds
-    // },
-}]);
-
-module.exports = apiconfig;

package/config/api.conf.js

@@ -1,77 +0,0 @@
-const deepmerge = require('deepmerge')
-process.env.BROWSERSTACK = true;
-const commonmobileconfig = require('./common.mobile.conf');
-
-const apiconfig = deepmerge.all([commonmobileconfig, {
-
-
-    services: [
-        ['browserstack', {
-
-            browserstackLocal: process.env.BROWSERSTACK_LOCAL || false,
-            opts: {
-                forcelocal: false,
-                // localIdentifier: "webdriverio-appium"
-            },
-
-        }]
-    ],
-    // ====================
-    // Capabilities
-    // ====================
-    capabilities: [
-        {
-            'bstack:options': {
-                projectName: process.env.PROJECTNAME || "roboticodigital",
-
-                browserName: 'chrome', // Choose the browser you want to test
-               // browserVersion: '129', // Specify the browser version
-                os: 'Windows', // Specify the operating system
-               // os_version: '10', // Specify the operating system version
-                interactiveDebugging: true,
-                buildName: process.env.BROWSERSTACK_BUILD_NAME || 'WEB_Build',
-                networkLogs: "true",
-                debug: "true",
-            }
-        },
-        // Add more capabilities for other browsers or devices as needed
-    ],
-
-    // ====================
-    // Test Configurations
-    // ====================
-    // logLevel: 'info', // Set the log level
-    // bail: 0, // Set to 1 to stop the test suite after the first test failure
-    // baseUrl: '', // Specify the base URL of your application
-    // waitforTimeout: 90000, // Set the timeout for all waitFor* commands
-    // connectionRetryTimeout: 90000, // Set the timeout in milliseconds for test retries
-    // connectionRetryCount: 2, // Set the number of times to retry the entire spec file
-
-    // ====================
-    // Framework
-    // ====================
-    // framework: 'mocha', // Use the Mocha framework
-    // reporters: ['spec'
-
-    // ], // Use the spec reporter
-
-    // ====================
-    // Hooks
-    // ====================
-    before: function (capabilities, specs) {
-        browser.maximizeWindow()
-        process.env.BS_SESSION_TYPE = "automate";
-    },
-
-
-
-    // // ====================
-    // // Mocha Options
-    // // ====================
-    // mochaOpts: {
-    //     ui: 'bdd', // Set the test interface to BDD
-    //     timeout: 90000, // Set the timeout for test cases in milliseconds
-    // },
-}]);
-
-module.exports = apiconfig;

package/config/common.mobile.conf.js

@@ -1,45 +0,0 @@
-const deepmerge = require('deepmerge')
-const commonconfig = require('./commonconfig');
-const isBrowserStackEnabled = process.env.BROWSERSTACK;
-console.log("isBrowserStackEnabled", isBrowserStackEnabled);
-
-const browserStackConfig = isBrowserStackEnabled === 'true' ? {
-    user: process.env.BROWSERSTACK_USERNAME,
-    key: Buffer.from(process.env.BROWSERSTACK_ACCESS_KEY, 'base64').toString('utf-8'),
-    commonCapabilities: {
-        'bstack:options': {
-            projectName: process.env.PROJECTNAME || "roboticodigital",
-            sessionName: 'Automation test session',
-            debug: true,
-            networkLogs: true
-        }
-    }
-}: {};
-
-const commonmobconfig = deepmerge.all([
-    
-    {
-        logLevel: 'info',
-        coloredLogs: true,
-        screenshotPath: './errorShots/',
-        baseUrl: '',
-        waitforTimeout: 90000,
-        connectionRetryTimeout: 90000,
-        connectionRetryCount: 2,
-
-        framework: 'mocha',
-        mochaOpts: {
-            ui: 'bdd',
-            timeout: 300000
-        },
-
-        maxInstances: 10,
-
-        updateJob: false,
-        reporters: ['spec'],
-    },
-    browserStackConfig,
-    commonconfig, 
-]);
-
-module.exports = commonmobconfig;

package/config/injectimage.js

@@ -1,4 +0,0 @@
-    
-    await driver.execute('browserstack_executor: {"action":"cameraImageInjection", "arguments": {"imageUrl" : "media://1965674f959d00128d4fb649dcc6823bd00b00cb"}}');
-    
-    await driver.execute('browserstack_executor: {"action":"cameraVideoInjection", "arguments": {"videoUrl" : "media://1920c80136e1c7e2278e15d820845ed64a676e92"}}')

package/config/ios.conf.js

@@ -1,47 +0,0 @@
-// This is the configuration file for iOS devices
-const deepmerge = require('deepmerge')
-process.env.BROWSERSTACK = true;
-const commonmobileconfig = require('./common.mobile.conf');
-
-const iosconfig = deepmerge.all([commonmobileconfig, {
-  services: [
-    [
-      'browserstack',
-      {
-        // testObservability: true,
-        // buildIdentifier: `#${process.env.BUILD_NUMBER}`,
-        browserstackLocal: process.env.BROWSERSTACK_LOCAL || false,
-        opts: {
-          forcelocal: false,
-          // localIdentifier: "webdriverio-appium"
-        },
-        app: process.env.BROWSERSTACK_APP_PATH || 'bs://d6588d0899a2ac5c485d4784af9ad28d06b98c44'
-      }
-    ]
-  ],
-
-  capabilities: [{
-    'bstack:options': {
-      projectName: process.env.PROJECTNAME || "roboticodigital",
-      deviceName: process.env.DEVICENAME || "iPhone 15 Pro Max",
-      osVersion: process.env.OSVERSION || "17",
-      platformName: 'iOS',
-      interactiveDebugging: true,
-      buildName: process.env.BROWSERSTACK_BUILD_NAME || 'IOS_Build',
-      networkLogs: "true",
-      debug: "true",
-      appProfiling: "true", 
-      //enableCameraImageInjection: "true",
-      deviceOrientation: process.env.DEVICENAME.toLowerCase().includes('tab') ? 'landscape' : 'portrait',
-
-    }
-  }],
-
-  before: function (capabilities, specs) {
-    // browser.maximizeWindow()
-    process.env.BS_SESSION_TYPE = "app-automate";
-  },
-}]);
-
-module.exports = iosconfig;
-