snap-ally 0.0.2 → 0.1.0-beta

package/dist/SnapAllyReporter.js

@@ -44,6 +44,9 @@ const fs = __importStar(require("fs"));
  * Generates an execution summary and detailed reports per test.
  */
 class SnapAllyReporter {
+    printsToStdio() {
+        return false;
+    }
     constructor(options = {}) {
         this.testIndex = 0;
         this.assetsManager = new A11yReportAssets_1.A11yReportAssets();
@@ -62,7 +65,8 @@ class SnapAllyReporter {
             groupedResults: {},
             wcagErrors: {},
             totalA11yErrorCount: 0,
-            browserSummaries: {}
+            browserSummaries: {},
+            date: ''
         };
         // Track async tasks to ensure they finish before onEnd
         this.tasks = [];
@@ -76,7 +80,7 @@ class SnapAllyReporter {
         this.tasks.push(this.processTestResult(test, result));
     }
     async processTestResult(test, result) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         this.testIndex++;
         const sanitizedTitle = test.title.replace(/[^a-z0-9]+/gi, '-').toLowerCase();
         const testFolderName = `${this.testIndex}-${sanitizedTitle}`;
@@ -88,14 +92,14 @@ class SnapAllyReporter {
         }
         const tags = test.tags.map(t => t.replace('@', ''));
         const statusIcon = models_1.TestStatusIcon[result.status] || 'help';
-        const browser = ((_a = test.parent.project()) === null || _a === void 0 ? void 0 : _a.name) || 'unknown';
+        const projectUse = ((_a = test.parent.project()) === null || _a === void 0 ? void 0 : _a.use) || {};
+        const browser = ((_b = test.parent.project()) === null || _b === void 0 ? void 0 : _b.name) || projectUse.browserName || projectUse.defaultBrowserType || 'chromium';
         const descAnnotation = test.annotations.find(a => a.type === 'Description');
         const description = (descAnnotation === null || descAnnotation === void 0 ? void 0 : descAnnotation.description) || 'No Description';
-        // Prepare steps from annotations
-        const skipTypes = new Set(['Pre Condition', 'Post Condition', 'Description', 'A11y']);
-        const steps = test.annotations
-            .filter(a => !skipTypes.has(a.type))
-            .map(a => a.description || 'Step');
+        // Prepare steps from actual test.step calls instead of just annotations
+        const steps = result.steps
+            .filter(s => s.category === 'test.step')
+            .map(s => s.title);
         const preConditions = test.annotations
             .filter(a => a.type === 'Pre Condition')
             .map(a => a.description || '');
@@ -126,6 +130,7 @@ class SnapAllyReporter {
         let a11yReportPath = undefined;
         let a11yErrorCount = 0;
         let aggregatedA11yErrors = [];
+        let testStatsPageUrl = undefined;
         // Loop through all accessibility scans in this test
         for (const [index, source] of a11yDataSources.entries()) {
             let reportData;
@@ -173,10 +178,10 @@ class SnapAllyReporter {
             // Set the main report path to the LAST one (or maybe first? using last for now)
             a11yReportPath = a11yReportName;
             // Re-apply configuration
-            reportData.criticalColor = ((_b = this.options.colors) === null || _b === void 0 ? void 0 : _b.critical) || '#c92a2a';
-            reportData.seriousColor = ((_c = this.options.colors) === null || _c === void 0 ? void 0 : _c.serious) || '#e67700';
-            reportData.moderateColor = ((_d = this.options.colors) === null || _d === void 0 ? void 0 : _d.moderate) || '#ca8a04';
-            reportData.minorColor = ((_e = this.options.colors) === null || _e === void 0 ? void 0 : _e.minor) || '#0891b2';
+            reportData.criticalColor = ((_c = this.options.colors) === null || _c === void 0 ? void 0 : _c.critical) || '#c92a2a';
+            reportData.seriousColor = ((_d = this.options.colors) === null || _d === void 0 ? void 0 : _d.serious) || '#e67700';
+            reportData.moderateColor = ((_e = this.options.colors) === null || _e === void 0 ? void 0 : _e.moderate) || '#ca8a04';
+            reportData.minorColor = ((_f = this.options.colors) === null || _f === void 0 ? void 0 : _f.minor) || '#0891b2';
             if (this.options.ado) {
                 reportData.adoOrganization = this.options.ado.organization || reportData.adoOrganization;
                 reportData.adoProject = this.options.ado.project || reportData.adoProject;
@@ -184,8 +189,24 @@ class SnapAllyReporter {
             // Sync video name
             if (video)
                 reportData.video = video;
+            // Backfill steps from actual test.step calls if annotations were empty
+            const filteredSteps = steps.filter(s => !s.includes('Capture A11y screenshot'));
+            if (filteredSteps.length > 0) {
+                reportData.a11yErrors.forEach(err => {
+                    err.target.forEach(t => {
+                        if (!t.steps || t.steps.length === 0) {
+                            t.steps = filteredSteps;
+                            t.stepsJson = JSON.stringify(filteredSteps);
+                        }
+                    });
+                });
+            }
             const auditFile = path.join(testResultsFolder, a11yReportName);
             await this.renderer.render('accessibility-report.html', { data: reportData, folderTest: testResultsFolder }, testResultsFolder, auditFile);
+            // Capture the first page URL for the testStats if not already set
+            if (reportData.pageUrl && !testStatsPageUrl) {
+                testStatsPageUrl = reportData.pageUrl;
+            }
             // --- 3. Update Browser-Specific Summary (Partial Aggregation) ---
             if (!this.executionSummary.browserSummaries[browser]) {
                 this.executionSummary.browserSummaries[browser] = {
@@ -203,12 +224,12 @@ class SnapAllyReporter {
                 };
             }
             const bSummary = this.executionSummary.browserSummaries[browser];
-            if (reportData.errors && reportData.errors.length > 0) {
+            if (reportData.a11yErrors && reportData.a11yErrors.length > 0) {
                 // Aggregate counts
-                const scanErrorCount = reportData.errors.reduce((sum, err) => sum + (err.total || 0), 0);
+                const scanErrorCount = reportData.a11yErrors.reduce((sum, err) => sum + (err.total || 0), 0);
                 a11yErrorCount += scanErrorCount;
-                aggregatedA11yErrors.push(...reportData.errors);
-                reportData.errors.forEach((err) => {
+                aggregatedA11yErrors.push(...reportData.a11yErrors);
+                reportData.a11yErrors.forEach((err) => {
                     const rule = err.id;
                     // Local Browser aggregation 
                     if (!bSummary.wcagErrors[rule]) {
@@ -275,13 +296,15 @@ class SnapAllyReporter {
             steps,
             postConditions,
             statusIcon,
+            pageUrl: testStatsPageUrl,
             videoPath: video,
             screenshotPaths: screenshots,
             attachments: allAttachments,
             errors: errorLogs,
             a11yReportPath,
             a11yErrorCount,
-            a11yErrors: aggregatedA11yErrors
+            a11yErrors: aggregatedA11yErrors,
+            colors: this.options.colors
         };
         this.executionSummary.groupedResults[fileGroup].push(testStats);
         // Update summary counts
@@ -302,14 +325,14 @@ class SnapAllyReporter {
         this.executionSummary.total++;
         // Create color config for template
         const colors = {
-            critical: ((_f = this.options.colors) === null || _f === void 0 ? void 0 : _f.critical) || '#c92a2a',
-            serious: ((_g = this.options.colors) === null || _g === void 0 ? void 0 : _g.serious) || '#e67700',
-            moderate: ((_h = this.options.colors) === null || _h === void 0 ? void 0 : _h.moderate) || '#ca8a04',
-            minor: ((_j = this.options.colors) === null || _j === void 0 ? void 0 : _j.minor) || '#0891b2'
+            critical: ((_g = this.options.colors) === null || _g === void 0 ? void 0 : _g.critical) || '#c92a2a',
+            serious: ((_h = this.options.colors) === null || _h === void 0 ? void 0 : _h.serious) || '#e67700',
+            moderate: ((_j = this.options.colors) === null || _j === void 0 ? void 0 : _j.moderate) || '#ca8a04',
+            minor: ((_k = this.options.colors) === null || _k === void 0 ? void 0 : _k.minor) || '#0891b2'
         };
         // Render Step Report
         const indexFile = path.join(testResultsFolder, `execution-${sanitizedTitle}.html`);
-        await this.renderer.render('test-execution-report.html', { result: testStats, colors }, testResultsFolder, indexFile);
+        await this.renderer.render('test-execution-report.html', { ...testStats, colors }, testResultsFolder, indexFile);
     }
     async onEnd(result) {
         var _a, _b, _c, _d;
@@ -319,13 +342,14 @@ class SnapAllyReporter {
         this.executionSummary.duration = A11yTimeUtils_1.A11yTimeUtils.formatDuration(result.duration);
         this.executionSummary.status = result.status;
         this.executionSummary.statusIcon = models_1.TestStatusIcon[result.status] || 'help';
+        this.executionSummary.date = A11yTimeUtils_1.A11yTimeUtils.formatDate(new Date());
         const colors = {
             critical: ((_a = this.options.colors) === null || _a === void 0 ? void 0 : _a.critical) || '#c92a2a',
             serious: ((_b = this.options.colors) === null || _b === void 0 ? void 0 : _b.serious) || '#e67700',
             moderate: ((_c = this.options.colors) === null || _c === void 0 ? void 0 : _c.moderate) || '#ca8a04',
             minor: ((_d = this.options.colors) === null || _d === void 0 ? void 0 : _d.minor) || '#0891b2'
         };
-        await this.renderer.render('execution-summary.html', { results: this.executionSummary, colors }, this.outputFolder, summaryFile);
+        await this.renderer.render('execution-summary.html', { ...this.executionSummary, colors }, this.outputFolder, summaryFile);
         console.log(`\n[SnapAlly] Reports generated in: ${path.resolve(this.outputFolder)}`);
     }
 }

package/dist/models/index.d.ts

@@ -1,8 +1,9 @@
 export interface ReportData {
     pageKey: string;
+    pageUrl?: string;
     accessibilityScore: number;
     video: string;
-    errors: A11yError[];
+    a11yErrors: A11yError[];
     criticalColor: string;
     seriousColor: string;
     moderateColor: string;
@@ -10,6 +11,7 @@ export interface ReportData {
     adoOrganization?: string;
     adoProject?: string;
     adoPat?: string;
+    timestamp?: string;
 }
 export interface A11yError {
     id: string;
@@ -50,6 +52,7 @@ export interface TestResults {
     duration: string;
     description: string;
     status: string;
+    pageUrl?: string;
     browser: string;
     tags: string[];
     preConditions: string[];
@@ -67,8 +70,15 @@ export interface TestResults {
     executionReportPath?: string;
     a11yErrors?: A11yError[];
     a11yErrorCount?: number;
+    colors?: {
+        critical?: string;
+        serious?: string;
+        moderate?: string;
+        minor?: string;
+    };
 }
 export interface TestSummary {
+    date?: string;
     duration: string;
     status: string;
     statusIcon: string;