Added entire cucumber boiler plate with tests

Author: avinash-qa-automation

.github/instructions.md

@@ -0,0 +1,48 @@
+# Copilot Instructions for Playwright Test Framework
+
+## Project Context
+This is a comprehensive Playwright testing library supporting web, API, BDD, and Mocha testing.
+
+## Code Style Guidelines
+- Use TypeScript strict mode
+- Follow async/await patterns
+- Use descriptive variable names
+- Add JSDoc comments for public methods
+- Export types and interfaces
+- Use factory patterns for object creation
+
+## When Adding New Features
+1. Create in appropriate src/ subdirectory
+2. Export from src/index.ts
+3. Add TypeScript types/interfaces
+4. Include error handling with custom errors
+5. Add logging with appropriate level
+6. Create example in tests/ directory
+7. Update README.md with usage
+8. Add unit tests if applicable
+
+## Testing Patterns
+- Use Page Object Model for web tests
+- Keep step definitions reusable
+- Use fixtures for test data
+- Implement proper cleanup in afterEach
+- Add tags for test categorization
+
+## Error Handling
+- Always use try-catch for async operations
+- Log errors with context
+- Throw custom error types
+- Attach screenshots on failures
+
+## Performance
+- Reuse browser contexts when possible
+- Implement connection pooling for API
+- Use Promise.all for parallel operations
+- Clean up resources in finally blocks
+
+## Commit Message Format
+- feat: New feature
+- fix: Bug fix
+- docs: Documentation changes
+- test: Test additions/changes
+- refactor: Code refactoring

.gitignore

@@ -0,0 +1,23 @@
+# Node dependencies
+node_modules/
+
+# Lockfiles (keep lockfile in repo - do NOT ignore package-lock.json or yarn.lock unless intentional)
+package-lock.json
+# yarn.lock
+
+
+# Logs created during execution
+logs/
+
+# # Test outputs and artifacts (generated by cucumber/playwright)
+# tests/test-results/
+# tests/test-results/**/*
+# tests/reports/
+# tests/playwright-report/
+# tests/logs/
+# tests/.cache/
+# tests/reports/**/*.*
+# tests/test-results/videos/
+# tests/test-results/videos/**/*.*
+# tests/test-results/screenshots/
+# tests/test-results/screenshots/**/*

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to Playwright Test Framework
+
+We love your input! We want to make contributing to this framework as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Development Process
+
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+1. Fork the repo and create your branch from `main`
+2. Add tests for any new functionality
+3. Ensure tests pass (`npm test`)
+4. Update documentation
+5. Submit pull request
+
+## Code Style Guidelines
+
+- Use TypeScript strict mode
+- Follow async/await patterns
+- Use descriptive variable names
+- Add JSDoc comments for public methods
+- Follow the existing coding style
+- Keep functions small and focused
+
+## Testing Guidelines
+
+- Add tests for any new features
+- Update existing tests for modifications
+- Use appropriate test categories (web/api/accessibility)
+- Include both positive and negative test cases
+- Follow the Page Object Model for web tests
+
+## Pull Request Process
+
+1. Update the README.md with details of changes if applicable
+2. Update the version number following semantic versioning
+3. Add entry to CHANGELOG.md
+4. The PR may be merged once you have the sign-off of another developer
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.

README.md

