simple-playwright-framework 0.0.5 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-playwright-framework",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "A modular Playwright framework with fixtures, loaders, and demo scaffolding.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,8 +13,8 @@
     "report": "playwright show-report"
   },
   "bin": {
-    "init-framework-project": "./scripts/init-framework-project.js",
-    "init-demo-project": "./scripts/init-demo-project.js"
+    "init-framework-project": "scripts/init-framework-project.js",
+    "init-demo-project": "scripts/init-demo-project.js"
   },
   "files": [
     "dist/**/*",

package/scripts/init-demo-project.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const fs = require("fs");
 const path = require("path");
 
@@ -6,62 +6,82 @@ 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
-fs.writeFileSync(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));
+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
-fs.writeFileSync(path.join(demoDir, "playwright.config.ts"), `import { defineConfig } from '@playwright/test';
-export default defineConfig({
-  testDir: './tests',
-  reporter: [['html']],
-});
+writeFileSafe(path.join(demoDir, "playwright.config.ts"), `import { defineConfig } from '@playwright/test';
+export default defineConfig({ testDir: './tests', reporter: [['html']] });
 `);
 
 // config
-const configDir = path.join(demoDir, "config");
-fs.mkdirSync(configDir, { recursive: true });
-fs.writeFileSync(path.join(configDir, "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
-const dataDir = path.join(demoDir, "data/login");
-fs.mkdirSync(dataDir, { recursive: true });
-fs.writeFileSync(path.join(dataDir, "login.json"), JSON.stringify({
-  prod: {
-    users: {
-      admin: { username: "Admin", password: "admin123" },
-      employee: { username: "Emp", password: "emp123" },
-      locked: { username: "LockedUser", password: "locked123" }
+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));
-fs.writeFileSync(path.join(dataDir, "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"] }
-  ]
-}, null, 2));
-fs.writeFileSync(path.join(dataDir, "loginwithauthstorage.json"), JSON.stringify({
-  prod: { users: { admin: { username: "Admin", password: "admin123" } } }
-}, null, 2));
+  }, 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
-const authDir = path.join(demoDir, "auth");
-fs.mkdirSync(authDir, { recursive: true });
-fs.writeFileSync(path.join(authDir, "orangehrm.login.ts"), `import { Page } from '@playwright/test';
+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 }) {}
@@ -74,19 +94,8 @@ export class OrangeHRMLogin implements AuthProvider {
 }
 `);
 
-// storage
-const storageDir = path.join(demoDir, "storage");
-fs.mkdirSync(storageDir, { recursive: true });
-fs.writeFileSync(path.join(storageDir, "authStorage.json"), JSON.stringify({
-  session: { validityMinutes: 30, provider: "OrangeHRMLogin" }
-}, null, 2));
-
-// tests
-const testsDir = path.join(demoDir, "tests");
-fs.mkdirSync(path.join(testsDir, "login"), { recursive: true });
-fs.mkdirSync(path.join(testsDir, "filehandling"), { recursive: true });
-
-fs.writeFileSync(path.join(testsDir, "login/login.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+// 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);
@@ -96,7 +105,7 @@ test('login with Admin user @smoke', async ({ page, envConfig, td }) => {
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "login/login.scenarios.spec.ts"), `import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
+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", () => {
@@ -114,7 +123,7 @@ test.describe.parallel("Login scenarios", () => {
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "login/loginwithauthstorage.spec.ts"), `import { test, expect, initAuthSession } from 'simple-playwright-framework';
+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);
@@ -123,7 +132,7 @@ test('login with Admin user using Auth Storage', async ({ page, envConfig, td })
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "login/login.testrail.spec.ts"), `import { test, expect } from 'simple-playwright-framework';
+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');
@@ -139,7 +148,8 @@ test('Login linked to TestRail case C1234', async ({ page, envConfig, testrail }
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "filehandling/filehandling.spec.ts"), `import { test } from 'simple-playwright-framework/fixtures';
+// 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");
@@ -150,4 +160,27 @@ test("upload and download demo", async ({ page, fileUtils }) => {
 });
 `);
 
-console.log("✅ Demo project created in ./demo-project with configs, data, auth, storage, and sample tests.");
+// 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

@@ -1,52 +1,75 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const fs = require("fs");
 const path = require("path");
+const readline = require("readline");
 
-const cwd = process.cwd();
-const demoDir = path.join(cwd, "demo-project");
-fs.mkdirSync(demoDir, { recursive: true });
-
-// package.json
-fs.writeFileSync(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"
+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}`);
   }
-}, null, 2));
-
-// config
-fs.mkdirSync(path.join(demoDir, "config"), { recursive: true });
-fs.writeFileSync(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
-const dataDir = path.join(demoDir, "data/login");
-fs.mkdirSync(dataDir, { recursive: true });
-fs.writeFileSync(path.join(dataDir, "login.json"), JSON.stringify({
-  prod: { users: { admin: { username: "Admin", password: "admin123" }, employee: { username: "Emp", password: "emp123" } }
-}, null, 2));
-fs.writeFileSync(path.join(dataDir, "login.scenarios.json"), JSON.stringify({
-  prod: [
-    { name: "Valid login", url: "https://opensource-demo.orangehrmlive.com/", username: "Admin", password: "admin123", expected: "success" },
-    { name: "Invalid login", url: "https://opensource-demo.orangehrmlive.com/", username: "WrongUser", password: "WrongPass", expected: "failure" }
-  ]
-}, null, 2));
-fs.writeFileSync(path.join(dataDir, "loginwithauthstorage.json"), JSON.stringify({
-  prod: { users: { admin: { username: "Admin", password: "admin123" } } }
-}, null, 2));
-
-// auth
-const authDir = path.join(demoDir, "auth");
-fs.mkdirSync(authDir, { recursive: true });
-fs.writeFileSync(path.join(authDir, "orangehrm.login.ts"), `import { Page } from '@playwright/test';
+
+  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 }) {}
@@ -59,19 +82,8 @@ export class OrangeHRMLogin implements AuthProvider {
 }
 `);
 
-// storage
-const storageDir = path.join(demoDir, "storage");
-fs.mkdirSync(storageDir, { recursive: true });
-fs.writeFileSync(path.join(storageDir, "authStorage.json"), JSON.stringify({
-  session: { validityMinutes: 30, provider: "OrangeHRMLogin" }
-}, null, 2));
-
-// tests
-const testsDir = path.join(demoDir, "tests");
-fs.mkdirSync(path.join(testsDir, "login"), { recursive: true });
-fs.mkdirSync(path.join(testsDir, "filehandling"), { recursive: true });
-
-fs.writeFileSync(path.join(testsDir, "login/login.test.ts"), `import { test, expect } from 'simple-playwright-framework';
+  // 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);
@@ -81,7 +93,7 @@ test('login with Admin user @smoke', async ({ page, envConfig, td }) => {
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "login/login.scenarios.spec.ts"), `import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
+  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", () => {
@@ -99,4 +111,68 @@ test.describe.parallel("Login scenarios", () => {
 });
 `);
 
-fs.writeFileSync(path.join(testsDir, "login/loginwithauthstorage.spec.ts"), `import { test, expect, initAuthSession } from '
+  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");
+})();