@flash-ai-team/flash-test-framework 0.0.1

package/dist/reporting/EmailReporter.js

@@ -0,0 +1,169 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const archiver_1 = __importDefault(require("archiver"));
+const ReporterUtils_1 = require("./ReporterUtils");
+class EmailReporter {
+    constructor() {
+        this.suiteStartTime = 0;
+    }
+    onBegin(config, suite) {
+        this.suiteStartTime = Date.now();
+        this.rootSuite = suite;
+        console.log(`[EmailReporter] Starting test suite at ${new Date(this.suiteStartTime).toISOString()}`);
+    }
+    async onEnd(result) {
+        const duration = Date.now() - this.suiteStartTime;
+        console.log(`[EmailReporter] Finished suite in ${duration}ms`);
+        let config;
+        try {
+            const configPath = path_1.default.resolve(process.cwd(), 'email.config.json');
+            if (fs_1.default.existsSync(configPath)) {
+                config = JSON.parse(fs_1.default.readFileSync(configPath, 'utf-8'));
+            }
+        }
+        catch (e) {
+            console.error('[EmailReporter] Failed to load email.config.json', e);
+        }
+        if (!config || !config.enabled) {
+            console.log('[EmailReporter] Email reporting disabled in email.config.json or file not found.');
+            return;
+        }
+        const reportFolder = (0, ReporterUtils_1.getReportFolder)({ suites: [] }); // Use memoized folder
+        const zipPath = `${reportFolder}.zip`;
+        console.log(`[EmailReporter] Zipping report folder: ${reportFolder}`);
+        try {
+            await this.zipDirectory(reportFolder, zipPath);
+            console.log(`[EmailReporter] Zip created at: ${zipPath}`);
+        }
+        catch (error) {
+            console.error('[EmailReporter] Failed to zip report:', error);
+        }
+        const transport = nodemailer_1.default.createTransport({
+            host: config.host,
+            port: config.port,
+            secure: config.secure,
+            auth: config.auth,
+        });
+        // Generate Detailed Summary
+        let suiteSummaryRows = '';
+        if (this.rootSuite) {
+            for (const projectSuite of this.rootSuite.suites) {
+                const projectName = projectSuite.title;
+                // In Playwright, projectSuite.suites are usually the files (specs)
+                for (const fileSuite of projectSuite.suites) {
+                    const suiteName = fileSuite.title;
+                    const allTests = fileSuite.allTests();
+                    const total = allTests.length;
+                    let passed = 0;
+                    let failed = 0;
+                    let skipped = 0;
+                    for (const test of allTests) {
+                        const outcome = test.results[0]?.status; // Naive status check, ideally check all results or use outcome() logic
+                        // Better: check test.outcome() if available or calculate
+                        if (test.outcome() === 'expected')
+                            passed++;
+                        else if (test.outcome() === 'skipped')
+                            skipped++;
+                        else if (test.outcome() === 'unexpected')
+                            failed++;
+                        else if (test.outcome() === 'flaky')
+                            passed++; // Treat flaky as passed in simple summary
+                    }
+                    // Only show if tests were run or if user wants to see everything
+                    if (total > 0) {
+                        const rowColor = failed > 0 ? '#ffe6e6' : '#e6ffe6';
+                        suiteSummaryRows += `
+                            <tr style="background-color: ${rowColor};">
+                                <td>${projectName}</td>
+                                <td>${path_1.default.basename(suiteName)}</td>
+                                <td>${total}</td>
+                                <td>${passed}</td>
+                                <td style="color: ${failed > 0 ? 'red' : 'green'}; font-weight: bold;">${failed}</td>
+                                <td>${skipped}</td>
+                            </tr>
+                         `;
+                    }
+                }
+            }
+        }
+        const status = result.status.toUpperCase();
+        const statusColor = status === 'PASSED' ? 'green' : 'red';
+        const subject = `Test Run ${status}: ${new Date().toLocaleString()}`;
+        const html = `
+            <h2>Test Execution Summary</h2>
+            <p><strong>Status:</strong> <span style="color: ${statusColor}; font-weight: bold;">${status}</span></p>
+            <p><strong>Duration:</strong> ${(duration / 1000).toFixed(2)}s</p>
+            <p><strong>Start Time:</strong> ${new Date(this.suiteStartTime).toLocaleString()}</p>
+            
+            <h3>Suite Breakdown</h3>
+            <table border="1" cellpadding="8" cellspacing="0" style="border-collapse: collapse; font-family: Arial, sans-serif; width: 100%;">
+                <thead style="background-color: #f2f2f2;">
+                    <tr>
+                        <th style="text-align: left;">Browser</th>
+                        <th style="text-align: left;">Suite (File)</th>
+                        <th>Total</th>
+                        <th>Passed</th>
+                        <th>Failed</th>
+                        <th>Skipped</th>
+                    </tr>
+                </thead>
+                <tbody>
+                    ${suiteSummaryRows}
+                </tbody>
+            </table>
+            
+            <br/>
+            <p>Report attached.</p>
+        `;
+        const mailOptions = {
+            from: config.from,
+            to: config.to,
+            subject: subject,
+            html: html,
+            attachments: []
+        };
+        if (fs_1.default.existsSync(zipPath)) {
+            mailOptions.attachments.push({
+                filename: 'TestReport.zip',
+                path: zipPath
+            });
+        }
+        const htmlReportPath = path_1.default.join(reportFolder, 'report.html');
+        if (fs_1.default.existsSync(htmlReportPath)) {
+            mailOptions.attachments.push({
+                filename: 'report.html',
+                path: htmlReportPath
+            });
+        }
+        else {
+            console.warn('[EmailReporter] Warning: Report zip file not found, sending email without attachment.');
+        }
+        try {
+            console.log(`[EmailReporter] Sending email to ${config.to}...`);
+            const info = await transport.sendMail(mailOptions);
+            console.log(`[EmailReporter] Email sent: ${info.messageId}`);
+        }
+        catch (error) {
+            console.error('[EmailReporter] Error sending email:', error);
+        }
+    }
+    zipDirectory(sourceDir, outPath) {
+        const archive = (0, archiver_1.default)('zip', { zlib: { level: 9 } });
+        const stream = fs_1.default.createWriteStream(outPath);
+        return new Promise((resolve, reject) => {
+            archive
+                .directory(sourceDir, false)
+                .on('error', err => reject(err))
+                .pipe(stream);
+            stream.on('close', () => resolve());
+            archive.finalize();
+        });
+    }
+}
+exports.default = EmailReporter;

