@cuppet/core 1.0.0 → 1.0.1

package/src/appiumTesting.js

@@ -1,79 +1,79 @@
-/**
- * @module appiumTesting
- */
-const config = require('config');
-
-module.exports = {
-    /**
-     * Handles UiSelector case as it requires special prefixing
-     * @param {string} selector
-     * @returns {string} - Either the original selector or a UiSelector formatted string
-     */
-    prepareSelector: function (selector) {
-        if (selector.startsWith('.')) {
-            // If the selector starts with ., treat it as a UiSelector
-            // For example .text('Example Text') becomes android='new UiSelector().text("Example Text")'
-            return `android=new UiSelector()${selector}`;
-        } else {
-            return selector; // Otherwise, return the selector as is
-        }
-    },
-
-    /**
-     * @param {import('@wdio/globals').driver} driver - The WebDriverIO appium instance.
-     * @param {string} androidPackage - The name of the Android package.
-     * @param {string} activity - The name of the Android activity.
-     * @returns {Promise<void>} - Resolves when the session is reloaded successfully.
-     * @throws Will throw an error if the element is not found or not clickable.
-     */
-    reloadSession: async function (driver, androidPackage, activity) {
-        const appiumCapabilities = config.get('appiumCapabilities');
-        const capabilities = {
-            ...appiumCapabilities,
-            'appium:appPackage': androidPackage,
-            'appium:appActivity': activity,
-        };
-        // Reload the session with the updated capabilities
-        await driver.reloadSession(capabilities);
-    },
-
-    /**
-     * @param {import('@wdio/globals')} driver - The WebDriverIO appium instance.
-     * @param {string} selector - The selector of the element to click.
-     * Possible values for selector: https://webdriver.io/docs/selectors/
-     * - A UiSelector string, e.g. '.text("Example Text")'
-     * - An ID selector (e.g. 'com.example:id/button1')
-     * - A class name selector (e.g. 'android.widget.Button')
-     * - An accessibility ID selector (e.g. '~button1')
-     * @returns {Promise<void>} - Resolves when the element is clicked successfully.
-     * @throws Will throw an error if the element is not found or not clickable.
-     */
-    clickElement: async function (driver, selector) {
-        try {
-            // $ and $$ are not async functions, as Wdio uses lazy loading.
-            // The actual element is not fetched until an action is performed like .click(), .getText(), .isDisplayed(), etc.
-            const element = driver.$(selector);
-            await element.waitForDisplayed({ timeout: 5000 });
-            await element.click();
-        } catch (error) {
-            throw new Error(`Error clicking element with selector ${selector}: ${error}`);
-        }
-    },
-
-    /**
-     * @param {import('@wdio/globals').driver} driver - The WebDriverIO appium instance.
-     * @param {string} selector - The selector of the element.
-     * @returns {Promise<void>} - Resolves when the element is scrolled into view successfully.
-     * @throws Will throw an error if the element is not found.
-     */
-    scrollToElement: async function (driver, selector) {
-        try {
-            await driver.findElement(
-                '-android uiautomator',
-                `new UiScrollable(new UiSelector().scrollable(true)).scrollIntoView(new UiSelector().${selector})`
-            );
-        } catch (error) {
-            throw new Error(`Cannot find element with selector ${selector}: ${error}`);
-        }
-    },
-};
+/**
+ * @module appiumTesting
+ */
+const config = require('config');
+
+module.exports = {
+    /**
+     * Handles UiSelector case as it requires special prefixing
+     * @param {string} selector
+     * @returns {string} - Either the original selector or a UiSelector formatted string
+     */
+    prepareSelector: function (selector) {
+        if (selector.startsWith('.')) {
+            // If the selector starts with ., treat it as a UiSelector
+            // For example .text('Example Text') becomes android='new UiSelector().text("Example Text")'
+            return `android=new UiSelector()${selector}`;
+        } else {
+            return selector; // Otherwise, return the selector as is
+        }
+    },
+
+    /**
+     * @param {import('@wdio/globals').driver} driver - The WebDriverIO appium instance.
+     * @param {string} androidPackage - The name of the Android package.
+     * @param {string} activity - The name of the Android activity.
+     * @returns {Promise<void>} - Resolves when the session is reloaded successfully.
+     * @throws Will throw an error if the element is not found or not clickable.
+     */
+    reloadSession: async function (driver, androidPackage, activity) {
+        const appiumCapabilities = config.get('appiumCapabilities');
+        const capabilities = {
+            ...appiumCapabilities,
+            'appium:appPackage': androidPackage,
+            'appium:appActivity': activity,
+        };
+        // Reload the session with the updated capabilities
+        await driver.reloadSession(capabilities);
+    },
+
+    /**
+     * @param {import('@wdio/globals')} driver - The WebDriverIO appium instance.
+     * @param {string} selector - The selector of the element to click.
+     * Possible values for selector: https://webdriver.io/docs/selectors/
+     * - A UiSelector string, e.g. '.text("Example Text")'
+     * - An ID selector (e.g. 'com.example:id/button1')
+     * - A class name selector (e.g. 'android.widget.Button')
+     * - An accessibility ID selector (e.g. '~button1')
+     * @returns {Promise<void>} - Resolves when the element is clicked successfully.
+     * @throws Will throw an error if the element is not found or not clickable.
+     */
+    clickElement: async function (driver, selector) {
+        try {
+            // $ and $$ are not async functions, as Wdio uses lazy loading.
+            // The actual element is not fetched until an action is performed like .click(), .getText(), .isDisplayed(), etc.
+            const element = driver.$(selector);
+            await element.waitForDisplayed({ timeout: 5000 });
+            await element.click();
+        } catch (error) {
+            throw new Error(`Error clicking element with selector ${selector}: ${error}`);
+        }
+    },
+
+    /**
+     * @param {import('@wdio/globals').driver} driver - The WebDriverIO appium instance.
+     * @param {string} selector - The selector of the element.
+     * @returns {Promise<void>} - Resolves when the element is scrolled into view successfully.
+     * @throws Will throw an error if the element is not found.
+     */
+    scrollToElement: async function (driver, selector) {
+        try {
+            await driver.findElement(
+                '-android uiautomator',
+                `new UiScrollable(new UiSelector().scrollable(true)).scrollIntoView(new UiSelector().${selector})`
+            );
+        } catch (error) {
+            throw new Error(`Cannot find element with selector ${selector}: ${error}`);
+        }
+    },
+};

