fix configurations and add global variable setup

Author: hexdee606

codecept.conf.js

@@ -1,4 +1,3 @@
-const path = require('path');
 const playwrightConfig = require('./config/playwright.conf');
 const restConfig = require('./config/rest.conf');
 const graphqlConfig = require('./config/graphql.conf');
@@ -7,6 +6,8 @@ const multipleConfig = require('./config/multiple.conf');
 const gherkinConfig = require('./config/gherkin.conf');
 const includeConfig = require('./config/include.conf');
 const mochaConfig = require('./config/mocha.conf');
+const globalVariablesConfig = require('./config/global.variables.conf');
+
 exports.config = {
     output: './outputs',
     helpers: {
@@ -27,5 +28,6 @@ exports.config = {
         retries: 2
     },
     multiple: multipleConfig,
-    waitForNavigation: "load"
+    waitForNavigation: "load",
+    globalVariables: globalVariablesConfig
 };

config/gherkin.conf.js

@@ -1,4 +1,4 @@
 module.exports = {
     features: './src/features/*.feature',
-    steps: './src/step_definitions/*.js'
-};
+    steps: './src/step_definitions/*_steps.js'
+};

config/global.variables.conf.js

@@ -0,0 +1,10 @@
+global.api_helper = require("../custom_helpers/api_helper");
+global.browser_storage_utils = require("../custom_helpers/browser_storage_utils");
+global.common_codeceptjs_utils = require("../custom_helpers/common_codeceptjs_utils");
+global.common_utils = require("../custom_helpers/common_utils");
+global.excel_utils = require("../custom_helpers/excel_utils");
+global.graphql_helper = require("../custom_helpers/graphql_helper");
+global.keyboard_utils = require("../custom_helpers/keyboard_utils");
+global.strings_data = require("../custom_helpers/strings_data");
+global.test_data = require("../custom_helpers/test_data");
+global.variables = require("../custom_helpers/variables");

config/include.conf.js

@@ -1,5 +1,4 @@
 module.exports = {
     I: './steps_file.js',
     page: './src/pages/*.js',
-    customHelper: '../custom_helpers/*.js'
 };

config/plugins.conf.js