@@ -0,0 +1,43 @@
+# Playwright + Cucumber Test Framework
+
+Quick notes and how-to.
+
+## Prerequisites
+- Node.js (recommended LTS)
+- npm install run before using scripts: npm ci or npm install
+
+## Install
+- npm ci
+
+## Run tests (single-worker)
+- node tests/run-cucumber.js
+- or: npx cucumber-js --require-module ts-node/register tests/features/**/*.feature
+
+## Run tests (parallel)
+- node tests/run-cucumber.js --parallel=2
+- OR set env: PARALLEL=2 or PARALLEL_WORKERS=2
+- run-cucumber script will auto-limit workers to CPU and disable heavy artifacts
+
+## Important environment variables
+- HEADLESS (true|false) — browser headless mode
+- RECORD_VIDEO (true|false) — video recording (disabled automatically for parallel runs)
+- PARALLEL or PARALLEL_WORKERS — number of workers for cucumber-js
+- BROWSER_WS_ENDPOINT — used when a shared browser server is launched for parallel runs
+
+## Performance tips
+- Video recording per-worker is expensive. Keep RECORD_VIDEO off for parallel runs.
+- Choose parallel count based on CPU cores (2–4 recommended on small machines).
+- To avoid overhead at start/end, run-cucumber can launch a single BrowserServer and workers will connect to it (see tests/run-cucumber.backup.js).
+- If scenarios are very short, parallel overhead may outweigh benefits — run with 1 or 2 workers.
+
+## Troubleshooting
+- If AfterAll hooks time out in parallel runs, increase setDefaultTimeout or specify hook timeout in tests/support/hooks.ts.
+- Ensure reporter output files are unique per worker; run-cucumber sets unique names for parallel runs.
+- To inspect the actual command run, the runner logs the computed cucumber-js command.
+
+## Do not commit
+- Test artifacts (videos, screenshots, test-results) are gitignored by default.
+
+If you want, I can:
+- Add a short npm script set in package.json for running with common flags.
+- Add a sample .env.example with recommended env settings.

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@yourorg/playwright-framework",
+  "version": "1.0.0",
+  "description": "Comprehensive Playwright testing framework with web, API, BDD, and Mocha support",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test:bdd:ui": "cross-env node tests/run-cucumber.js",
+    "test:ui:parallel": "cross-env node tests/run-cucumber.parallel.js",
+    "lint": "eslint src tests",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "init": "playwright install && npm install"
+  },
+  "keywords": [
+    "playwright",
+    "testing",
+    "automation",
+    "bdd",
+    "cucumber",
+    "mocha",
+    "typescript"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@axe-core/playwright": "^4.7.0",
+    "@playwright/test": "^1.39.0",
+    "dotenv": "^16.0.3",
+    "winston": "^3.10.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^12.2.0",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "allure-cucumberjs": "^3.4.1",
+    "allure-js-commons": "^3.4.1",
+    "chai": "^4.3.0",
+    "cross-env": "^10.1.0",
+    "eslint": "^8.0.0",
+    "mocha": "^10.0.0",
+    "prettier": "^2.8.0",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}

src/reporting/logger.ts

@@ -0,0 +1,63 @@
+import winston from 'winston';
+
+export class Logger {
+  private logger: winston.Logger;
+
+  constructor(context: string) {
+    this.logger = winston.createLogger({
+      level: process.env.LOG_LEVEL || 'info',
+      format: winston.format.combine(
+        winston.format.timestamp(),
+        winston.format.json(),
+        winston.format.printf(({ timestamp, level, message, ...meta }) => {
+          return JSON.stringify({
+            timestamp,
+            level,
+            context,
+            message,
+            ...meta,
+          });
+        })
+      ),
+      transports: [
+        new winston.transports.Console({
+          format: winston.format.combine(
+            winston.format.colorize(),
+            winston.format.simple()
+          ),
+        }),
+        new winston.transports.File({
+          filename: 'logs/error.log',
+          level: 'error',
+        }),
+        new winston.transports.File({
+          filename: 'logs/combined.log',
+        }),
+      ],
+    });
+  }
+
+  info(message: string, meta?: Record<string, unknown>): void {
+    this.logger.info(message, meta);
+  }
+
+  error(message: string, error?: Error, meta?: Record<string, unknown>): void {
+    this.logger.error(message, {
+      error: error?.message,
+      stack: error?.stack,
+      ...meta,
+    });
+  }
+
+  warn(message: string, meta?: Record<string, unknown>): void {
+    this.logger.warn(message, meta);
+  }
+
+  debug(message: string, meta?: Record<string, unknown>): void {
+    this.logger.debug(message, meta);
+  }
+
+  trace(message: string, meta?: Record<string, unknown>): void {
+    this.logger.silly(message, meta);
+  }
+}