package/src/visualRegression.js

@@ -1,67 +1,67 @@
-const config = require('config');
-const backStop = require('backstopjs');
-const backStopConfig = require('../backStopData/backStopConfig.json');
-
-module.exports = {
-    /**
-     *
-     * @returns {Object} - the backstop configuration object
-     */
-    backstopConfigPrepare: function () {
-        let newConfig = backStopConfig;
-        newConfig.id = process.env.NODE_CONFIG_ENV;
-        newConfig.viewports[0].width = Number(config.get('viewport.width'));
-        newConfig.viewports[0].height = Number(config.get('viewport.height'));
-        newConfig.engineOptions.args = config.get('args');
-        return newConfig;
-    },
-
-    /**
-     *
-     * @param command
-     * @param configObject
-     * @returns {Promise<void>}
-     */
-    runBackStop: async function (command, configObject) {
-        await backStop(command, { config: configObject })
-            .then(() => {
-                console.log(`${command} backstop run executed successfully!`);
-                // test successful
-            })
-            .catch((error) => {
-                throw new Error(error);
-            });
-    },
-
-    /**
-     *
-     * @param scenarioName
-     * @param path
-     * @param testCommand
-     * @returns {Promise<void>}
-     */
-    runBackStopSingleScenario: async function (scenarioName, path, testCommand) {
-        const newConfig = this.backstopConfigPrepare();
-        newConfig.scenarios[0].label = scenarioName;
-        newConfig.scenarios[0].url = path;
-        await this.runBackStop(testCommand, newConfig);
-    },
-    /**
-     *
-     * @param pages
-     * @param testCommand
-     * @returns {Promise<void>}
-     */
-    runBackstopMultiplePages: async function (pages, testCommand) {
-        const newConfig = this.backstopConfigPrepare();
-        newConfig.scenarios = [];
-        pages.forEach((page) => {
-            newConfig.scenarios.push({
-                label: page.label,
-                url: page.url,
-                // Add other scenario properties as needed...
-            });
-        });
-        await this.runBackStop(testCommand, newConfig);
-    },
-};
+const config = require('config');
+const backStop = require('backstopjs');
+const backStopConfig = require('../backStopData/backStopConfig.json');
+
+module.exports = {
+    /**
+     *
+     * @returns {Object} - the backstop configuration object
+     */
+    backstopConfigPrepare: function () {
+        let newConfig = backStopConfig;
+        newConfig.id = process.env.NODE_CONFIG_ENV;
+        newConfig.viewports[0].width = Number(config.get('viewport.width'));
+        newConfig.viewports[0].height = Number(config.get('viewport.height'));
+        newConfig.engineOptions.args = config.get('args');
+        return newConfig;
+    },
+
+    /**
+     *
+     * @param command
+     * @param configObject
+     * @returns {Promise<void>}
+     */
+    runBackStop: async function (command, configObject) {
+        await backStop(command, { config: configObject })
+            .then(() => {
+                console.log(`${command} backstop run executed successfully!`);
+                // test successful
+            })
+            .catch((error) => {
+                throw new Error(error);
+            });
+    },
+
+    /**
+     *
+     * @param scenarioName
+     * @param path
+     * @param testCommand
+     * @returns {Promise<void>}
+     */
+    runBackStopSingleScenario: async function (scenarioName, path, testCommand) {
+        const newConfig = this.backstopConfigPrepare();
+        newConfig.scenarios[0].label = scenarioName;
+        newConfig.scenarios[0].url = path;
+        await this.runBackStop(testCommand, newConfig);
+    },
+    /**
+     *
+     * @param pages
+     * @param testCommand
+     * @returns {Promise<void>}
+     */
+    runBackstopMultiplePages: async function (pages, testCommand) {
+        const newConfig = this.backstopConfigPrepare();
+        newConfig.scenarios = [];
+        pages.forEach((page) => {
+            newConfig.scenarios.push({
+                label: page.label,
+                url: page.url,
+                // Add other scenario properties as needed...
+            });
+        });
+        await this.runBackStop(testCommand, newConfig);
+    },
+};

