artes 1.0.4 → 1.0.7

package/README.md

@@ -1,8 +1,12 @@
+<p align="center">
+  <img alt="madge" src="https://github.com/user-attachments/assets/e0641011-0e96-4330-8ad5-935b395b0838" width="280">
+</p>
+
 <h1 align="center">Artes</h1>
 
 ## 🚀 Summary
 
-Artes is a test runner for Playwright that executes [predefined Cucumber tests](./stepDefinitions.md) and can generate Allure reports for test results. It simplifies the process of setting up Playwright with Cucumber in your automation workflow. With Artes, you can easily run tests without writing step definitions, generate reports, and customize your testing environment.
+Artes is a test runner for Playwright that executes [predefined Cucumber tests](./stepDefinitions.md) and can generate Allure reports for test results. It simplifies setting up Playwright with Cucumber in your automation workflow. With Artes, you can easily run tests without writing step definitions, generate reports, and customize your testing environment.
 
 ## 🧑‍💻 Installation
 
@@ -43,6 +47,8 @@ npx artes [options]
 | 🏗️ `-c, --create`  | Create an example project with Artes                          | `artes -c` or `artes --create`          |
 | ✅ `-y, --yes`     | Skip the confirmation prompt when creating an example project | `artes -c -y` or `artes --create --yes` |
 | 📊 `-r, --report`  | Run tests and generate Allure report                          | `artes -r` or `artes --report`          |
+| 🕵️‍♂️ `-t, --trace`   | Run tests with trace and open trace viewer                    | `artes -t` or `artes --trace`           |
+
 
 \*\* To just run the tests: <br>
 Globally: artes <br>
@@ -53,7 +59,7 @@ Locally: npx artes
 ## 🎯 Best Practices
 
 - **Global Installation:**  
