@cuppet/core 1.0.0 → 1.0.1

package/features/app/stepDefinitions/accessibilitySteps.js

@@ -1,17 +1,17 @@
-/**
- * @type {string}
- * @name scenarioName - name of the scenario from the Before hook
- */
-const { Given, When } = require('@cucumber/cucumber');
-const accessibilitySteps = require('../../../src/accessibilityTesting');
-const dataStorage = require('../../../src/dataStorage');
-const main = require('../../../src/mainFunctions');
-
-Given('I validate the saved page accessibility', async function () {
-    const path = await dataStorage.getVariable('path');
-    await accessibilitySteps.validatePageAccessibility(this.browser, this.page, this.scenarioName, path);
-});
-When('I validate the accessibility of the {string} page', async function (path) {
-    const preparedPath = main.prepareUrl(path);
-    await accessibilitySteps.validatePageAccessibility(this.browser, this.page, this.scenarioName, preparedPath);
-});
+/**
+ * @type {string}
+ * @name scenarioName - name of the scenario from the Before hook
+ */
+const { Given, When } = require('@cucumber/cucumber');
+const accessibilitySteps = require('../../../src/accessibilityTesting');
+const dataStorage = require('../../../src/dataStorage');
+const main = require('../../../src/mainFunctions');
+
+Given('I validate the saved page accessibility', async function () {
+    const path = await dataStorage.getVariable('path');
+    await accessibilitySteps.validatePageAccessibility(this.browser, this.page, this.scenarioName, path);
+});
+When('I validate the accessibility of the {string} page', async function (path) {
+    const preparedPath = main.prepareUrl(path);
+    await accessibilitySteps.validatePageAccessibility(this.browser, this.page, this.scenarioName, preparedPath);
+});

package/features/app/stepDefinitions/apiSteps.js

@@ -1,52 +1,52 @@
-const { Given, When, Then } = require('@cucumber/cucumber');
-const apiSteps = require('../../../src/apiFunctions');
-const main = require('../../../src/mainFunctions');
-const dataStorage = require('../../../src/dataStorage');
-
-Given('that I send a {string} request to {string}', async function (method, path) {
-    await apiSteps.sendRequest(method, path);
-});
-When(
-    'I send a {string} request to {string} with http header {string} and value {string}',
-    async function (method, path, headerName, headerValue) {
-        const name = await dataStorage.checkForSavedVariable(headerName);
-        const value = await dataStorage.checkForSavedVariable(headerValue);
-        const headers = {};
-        headers[name] = value;
-        await apiSteps.sendRequest(method, path, headers);
-    }
-);
-Given('the response code should be {string}', async function (code) {
-    await apiSteps.validateResponseCode(code);
-});
-Then('the response should be an {string}', async function (type) {
-    await apiSteps.validateResponseType(type);
-});
-Then('the property {string} should be an {string}', async function (property, type) {
-    await apiSteps.propertyIs(property, type);
-});
-Then('the response should have property {string} with value {string}', async function (property, value) {
-    await apiSteps.propertyHasValue(property, value);
-});
-When('I store {string} to {string} variable', async function (property, variable) {
-    await apiSteps.iRememberVariable(property, variable);
-});
-Given('that I have request body', async function (docString) {
-    const body = JSON.stringify(docString);
-    await apiSteps.prepareRequestBody(body);
-});
-Given(
-    'I put {string} to {string} property of {string} element in the body',
-    async function (value, property, parentObj) {
-        await apiSteps.iPutValuesInRequestBody(value, property, parentObj);
-    }
-);
-
-Given('I create json object from {string} file', async function (filePath) {
-    const checkedPath = await dataStorage.checkForSavedVariable(filePath);
-    await apiSteps.createRequestBodyFromFile(checkedPath);
-});
-Given('I validate that the page is a valid XML', async function () {
-    const currentPath = main.extractPath(this.page, true);
-    await apiSteps.validateXMLEndpoint(currentPath);
-});
+const { Given, When, Then } = require('@cucumber/cucumber');
+const apiSteps = require('../../../src/apiFunctions');
+const main = require('../../../src/mainFunctions');
+const dataStorage = require('../../../src/dataStorage');
+
+Given('that I send a {string} request to {string}', async function (method, path) {
+    await apiSteps.sendRequest(method, path);
+});
+When(
+    'I send a {string} request to {string} with http header {string} and value {string}',
+    async function (method, path, headerName, headerValue) {
+        const name = await dataStorage.checkForSavedVariable(headerName);
+        const value = await dataStorage.checkForSavedVariable(headerValue);
+        const headers = {};
+        headers[name] = value;
+        await apiSteps.sendRequest(method, path, headers);
+    }
+);
+Given('the response code should be {string}', async function (code) {
+    await apiSteps.validateResponseCode(code);
+});
+Then('the response should be an {string}', async function (type) {
+    await apiSteps.validateResponseType(type);
+});
+Then('the property {string} should be an {string}', async function (property, type) {
+    await apiSteps.propertyIs(property, type);
+});
+Then('the response should have property {string} with value {string}', async function (property, value) {
+    await apiSteps.propertyHasValue(property, value);
+});
+When('I store {string} to {string} variable', async function (property, variable) {
+    await apiSteps.iRememberVariable(property, variable);
+});
+Given('that I have request body', async function (docString) {
+    const body = JSON.stringify(docString);
+    await apiSteps.prepareRequestBody(body);
+});
+Given(
+    'I put {string} to {string} property of {string} element in the body',
+    async function (value, property, parentObj) {
+        await apiSteps.iPutValuesInRequestBody(value, property, parentObj);
+    }
+);
+
+Given('I create json object from {string} file', async function (filePath) {
+    const checkedPath = await dataStorage.checkForSavedVariable(filePath);
+    await apiSteps.createRequestBodyFromFile(checkedPath);
+});
+Given('I validate that the page is a valid XML', async function () {
+    const currentPath = main.extractPath(this.page, true);
+    await apiSteps.validateXMLEndpoint(currentPath);
+});

