simple-playwright-framework 0.0.9 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-playwright-framework",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "A modular Playwright framework with fixtures, loaders, and demo scaffolding.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,6 +40,7 @@
     "rimraf": "^6.1.2",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "node-fetch": "^2.6.7"
   }
 }

package/scripts/init-demo-project.js

@@ -18,7 +18,7 @@ function run(cmd, cwd) {
   execSync(cmd, { stdio: "inherit", cwd });
 }
 
-// package.json
+// -------------------- package.json --------------------
 writeFileSafe(path.join(demoDir, "package.json"),
   JSON.stringify({
     name: "demo-project",
@@ -39,7 +39,7 @@ writeFileSafe(path.join(demoDir, "package.json"),
   }, null, 2)
 );
 
-// tsconfig.json
+// -------------------- tsconfig.json --------------------
 writeFileSafe(path.join(demoDir, "tsconfig.json"),
   JSON.stringify({
     compilerOptions: {
@@ -52,30 +52,84 @@ writeFileSafe(path.join(demoDir, "tsconfig.json"),
       resolveJsonModule: true,
       types: ["@playwright/test", "simple-playwright-framework", "node"],
       baseUrl: ".",
-      paths: { "@demo-project/*": ["./*"] , "@demo-project/auth": ["auth/index.ts"]},
+      paths: { "@demo-project/*": ["./*"], "@demo-project/auth": ["auth/index.ts"] },
       outDir: "dist"
     },
     include: ["tests/**/*.ts", "global.d.ts"]
   }, null, 2)
 );
 
-// playwright.config.ts
-writeFileSafe(path.join(demoDir, "playwright.config.ts"), `import { defineConfig } from '@playwright/test';
+// -------------------- playwright.config.ts --------------------
+writeFileSafe(path.join(demoDir, "playwright.config.ts"), 
+`import { defineConfig } from '@playwright/test';
 export default defineConfig({ testDir: './tests', reporter: [['html']] });
 `);
 
-
-// config
+// -------------------- environments.json --------------------
 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" } }
+    prod: { baseUrl: "https://opensource-demo.orangehrmlive.com/", apiUrl: "https://jsonplaceholder.typicode.com", authStorage: { enabled: true, provider: "OrangeHRMLogin" } }
   }, null, 2)
 );
 
-// data/login
+// -------------------- Auth Provider --------------------
+writeFileSafe(path.join(demoDir, "auth/index.ts"), 
+`import { OrangeHRMLogin } from "./orangehrm.login";
+
+export const providerRegistry = {
+  OrangeHRMLogin,
+};
+`);
+
+writeFileSafe(path.join(demoDir, "auth/orangehrm.login.ts"), 
+`import { Page } from '@playwright/test';
+import { AuthProvider } from 'simple-playwright-framework';
+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']");
+    // No unconditional waitForURL here — handled in tests
+  }
+}
+`);
+
+// -------------------- FileUtils --------------------
+writeFileSafe(path.join(demoDir, "utils/file-utils.ts"), 
+`import { Page } from "@playwright/test";
+import fs from "fs";
+import path from "path";
+
+export class FileUtils {
+  constructor(private page: Page) {}
+
+  async uploadFile(selector: string, filePath: string) {
+    const absolutePath = path.resolve(filePath);
+    if (!fs.existsSync(absolutePath)) {
+      throw new Error(\`❌ File not found: \${absolutePath}\`);
+    }
+    await this.page.setInputFiles(selector, absolutePath);
+    console.log(\`✅ Uploaded file: \${absolutePath}\`);
+  }
+
+  async downloadFile(selector: string, downloadDir: string = "downloads") {
+    const downloadPromise = this.page.waitForEvent("download");
+    await this.page.click(selector);
+    const download = await downloadPromise;
+
+    const filePath = path.join(downloadDir, await download.suggestedFilename());
+    await download.saveAs(filePath);
+    console.log(\`✅ File downloaded to: \${filePath}\`);
+    return filePath;
+  }
+}
+`);
+
+// -------------------- Data --------------------
 writeFileSafe(path.join(demoDir, "data/login/login.json"),
   JSON.stringify({
     prod: {
@@ -88,58 +142,35 @@ writeFileSafe(path.join(demoDir, "data/login/login.json"),
     }
   }, 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"] }
+      { name: "Valid login Two", url: "https://opensource-demo.orangehrmlive.com/", username: "Admin", password: "admin123", 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)
 );
 
-
-// -------------------- auth/index.ts --------------------
-writeFileSafe(path.join(demoDir, "auth/index.ts"), 
-`import { OrangeHRMLogin } from "./orangehrm.login";
-
-export const providerRegistry = {
-  OrangeHRMLogin,
-};
-`);
-
-// 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';
-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';
+// -------------------- Tests --------------------
+// Login basic test
+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);
@@ -149,7 +180,9 @@ test('login with Admin user @smoke', async ({ page, envConfig, td }) => {
 });
 `);
 
-writeFileSafe(path.join(demoDir, "tests/login/login.scenarios.spec.ts"), `import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
+// Login scenarios
+writeFileSafe(path.join(demoDir, "tests/login/login.scenarios.spec.ts"), 
+`import { test, expect, scenarioLoader, initAuthSession } from 'simple-playwright-framework';
 import { providerRegistry } from '@demo-project/auth';
 const scenarios = scenarioLoader(__filename);
 test.describe.parallel("Login scenarios", () => {
@@ -167,7 +200,9 @@ test.describe.parallel("Login scenarios", () => {
 });
 `);
 
-writeFileSafe(path.join(demoDir, "tests/login/loginwithauthstorage.spec.ts"), `import { test, expect, initAuthSession } from 'simple-playwright-framework';
+// Login with auth storage
+writeFileSafe(path.join(demoDir, "tests/login/loginwithauthstorage.spec.ts"), 
+`import { test, expect, initAuthSession } from 'simple-playwright-framework';
 import { providerRegistry } from '@demo-project/auth';
 test('login with Admin user using Auth Storage', async ({ page, envConfig, td }) => {
   await page.goto(envConfig.baseUrl);
@@ -176,7 +211,9 @@ test('login with Admin user using Auth Storage', async ({ page, envConfig, td })
 });
 `);
 
-writeFileSafe(path.join(demoDir, "tests/login/login.testrail.spec.ts"), `import { test, expect } from 'simple-playwright-framework';
+// Login with TestRail reporting
+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');
@@ -192,46 +229,59 @@ test('Login linked to TestRail case C1234', async ({ page, envConfig, testrail }
 });
 `);
 
-// tests/filehandling
-writeFileSafe(path.join(demoDir, "tests/filehandling/filehandling.spec.ts"), `import { test } from 'simple-playwright-framework';
+// File handling test
+writeFileSafe(path.join(demoDir, "tests/filehandling/filehandling.spec.ts"), 
+`import { test, expect } from 'simple-playwright-framework';
+
 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']");
+  const link = page.locator("a[href*='sample.txt']");
+  await expect(link).toBeVisible();
+
+  const downloadedPath = await fileUtils.downloadFile("a[href*='sample.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';
+// API test
+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\`);
+  console.log("API URL: " + envConfig.apiUrl);
+  const response = await request.get(\`\${envConfig.apiUrl}/users\`);
   expect(response.status()).toBe(200);
 });
 `);
 
-// tests/utils
-writeFileSafe(path.join(demoDir, "tests/utils/fileutils.test.ts"), `import { test } from 'simple-playwright-framework';
-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';
+// Reporting example
+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
-writeFileSafe(path.join(demoDir, "README.md"), `# Demo Project
+writeFileSafe(path.join(demoDir, "README.md"), 
+`# Demo Project
 
 This is a scaffolded Playwright demo project using **simple-playwright-framework**.
-Run \`npm run test\` to execute the sample tests.
+
+## Features
+- ✅ UI login scenarios (success & failure)
+- ✅ API test using jsonplaceholder
+- ✅ File upload & download test with FileUtils
+- ✅ Auth storage example
+- ✅ TestRail reporting example
+
+## Usage
+- Run \`npm run init\` to scaffold the project
+- Run \`npm run test\` to execute all sample tests
+- Run \`npm run build\` to compile TypeScript
 `);
 
 // Final step: install deps + build