-  For ease of use, it's recommended to install Artes globally. You can do this by running the following command:
+  For ease of use, it's recommended that Artes be installed globally. You can do this by running the following command:
 
   ```bash
   npm install -g artes

package/cucumber.config.js

@@ -2,12 +2,12 @@ const fs = require("fs");
 const path = require("path");
 const { moduleConfig } = require("./src/helper/imports/commons");
 
-let argusConfig = {};
+let artesConfig = {};
 
 try {
   if (fs.existsSync(moduleConfig.cucumberConfigPath)) {
-    const argusConf = require(moduleConfig.cucumberConfigPath);
-    argusConfig = argusConf || {};
+    const artesConf = require(moduleConfig.cucumberConfigPath);
+    artesConfig = artesConf || {};
   }
 } catch (error) {
   console.warn("Error reading config file:", error.message);
@@ -17,67 +17,67 @@ try {
 module.exports = {
   default: {
     // File paths and patterns
-    cucumberTimeout: argusConfig.cucumberTimeout || 5000, // Default timeout in milliseconds
-    paths: argusConfig.features
-      ? path.join(moduleConfig.projectPath, argusConfig.features)
+    cucumberTimeout: artesConfig.cucumberTimeout || 30, // Default timeout in milliseconds
+    paths: artesConfig.features
+      ? path.join(moduleConfig.projectPath, artesConfig.features)
       : [moduleConfig.featuresPath], // Paths to feature files
     require: [
-      argusConfig.steps
-        ? path.join(moduleConfig.projectPath, argusConfig.steps)
+      artesConfig.steps
+        ? path.join(moduleConfig.projectPath, artesConfig.steps)
         : moduleConfig.stepsPath,
       "src/tests/stepDefinitions/*.js",
       "src/hooks/hooks.js",
     ], // Support code paths (CommonJS)
-    pomPath: argusConfig.pomPath
-      ? path.join(moduleConfig.projectPath, argusConfig.pomPath)
+    pomPath: artesConfig.pomPath
+      ? path.join(moduleConfig.projectPath, artesConfig.pomPath)
       : moduleConfig.pomPath,
-    import: argusConfig.import || [], // Support code paths
+    import: artesConfig.import || [], // Support code paths
 
     // Formatting and output
-    format: argusConfig.format || [
+    format: artesConfig.format || [
       "rerun:@rerun.txt",
       "allure-cucumberjs/reporter",
     ], // Formatter names/paths
-    formatOptions: argusConfig.formatOptions || {
+    formatOptions: artesConfig.formatOptions || {
       resultsDir: `allure-result`,
     }, // Formatter options
 
     // Execution options
-    parallel: argusConfig.parallel || 1, // Number of parallel workers
-    dryRun: argusConfig.dryRun || false, // Prepare test run without execution
-    failFast: argusConfig.failFast || false, // Stop on first test failure
-    forceExit: argusConfig.forceExit || false, // Force process.exit() after tests
-    strict: argusConfig.strict || true, // Fail on pending steps
-    backtrace: argusConfig.backtrace || false, // Show full backtrace for errors
+    parallel: artesConfig.parallel || 1, // Number of parallel workers
+    dryRun: artesConfig.dryRun || false, // Prepare test run without execution
+    failFast: artesConfig.failFast || false, // Stop on first test failure
+    forceExit: artesConfig.forceExit || false, // Force process.exit() after tests
+    strict: artesConfig.strict || true, // Fail on pending steps
+    backtrace: artesConfig.backtrace || false, // Show full backtrace for errors
 
     // Filtering and organization
-    tags: argusConfig.tags || process.env.npm_config_TAGS || "", // Tag expression to filter scenarios
-    name: argusConfig.name || [], // Run scenarios matching regex
-    order: argusConfig.order || "defined", // Run order (defined/random)
-    language: argusConfig.language || "en", // Default feature file language
+    tags: artesConfig.tags || process.env.npm_config_TAGS || "", // Tag expression to filter scenarios
+    name: artesConfig.name || [], // Run scenarios matching regex
+    order: artesConfig.order || "defined", // Run order (defined/random)
+    language: artesConfig.language || "en", // Default feature file language
 
     // Module loading
-    loader: argusConfig.loader || [], // Module loader specifications
-    requireModule: argusConfig.requireModule || [], // Transpilation module names
+    loader: artesConfig.loader || [], // Module loader specifications
+    requireModule: artesConfig.requireModule || [], // Transpilation module names
 
     // Retry logic
-    retry: argusConfig.retry || 0, // Retry attempts for failing tests
-    retryTagFilter: argusConfig.retryTagFilter || "", // Tag expression for retries
+    retry: artesConfig.retry || 0, // Retry attempts for failing tests
+    retryTagFilter: artesConfig.retryTagFilter || "", // Tag expression for retries
 
     // Publishing
-    publish: argusConfig.publish || false, // Publish to cucumber.io
+    publish: artesConfig.publish || false, // Publish to cucumber.io
 
     // World parameters
-    worldParameters: argusConfig.worldParameters || {}, // Custom world parameters
+    worldParameters: artesConfig.worldParameters || {}, // Custom world parameters
   },
 
   browser: {
-    browserType: argusConfig.browserType || "chrome",
+    browserType: artesConfig.browserType || "chrome",
     viewport: {
-      width: argusConfig.viewport?.width || 1280,
-      height: argusConfig.viewport?.height || 720,
+      width: artesConfig.viewport?.width || 1280,
+      height: artesConfig.viewport?.height || 720,
     },
-    headless: argusConfig.headless !== undefined ? argusConfig.headless : true,
+    headless: artesConfig.headless !== undefined ? artesConfig.headless : true,
   },
 
   ci: {

package/executer.js

@@ -1,10 +1,7 @@
 #!/usr/bin/env node
-const { showHelp } = require("./src/helper/executers/helper");
-const { showVersion } = require("./src/helper/executers/versionChecker");
-const { createProject } = require("./src/helper/executers/projectCreator");
-const { runTests } = require("./src/helper/executers/testRunner");
-const { generateReport } = require("./src/helper/executers/reportGenerator");
-const { cleanUp } = require("./src/helper/executers/cleaner");
+
+const { showHelp,showVersion,createProject,runTests,generateReport,cleanUp,tracer } = require("./src/helper/executers/exporter");
+
 
 const args = process.argv.slice(2);
 
@@ -14,9 +11,12 @@ const flags = {
   create: args.includes("-c") || args.includes("--create"),
   createYes: args.includes("-y") || args.includes("--yes"),
   report: args.includes("-r") || args.includes("--report"),
+  trace: args.includes("-t") || args.includes("--trace"),
 };
 
 function main() {
+
+
   if (flags.help) {
     showHelp();
     return;
@@ -32,6 +32,18 @@ function main() {
     return;
   }
 
+  if (flags.trace) {
+    runTests();
+    tracer();
+    cleanUp();
+  } 
+  if (flags.report && flags.trace) {
+    runTests();
+    generateReport();
+    tracer();
+    cleanUp();
+  } 
+
   if (flags.report) {
     runTests();
     generateReport();
@@ -43,3 +55,7 @@ function main() {
 }
 
 main();
+
+module.exports = {
+  flags
+}

package/functionDefinitions.md

@@ -393,16 +393,51 @@ await navigateTo("https://example.com");
 
 ---
 
+#### `navigateBack()`
+
+Navigates to the previous page.
+
+```javascript
+ navigateBack();
+```
+
+  ---
+
+#### `navigateForward()`
+
+Navigates to the next page.
+
+```javascript
+navigateForward();
+```
+
+---
+
 #### `getURL()`
 
 Retrieves the current URL of the page.
 
 ```javascript