package/features/app/stepDefinitions/lighthouseSteps.js

@@ -1,17 +1,17 @@
-/**
- * @type {string}
- * @name scenarioName - name of the scenario from the Before hook
- */
-const { Given, When } = require('@cucumber/cucumber');
-const lighthouseMethods = require('../../../src/lighthouse');
-const dataStorage = require('../../../src/dataStorage');
-const main = require('../../../src/mainFunctions');
-
-Given('I generate lighthouse report for the saved page', async function () {
-    const path = await dataStorage.getVariable('path');
-    await lighthouseMethods.validatePageSpeed(this.page, path, this.scenarioName);
-});
-When('I generate lighthouse report for {string} page', async function (path) {
-    const preparedPath = main.prepareUrl(path);
-    await lighthouseMethods.validatePageSpeed(this.page, preparedPath, this.scenarioName);
-});
+/**
+ * @type {string}
+ * @name scenarioName - name of the scenario from the Before hook
+ */
+const { Given, When } = require('@cucumber/cucumber');
+const lighthouseMethods = require('../../../src/lighthouse');
+const dataStorage = require('../../../src/dataStorage');
+const main = require('../../../src/mainFunctions');
+
+Given('I generate lighthouse report for the saved page', async function () {
+    const path = await dataStorage.getVariable('path');
+    await lighthouseMethods.validatePageSpeed(this.page, path, this.scenarioName);
+});
+When('I generate lighthouse report for {string} page', async function (path) {
+    const preparedPath = main.prepareUrl(path);
+    await lighthouseMethods.validatePageSpeed(this.page, preparedPath, this.scenarioName);
+});

package/features/app/stepDefinitions/visualRegressionSteps.js

