froth-webdriverio-framework 0.1.1

package/android.conf.js

@@ -0,0 +1,95 @@
+exports.config = {
+
+  user: process.env.BROWSERSTACK_USERNAME || 'subhrasubudhi_uf8nhj',
+  key: process.env.BROWSERSTACK_ACCESS_KEY || 'DUGGqze7p9QMZb84y66s',
+
+  hostname: 'hub.browserstack.com',
+
+  services: [
+    [
+      'browserstack',
+      {
+        buildIdentifier: '${BUILD_NUMBER}',
+        browserstackLocal: true,
+        opts: { forcelocal: false, localIdentifier: "webdriverio-appium-app-browserstack-repo" },
+        // app: process.env.BROWSERSTACK_APP_PATH || '/Users/subhrasubudhi/WORKSPACES/WEBDRIVERIO/codeceptjs/android/test/Geneco.apk',
+        app: 'bs://55f48309e6776984188c25d044bde2b3d90ea057'
+      }
+    ]
+  ],
+
+  capabilities: [{
+    'bstack:options': {
+      deviceName: 'Samsung Galaxy S21',
+      osVersion: "11.0"
+    }
+  }
+    //, {
+    //   'bstack:options': {
+    //     deviceName: 'Samsung Galaxy S10e',
+    //     osVersion: "9.0"
+    //   }
+    // }
+  ],
+
+  commonCapabilities: {
+    'bstack:options': {
+      projectName: "YTL APP",
+      buildName: 'Android Yes App Build',
+      sessionName: 'Yes App Session',
+      debug: true,
+      networkLogs: true
+      // source: 'webdriverio:appium-sample-sdk:v1.0'
+    }
+  },
+  maxInstances: 10,
+
+  updateJob: false,
+  specs: [
+    [
+      //'./android/specs/yesapp/login.js'
+
+    ]],
+  exclude: [],
+  logLevel: 'info',
+  coloredLogs: true,
+  screenshotPath: './androidReports/',
+  baseUrl: '',
+  waitforTimeout: 10000,
+  connectionRetryTimeout: 90000,
+  connectionRetryCount: 3,
+
+  framework: 'mocha',
+  mochaOpts: {
+    ui: 'bdd',
+    timeout: 60000
+  },
+  before: function () {
+    const chai = require('chai');
+    global.expect = chai.expect;
+  },
+
+  reporters: [
+    'spec',
+    ['allure', {
+      outputDir: './androidReports/allure-results', // Specify the output directory
+      disableWebdriverStepsReporting: true,
+      disableWebdriverScreenshotsReporting: true,
+    }],
+  ],
+  afterStep: function (test, context, { error, result, duration, passed, retries }) {
+    // if (passed) {
+    browser.takeScreenshot();
+    // }
+  },
+  afterTest: async function (test, context, { error, result, duration, passed, retries }) {
+    if (passed) { await browser.takeScreenshot() }
+  }
+
+};
+
+// Code to support common capabilities
+exports.config.capabilities.forEach(function (caps) {
+  for (let key in exports.config.commonCapabilities)
+    caps[key] = { ...caps[key], ...exports.config.commonCapabilities[key] };
+});

package/api/index.js

@@ -0,0 +1,18 @@
+const express = require('express')
+const app = express()
+const port = 5000
+
+let count = 0;
+
+app.get('/api', (req, res) => {
+res.json({count})
+})
+
+app.post('/api', (req, res) => {
+++count;
+res.json({count});
+});
+
+app.listen(port, () => {
+console.log(`Example app listening on port ${port}`)
+})

package/config/commonconfig.js

