simple-playwright-framework 0.0.4 → 0.0.6

package/package.json

@@ -1,23 +1,45 @@
 {
   "name": "simple-playwright-framework",
-  "version": "0.0.4",
+  "version": "0.0.6",
+  "description": "A modular Playwright framework with fixtures, loaders, and demo scaffolding.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "clean": "rimraf dist .cache",
-    "build": "tsc -p tsconfig.json"
-  },
-  "dependencies": {
-    "node-fetch": "^2.6.7"
-  },
-  "peerDependencies": {
-    "@playwright/test": "^1.58.2"
+    "clean": "rimraf node_modules package-lock.json dist .cache",
+    "reinstall": "npm install",
+    "compile": "tsc -p tsconfig.json",
+    "build": "npm run clean && npm run reinstall && npm run compile",
+    "test": "rimraf playwright-report && playwright test",
+    "report": "playwright show-report"
   },
   "bin": {
-    "init-sample-project": "./scripts/setup-framework.js"
+    "init-framework-project": "scripts/init-framework-project.js",
+    "init-demo-project": "scripts/init-demo-project.js"
   },
   "files": [
-    "dist",
-    "scripts"
-  ]
+    "dist/**/*",
+    "scripts/init-framework-project.js",
+    "scripts/init-demo-project.js"
+  ],
+  "keywords": [
+    "playwright",
+    "framework",
+    "testing",
+    "automation",
+    "fixtures",
+    "typescript"
+  ],
+  "author": "Udayakumar",
+  "license": "MIT",
+  "dependencies": {
+    "@framework/fixtures": "file:../framework"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.58.2",
+    "@types/node": "^25.2.3",
+    "rimraf": "^6.1.2",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.9.3"
+  }
 }

package/scripts/init-demo-project.js