-const currentURL = await getURL();
+await getURL();
 ```
 
 - **Returns**:
   - _(string)_: The current page URL.
+  
+  ---
+
+#### `wait()`
+
+Waits on the page until specified times.
+
+```javascript
+await wait(time);
+```
+- **Parameters**:
+  - `time` _(int)_: millisecond.
+
+---
+  
 
 ### **Assertion Functions**
 

package/index.js

@@ -14,7 +14,7 @@ const {
   frame,
   assert,
   elementInteractions,
-} = require("./src/helper/stepFunctions/actionCommons");
+} = require("./src/helper/stepFunctions/exporter");
 
 module.exports = {
   expect,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "The package provide step definitions and user writes feature files, and the package handles automation, with optional POM files and custom step definitions.",
   "main": "index.js",
   "scripts": {

package/src/helper/executers/cleaner.js

@@ -13,9 +13,7 @@ function cleanUp() {
       },
     );
 
-    if (result.error) {
-      throw result.error;
-    }
+
   } catch (error) {
     console.error("❌ Error in cleanup:", error.message);
     process.exit(1);

package/src/helper/executers/exporter.js

@@ -0,0 +1,17 @@
+const { showHelp } = require("./helper");
+const { createProject } = require("./projectCreator");
+const { generateReport } = require("./reportGenerator");
+const { runTests } = require("./testRunner");
+const { tracer } = require("./tracer");
+const { showVersion } = require("./versionChecker");
+const { cleanUp } = require("./cleaner");
+
+module.exports = {
+    createProject,
+    generateReport,
+    runTests,
+    showHelp,
+    showVersion,
+    tracer,
+    cleanUp
+}

package/src/helper/executers/projectCreator.js

@@ -40,26 +40,27 @@ function createProject(createYes) {
 
     // Configuration options:
     // paths: [],                    // string[] - Paths to feature files
-    // require: "",                  // string - Step definitions files
+    // steps: "",                    // string - Step definitions files
     // pomPath: "",                  // string - Path to POM files
+    // timeout : 0                   // number - Test timeout in seconds
+    // parallel: 0,                  // number - Number of parallel workers
+    // format: [],                   // string[] - Formatter names/paths
+    // formatOptions: {},            // object - Formatter options    
+    // retry: 0,                     // number - Retry attempts for failing tests
+    // tags: "",                     // string - Tag expression to filter scenarios
     // backtrace: false,             // boolean - Show full backtrace for errors
     // dryRun: false,                // boolean - Prepare test run without execution
     // forceExit: false,             // boolean - Force process.exit() after tests
     // failFast: false,              // boolean - Stop on first test failure
-    // format: [],                   // string[] - Formatter names/paths
-    // formatOptions: {},            // object - Formatter options
     // import: [],                   // string[] - Support code paths
     // language: "en",               // string - Default feature file language
     // loader: [],                   // string[] - Module loader specifications
     // name: [],                     // string[] - Run scenarios matching regex
     // order: "defined",             // string - Run order (defined/random)
-    // parallel: 0,                  // number - Number of parallel workers
     // publish: false,               // boolean - Publish to cucumber.io
     // requireModule: [],            // string[] - Transpilation module names
-    // retry: 0,                     // number - Retry attempts for failing tests
     // retryTagFilter: "",           // string - Tag expression for retries
     // strict: true,                 // boolean - Fail on pending steps
-    // tags: "",                     // string - Tag expression to filter scenarios
     // worldParameters: {}           // object - World constructor parameters
 };
 `;

