Bm/feature map (#9)

* adding feature map calculation

* adding daily run

.env

@@ -13,4 +13,7 @@ ADMIN_PASSWORD=welcome01
 # Required for Currents.dev reporting
 # CURRENTS_PROJECT_ID=
 # CURRENTS_RECORD_KEY=
-# CURRENTS_CI_BUILD_ID=
+# CURRENTS_CI_BUILD_ID=
+
+# Calculation Coverage
+CALCULATE_COVERAGE=true

.github/workflows/playwright.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
     branches: [main, master]
   schedule:
-    - cron: "0 0 * * 1"
+    - cron: "0 6 * * *"
   workflow_dispatch:
 
 jobs:

.gitignore

@@ -5,6 +5,7 @@ node_modules/
 /playwright/.cache/
 .auth/
 *_spec3.json
+coverage-output.txt
 
 # System Files
 .DS_Store

featureMap.yml

@@ -0,0 +1,59 @@
+- page: "/auth/login"
+  features:
+    sign in with google: false
+    email: true
+    password: true
+    login: true
+    register your account: false
+    forgot password: false
+- page: "/auth/forgot-password"
+  features:
+    email: false
+    set new password: false
+- page: "/auth/register"
+  features:
+    first name: false
+    last name: false
+    date of birth: false
+    address: false
+    postcode: false
+    city: false
+    state: false
+    country: false
+    phone rate: false
+    e-mail address: false
+    password: false
+    register button: false
+- page: "/category/hand-tools"
+  features:
+    header: true
+    sidebar:
+      sort: false
+      filters: false
+      by brand: false
+    product card:
+      image: false
+      image zoom: false
+      title: false
+      price: false
+    pagination:
+      previous: false
+      next: false
+      number: false
+- page: "/product/{id}"
+  features:
+    header: false
+    product details:
+      image: false
+      title: false
+      tags: false
+      price: false
+      description: false
+      quantity: false
+      add to cart: false
+      add to favorites: false
+    related products:
+      image: false
+      title: false
+      more information: false
+    footer: false

package.json

@@ -11,11 +11,13 @@
   "license": "ISC",
   "devDependencies": {
     "@currents/playwright": "^0.10.6",
-    "@playwright/test": "^1.39",
+    "@playwright/test": "^1.40",
     "typescript": "^5.2.2"
   },
   "dependencies": {
     "dotenv": "^16.3.0",
+    "feature-map": "^1.0.0",
+    "js-yaml": "^4.1.0",
     "ts-node": "^10.9.1"
   }
 }

playwright.config.ts

@@ -8,9 +8,14 @@ export default defineConfig<APIRequestOptions & TestOptions>({
   timeout: 30_000,
   projects: [
     { name: "setup", testMatch: /.*\.setup\.ts/, fullyParallel: true },
+    {
+      name: "calculation",
+      testMatch: /.*\.calculation\.ts/,
+    },
+
     {
       name: "ui-tests",
-      dependencies: ["setup"],
+      dependencies: ["setup", "calculation"],
     },
   ],
   testDir: "./tests",

tests/featuremap.calculation.ts

@@ -0,0 +1,12 @@
+import { test as calculation } from "@playwright/test";
+import { calculateYamlCoverage } from "feature-map";
+
+calculation("Feature Map", async () => {
+  let runCalculationCoverage = process.env.CALCULATE_COVERAGE;
+  if (runCalculationCoverage) {
+    console.log("Calculating coverage");
+    calculateYamlCoverage("./featureMap.yml");
+  } else {
+    console.log("Skipping coverage calculation");
+  }
+});