@@ -0,0 +1,77 @@
+const USER_DIR = process.env['user.dir'];
+
+const commonconfig = {
+     /**
+      * Gets executed before the suite starts (in Mocha/Jasmine only).
+      * @param {object} suite suite details
+      */
+     beforeSuite: function (suite) {
+         console.log("Running suite:", suite.title);
+     },
+ 
+     /**
+     * Function to be executed before a test (in Mocha/Jasmine only)
+     * @param {object} test    test object
+     * @param {object} context scope object the test was executed with
+     */
+     beforeTest: function (test, context) {
+         console.log("Test Name:", test.title);
+         console.log("Context Details:", context.title);
+         console.log("File Name:", test.file);
+         
+     },
+ 
+     afterStep: function (test, context, { error, result, duration, passed, retries }) {
+         // if (passed) {
+         browser.takeScreenshot();
+         // }
+     },
+     // afterTest: async function (test, context, { error, result, duration, passed, retries }) {
+     //     if (passed) { await browser.takeScreenshot() }
+     // },
+     /**
+      * Function to be executed after a test (in Mocha/Jasmine only)
+      * @param {object}  test             test object
+      * @param {object}  context          scope object the test was executed with
+      * @param {Error}   result.error     error object in case the test fails, otherwise `undefined`
+      * @param {*}       result.result    return object of test function
+      * @param {number}  result.duration  duration of test
+      * @param {boolean} result.passed    true if test has passed, otherwise false
+      * @param {object}  result.retries   information about spec related retries, e.g. `{ attempts: 0, limit: 0 }`
+      */
+     afterTest: function (test, context, { error, result, duration, passed, retries }) {
+         console.log(`Test '${test.title}' finished.`);
+         console.log(`Duration: ${duration}ms`);
+         console.log(`Passed: ${passed}`);
+         if (error) {
+             console.error(`Error: ${error.message}`);
+         }
+         console.log('---------------------------------------');
+     },
+      /**
+      * Hook that gets executed after the suite has ended (in Mocha/Jasmine only).
+      * @param {object} suite suite details
+      */
+     afterSuite: function (suite) {
+         console.log(`Test suite '${suite.title}' has ended.`);
+     },
+      /**
+      * Gets executed after all tests are done. You still have access to all global variables from
+      * the test.
+      * @param {number} result 0 - test pass, 1 - test fail
+      * @param {Array.<Object>} capabilities list of capabilities details
+      * @param {Array.<String>} specs List of spec file paths that ran
+      */
+     after: function (result, capabilities, specs) {
+         console.log('All tests are done.');
+         console.log(`Result: ${result === 0 ? 'Pass' : 'Fail'}`);
+         console.log('Capabilities:');
+         console.log(capabilities);
+         console.log('Specs:');
+         console.log(specs);
+     },
+     
+ };
+ 
+ module.exports = commonconfig;
+ 

package/ios.conf.js

@@ -0,0 +1,75 @@
+
+exports.config = {
+  user: process.env.BROWSERSTACK_USERNAME || 'subhrasubudhi_uf8nhj',
+  key: process.env.BROWSERSTACK_ACCESS_KEY || 'DUGGqze7p9QMZb84y66s',
+
+  services: [
+    [
+      'browserstack',
+      {
+        buildIdentifier: '${BUILD_NUMBER}',
+        browserstackLocal: true,
+        opts: { forcelocal: false, localIdentifier: "webdriverio-appium-app-browserstack-repo" },
+        //app: process.env.BROWSERSTACK_APP_PATH || '/Users/subhrasubudhi/WORKSPACES/WEBDRIVERIO/codeceptjs/ios/test/BStackSampleApp.ipa'
+        app: 'bs://512eefa5c0b9f103907f0c69f6ef811defc4a9cb'
+      }
+    ]
+  ],
+
+  capabilities: [{
+    'bstack:options': {
+      deviceName: "iPhone 15 Pro Max",
+      osVersion: "17"
+    }
+  }
+
+  ],
+
+  commonCapabilities: {
+    'bstack:options': {
+      projectName: "Yes App",
+      buildName: 'IOS Yes App build',
+      sessionName: 'Yes App Session',
+      debug: true,
+      networkLogs: true,
+      // source: 'webdriverio:appium-sample-sdk:v1.0'
+    }
+  },
+
+  maxInstances: 10,
+
+  updateJob: false,
+  specs: [
+    //  './specs/single_test.js'
+  ],
+  exclude: [],
+
+
+  logLevel: 'info',
+  coloredLogs: true,
+  screenshotPath: './errorShots/',
+  baseUrl: '',
+  waitforTimeout: 10000,
+  connectionRetryTimeout: 90000,
+  connectionRetryCount: 3,
+
+  framework: 'mocha',
+
+  mochaOpts: {
+    ui: 'bdd',
+    timeout: 60000
+  },
+
+  before: function () {
+    const chai = require('chai');
+    global.expect = chai.expect;
+  },
+
+
+};
+
+// Code to support common capabilities
+exports.config.capabilities.forEach(function (caps) {
+  for (let key in exports.config.commonCapabilities)
+    caps[key] = { ...caps[key], ...exports.config.commonCapabilities[key] };
+});

package/local.log

@@ -0,0 +1,8 @@
+
+
+Thu Feb 15 2024 20:15:19:833 GMT+0800 (+08) -- Starting configuration console on http://localhost:45454
+Thu Feb 15 2024 20:15:21:656 GMT+0800 (+08) -- [SUCCESS] You can now access your local server(s) in our remote browser
+
+Thu Feb 15 2024 20:15:22:756 GMT+0800 (+08) -- Press Ctrl-C to exit
+
+

package/mobile/commonMethods/Utils.js