@@ -1,7 +1,7 @@
 module.exports = {
     allure: {
         enabled: true, // Enable or disable the allure plugin
-        outputDir: './allure-results', // Directory to save allure results
+        outputDir: './outputs/allure-results', // Directory to save allure results
         require: '@codeceptjs/allure-legacy', // Use the allure legacy reporter
 
         // Basic Configuration

custom_helpers/api_helper.js

@@ -1,4 +1,6 @@
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
 const I = actor();
+
 const envURL = require('../config/env.conf'); // Import environment configuration
 
 // Extract the base API endpoint from the environment configuration
@@ -11,8 +13,9 @@ if (!api_endpoint) {
 /**
  * API Helper class for managing API requests and configurations.
  */
-class ApiHelper {
-    constructor() {
+class ApiHelper extends Helper{
+    constructor(config) {
+        super(config);
         // Initialize common variables or settings
     }
 

custom_helpers/browser_storage_utils.js

@@ -1,7 +1,9 @@
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
 const I = actor();
 
-export class browser_storage_utils {
-    constructor() {
+module.exports = new class browser_storage_utils extends Helper {
+    constructor(config) {
+        super(config);
     }
 
     /**

custom_helpers/common_codeceptjs_utils.js

@@ -1,8 +1,9 @@
-const I = actor()
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
+const I = actor();
 const {assert} = require('chai'); // Import Chai assertion library for validating test conditions
-export class common_codeceptjs_utils {
-    constructor() {
-
+class common_codeceptjs_utils extends Helper{
+    constructor(config) {
+        super(config);
     }
 
     /**
@@ -152,4 +153,6 @@ export class common_codeceptjs_utils {
         const value = await I.grabAttributeFrom(locator, 'selected');
         assert.equal(value[0], 'true');
     }
-}
+}
+
+module.exports = new common_codeceptjs_utils();

custom_helpers/common_utils.js

@@ -1,12 +1,14 @@
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
 const I = actor();
 const {assert} = require('chai'); // Import Chai assertion library for validating test conditions
 const ExcelJS = require('exceljs'); // Import exceljs for reading and writing Excel files
 const path = require('path'); // Import path module for handling and transforming file paths
 const fs = require('fs'); // Import fs module for file system operations
 const mongoose = require('mongoose');
 
-export class common_utils {
-    constructor() {
+class common_utils extends Helper {
+    constructor(config) {
+        super(config);
 
     }
 
@@ -160,4 +162,6 @@ export class common_utils {
             }
         }
     }
-}
+}
+
+module.exports = new common_utils();

custom_helpers/excel_utils.js

@@ -1,11 +1,9 @@
-const I = actor();
-const {assert} = require('chai'); // Import Chai assertion library for validating test conditions
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
 const ExcelJS = require('exceljs'); // Import exceljs for reading and writing Excel files
 const path = require('path'); // Import path module for handling and transforming file paths
-const fs = require('fs'); // Import fs module for file system operations
-const mongoose = require('mongoose');
 
-export class excel_utils {
+
+class excel_utils extends Helper{
     /**
      * Reads an Excel file and returns the workbook.
      * @param {string} filePath - Path to the Excel file.
@@ -247,4 +245,8 @@ export class excel_utils {
             return rowData;
         });
     }
+}
+
+module.exports = {
+    excel_utils: new excel_utils()
 }

custom_helpers/graphql_helper.js

@@ -1,5 +1,6 @@
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
 const I = actor();
-const envURL = require('../config/env.conf'); // Import environment configuration
+const envURL = require('../config/env.conf');
 
 // Extract the base API endpoint for GraphQL from the environment configuration
 const graphql_endpoint = envURL[envURL.env].services.end_point;
@@ -11,8 +12,9 @@ if (!graphql_endpoint) {
 /**
  * GraphQL Helper class for managing GraphQL queries and mutations.
  */
-class GraphQLHelper {
-    constructor() {
+class GraphQLHelper extends Helper {
+    constructor(config) {
+        super(config);
         // Initialize common variables or settings
         this.defaultTimeout = 30000; // Default timeout for requests
     }

custom_helpers/keyboard_utils.js

@@ -1,8 +1,9 @@
-const { Helper } = require('@codeceptjs/helper');
+const {actor, Helper} = require("codeceptjs"); // Import environment configuration
+const I = actor();
 const os = require('os');
-const { Key } = require('playwright');
+const {Key} = require('playwright');
 
-class KeyboardHelper extends Helper {
+class keyboard_utils extends Helper {
     constructor(config) {
         super(config);
         this.platform = os.platform();
@@ -67,7 +68,7 @@ class KeyboardHelper extends Helper {
 
     // Method to press keys with multiple combinations
     async pressKey(keyCombination) {
-        const { I } = this.helpers;
+        const {I} = this.helpers;
         await I.pressKey(this.mapKeyCombination(keyCombination));
     }
 
@@ -122,4 +123,4 @@ class KeyboardHelper extends Helper {
     }
 }
 
-module.exports = KeyboardHelper;
+module.exports = new keyboard_utils();

package.json

@@ -31,10 +31,10 @@
     "step_definitions": "./src/step_definitions"
   },
   "scripts": {
-    "test:run": "codeceptjs run --plugins allure --config=./codecept.conf.js",
-    "test:report-serve": "allure serve ./allure-results --clean",
+    "test:run": "codeceptjs run --debug --plugins allure --config=./codecept.conf.js",
+    "test:report-serve": "allure serve ./outputs/allure-results --clean",
     "test:debug": "codeceptjs run --debug --grep '@debug' --config=./codecept.conf.js",
-    "test:report-generate": "allure generate ./allure-results --clean -o ./allure-report",
+    "test:report-generate": "allure generate ./outputs/allure-results --clean -o ./allure-report",
     "test:e2e": "codeceptjs run --plugins allure --config=./codecept.conf.js",
     "test:parallel": "codeceptjs run-multiple --all --plugins allure --config=./codecept.conf.js",
     "test:report-open": "allure open ./allure-report"
@@ -44,7 +44,6 @@
   },
   "dependencies": {
     "@codeceptjs/configure": "^1.0.1",
-    "@codeceptjs/helper": "^2.0.4",
     "axios": "^1.7.3",
     "chai": "^4.5.0",
     "codeceptjs": "^3.6.5",
@@ -62,7 +61,6 @@
     "allure-playwright": "^3.0.0-beta.7",
     "codeceptjs-browserlogs-plugin": "^1.0.5",
     "debug": "^4.3.6",
-    "eslint": "^9.8.0",
     "moment": "^2.30.1"
   },
   "engines": {

src/features/01-test_feature.feature

@@ -0,0 +1,4 @@
+Feature: test-feature
+  Scenario: test-scenario
+    Given test step here
+#    And steps to be check

src/step_definitions/01-test_feature_steps.js

@@ -0,0 +1,4 @@
+
+Given(/^test step here$/, function () {
+    console.log(variables.test)
+});

steps.d.ts

@@ -1,10 +1,9 @@
 /// <reference types='codeceptjs' />
 type steps_file = typeof import('./steps_file.js');
 type page = typeof import('./src/pages/*.js');
-type customHelper = typeof import('./custom_helpers/*.js');
 
 declare namespace CodeceptJS {
-  interface SupportObject { I: I, current: any, page: page, customHelper: customHelper }
+  interface SupportObject { I: I, current: any, page: page }
   interface Methods extends Playwright, REST, GraphQL, FileSystem {}
   interface I extends ReturnType<steps_file>, WithTranslation<Methods> {}
   namespace Translation {