package/stepDefinitions.js

@@ -1,17 +1,17 @@
-// Cuppet Core Step Definitions
-// This file exports all step definitions for use in consuming projects
-
-module.exports = {
-    accessibilitySteps: require('./features/app/stepDefinitions/accessibilitySteps'),
-    apiSteps: require('./features/app/stepDefinitions/apiSteps'),
-    appiumSteps: require('./features/app/stepDefinitions/appiumSteps'),
-    generalSteps: require('./features/app/stepDefinitions/generalSteps'),
-    helperSteps: require('./features/app/stepDefinitions/helperSteps'),
-    iframeSteps: require('./features/app/stepDefinitions/iframeSteps'),
-    ifVisibleSteps: require('./features/app/stepDefinitions/ifVisibleSteps'),
-    lighthouseSteps: require('./features/app/stepDefinitions/lighthouseSteps'),
-    pageElements: require('./features/app/stepDefinitions/pageElements'),
-    pageElementsConfig: require('./features/app/stepDefinitions/pageElementsConfig'),
-    pageElementsJson: require('./features/app/stepDefinitions/pageElementsJson'),
-    visualRegressionSteps: require('./features/app/stepDefinitions/visualRegressionSteps')
-}; 
+// Cuppet Core Step Definitions
+// This file exports all step definitions for use in consuming projects
+
+module.exports = {
+    accessibilitySteps: require('./features/app/stepDefinitions/accessibilitySteps'),
+    apiSteps: require('./features/app/stepDefinitions/apiSteps'),
+    appiumSteps: require('./features/app/stepDefinitions/appiumSteps'),
+    generalSteps: require('./features/app/stepDefinitions/generalSteps'),
+    helperSteps: require('./features/app/stepDefinitions/helperSteps'),
+    iframeSteps: require('./features/app/stepDefinitions/iframeSteps'),
+    ifVisibleSteps: require('./features/app/stepDefinitions/ifVisibleSteps'),
+    lighthouseSteps: require('./features/app/stepDefinitions/lighthouseSteps'),
+    pageElements: require('./features/app/stepDefinitions/pageElements'),
+    pageElementsConfig: require('./features/app/stepDefinitions/pageElementsConfig'),
+    pageElementsJson: require('./features/app/stepDefinitions/pageElementsJson'),
+    visualRegressionSteps: require('./features/app/stepDefinitions/visualRegressionSteps'),
+};