package/dist/reporting/HtmlReporter.d.ts

@@ -0,0 +1,11 @@
+import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
+declare class HtmlReporter implements Reporter {
+    private suiteStartTime;
+    private reportPath;
+    onBegin(config: FullConfig, suite: Suite): void;
+    onEnd(result: FullResult): Promise<void>;
+    private testResults;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    private generateHtml;
+}
+export default HtmlReporter;

package/dist/reporting/HtmlReporter.js

@@ -0,0 +1,190 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const ReporterUtils_1 = require("./ReporterUtils");
+class HtmlReporter {
+    constructor() {
+        this.suiteStartTime = 0;
+        this.reportPath = '';
+        // onExit removed as generation is now in onEnd
+        this.testResults = [];
+    }
+    onBegin(config, suite) {
+        this.suiteStartTime = Date.now();
+        const folder = (0, ReporterUtils_1.getReportFolder)(suite);
+        this.reportPath = path.join(folder, 'report.html');
+    }
+    async onEnd(result) {
+        if (!this.reportPath)
+            return;
+        const html = this.generateHtml();
+        if (!fs.existsSync(path.dirname(this.reportPath))) {
+            fs.mkdirSync(path.dirname(this.reportPath), { recursive: true });
+        }
+        fs.writeFileSync(this.reportPath, html);
+        console.log(`HTML Report generated at: ${this.reportPath}`);
+    }
+    onTestEnd(test, result) {
+        let suite = test.parent;
+        let suiteName = '';
+        while (suite) {
+            if (suite.title && suite.title !== 'Root') {
+                suiteName = suite.title + (suiteName ? ' > ' + suiteName : '');
+            }
+            suite = suite.parent;
+        }
+        if (!suiteName) {
+            suiteName = path.basename(test.location.file);
+        }
+        const reportDir = this.reportPath ? path.dirname(this.reportPath) : '';
+        if (reportDir && !fs.existsSync(reportDir)) {
+            fs.mkdirSync(reportDir, { recursive: true });
+        }
+        // Helper to copy attachment
+        const copyAttachment = (name, matchFn) => {
+            const attachment = result.attachments.find(matchFn);
+            if (attachment && attachment.path && reportDir) {
+                const fileName = `${name}_${test.title.replace(/[^a-z0-9]/gi, '_')}_${Date.now()}${path.extname(attachment.path)}`;
+                const destPath = path.join(reportDir, fileName);
+                try {
+                    fs.copyFileSync(attachment.path, destPath);
+                    return fileName;
+                }
+                catch (e) {
+                    console.error(`Failed to copy ${name} attachment`, e);
+                }
+            }
+            return undefined;
+        };
+        // Handle Video
+        const videoRelativePath = copyAttachment('video', a => a.name === 'video' && !!a.path);
+        // Handle Screenshot (usually named 'screenshot' or has image content type)
+        const screenshotRelativePath = copyAttachment('screenshot', a => (a.name === 'screenshot' || a.contentType.startsWith('image/')) && !!a.path);
+        this.testResults.push({ test, result, suiteName, videoPath: videoRelativePath, screenshotPath: screenshotRelativePath });
+    }
+    generateHtml() {
+        const rows = this.testResults.map((item, index) => {
+            const statusColor = item.result.status === 'passed' ? '#dff0d8' : item.result.status === 'failed' ? '#f2dede' : '#fcf8e3';
+            const statusText = item.result.status.toUpperCase();
+            // Steps processing
+            const stepsHtml = item.result.steps.map(step => {
+                return `<div class="step">
+                            <span class="step-title">${step.title}</span>
+                            <span class="step-duration">${step.duration}ms</span>
+                            ${step.error ? `<div class="error">${step.error.message}</div>` : ''}
+                        </div>`;
+            }).join('');
+            const screenshotHtml = item.screenshotPath ? `
+                <div class="screenshot-container" style="margin-top: 15px;">
+                    <h3>Screenshot</h3>
+                    <img src="${item.screenshotPath}" alt="Failure Screenshot" style="max-width: 100%; border: 1px solid #ddd;">
+                </div>
+            ` : '';
+            const videoHtml = item.videoPath ? `
+                <div class="video-container" style="margin-top: 15px;">
+                    <h3>Video Recording</h3>
+                    <video width="640" height="480" controls>
+                        <source src="${item.videoPath}" type="video/webm">
+                        Your browser does not support the video tag.
+                    </video> 
+                </div>
+            ` : '';
+            return `
+                <tr class="test-row" onclick="toggleDetails(${index})" style="background-color: ${statusColor}">
+                    <td>${item.suiteName}</td>
+                    <td>${item.test.title}</td>
+                    <td>${statusText}</td>
+                    <td>${item.result.duration}ms</td>
+                </tr>
+                <tr id="details-${index}" style="display:none">
+                    <td colspan="4">
+                        <div class="details-container">
+                            ${stepsHtml}
+                            ${screenshotHtml}
+                            ${videoHtml}
+                        </div>
+                    </td>
+                </tr>
+            `;
+        }).join('');
+        return `
+            <!DOCTYPE html>
+            <html>
+            <head>
+                <title>Test Execution Report</title>
+                <style>
+                    body { font-family: Arial, sans-serif; margin: 20px; }
+                    h1 { color: #333; }
+                    table { width: 100%; border-collapse: collapse; margin-top: 20px; }
+                    th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }
+                    th { background-color: #f2f2f2; }
+                    .test-row { cursor: pointer; }
+                    .step { margin: 5px 0; padding: 5px; border-left: 3px solid #007bff; background: #f9f9f9; }
+                    .step-title { font-weight: bold; }
+                    .step-duration { float: right; color: #666; font-size: 0.9em; }
+                    .error { color: red; margin-top: 5px; white-space: pre-wrap; }
+                    .details-container { padding: 10px; background: #fff; border: 1px solid #ddd; }
+                </style>
+                <script>
+                    function toggleDetails(id) {
+                        var row = document.getElementById('details-' + id);
+                        row.style.display = row.style.display === 'none' ? 'table-row' : 'none';
+                    }
+                </script>
+            </head>
+            <body>
+                <h1>Execution Report</h1>
+                <p>Generated: ${new Date().toLocaleString()}</p>
+                <table>
+                    <thead>
+                        <tr>
+                            <th>Test Suite</th>
+                            <th>Test Case</th>
+                            <th>Status</th>
+                            <th>Duration</th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                        ${rows}
+                    </tbody>
+                </table>
+            </body>
+            </html>
+        `;
+    }
+}
+exports.default = HtmlReporter;