@@ -1,26 +1,26 @@
-/**
- * @type {string}
- * @name scenarioName - name of the scenario from the Before hook
- */
-const { Given, Then } = require('@cucumber/cucumber');
-const imageCompare = require('../../../src/visualRegression');
-const main = require('../../../src/mainFunctions');
-const dataStorage = require('../../../src/dataStorage');
-Given('I generate reference screenshot for {string}', async function (path) {
-    const storedUrl = await dataStorage.checkForVariable(path);
-    const url = await main.prepareUrl(storedUrl);
-    await imageCompare.runBackStopSingleScenario(this.scenarioName, url, 'reference');
-});
-Then('I compare {string} to reference screenshot', async function (path) {
-    const storedUrl = await dataStorage.checkForVariable(path);
-    const url = await main.prepareUrl(storedUrl);
-    await imageCompare.runBackStopSingleScenario(this.scenarioName, url, 'test');
-});
-Given('I generate reference screenshot for multiple pages', async function (docString) {
-    const pages = JSON.parse(docString);
-    await imageCompare.runBackstopMultiplePages(pages, 'reference');
-});
-Then('I compare multiple pages to their references', async function (docString) {
-    const pages = JSON.parse(docString);
-    await imageCompare.runBackstopMultiplePages(pages, 'test');
-});
+/**
+ * @type {string}
+ * @name scenarioName - name of the scenario from the Before hook
+ */
+const { Given, Then } = require('@cucumber/cucumber');
+const imageCompare = require('../../../src/visualRegression');
+const main = require('../../../src/mainFunctions');
+const dataStorage = require('../../../src/dataStorage');
+Given('I generate reference screenshot for {string}', async function (path) {
+    const storedUrl = await dataStorage.checkForVariable(path);
+    const url = await main.prepareUrl(storedUrl);
+    await imageCompare.runBackStopSingleScenario(this.scenarioName, url, 'reference');
+});
+Then('I compare {string} to reference screenshot', async function (path) {
+    const storedUrl = await dataStorage.checkForVariable(path);
+    const url = await main.prepareUrl(storedUrl);
+    await imageCompare.runBackStopSingleScenario(this.scenarioName, url, 'test');
+});
+Given('I generate reference screenshot for multiple pages', async function (docString) {
+    const pages = JSON.parse(docString);
+    await imageCompare.runBackstopMultiplePages(pages, 'reference');
+});
+Then('I compare multiple pages to their references', async function (docString) {
+    const pages = JSON.parse(docString);
+    await imageCompare.runBackstopMultiplePages(pages, 'test');
+});

package/features/app/world.js

@@ -1,4 +1,5 @@
 const { setWorldConstructor, setDefaultTimeout } = require('@cucumber/cucumber');
+const commonFields = require('./commonComponents/commonFields');
 
 setDefaultTimeout(120 * 1000);
 
