@cuppet/core 1.0.0 → 1.0.2

package/README.md

@@ -1,183 +1,144 @@
-# @cuppet/core
-
-Core testing framework components for Cuppet - a BDD framework based on Cucumber and Puppeteer.
-
-## Installation
-
-```bash
-npm install @cuppet/core
-```
-
-## Usage
-
-### Basic Setup
-
-```javascript
-const { 
-    BrowserManager, 
-    elementInteraction, 
-    dataStorage
-} = require('@cuppet/core');
-```
-
-### In your hooks.js
-
-```javascript
-const { Before, After } = require('@cucumber/cucumber');
-const { BrowserManager, AppiumManager } = require('@cuppet/core');
-const config = require('config');
-
-Before(async function (testCase) {
-    const browserArgs = config.get('browserOptions.args');
-    const browserViewport = config.get('browserOptions.viewport.default');
-    
-    const browserManager = new BrowserManager(browserViewport, browserArgs);
-    await browserManager.initialize();
-    this.browserManager = browserManager;
-    this.browser = browserManager.browser;
-    this.page = browserManager.page;
-    
-});
-```
-
-### In your step definitions
-
-```javascript
-const { Given, When, Then } = require('@cucumber/cucumber');
-const { elementInteraction, mainFunctions } = require('@cuppet/core');
-
-Given('I am on the homepage', async function() {
-    await mainFunctions.visitPath(this.page, 'homepage');
-});
-
-When('I click the {string} button', async function(cssSelector) {
-    await elementInteraction.click(this.page, cssSelector);
-});
-```
-
-## Available Components
-
-### Core Functions
-- `elementInteraction` - Element interaction utilities
-- `dataStorage` - Data storage and management
-- `mainFunctions` - Main testing functions
-- `helperFunctions` - Helper utilities
-- `apiFunctions` - API testing functions
-- `appiumTesting` - Appium mobile testing
-- `accessibilityTesting` - Accessibility testing with Pa11y
-- `lighthouse` - Performance testing with Lighthouse
-- `visualRegression` - Visual regression testing with BackstopJS
-
-### Managers
-- `BrowserManager` - Puppeteer browser management
-- `AppiumManager` - Appium mobile testing management
-
-### Step Definitions
-- `stepDefinitions` - Pre-built Cucumber step definitions for common testing scenarios
-
-## Using Step Definitions in Other Projects
-
-The cuppet-core package includes pre-built step definitions that you can use in your main project. Here are several ways to integrate them:
-
-### Option 1: Import and use directly in your step definition files
-
-```javascript
-// In your project's step definition file (e.g., mySteps.js)
-const { Given, When, Then } = require('@cucumber/cucumber');
-const { stepDefinitions } = require('@cuppet/core');
-
-// Use the pre-built step definitions
-const { generalSteps, helperSteps, apiSteps } = stepDefinitions;
-
-// You can now use the step definitions directly
-Given('I am on the homepage', generalSteps.givenIAmOnTheHomepage);
-When('I click the login button', helperSteps.whenIClickTheLoginButton);
-Then('I should see the dashboard', generalSteps.thenIShouldSeeTheDashboard);
-```
-
-### Option 2: Import step definitions separately
-
-```javascript
-// Import step definitions directly
-const stepDefinitions = require('@cuppet/core/stepDefinitions');
-
-// Or import specific step definition modules
-const generalSteps = require('@cuppet/core/features/app/stepDefinitions/generalSteps');
-const apiSteps = require('@cuppet/core/features/app/stepDefinitions/apiSteps');
-```
-
-### Option 3: Extend and customize step definitions
-
-```javascript
-// In your project's step definition file
-const { Given, When, Then } = require('@cucumber/cucumber');
-const { stepDefinitions } = require('@cuppet/core');
-
-// Extend the base step definitions with your custom logic
-Given('I am logged in as {string}', async function(userType) {
-    // Your custom login logic
-    await this.page.goto('https://your-app.com/login');
-    await this.page.fill('[data-testid="username"]', userType);
-    await this.page.fill('[data-testid="password"]', 'password');
-    await this.page.click('[data-testid="login-button"]');
-    
-    // Then use the base step definition
-    await stepDefinitions.generalSteps.thenIShouldSeeTheDashboard.call(this);
-});
-```
-
-### Available Step Definition Categories
-
-- `accessibilitySteps` - Accessibility testing steps
-- `apiSteps` - API testing and validation steps
-- `appiumSteps` - Mobile testing with Appium
-- `generalSteps` - Common navigation and interaction steps
-- `helperSteps` - Utility and helper steps
-- `iframeSteps` - Iframe handling steps
-- `ifVisibleSteps` - Conditional visibility steps
-- `lighthouseSteps` - Performance testing steps
-- `pageElements` - Page element management
-- `pageElementsConfig` - Page element configuration
-- `pageElementsJson` - JSON-based page elements
-- `visualRegressionSteps` - Visual regression testing steps
-
-### Cucumber Configuration
-
-Make sure your Cucumber configuration includes the step definition paths:
-
-```javascript
-// cucumber.js
-module.exports = {
-    default: {
-        requireModule: ['@cuppet/core'],
-        require: [
-            'node_modules/@cuppet/core/features/app/stepDefinitions/*.js',
-            'features/step-definitions/**/*.js' // Your project's step definitions
-        ]
-    }
-};
-```
-
-## Project-Specific Components
-
-The following components should be created in your project as they are specific to your application:
-
-- `commonComponents/` - Common form fields and page paths for your application
-- `multilingualStrings/` - Multilingual string support for your application
-
-## Peer Dependencies
-
-This package requires the following peer dependencies:
-- `@cucumber/cucumber` ^11.0.0
-- `puppeteer` ^24.0.1
-- `config` ^3.3.9
-
-Make sure to install these in your project:
-
-```bash
-npm install @cucumber/cucumber puppeteer config
-```
-
-## License
-
-ISC 
+# @cuppet/core
+
+Core testing framework components for Cuppet - a BDD framework based on Cucumber and Puppeteer.
+
+## Installation
+
+```bash
+npm install @cuppet/core
+```
+
+## Usage
+
+### Basic Setup
+
+```bash
+yarn install
+```
+
+### There is a predefined structure in place made available for testing changes. To execute the example test run:
+
+```bash
+yarn test
+```
+
+
+## Available Components
+
+### Core Functions
+
+- `elementInteraction` - Element interaction utilities
+- `dataStorage` - Data storage and management
+- `mainFunctions` - Main testing functions
+- `helperFunctions` - Helper utilities
+- `apiFunctions` - API testing functions
+- `appiumTesting` - Appium mobile testing
+- `accessibilityTesting` - Accessibility testing with Pa11y
+- `lighthouse` - Performance testing with Lighthouse
+- `visualRegression` - Visual regression testing with BackstopJS
+
+### Managers
+
+- `BrowserManager` - Puppeteer browser management
+- `AppiumManager` - Appium mobile testing management
+
+### Step Definitions
+
+- `stepDefinitions` - Pre-built Cucumber step definitions for common testing scenarios
+
+## Using Step Definitions in Other Projects
+
+The cuppet-core package includes pre-built step definitions that you can use in your main project. Here are several ways to integrate them:
+
+### Option 1: Import and use directly in your cucumber based project
+
+Make sure your Cucumber configuration includes the step definition paths:
+
+```javascript
+// cucumber.js
+module.exports = {
+    default: {
+        requireModule: ['@cuppet/core'],
+        require: [
+            'node_modules/@cuppet/core/features/app/stepDefinitions/*.js',
+            'features/step-definitions/**/*.js', // Your project's step definitions
+        ],
+    },
+};
+```
+
+### Option 2: Import step definitions on bulk or separately and override them
+
+```javascript
+// Import step definitions directly
+const stepDefinitions = require('@cuppet/core/stepDefinitions');
+
+// Or import specific step definition modules
+const generalSteps = require('@cuppet/core/features/app/stepDefinitions/generalSteps');
+const apiSteps = require('@cuppet/core/features/app/stepDefinitions/apiSteps');
+const { Then } = require('@cucumber/cucumber');
+
+Then('the response should be an {string}', async function (type) {
+    console.log("Add your new custom logic", type)
+});
+```
+
+### Option 3: Extend or customize step definitions
+
+```javascript
+// In your project's step definition file
+const { Given, When, Then } = require('@cucumber/cucumber');
+const generalSteps = require('@cuppet/core/features/app/stepDefinitions/generalSteps');
+
+// Extend the base step definitions with your custom logic
+Given('I am logged in as {string}', async function (userName) {
+    // Your custom login logic
+    await this.page.goto('https://your-app.com/login');
+    await this.page.fill('[data-testid="username"]', userName);
+    await this.page.fill('[data-testid="password"]', 'password');
+    await this.page.click('[data-testid="login-button"]');
+
+    // Then use a base step definition
+    await generalSteps.['I follow {string}'].call(this,userName);
+});
+```
+
+### Available Step Definition Categories
+
+- `accessibilitySteps` - Accessibility testing steps
+- `apiSteps` - API testing and validation steps
+- `appiumSteps` - Mobile testing with Appium
+- `generalSteps` - Common navigation and interaction steps
+- `helperSteps` - Utility and helper steps
+- `iframeSteps` - Iframe handling steps
+- `ifVisibleSteps` - Conditional visibility steps
+- `lighthouseSteps` - Performance testing steps
+- `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
+
+The following components should be created in your project as they are specific to your application:
+
+- `commonComponents/` - Common form fields and page paths for your application
+- `multilingualStrings/` - Multilingual string support for your application
+
+## Peer Dependencies
+
+This package requires the following peer dependencies:
+
+- `@cucumber/cucumber` ^11.0.0
+- `puppeteer` ^24.0.1
+- `config` ^3.3.9
+
+Make sure to install these in your project:
+
+```bash
+npm install @cucumber/cucumber puppeteer config
+```
+
+## License
+
+ISC

package/features/app/appiumManager.js

@@ -1,58 +1,58 @@
-/**
- * Wdio session
- *
- * @type {import('webdriverio')}
- */
-const { remote } = require('webdriverio');
-
-/**
- * Appium instance manager for handling Appium sessions and capabilities.
- *
- * @class AppiumManager
- * @typedef {AppiumManager}
- */
-class AppiumManager {
-    /**
-     * Creates an instance of AppiumManager.
-     *
-     * @constructor
-     * @param {*} capabilities
-     */
-    constructor(capabilities) {
-        this.capabilities = capabilities;
-        this.appiumDriver = null;
-        this.appiumService = null;
-    }
-
-    /**
-     * Description placeholder
-     *
-     * @async
-     * @returns {Promise<void>}
-     * @throws {Error} If the Appium service fails to start.
-     */
-    async initialize() {
-        const wdOpts = {
-            hostname: process.env.APPIUM_HOST || 'localhost',
-            port: parseInt(process.env.APPIUM_PORT, 10) || 4723,
-            logLevel: 'silent', // Can be: 'trace', 'debug', 'info', 'warn', 'error', or 'silent'
-            capabilities: this.capabilities,
-        };
-        this.appiumDriver = await remote(wdOpts);
-    }
-
-    /**
-     * Description placeholder
-     *
-     * @async
-     * @returns {Promise<void>}
-     */
-    async stop() {
-        if (this.appiumDriver) {
-            await this.appiumDriver.deleteSession();
-            this.appiumDriver = null;
-        }
-    }
-}
-
-module.exports = AppiumManager;
+/**
+ * Wdio session
+ *
+ * @type {import('webdriverio')}
+ */
+const { remote } = require('webdriverio');
+
+/**
+ * Appium instance manager for handling Appium sessions and capabilities.
+ *
+ * @class AppiumManager
+ * @typedef {AppiumManager}
+ */
+class AppiumManager {
+    /**
+     * Creates an instance of AppiumManager.
+     *
+     * @constructor
+     * @param {*} capabilities
+     */
+    constructor(capabilities) {
+        this.capabilities = capabilities;
+        this.appiumDriver = null;
+        this.appiumService = null;
+    }
+
+    /**
+     * Description placeholder
+     *
+     * @async
+     * @returns {Promise<void>}
+     * @throws {Error} If the Appium service fails to start.
+     */
+    async initialize() {
+        const wdOpts = {
+            hostname: process.env.APPIUM_HOST || 'localhost',
+            port: parseInt(process.env.APPIUM_PORT, 10) || 4723,
+            logLevel: 'silent', // Can be: 'trace', 'debug', 'info', 'warn', 'error', or 'silent'
+            capabilities: this.capabilities,
+        };
+        this.appiumDriver = await remote(wdOpts);
+    }
+
+    /**
+     * Description placeholder
+     *
+     * @async
+     * @returns {Promise<void>}
+     */
+    async stop() {
+        if (this.appiumDriver) {
+            await this.appiumDriver.deleteSession();
+            this.appiumDriver = null;
+        }
+    }
+}
+
+module.exports = AppiumManager;

package/features/app/browserManager.js

@@ -1,54 +1,54 @@
-const puppeteer = require('puppeteer');
-
-class BrowserManager {
-    constructor(config, args, credentials) {
-        this.config = config;
-        this.args = args;
-        this.credentials = credentials;
-        this.browser = null;
-        this.page = null;
-    }
-
-    async initialize() {
-        // Launch the browser with the provided arguments and configuration
-        this.browser = await puppeteer.launch({
-            headless: false,
-            args: this.args,
-            defaultViewport: null,
-            w3c: false,
-        });
-        // Check if the browser was launched successfully and a page is available
-        const pages = await this.browser.pages();
-        if (pages.length > 0) {
-            this.page = pages[0];
-        } else {
-            this.page = await this.browser.newPage();
-        }
-
-        // Set the viewport for headless mode
-        if (Array.isArray(this.args)) {
-            const isHeadless = this.args.includes('--headless=new');
-            if (isHeadless) {
-                await this.page.setViewport({
-                    width: Number(this.config.width),
-                    height: Number(this.config.height),
-                });
-            }
-        }
-
-        // Pass basic authentication credentials if provided
-        if (this.credentials) {
-            await this.page.authenticate(this.credentials);
-        }
-    }
-
-    async stop() {
-        if (this.browser) {
-            await this.browser.close();
-            this.browser = null;
-            this.page = null;
-        }
-    }
-}
-
-module.exports = BrowserManager;
+const puppeteer = require('puppeteer');
+
+class BrowserManager {
+    constructor(config, args, credentials) {
+        this.config = config;
+        this.args = args;
+        this.credentials = credentials;
+        this.browser = null;
+        this.page = null;
+    }
+
+    async initialize() {
+        // Launch the browser with the provided arguments and configuration
+        this.browser = await puppeteer.launch({
+            headless: false,
+            args: this.args,
+            defaultViewport: null,
+            w3c: false,
+        });
+        // Check if the browser was launched successfully and a page is available
+        const pages = await this.browser.pages();
+        if (pages.length > 0) {
+            this.page = pages[0];
+        } else {
+            this.page = await this.browser.newPage();
+        }
+
+        // Set the viewport for headless mode
+        if (Array.isArray(this.args)) {
+            const isHeadless = this.args.includes('--headless=new');
+            if (isHeadless) {
+                await this.page.setViewport({
+                    width: Number(this.config.width),
+                    height: Number(this.config.height),
+                });
+            }
+        }
+
+        // Pass basic authentication credentials if provided
+        if (this.credentials) {
+            await this.page.authenticate(this.credentials);
+        }
+    }
+
+    async stop() {
+        if (this.browser) {
+            await this.browser.close();
+            this.browser = null;
+            this.page = null;
+        }
+    }
+}
+
+module.exports = BrowserManager;

package/features/app/commonComponents/commonFields.js

@@ -0,0 +1,18 @@
+const commonFields = {
+    Submit: '[id^="edit-submit"]',
+    Delete: '#edit-delete',
+    Run: '#edit-run',
+    Cancel: '#edit-cancel',
+    Deploy: '#edit-deploy',
+    Apply: '#edit-submit-admin-views-user',
+    Index50: '#edit-cron',
+    SubmitFilters: '#edit-filters-submit',
+    Confirm: '#edit-confirm',
+    Recipe: '#btn_continue',
+    Finish: '#edit-return',
+    Name: '#edit-name',
+    Pass: '#edit-pass',
+    TextBox: '.show #item-0',
+};
+
+module.exports = commonFields;

package/features/app/commonComponents/commonPaths.js

@@ -0,0 +1,17 @@
+const commonPaths = {
+    Content: '/admin/content',
+    CreateUser: '/admin/people/create',
+    User: '/user',
+    People: '/admin/people',
+    NodeAdd: '/node/add',
+    Terms: '/admin/structure/taxonomy',
+    Media: '/admin/content/media',
+    Menus: '/admin/structure/menu',
+    Config: '/admin/config',
+    CacheClear: '/admin/config/development/performance',
+    Cron: '/admin/config/system/cron/jobs',
+    BasicSettings: '/admin/config/system/site-information',
+    Redirects: '/admin/config/search/redirect',
+};
+
+module.exports = commonPaths;