@@ -0,0 +1,21 @@
+const ScrollToEnd = require('./ScrollToEnd');
+const ClickIfVisible= require('./clickIfVisible');
+const VerifyTextInFieldAttribute= require('./verifyTextInFieldAttribute');
+const ScrollToBeginning = require('./scrollToBeginning');
+const ScrollToLeft = require('./scrollToLeft');
+const ScrollToRight = require('./scrollToRight');
+const ScrollDownToView= require('./ScrollDownToView');
+const ScrollRightToView= require('./ScrollRightToView');
+const verifyText= require('./verifyText');
+// Export the functions
+module.exports = {
+    ScrollToEnd,
+    ClickIfVisible,
+    VerifyTextInFieldAttribute,
+    ScrollToBeginning,
+    ScrollToLeft,
+    ScrollToRight,
+    ScrollRightToView,
+    ScrollDownToView,
+    verifyText
+};

package/mobile/commonMethods/clickIfVisible.js

@@ -0,0 +1,23 @@
+async function clickIfVisible(elementSelector) {
+  try {
+    let isDisplayed;
+    // Wait for the element to be visible
+    await driver.waitUntil(async () => {
+      console.log("Waiting for element to be visible");
+      const element = await driver.$(elementSelector);
+      isDisplayed = await element.isDisplayed();
+      console.log("Element is displayed:", isDisplayed);
+      if (isDisplayed) {
+        // Get the actual text from the element
+        const element = await driver.$(elementSelector);
+        await element.click();
+        console.log("Element is clicked successfully.");
+        return ;
+      } 
+    }, { timeout: 30000 });
+  } catch (error) {
+    console.error("Element not found or not visible within 30 seconds");
+  }
+}
+
+module.exports = clickIfVisible;

package/mobile/commonMethods/getdata.js

@@ -0,0 +1,38 @@
+const fs = require('fs');
+const path = require('path');
+const directory = '/Users/subhrasubudhi/WORKSPACES/WEBDRIVERIO/TEST/mobile/Testdata'; // specify your directory path
+async function getdata(filename_propertyname) {
+    try {
+        console.log('data:', filename_propertyname);
+        const parts = filename_propertyname.split(".");
+        const property = parts[1];
+        console.log('property:', property);
+        fileName = parts[0] + '.json';
+        console.log('filename:', fileName);
+
+        const files = await fs.promises.readdir(directory);
+        const file = files.find(file => file === fileName);
+
+        if (file) {
+            const filePath = path.join(directory, file);
+            const jsonData = await fs.promises.readFile(filePath, 'utf-8');
+            const parsedData = JSON.parse(jsonData);
+            console.log(parsedData);
+            const value = parsedData[property];
+            console.log(value);
+            return value;
+        } else {
+            throw new Error(`File '${_filename}' not found in directory '${directory}'.`);
+        }
+    } catch (error) {
+        console.error('Error occurred:', error);
+        throw error; // Rethrow the error for the caller to handle.
+    }
+}
+module.exports = getdata;
+// Example usage:
+// specify your file name
+
+console.log(getdata('data1.env'));
+
+

package/mobile/commonMethods/scrollDownToView.js