@@ -6,6 +7,7 @@ setDefaultTimeout(120 * 1000);
 class World {
     constructor({ attach }) {
         this.attach = attach;
+        this.commonFields = commonFields;
     }
 
     fixSonar() {

package/features/tests/example.feature

@@ -0,0 +1,17 @@
+Feature: Open DEMO QA (as base site) and use the elements section
+
+   Scenario: Go to demo qa page and open the elements section
+     Given I go to "/"
+     And I should see "Elements" in "Cards" region
+     Then I click on the text "Elements" in the "Cards" region
+     And I wait for the text "Please select an item from left" to appear within "5" seconds
+     Then I click on the element "TextBox"
+     And I wait for "0.5" seconds
+     And I fill in "#userName" with "Example Name"
+     And I fill in "#userEmail" with "example@example.com"
+     And I fill in "#currentAddress" with "Example text in text area"
+     Then I click on the element "#submit"
+     And I wait for element with "#output" selector to appear within "2" seconds
+     And I should see the element with selector "#name"
+     And I should see the element with selector "#email"
+     And I should see the element with selector "p#currentAddress"

package/index.js

@@ -1,43 +1,43 @@
-// Core Cuppet Framework Components
-// This package provides the core testing framework functionality
-
-// Export main function modules
-const elementInteraction = require('./src/elementInteraction');
-const dataStorage = require('./src/dataStorage');
-const mainFunctions = require('./src/mainFunctions');
-const helperFunctions = require('./src/helperFunctions');
-const apiFunctions = require('./src/apiFunctions');
-const appiumTesting = require('./src/appiumTesting');
-const accessibilityTesting = require('./src/accessibilityTesting');
-const lighthouse = require('./src/lighthouse');
-const visualRegression = require('./src/visualRegression');
-
-// Export managers
-const BrowserManager = require('./features/app/browserManager');
-const AppiumManager = require('./features/app/appiumManager');
-
-// Export step definitions
-const stepDefinitions = require('./stepDefinitions');
-
-module.exports = {
-    // Core functions
-    elementInteraction,
-    dataStorage,
-    mainFunctions,
-    helperFunctions,
-    apiFunctions,
-    appiumTesting,
-    accessibilityTesting,
-    lighthouse,
-    visualRegression,
-    
-    // Managers
-    BrowserManager,
-    AppiumManager,
-    
-    // Step definitions
-    stepDefinitions,
-    
-    // Version info
-    version: require('./package.json').version
-}; 
+// Core Cuppet Framework Components
+// This package provides the core testing framework functionality
+
+// Export main function modules
+const elementInteraction = require('./src/elementInteraction');
+const dataStorage = require('./src/dataStorage');
+const mainFunctions = require('./src/mainFunctions');
+const helperFunctions = require('./src/helperFunctions');
+const apiFunctions = require('./src/apiFunctions');
+const appiumTesting = require('./src/appiumTesting');
+const accessibilityTesting = require('./src/accessibilityTesting');
+const lighthouse = require('./src/lighthouse');
+const visualRegression = require('./src/visualRegression');
+
+// Export managers
+const BrowserManager = require('./features/app/browserManager');
+const AppiumManager = require('./features/app/appiumManager');
+
+// Export step definitions
+const stepDefinitions = require('./stepDefinitions');
+
+module.exports = {
+    // Core functions
+    elementInteraction,
+    dataStorage,
+    mainFunctions,
+    helperFunctions,
+    apiFunctions,
+    appiumTesting,
+    accessibilityTesting,
+    lighthouse,
+    visualRegression,
+
+    // Managers
+    BrowserManager,
+    AppiumManager,
+
+    // Step definitions
+    stepDefinitions,
+
+    // Version info
+    version: require('./package.json').version,
+};

package/package.json

@@ -1,57 +1,72 @@
-{
-  "name": "@cuppet/core",
-  "version": "1.0.0",
-  "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
-  "main": "index.js",
-  "files": [
-    "src/",
-    "features/",
-    "index.js",
-    "stepDefinitions.js"
-  ],
-  "keywords": [
-    "testing",
-    "bdd",
-    "cucumber",
-    "puppeteer",
-    "appium",
-    "automation",
-    "e2e"
-  ],
-  "author": "Miroslav Rusev",
-  "license": "ISC",
-  "peerDependencies": {
-    "@cucumber/cucumber": "^11.0.0",
-    "puppeteer": "^24.0.1",
-    "config": "^3.3.9"
-  },
-  "dependencies": {
-    "@supercharge/strings": "^2.0.0",
-    "axios": "^1.8.2",
-    "backstopjs": "^6.3.23",
-    "chai": "^4.3.7",
-    "lighthouse": "^12.1.0",
-    "mime": "^3.0.0",
-    "moment": "^2.30.1",
-    "pa11y": "^8.0.0",
-    "pa11y-reporter-html": "^2.0.0",
-    "xml2js": "^0.6.2"
-  },
-  "devDependencies": {
-    "@wdio/globals": "^9.14.0",
-    "appium": "^2.18.0",
-    "appium-uiautomator2-driver": "^4.2.3",
-    "webdriverio": "9.12.7"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MiroslavRusev/cuppet-core.git"
-  },
-  "bugs": {
-    "url": "https://github.com/MiroslavRusev/cuppet-core/issues"
-  },
-  "homepage": "https://github.com/MiroslavRusev/cuppet-core#readme"
-}
+{
+    "name": "@cuppet/core",
+    "version": "1.0.1",
+    "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
+    "main": "index.js",
+    "files": [
+        "src/",
+        "features/",
+        "index.js",
+        "stepDefinitions.js"
+    ],
+    "keywords": [
+        "testing",
+        "bdd",
+        "cucumber",
+        "puppeteer",
+        "appium",
+        "automation",
+        "e2e"
+    ],
+    "author": "Miroslav Rusev",
+    "license": "ISC",
+    "peerDependencies": {
+        "@cucumber/cucumber": "^11.0.0",
+        "config": "^3.3.9",
+        "puppeteer": "^24.0.1"
+    },
+    "dependencies": {
+        "@supercharge/strings": "^2.0.0",
+        "axios": "^1.8.2",
+        "backstopjs": "^6.3.23",
+        "chai": "^4.3.7",
+        "lighthouse": "^12.1.0",
+        "mime": "^3.0.0",
+        "moment": "^2.30.1",
+        "pa11y": "^8.0.0",
+        "pa11y-reporter-html": "^2.0.0",
+        "xml2js": "^0.6.2"
+    },
+    "devDependencies": {
+        "@cucumber/cucumber": "^11.0.0",
+        "@semantic-release/changelog": "^6.0.3",
+        "@semantic-release/git": "^10.0.1",
+        "@semantic-release/github": "^11.0.3",
+        "@semantic-release/npm": "^12.0.1",
+        "@wdio/globals": "^9.14.0",
+        "appium": "^2.18.0",
+        "appium-uiautomator2-driver": "^4.2.3",
+        "config": "^3.3.9",
+        "eslint": "^9.29.0",
+        "eslint-config-prettier": "^10.1.5",
+        "eslint-plugin-prettier": "^5.5.1",
+        "prettier": "^3.6.1",
+        "puppeteer": "^24.0.1",
+        "semantic-release": "^24.2.5",
+        "webdriverio": "9.12.7"
+    },
+    "scripts": {
+        "test": "cucumber-js features/tests",
+        "postinstall": "sh postinstall.sh",
+        "lint": "eslint .",
+        "format": "prettier --write ."
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/MiroslavRusev/cuppet-core.git"
+    },
+    "bugs": {
+        "url": "https://github.com/MiroslavRusev/cuppet-core/issues"
+    },
+    "homepage": "https://github.com/MiroslavRusev/cuppet-core#readme"
+}

package/src/accessibilityTesting.js

@@ -1,44 +1,44 @@
-/**
- * @module accessibilityTesting
- * @typedef {import('puppeteer').Page} Page
- * @typedef {import('puppeteer').Browser} Browser
- */
-const config = require('config');
-const storage = require('./dataStorage');
-const helper = require('./helperFunctions');
-const pa11y = require('pa11y');
-const htmlReporter = require('pa11y-reporter-html');
-
-module.exports = {
-    /**
-     * Method to validate if certain path meets the criteria from the config.
-     * Please use the config json files to set options.
-     * You can find more info at - https://github.com/pa11y/pa11y#configuration
-     * @param {Browser} browser - puppeteer browser object
-     * @param {Page} page - puppeteer page object
-     * @param scenarioName - the current scenario name
-     * @param path - the path of the page which accessibility will be tested
-     * @throws Error
-     * @returns {Promise<void>}
-     */
-    validatePageAccessibility: async function (browser, page, scenarioName, path) {
-        const pa11yConfig = config.get('pa11yConfig');
-        const configOptions = {
-            ...pa11yConfig,
-            browser: browser,
-            page: page,
-        };
-        if (!path.startsWith('http')) {
-            throw new Error('Only absolute paths are allowed!');
-        }
-
-        const results = await pa11y(path, configOptions);
-        const fileName = await helper.prepareFileNameFromUrl(path);
-        // make the URL ready for filepath usage
-        if (results.issues) {
-            const html = await htmlReporter.results(results);
-            await storage.createHtmlReport('Pa11y-' + scenarioName.slice(0, -1) + fileName, html);
-            throw new Error(`${path} page has accessibility issues. HTML report has been generated!`);
-        }
-    },
-};
+/**
+ * @module accessibilityTesting
+ * @typedef {import('puppeteer').Page} Page
+ * @typedef {import('puppeteer').Browser} Browser
+ */
+const config = require('config');
+const storage = require('./dataStorage');
+const helper = require('./helperFunctions');
+const pa11y = require('pa11y');
+const htmlReporter = require('pa11y-reporter-html');
+
+module.exports = {
+    /**
+     * Method to validate if certain path meets the criteria from the config.
+     * Please use the config json files to set options.
+     * You can find more info at - https://github.com/pa11y/pa11y#configuration
+     * @param {Browser} browser - puppeteer browser object
+     * @param {Page} page - puppeteer page object
+     * @param scenarioName - the current scenario name
+     * @param path - the path of the page which accessibility will be tested
+     * @throws Error
+     * @returns {Promise<void>}
+     */
+    validatePageAccessibility: async function (browser, page, scenarioName, path) {
+        const pa11yConfig = config.get('pa11yConfig');
+        const configOptions = {
+            ...pa11yConfig,
+            browser: browser,
+            page: page,
+        };
+        if (!path.startsWith('http')) {
+            throw new Error('Only absolute paths are allowed!');
+        }
+
+        const results = await pa11y(path, configOptions);
+        const fileName = await helper.prepareFileNameFromUrl(path);
+        // make the URL ready for filepath usage
+        if (results.issues) {
+            const html = await htmlReporter.results(results);
+            await storage.createHtmlReport('Pa11y-' + scenarioName.slice(0, -1) + fileName, html);
+            throw new Error(`${path} page has accessibility issues. HTML report has been generated!`);
+        }
+    },
+};