package/src/helper/executers/reportGenerator.js

@@ -15,10 +15,6 @@ function generateReport() {
       },
     );
 
-    if (result.error) {
-      throw result.error;
-    }
-
     console.log(
       `📋 Report generated successfully in ${moduleConfig.reportPath}!`,
     );

package/src/helper/executers/testRunner.js

@@ -19,9 +19,6 @@ function runTests() {
       },
     });
 
-    if (result.error) {
-      throw result.error;
-    }
 
     console.log("✅ Tests completed successfully!");
   } catch (error) {

package/src/helper/executers/tracer.js

@@ -0,0 +1,24 @@
+const { spawnSync } = require("child_process");
+const { moduleConfig } = require("../imports/commons");
+
+
+function tracer() {
+  try {
+    console.log("🕵️‍♂️ Tracer is generating...");
+
+    const result = spawnSync("npx", ["playwright", "show-trace", '/trace.zip'], {
+      cwd: moduleConfig.modulePath,
+      stdio: "inherit",
+      shell: true
+    });
+
+    console.log("✅ Trace viewer is opened!"); 
+  } catch (error) {
+    console.error("❌ Test execution failed:", error);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+    tracer,
+};

package/src/helper/imports/commons.js

@@ -16,6 +16,7 @@ const moduleConfig = {
   modulePackageJsonPath: path.join(modulePath, "/package.json"),
   modulePath: path.join(modulePath, "/node_modules/artes"),
   reportPath: path.join(modulePath, "/report"),
+  tracerPath: path.join(projectPath, "/trace.zip"),
   cucumberConfigPath: path.join(projectPath, "/artes.config.js"),
   featuresPath: path.join(projectPath, "/tests/features/"),
   stepsPath: path.join(projectPath, "/tests/steps/*.js"),

package/src/helper/stepFunctions/pageActions.js

@@ -7,6 +7,15 @@ const page = {
   getURL: async () => {
     return await context.page.url();
   },
+  navigateBack:async () => {
+    return await context.page.goBack();
+  },
+  navigateForward:async () => {
+    return await context.page.goForward();
+  },
+  wait: async (time) => {
+    return await context.page.waitForTimeout(time);
+  },
 };
 
 module.exports = {

package/src/hooks/hooks.js

@@ -8,15 +8,16 @@ const {
 } = require("@cucumber/cucumber");
 const { invokeBrowser } = require("../helper/contextManager/browserManager");
 const { invokeRequest } = require("../helper/contextManager/requestManager");
-const { context } = require("./context");
 const { pomCollector } = require("../helper/pomController/pomCollector");
-const fs = require("fs");
 const cucumberConfig = require("../../cucumber.config");
+const { flags } = require("../../executer");
+const { context } = require("./context");
+const fs = require("fs");
 
 let browser;
 let request;
 
-setDefaultTimeout(cucumberConfig.default.cucumberTimeout);
+setDefaultTimeout(cucumberConfig.default.cucumberTimeout * 1000);
 
 BeforeAll(async function () {
   browser = await invokeBrowser();
@@ -24,7 +25,7 @@ BeforeAll(async function () {
 
   pomCollector();
 
-  browser.tracing.start({
+  flags.trace && browser.tracing.start({
     sources: true,
     screenshots: true,
     snapshots: true,
@@ -50,8 +51,6 @@ After(async function ({ pickle, result }) {
     this.attach(img, "image/png");
   }
 
-  await browser.tracing.stop({ path: "./trace.zip" });
-
   await context.page.close();
 
   if (result?.status == Status.FAILED) {
@@ -63,5 +62,5 @@ After(async function ({ pickle, result }) {
 
 AfterAll(function () {
   browser.close();
-  browser.tracing.stop({ path: "../../trace.zip" });
+  flags.trace && browser.tracing.stop({ path: '/trace.zip' });
 });

package/src/tests/stepDefinitions/assertions.steps.js

@@ -1,5 +1,5 @@
 const { Then } = require("../../helper/imports/commons");
-const { assert } = require("../../helper/stepFunctions/actionCommons");
+const { assert } = require("../../helper/stepFunctions/exporter");
 
 // Check if a selector should be attached
 Then("User expects {string} should be attached", function (selector) {

package/src/tests/stepDefinitions/frameActions.steps.js

@@ -1,5 +1,5 @@
 const { When } = require("../../helper/imports/commons");
-const { frame } = require("../../helper/stepFunctions/actionCommons");
+const { frame } = require("../../helper/stepFunctions/exporter");
 
 // User takes a screenshot of a specific selector
 When("User takes a screenshot of {string}", async function (selector) {

package/src/tests/stepDefinitions/keyboardActions.steps.js

@@ -1,5 +1,5 @@
 const { When } = require("../../helper/imports/commons");
-const { keyboard } = require("../../helper/stepFunctions/actionCommons");
+const { keyboard } = require("../../helper/stepFunctions/exporter");
 
 // User presses a key on a specific selector
 When("User presses {string} on {string}", async function (key, selector) {

package/src/tests/stepDefinitions/mouseActions.steps.js

@@ -1,5 +1,5 @@
 const { When } = require("../../helper/imports/commons");
-const { mouse } = require("../../helper/stepFunctions/actionCommons");
+const { mouse } = require("../../helper/stepFunctions/exporter");
 
 // User clicks on a selector
 When("User clicks {string}", async function (selector) {

package/src/tests/stepDefinitions/page.steps.js

@@ -1,5 +1,5 @@
 const { When, context } = require("../../helper/imports/commons");
-const { page } = require("../../helper/stepFunctions/actionCommons");
+const { page } = require("../../helper/stepFunctions/exporter");
 
 When("User navigates to {string} page", async function (url) {
   await page.navigateTo(url);
@@ -9,8 +9,12 @@ When("User navigates to {string} page", async function (url) {
 //   await page.navigateTo(url);
 // });
 
-When("User gets URL of page", async function () {
-  await page.getURL();
+When("User navigates previous page", async function () {
+  await page.navigateBack();
+});
+
+When("User navigates next page", async function () {
+  await page.navigateForward();
 });
 
 When("User gets URL of page", async function () {
@@ -18,13 +22,13 @@ When("User gets URL of page", async function () {
 });
 
 When(`User waits {int} seconds`, async (sec) => {
-  await context.page.waitForTimeout(sec * 1000);
+  await page.wait(sec * 1000);
 });
 
 When(`User waits {int} milliseconds`, async (sec) => {
-  await context.page.waitForTimeout(sec);
+  await page.wait(sec);
 });
 
 When(`User waits {int} minutes`, async (sec) => {
-  await context.page.waitForTimeout(sec * 1000 * 60);
+  await page.wait(sec * 1000 * 60);
 });

package/stepDefinitions.md

@@ -110,6 +110,8 @@
 ### Navigation Actions
 
 - User navigates to `{string}` page
+- User navigates previous page
+- User navigates next page
 
 ### URL Actions