@@ -0,0 +1,186 @@
+#!/usr/bin/env node
+const fs = require("fs");
+const path = require("path");
+
+const cwd = process.cwd();
+const demoDir = path.join(cwd, "demo-project");
+fs.mkdirSync(demoDir, { recursive: true });
+
+function writeFileSafe(filePath, content) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, content);
+  console.log(`📄 Created: ${filePath}`);
+}
+
+// package.json
+writeFileSafe(path.join(demoDir, "package.json"),
+  JSON.stringify({
+    name: "demo-project",
+    version: "1.0.0",
+    private: true,
+    scripts: { test: "playwright test" },
+    devDependencies: {
+      "@playwright/test": "^1.58.2",
+      "simple-playwright-framework": "latest"
+    }
+  }, null, 2)
+);
+
+// playwright.config.ts
+writeFileSafe(path.join(demoDir, "playwright.config.ts"), `import { defineConfig } from '@playwright/test';
+export default defineConfig({ testDir: './tests', reporter: [['html']] });
+`);
+
+// config
+writeFileSafe(path.join(demoDir, "config/environments.json"),
+  JSON.stringify({
+    defaults: { timeout: 30000, retries: 1, autoLaunch: false },
+    dev: { baseUrl: "https://dev.orangehrm.example.com", authStorage: { enabled: true, provider: "OrangeHRMLogin" } },
+    qa: { baseUrl: "https://qa.orangehrm.example.com", authStorage: { enabled: true, provider: "OrangeHRMLogin" } },
+    prod: { baseUrl: "https://opensource-demo.orangehrmlive.com/", authStorage: { enabled: true, provider: "OrangeHRMLogin" } }
+  }, null, 2)
+);
+
+// data/login
+writeFileSafe(path.join(demoDir, "data/login/login.json"),
+  JSON.stringify({
+    prod: {
+      users: {
+        admin: { username: "Admin", password: "admin123" },
+        employee: { username: "Emp", password: "emp123" },
+        locked: { username: "LockedUser", password: "locked123" },
+        problem: { username: "ProblemUser", password: "problem123" }
+      }
+    }
+  }, null, 2)
+);
+writeFileSafe(path.join(demoDir, "data/login/login.scenarios.json"),
+  JSON.stringify({
+    prod: [
+      { name: "Valid login", url: "https://opensource-demo.orangehrmlive.com/", username: "Admin", password: "admin123", expected: "success", tags: ["smoke"] },
+      { name: "Invalid login", url: "https://opensource-demo.orangehrmlive.com/", username: "WrongUser", password: "WrongPass", expected: "failure", tags: ["negative"] },
+      { name: "Valid login Two", url: "https://opensource-demo.orangehrmlive.com/", username: "akshay.emp.61499", password: "October@2020", expected: "success", tags: ["regression","positive"] }
+    ]
+  }, null, 2)
+);
+writeFileSafe(path.join(demoDir, "data/login/loginwithauthstorage.json"),
+  JSON.stringify({ prod: { users: { admin: { username: "Admin", password: "admin123" } } } }, null, 2)
+);
+
+// data/api
+writeFileSafe(path.join(demoDir, "data/api/payload.json"),
+  JSON.stringify({ createUser: { username: "demoUser", password: "demoPass" } }, null, 2)
+);
+
+// data/ui
+writeFileSafe(path.join(demoDir, "data/ui/sample.txt"), "This is a sample file used for upload tests.\n");
+
+// storage
+writeFileSafe(path.join(demoDir, "storage/authStorage.json"),
+  JSON.stringify({ session: { validityMinutes: 30, provider: "OrangeHRMLogin" } }, null, 2)
+);
+
+// auth
+writeFileSafe(path.join(demoDir, "auth/orangehrm.login.ts"), `import { Page } from '@playwright/test';
+import { AuthProvider } from 'simple-playwright-framework/fixtures/src/types/auth';
+export class OrangeHRMLogin implements AuthProvider {
+  constructor(private creds: { username: string; password: string }) {}
+  async login(page: Page): Promise<void> {
+    await page.fill("input[name='username']", this.creds.username);
+    await page.fill("input[name='password']", this.creds.password);
+    await page.click("button[type='submit']");
+    await page.waitForURL("**/dashboard/**");
+  }
+}
+`);
+
+// tests/login
+writeFileSafe(path.join(demoDir, "tests/login/login.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('login with Admin user @smoke', async ({ page, envConfig, td }) => {
+  await page.goto(envConfig.baseUrl);
+  await page.fill('input[name="username"]', td.users.admin.username);
+  await page.fill('input[name="password"]', td.users.admin.password);
+  await page.click('button[type="submit"]');
+  await expect(page).toHaveURL(/dashboard/);
+});
+`);
+
+writeFileSafe(path.join(demoDir, "tests/login/login.scenarios.spec.ts"), `import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
+import { providerRegistry } from '@project/auth';
+const scenarios = scenarioLoader(__filename);
+test.describe.parallel("Login scenarios", () => {
+  for (const sc of scenarios) {
+    test(\`Scenario: \${sc.name}\`, async ({ page, envConfig }) => {
+      await page.goto(envConfig.baseUrl);
+      await initAuthSession(page, envConfig.authStorage!, { username: sc.username, password: sc.password }, providerRegistry);
+      if (sc.expected === "success") {
+        await expect(page).toHaveURL(/.*dashboard.*/);
+      } else {
+        await expect(page.locator(".oxd-alert-content")).toBeVisible();
+      }
+    });
+  }
+});
+`);
+
+writeFileSafe(path.join(demoDir, "tests/login/loginwithauthstorage.spec.ts"), `import { test, expect, initAuthSession } from 'simple-playwright-framework';
+import { providerRegistry } from '@project/auth';
+test('login with Admin user using Auth Storage', async ({ page, envConfig, td }) => {
+  await page.goto(envConfig.baseUrl);
+  await initAuthSession(page, envConfig.authStorage!, { username: td.users.admin.username, password: td.users.admin.password }, providerRegistry);
+  await expect(page).toHaveURL(/dashboard/);
+});
+`);
+
+writeFileSafe(path.join(demoDir, "tests/login/login.testrail.spec.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('Login linked to TestRail case C1234', async ({ page, envConfig, testrail }) => {
+  await page.goto(envConfig.baseUrl);
+  await page.fill('input[name="username"]', 'Admin');
+  await page.fill('input[name="password"]', 'admin123');
+  await page.click('button[type="submit"]');
+  try {
+    await expect(page).toHaveURL(/dashboard/);
+    await testrail.addResult(1234, 1, "Login passed ✅");
+  } catch (err) {
+    await testrail.addResult(1234, 5, "Login failed ❌");
+    throw err;
+  }
+});
+`);
+
+// tests/filehandling
+writeFileSafe(path.join(demoDir, "tests/filehandling/filehandling.spec.ts"), `import { test } from 'simple-playwright-framework/fixtures';
+test("upload and download demo", async ({ page, fileUtils }) => {
+  await page.goto("https://the-internet.herokuapp.com/upload");
+  await fileUtils.uploadFile("#file-upload", "data/ui/sample.txt");
+  await page.click("#file-submit");
+  await page.goto("https://the-internet.herokuapp.com/download");
+  const downloadedPath = await fileUtils.downloadFile("a[href*='some-file.txt']");
+  console.log("Downloaded file path:", downloadedPath);
+});
+`);
+
+// tests/api
+writeFileSafe(path.join(demoDir, "tests/api/api.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('sample API call', async ({ request, envConfig }) => {
+  const response = await request.get(\`\${envConfig.baseUrl}/api/health\`);
+  expect(response.status()).toBe(200);
+});
+`);
+
+// tests/utils
+writeFileSafe(path.join(demoDir, "tests/utils/fileutils.test.ts"), `import { test } from 'simple-playwright-framework/fixtures';
+test('use fileUtils directly', async ({ fileUtils }) => {
+  const path = await fileUtils.downloadFile("https://example.com/file.txt");
+  console.log("Downloaded:", path);
+});
+`);
+
+// tests/reporting
+writeFileSafe(path.join(demoDir, "tests/reporting/testrail.test.ts"), `import { test } from 'simple-playwright-framework';
+test('reporting example', async ({ testrail }) => {
+  await testrail.addResult(5678, 1, "Reporting fixture works ✅");
+});
+`);
+
+// README

package/scripts/init-framework-project.js

@@ -0,0 +1,178 @@
+#!/usr/bin/env node
+const fs = require("fs");
+const path = require("path");
+const readline = require("readline");
+
+const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+const ask = (q) => new Promise(res => rl.question(q, ans => res(ans.trim())));
+
+async function scaffoldFile(filePath, content) {
+  if (fs.existsSync(filePath)) {
+    console.log(`⚠️ ALERT: ${filePath} already exists.`);
+    const ans = await ask(`Do you want to overwrite ${filePath}? (y/N): `);
+    if (ans.toLowerCase() !== "y") {
+      console.log(`❌ Skipped ${filePath}`);
+      return;
+    }
+    console.log(`✅ Approved overwrite for ${filePath}`);
+  } else {
+    const ans = await ask(`Create new file ${filePath}? (y/N): `);
+    if (ans.toLowerCase() !== "y") {
+      console.log(`❌ Skipped ${filePath}`);
+      return;
+    }
+    console.log(`✅ Approved creation of ${filePath}`);
+  }
+
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, content);
+  console.log(`📄 File created/updated: ${filePath}`);
+}
+
+(async () => {
+  const cwd = process.cwd();
+  console.log("🚀 Starting framework integration with confirmations...");
+
+  // config
+  await scaffoldFile(path.join(cwd, "config/environments.json"),
+    JSON.stringify({
+      defaults: { timeout: 30000, retries: 1, autoLaunch: false },
+      qa: { baseUrl: "http://localhost:3000", authStorage: { enabled: true, provider: "OrangeHRMLogin" } }
+    }, null, 2)
+  );
+
+  // data/login
+  await scaffoldFile(path.join(cwd, "data/login/login.json"),
+    JSON.stringify({ qa: { users: { admin: { username: "Admin", password: "admin123" } } } }, null, 2)
+  );
+  await scaffoldFile(path.join(cwd, "data/login/login.scenarios.json"),
+    JSON.stringify({ qa: [
+      { name: "Valid login", username: "Admin", password: "admin123", expected: "success" },
+      { name: "Invalid login", username: "WrongUser", password: "WrongPass", expected: "failure" }
+    ] }, null, 2)
+  );
+  await scaffoldFile(path.join(cwd, "data/login/loginwithauthstorage.json"),
+    JSON.stringify({ qa: { users: { admin: { username: "Admin", password: "admin123" } } } }, null, 2)
+  );
+
+  // data/api
+  await scaffoldFile(path.join(cwd, "data/api/payload.json"),
+    JSON.stringify({ createUser: { username: "demoUser", password: "demoPass" } }, null, 2)
+  );
+
+  // data/ui
+  await scaffoldFile(path.join(cwd, "data/ui/sample.txt"), "This is a sample file used for upload tests.\n");
+
+  // storage
+  await scaffoldFile(path.join(cwd, "storage/authStorage.json"),
+    JSON.stringify({ session: { validityMinutes: 30, provider: "OrangeHRMLogin" } }, null, 2)
+  );
+
+  // auth
+  await scaffoldFile(path.join(cwd, "auth/orangehrm.login.ts"), `import { Page } from '@playwright/test';
+import { AuthProvider } from 'simple-playwright-framework/fixtures/src/types/auth';
+export class OrangeHRMLogin implements AuthProvider {
+  constructor(private creds: { username: string; password: string }) {}
+  async login(page: Page): Promise<void> {
+    await page.fill("input[name='username']", this.creds.username);
+    await page.fill("input[name='password']", this.creds.password);
+    await page.click("button[type='submit']");
+    await page.waitForURL("**/dashboard/**");
+  }
+}
+`);
+
+  // tests/login
+  await scaffoldFile(path.join(cwd, "tests/login/login.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('login with Admin user @smoke', async ({ page, envConfig, td }) => {
+  await page.goto(envConfig.baseUrl);
+  await page.fill('input[name="username"]', td.users.admin.username);
+  await page.fill('input[name="password"]', td.users.admin.password);
+  await page.click('button[type="submit"]');
+  await expect(page).toHaveURL(/dashboard/);
+});
+`);
+
+  await scaffoldFile(path.join(cwd, "tests/login/login.scenarios.spec.ts"), `import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
+import { providerRegistry } from '@project/auth';
+const scenarios = scenarioLoader(__filename);
+test.describe.parallel("Login scenarios", () => {
+  for (const sc of scenarios) {
+    test(\`Scenario: \${sc.name}\`, async ({ page, envConfig }) => {
+      await page.goto(envConfig.baseUrl);
+      await initAuthSession(page, envConfig.authStorage!, { username: sc.username, password: sc.password }, providerRegistry);
+      if (sc.expected === "success") {
+        await expect(page).toHaveURL(/.*dashboard.*/);
+      } else {
+        await expect(page.locator(".oxd-alert-content")).toBeVisible();
+      }
+    });
+  }
+});
+`);
+
+  await scaffoldFile(path.join(cwd, "tests/login/loginwithauthstorage.spec.ts"), `import { test, expect, initAuthSession } from 'simple-playwright-framework';
+import { providerRegistry } from '@project/auth';
+test('login with Admin user using Auth Storage', async ({ page, envConfig, td }) => {
+  await page.goto(envConfig.baseUrl);
+  await initAuthSession(page, envConfig.authStorage!, { username: td.users.admin.username, password: td.users.admin.password }, providerRegistry);
+  await expect(page).toHaveURL(/dashboard/);
+});
+`);
+
+  await scaffoldFile(path.join(cwd, "tests/login/login.testrail.spec.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('Login linked to TestRail case C1234', async ({ page, envConfig, testrail }) => {
+  await page.goto(envConfig.baseUrl);
+  await page.fill('input[name="username"]', 'Admin');
+  await page.fill('input[name="password"]', 'admin123');
+  await page.click('button[type="submit"]');
+  try {
+    await expect(page).toHaveURL(/dashboard/);
+    await testrail.addResult(1234, 1, "Login passed ✅");
+  } catch (err) {
+    await testrail.addResult(1234, 5, "Login failed ❌");
+    throw err;
+  }
+});
+`);
+
+  // tests/filehandling
+  await scaffoldFile(path.join(cwd, "tests/filehandling/filehandling.spec.ts"), `import { test } from 'simple-playwright-framework/fixtures';
+test("upload and download demo", async ({ page, fileUtils }) => {
+  await page.goto("https://the-internet.herokuapp.com/upload");
+  await fileUtils.uploadFile("#file-upload", "data/ui/sample.txt");
+  await page.click("#file-submit");
+  await page.goto("https://the-internet.herokuapp.com/download");
+  const downloadedPath = await fileUtils.downloadFile("a[href*='some-file.txt']");
+  console.log("Downloaded file path:", downloadedPath);
+});
+`);
+
+  // tests/api
+  await scaffoldFile(path.join(cwd, "tests/api/api.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+test('sample API call', async ({ request, envConfig }) => {
+  const response = await request.get(\`\${envConfig.baseUrl}/api/health\`);
+  expect(response.status()).toBe(200);
+});
+`);
+
+  // tests/utils
+  await scaffoldFile(path.join(cwd, "tests/utils/fileutils.test.ts"), `import { test } from 'simple-playwright-framework/fixtures';
+test('use fileUtils directly', async ({ fileUtils }) => {
+  const path = await fileUtils.downloadFile("https://example.com/file.txt");
+  console.log("Downloaded:", path);
+});
+`);
+
+  // tests/reporting
+  await scaffoldFile(path.join(cwd, "tests/reporting/testrail.test.ts"), `import { test } from 'simple-playwright-framework';
+test('reporting example', async ({ testrail }) => {
+  await testrail.addResult(5678, 1, "Reporting fixture works ✅");
+});
+`);
+
+  rl.close();
+  console.log("\n🎉 Framework integration complete with confirmations.");
+  console.log("👉 Next step: commit and push these changes to GitHub:");
+  console.log("   git add . && git commit -m \"Integrate Playwright framework\" && git push");
+})();

package/scripts/setup-framework.js

@@ -1,70 +0,0 @@
-#!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import readline from "readline";
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
-
-function ask(question, defaultValue) {
-  return new Promise(resolve => {
-    rl.question(`${question} (${defaultValue}): `, answer => {
-      resolve(answer.trim() || defaultValue);
-    });
-  });
-}
-
-async function main() {
-  console.log("🚀 Init Sample Playwright Project");
-
-  const projectName = await ask("Project name", "sample-project");
-  const includeAuth = await ask("Include auth example? yes/no", "yes");
-  const includeData = await ask("Include data example? yes/no", "yes");
-
-  rl.close();
-
-  const projectDir = path.join(process.cwd(), projectName);
-  fs.mkdirSync(projectDir, { recursive: true });
-
-  // Config
-  fs.mkdirSync(path.join(projectDir, "config"), { recursive: true });
-  fs.writeFileSync(
-    path.join(projectDir, "config", "environments.json"),
-    JSON.stringify({ qa: { baseUrl: "http://localhost:3000" } }, null, 2)
-  );
-
-  // Tests
-  fs.mkdirSync(path.join(projectDir, "tests", "ui"), { recursive: true });
-  fs.writeFileSync(
-    path.join(projectDir, "tests", "ui", "login.spec.ts"),
-    `import { test, expect } from '@playwright/test';
-
-test('login example', async ({ page }) => {
-  await page.goto('http://localhost:3000/login');
-  await expect(page).toHaveTitle(/Login/);
-});`
-  );
-
-  if (includeAuth.toLowerCase() === "yes") {
-    fs.mkdirSync(path.join(projectDir, "auth"), { recursive: true });
-    fs.writeFileSync(
-      path.join(projectDir, "auth", "index.ts"),
-      `export const creds = { username: "testuser", password: "testpass" };`
-    );
-  }
-
-  if (includeData.toLowerCase() === "yes") {
-    fs.mkdirSync(path.join(projectDir, "data", "ui"), { recursive: true });
-    fs.writeFileSync(
-      path.join(projectDir, "data", "ui", "sample.txt"),
-      "Sample test data"
-    );
-  }
-
-  console.log(`✅ Sample project created in ${projectDir}`);
-  console.log(`👉 Next steps:\n   cd ${projectName}\n   npx playwright test`);
-}
-
-main();