@cuppet/core 2.0.5 → 3.0.0

package/README.md

@@ -34,7 +34,6 @@ yarn test
 - `appiumTesting` - Appium mobile testing
 - `accessibilityTesting` - Accessibility testing with Pa11y
 - `lighthouse` - Performance testing with Lighthouse
-- `visualRegression` - Visual regression testing with BackstopJS
 
 ### Managers
 
@@ -115,7 +114,6 @@ Given('I am logged in as {string}', async function (userName) {
 - `pageElements` - Page element testing
 - `pageElementsConfig` - Page element testing with values from config
 - `pageElementsJson` - Page element testing with values from locally stored JSON file
-- `visualRegressionSteps` - Visual regression testing steps
 
 ## Project-Specific Components
 

package/features/app/stepDefinitions/apiSteps.js

@@ -22,6 +22,9 @@ Given('the response code should be {string}', async function (code) {
 Then('the response should be an {string}', async function (type) {
     await apiSteps.validateResponseType(type);
 });
+Then('the response should be an empty array', async function () {
+    await apiSteps.validateResponseIsEmptyArray();
+});
 Then('the property {string} should be an {string}', async function (property, type) {
     await apiSteps.propertyIs(property, type);
 });

package/index.js

@@ -11,7 +11,6 @@ const mqttFunctions = require('./src/mqttFunctions');
 const appiumTesting = require('./src/appiumTesting');
 const accessibilityTesting = require('./src/accessibilityTesting');
 const lighthouse = require('./src/lighthouse');
-const visualRegression = require('./src/visualRegression');
 const kafkaFunctions = require('./src/kafkaFunctions');
 
 // Export managers
@@ -32,7 +31,6 @@ module.exports = {
     appiumTesting,
     accessibilityTesting,
     lighthouse,
-    visualRegression,
 
     // Managers
     BrowserManager,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuppet/core",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "Core testing framework components for Cuppet - BDD framework based on Cucumber and Puppeteer",
   "main": "index.js",
   "files": [
@@ -8,8 +8,7 @@
     "features/",
     "index.js",
     "stepDefinitions.js",
-    "postinstall.js",
-    "backStopData/"
+    "postinstall.js"
   ],
   "keywords": [
     "testing",
@@ -34,7 +33,6 @@
     "appium": "3.2.2",
     "appium-uiautomator2-driver": "7.0.0",
     "axios": "^1.13.6",
-    "backstopjs": "^6.3.25",
     "chai": "6.2.2",
     "kafkajs": "^2.2.4",
     "lighthouse": "^13.0.3",
@@ -62,7 +60,6 @@
   "scripts": {
     "test": "cucumber-js features/tests/example.feature",
     "run:kafka": "cucumber-js features/tests/example-kafka.feature",
-    "run:visual": "cucumber-js features/tests/example-visual-test.feature",
     "run:pa11y": "cucumber-js features/tests/example-pa11y.feature",
     "run:lighthouse": "cucumber-js features/tests/example-lighthouse.feature",
     "run:mqtt": "cucumber-js features/tests/example-mqtt.feature",

package/src/apiFunctions.js

@@ -196,7 +196,16 @@ module.exports = {
      * @returns {Promise<void>}
      */
     validateResponseType: async function (type) {
-        await assert.typeOf(this.response.data, type, `Response is not an ${type}`);
+        assert.typeOf(this.response.data, type, `Response is not an ${type}`);
+    },
+
+    /**
+     * Validate that the response body is an empty array
+     * @returns {Promise<void>}
+     */
+    validateResponseIsEmptyArray: async function () {
+        assert.isArray(this.response.data, 'Response is not an array');
+        assert.isEmpty(this.response.data, `Expected an empty array but got ${JSON.stringify(this.response.data)}`);
     },
 
     /**

package/stepDefinitions.js

@@ -14,5 +14,5 @@ module.exports = {
     pageElements: require('./features/app/stepDefinitions/pageElements'),
     pageElementsConfig: require('./features/app/stepDefinitions/pageElementsConfig'),
     pageElementsJson: require('./features/app/stepDefinitions/pageElementsJson'),
-    visualRegressionSteps: require('./features/app/stepDefinitions/visualRegressionSteps'),
+    kafkaSteps: require('./features/app/stepDefinitions/kafkaSteps'),
 };

package/backStopData/backStopConfig.json

@@ -1,32 +0,0 @@
-{
-  "id": "test",
-  "viewports": [
-    {
-      "label": "desktop",
-      "width": 1920,
-      "height": 1080
-    }
-  ],
-  "scenarios": [
-    {
-      "label": "Single Test",
-      "url": "https://example.com"
-    }
-  ],
-  "paths": {
-    "bitmaps_reference": "backStopData/bitmaps_reference",
-    "bitmaps_test": "backStopData/bitmaps_test",
-    "engine_scripts": "backStopData/engine_scripts",
-    "html_report": "backStopData/html_report",
-    "ci_report": "backStopData/ci_report"
-  },
-  "report": ["CI"],
-  "engine": "puppeteer",
-  "engineOptions": {
-    "args": ["--headless=new"]
-  },
-  "asyncCaptureLimit": 5,
-  "asyncCompareLimit": 50,
-  "debug": false,
-  "debugWindow": false
-}

package/features/app/stepDefinitions/visualRegressionSteps.js

@@ -1,26 +0,0 @@
-/**
- * @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/tests/example-visual-test.feature

@@ -1,5 +0,0 @@
- Feature: Open DEMO QA and run visual tests
-
-  Scenario: Backstop visual test 
-    And I generate reference screenshot for "https://demoqa.com/elements"
-    Then I compare "https://demoqa.com/elements" to reference screenshot

package/src/visualRegression.js

@@ -1,68 +0,0 @@
-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 || 'default';
-        const browserViewport = config.get('browserOptions.viewport.backstop');
-        newConfig.viewports[0].width = Number(browserViewport.width);
-        newConfig.viewports[0].height = Number(browserViewport.height);
-        newConfig.engineOptions.args = config.get('browserOptions.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);
-    },
-};