artes 1.6.2 → 1.6.4

package/README.md

@@ -4,7 +4,36 @@
 
 <h1 align="center">Artes</h1>
 
-## 🚀 Summary
+<p >
+  <a href="https://www.npmjs.com/package/artes">
+    <img src="https://img.shields.io/npm/dm/artes?label=npm&logo=npm&color=blue" alt="npm version">
+  </a>
+
+   <a href="https://github.com/4gayev1/Artes">
+    <img src="https://img.shields.io/badge/GitHub-Artes-181717?logo=github&logoColor=white" alt="GitHub Artes">
+  </a>
+
+  <a href="https://hub.docker.com/r/vahidaghayev/artes">
+    <img src="https://img.shields.io/badge/Docker-Artes-blue?logo=docker&logoColor=white" alt="Docker Artes">
+  </a>
+
+   <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">
+    <img src="https://img.shields.io/badge/JavaScript-F7DF1E?logo=javascript&logoColor=black" alt="JavaScript">
+  </a>
+  
+  <a href="https://playwright.dev/">
+    <img src="https://img.shields.io/badge/Playwright-2EAD33?logo=playwright&logoColor=white" alt="Playwright">
+  </a>
+  
+  <a href="https://cucumber.io/">
+    <img src="https://img.shields.io/badge/Cucumber-23D96C?logo=cucumber&logoColor=white" alt="Cucumber">
+  </a>
+
+  <a href="https://www.apache.org/licenses/LICENSE-2.0">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Apache 2.0 License">
+  </a>
+
+</p>
 
 Artes is a test runner for Playwright that executes [predefined Cucumber tests](./docs/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.
 
@@ -20,7 +49,7 @@ Artes is a test runner for Playwright that executes [predefined Cucumber tests](
 - Well-structured, easy-to-follow documentation for a smooth learning curve
 - Designed for long-term maintainability and scalability
 
-### 🧩 Powerful & Developer-Friendly Architecture
+### 🧩 Powerful & QA-Friendly Architecture
 
 - Intuitive API for writing custom step definitions
 - Rich set of ready-to-use step definitions to speed up test creation
@@ -115,12 +144,12 @@ npx artes [options]
 | `-rwt, --reportWithTrace` | Add trace to the report                                                            | `artes -rwt` or `artes --reportWithTrace`                             |
 | `--singleFileReport`      | Generate single file allure report                                                 | `artes -r --singleFileReport`                                         |
 | `--zip`                   | Zip the report folder after generation                                             | `artes -r --zip`                                                      |
-| `--uploadReport`          | Upload the generated report to Artes Reporting System                              | `artes --uploadReport --reporterURL "https://example.com"`            |
-| `--reporterURL`           | URL of the Artes Reporting System to upload the report                             | `artes --uploadReport --reporterURL "https://example.com"`            |
-| `--projectName`           | Name of the project in the Artes Reporting System (default: `"Artes Report"`)     | `artes --uploadReport --reporterURL "https://example.com" --projectName "My Project"` |
-| `--projectType`           | Type of the project for reporting purposes (default: `"Artes"`)                   | `artes --uploadReport --reporterURL "https://example.com" --projectType "API"` |
-| `--reportPath`            | Path to the report zip file to upload (default: `./report.zip`)                   | `artes --uploadReport --reporterURL "https://example.com" --reportPath "./my_report.zip"` |
-| 🖼️ `--logo`               | Set a custom logo in the report sidebar. Accepts an absolute path, a relative path, or a direct image URL | `artes --logo /abs/path/logo.png`<br>`artes --logo logo.png`<br>`artes --logo 'https://example.com/logo.png'` |
+| `--uploadReport`          | Upload the generated report to Artes Reporting System                              | `artes -r --zip --uploadReport --reporterURL "https://example.com"`            |
+| `--reporterURL`           | URL of the Artes Reporting System to upload the report                             | `artes -r --zip --uploadReport --reporterURL "https://example.com"`            |
+| `--projectName`           | Name of the project in the Artes Reporting System (default: `"Artes Report"`)     | `artes -r --zip --uploadReport --reporterURL "https://example.com" --projectName "My Project"` |
+| `--projectType`           | Type of the project for reporting purposes (default: `"Artes"`)                   | `artes -r --zip --uploadReport --reporterURL "https://example.com" --projectType "API"` |
+| `--reportPath`            | Path to the report zip file to upload (default: `./report.zip`)                   | `artes -r --zip --uploadReport --reporterURL "https://example.com" --reportPath "./my_report.zip"` |
+| 🖼️ `--logo`               | Set a custom logo in the report sidebar. Accepts an absolute path, a relative path, or a direct image URL | `artes -r --logo /abs/path/logo.png`<br>`artes --logo logo.png`<br>`artes --logo 'https://example.com/logo.png'` |
 | 🏢 `--brandName`          | Set the brand name displayed next to the logo in the report sidebar                | `artes --brandName 'My Company'`                                      |
 | 📄 `--reportName`         | Report name displayed on the summary widget and in the Artes Reporting System                       | `artes --reportName 'Alma UI'`  
 | 📁 `--features`           | Specify one or more feature files' relative paths to run (comma-separated)         | `artes --features "tests/features/Alma,tests/features/Banan.feature"` |
@@ -176,8 +205,8 @@ After running the `-c` flag to create a new project, the structure will look lik
       (Your feature files here)
     /POMs    // Optional
       (POM JSON file here)
-    /steps  // For custom steps
-        (Your step definition JS files here)
+    /steps  // For custom steps and hooks
+        (Your step definition and hooks JS files here)
   artes.config.js
   /report
     (Generated Allure report HTML here)
@@ -631,6 +660,8 @@ Artes can generate Allure reports. After running tests with the `-r` flag, the r
 
 Artes has a built-in integration with the Artes Reporting System. By configuring the options below, you can automatically upload your test reports and keep your pipeline stages clean and organized.
 
+*Note: report and zip should be true for report uploading*
+
 | **Option**       | **Default Value**             | **Description**                                                        |
 | ---------------- | ----------------------------- | ---------------------------------------------------------------------- |
 | `uploadReport`   | `false`                       | Automatically upload the report to Artes Reporting System after tests. |

package/cucumber.config.js

@@ -226,7 +226,7 @@ module.exports = {
       ? JSON.parse(process.env.MODE)
       : artesConfig?.headless !== undefined
         ? artesConfig.headless
-        : true,
+        : false,
     slowMo: process.env.SLOWMO
       ? Number(process.env.SLOWMO) * 1000
       : artesConfig?.slowMo * 1000 || 0,

package/executer.js

@@ -193,7 +193,7 @@ async function main() {
 
   const testCoverage = testCoverageCalculator();
 
-  if (testCoverage.totalTests === 0) {
+  if (testCoverage?.totalTests === 0) {
     console.log("\x1b[33mNo tests were run (0 scenarios). Skipping report generation and upload.\x1b[0m");
     cleanUp();
     process.exit(process.env.EXIT_CODE);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.6.2",
+  "version": "1.6.4",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {

package/src/helper/controller/findDuplicateTestNames.js

@@ -60,6 +60,7 @@ function findDuplicateTestNames() {
       console.log("");
     });
     console.log("\x1b[0m");
+    console.log("");
   }
 
   return duplicates;

package/src/helper/controller/pomCollector.js

@@ -77,6 +77,7 @@ function logPomWarnings() {
   });
 
   console.log("\x1b[0m");
+  console.log("");
 }
 
 module.exports = { pomCollector, logPomWarnings };

package/src/helper/controller/testCoverageCalculator.js

@@ -68,11 +68,12 @@ function testCoverageCalculator({ silent = false } = {}) {
   });
 
   if (!silent && retriedTests.length > 0) {
-    console.warn("\n\x1b[33mRetried test cases:");
+    console.warn(`\n\x1b[33mRetried test cases (${retriedTests.length} test cases):`);
     retriedTests.forEach((t) => {
       console.warn(`- "${t.scenario}" ran ${t.count} times`);
     });
     console.log("\x1b[0m");
+    console.log("");
   }
 
   return {

package/src/helper/executers/projectCreator.js

@@ -43,9 +43,8 @@ function createProject(createYes, noDeps) {
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 
   const config = `module.exports = {
-       headless: false,                 // Set to true for headless browser mode
-
     // Configuration options:
+    // headless: false,              // Set to true for headless browser mode
     // env: "",                      // string - Environment name for tests
     // variables: {}                 // object - Variables for tests
     // testPercentage: 0,            // number - Minimum success rate percentage(Default: 0)