@@ -0,0 +1,12 @@
+async function ScrollDownToView(text) {
+
+    try {
+        console.log('Scrolling down until text is found');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).scrollTextIntoView("' + text + '")');
+        await driver.pause(3000);
+        console.log('Scrolled down completed');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollDownToView;

package/mobile/commonMethods/scrollRightToView.js

@@ -0,0 +1,12 @@
+async function ScrollRightToView(text) {
+
+    try {
+        console.log('Scrolling to right until text is found');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).setAsHorizontalList().scrollTextIntoView("' + text + '")');
+        await driver.pause(3000);
+        console.log('Scrolled to right completed');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollRightToView;

package/mobile/commonMethods/scrollToBeginning.js

@@ -0,0 +1,12 @@
+async function ScrollToBeginning(maxSwipes,steps) {
+
+    try {
+        console.log('Scrolling to beginning');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).scrollToBeginning('+maxSwipes+','+steps+')');
+        await driver.pause(3000);
+        console.log('Scrolled to beginning');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollToBeginning;

package/mobile/commonMethods/scrollToEnd.js

@@ -0,0 +1,12 @@
+async function ScrollToEnd(maxSwipes,steps) {
+
+    try {
+        console.log('Scrolling to end');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).scrollToEnd('+maxSwipes+','+steps+')');
+        await driver.pause(3000);
+        console.log('Scrolled to end');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollToEnd;

package/mobile/commonMethods/scrollToLeft.js

@@ -0,0 +1,12 @@
+async function ScrollToLeft(steps) {
+
+    try {
+        console.log('Scrolling to left');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).scrollable.setAsHorizontalList().scrollBackward('+steps+')');
+        await driver.pause(3000);
+        console.log('Scrolled to left');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollToLeft;

package/mobile/commonMethods/scrollToRight.js

@@ -0,0 +1,12 @@
+async function ScrollToRight(steps) {
+
+    try {
+        console.log('Scrolling to right');
+        await $('android=new UiScrollable(new UiSelector().scrollable(true)).scrollable.setAsHorizontalList().scrollForward('+steps+')');
+        await driver.pause(3000);
+        console.log('Scrolled to right');
+    } catch (error) {
+        console.error(error.message);
+    }
+}
+module.exports = ScrollToRight;

package/mobile/commonMethods/test.js

@@ -0,0 +1,19 @@
+const fs = require("fs");
+
+function readAndParseJSON(filename) {
+    const [fileName, fileExtension] = filename.split(".");
+    const jsonFilePath = fileName + ".json";
+    const constantProperty = fileExtension;
+
+    const filePath = `/Users/subhrasubudhi/WORKSPACES/WEBDRIVERIO/TEST/mobile/Testdata/${jsonFilePath}`;
+
+    const jsonData = fs.readFileSync(filePath, "utf-8");
+    const parsedData = JSON.parse(jsonData);
+    
+    console.log(parsedData);
+    const value = parsedData[constantProperty];
+    return value;
+}
+
+const data1 = readAndParseJSON("data1.env");
+console.log(data1);

package/mobile/commonMethods/verifyText.js

@@ -0,0 +1,28 @@
+// Function to verify text in Android app
+async function verifyText(driver, elementSelector, expectedText) {
+  try {
+    // Wait for the element to be visible
+    await driver.waitUntil(async () => {
+      const element = await driver.$(elementSelector);
+      return await element.isDisplayed();
+    }, { timeout: 30000});
+
+    // Get the actual text from the element
+    const element = await driver.$(elementSelector);
+    const actualText = await element.getText();
+
+    // Compare the actual text with the expected text
+    if (actualText === expectedText) {
+      console.log('Text verification passed. Actual text:', actualText, 'Expected text:', expectedText);
+      return true;
+    } else {
+      console.warn('Text verification failed. Actual text:', actualText, 'Expected text:', expectedText);
+    }
+  } catch (error) {
+    console.error('Error occurred while verifying text:', error);
+  }
+}
+
+module.exports = verifyText;
+
+

package/mobile/commonMethods/verifyTextInFieldAttribute.js

@@ -0,0 +1,17 @@
+
+async function verifyTextInFieldAttribute(element, attribute, expectedText, driver) {
+
+    try {
+        let ele = await driver.$(element);
+        // Get the actual text from the specified attribute
+        const actualText = await ele.getAttribute(attribute);
+
+        // Assert that the actual text matches the expected text
+        assert.strictEqual(actualText, expectedText, `Expected text: ${expectedText}, Actual text: ${actualText}`);
+        console.log('Text verification passed!');
+    } catch (error) {
+        console.log('Text verification failed:', `Expected text: ${expectedText}, Actual text: ${actualText}`);
+        console.error(error.message);
+    }
+}
+module.exports = verifyTextInFieldAttribute;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "froth-webdriverio-framework",
+  "version": "0.1.1",
+  "readme": "WendriverIO Integration with [BrowserStack]",
+  "description": "WebdriverIO and BrowserStack App Automate",
+  "license": "MIT",
+  "scripts": {
+    "wdio:ios": "npx wdio ./ios.conf.js",
+    "wdio:android": "npx wdio ./android.conf.js",
+    "wdio:web": "npx wdio ./web.conf.js",
+    "wdio:webbs": "npx wdio ./web.conf.bs.js",
+    "wdio:ios:local": "npx wdio ./ios.local.conf.js",
+    "android:generate-allure-report": "allure generate ./mobile/androidReports/allure-results --clean && allure open",
+    "ios:generate-allure-report": "allure generate  ./mobile/iosReports/allure-results --clean && allure open",
+    "web:generate-allure-report": "allure generate ./webReports/allure-results --clean && allure open",
+    "lint": "eslint ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RoboticoDigitalProjects/froth-webdriverio.git"
+  },
+  "keywords": [
+    "webdriverio",
+    "browserstack",
+    "appium",
+    "tests"
+  ],
+  "devDependencies": {
+    "@wdio/appium-service": "^8.36.1",
+    "@wdio/browserstack-service": "^8.36.1",
+    "@wdio/cli": "^8.36.1",
+    "@wdio/local-runner": "^8.36.1",
+    "@wdio/mocha-framework": "^8.36.1",
+    "@wdio/spec-reporter": "^8.36.1",
+    "appium": "^2.5.4",
+    "appium-uiautomator2-driver": "^3.2.0"
+  }
+}