package/dist/reporting/ReporterUtils.d.ts

@@ -0,0 +1,3 @@
+import { Suite } from '@playwright/test/reporter';
+export declare function getReportFolder(suite: Suite): string;
+export declare function resetReportFolderCache(): void;

package/dist/reporting/ReporterUtils.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReportFolder = getReportFolder;
+exports.resetReportFolderCache = resetReportFolderCache;
+const path = __importStar(require("path"));
+let cachedReportFolder = null;
+function getReportFolder(suite) {
+    if (cachedReportFolder) {
+        return cachedReportFolder;
+    }
+    const timestamp = new Date().toISOString().replace(/T/, '_').replace(/:/g, '').split('.')[0];
+    // Find the first test file suite
+    let suiteName = 'TestRun';
+    if (suite.suites.length > 0) {
+        const projectSuite = suite.suites[0];
+        if (projectSuite.suites.length > 0) {
+            const fileSuite = projectSuite.suites[0];
+            // Extract basename without extension (e.g. "TestA.spec.ts" -> "TestA")
+            const filename = path.basename(fileSuite.location?.file || '');
+            if (filename) {
+                suiteName = filename.split('.')[0];
+            }
+        }
+    }
+    cachedReportFolder = path.join(process.cwd(), 'reports', suiteName, `test_${timestamp}`);
+    console.log(`[ReporterUtils] Calculated report folder: ${cachedReportFolder}`);
+    return cachedReportFolder;
+}
+function resetReportFolderCache() {
+    cachedReportFolder = null;
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@flash-ai-team/flash-test-framework",
+  "version": "0.0.1",
+  "description": "A powerful keyword-driven automation framework built on top of Playwright and TypeScript.",
+  "keywords": [
+    "playwright",
+    "automation",
+    "framework",
+    "keyword-driven",
+    "typescript",
+    "testing",
+    "flash-test"
+  ],
+  "homepage": "https://bitbucket.org/dluonganh/flash-ai-test#readme",
+  "bugs": {
+    "url": "https://bitbucket.org/dluonganh/flash-ai-test/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/dluonganh/flash-ai-test.git"
+  },
+  "license": "ISC",
+  "author": "Flash Test Team",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "directories": {
+    "test": "tests"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
+    "test:chrome": "npm run test:chrome:headless",
+    "test:chrome:headless": "playwright test --project=chrome",
+    "test:chrome:ui": "playwright test --project=chrome --headed",
+    "test:firefox": "playwright test --project=firefox",
+    "test:webkit": "playwright test --project=webkit",
+    "test:suite:parallel": "playwright test tests/suites/parallel_suite.spec.ts",
+    "test:suite:sequential": "playwright test tests/suites/sequential_suite.spec.ts",
+    "test:all:parallel": "playwright test --workers=4",
+    "test:all:serial": "playwright test --workers=1"
+  },
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "jimp": "^1.6.0",
+    "nodemailer": "^7.0.12",
+    "openai": "^6.15.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.57.0",
+    "@types/archiver": "^7.0.0",
+    "@types/node": "^25.0.3",
+    "@types/nodemailer": "^7.0.4",
+    "typescript": "^5.9.3"
+  }
+}