updated screenshot on fail update

Author: teo-nikolov

@bellatrix/extras/src/plugins/ScreenshotOnFailPlugin.ts

@@ -3,23 +3,47 @@ import { TestMetadata } from '@bellatrix/core/test/props';
 import { ServiceLocator } from '@bellatrix/core/utilities';
 import { Image } from '@bellatrix/core/image';
 import { App } from '@bellatrix/web/infrastructure';
-import * as fs from 'fs';
-import * as path from 'path';
+import { existsSync, mkdirSync, writeFileSync } from 'fs';
+import { dirname, extname, join } from 'path';
+import { BellatrixSettings } from '@bellatrix/core/settings';
 
 export class ScreenshotOnFailPlugin extends Plugin {
     override async preAfterTest(metadata: TestMetadata): Promise<void> {
+        const pluginSettings = BellatrixSettings.get().screenshotOnFailPluginSettings;
+
+        if (!pluginSettings?.isPluginEnabled) {
+            return;
+        }
+
         if (!metadata.error) {
             return;
         }
 
         const app = ServiceLocator.resolve(App);
         const screenshotImage = await app.browser.getScreenshot();
-        // Save the screenshot as an image file
+
+        const outputPath = pluginSettings?.outputPath;
+
+        if (!outputPath) {
+            console.error('Output path for screenshots is not defined in the configuration.');
+            return;
+        }
+
         try {
-            const savePath = this.saveImageToFile(screenshotImage, '../reports/screenshots/' + metadata.testName); // TODO: take from config
+            const projectRoot = process.env['BELLATRIX_CONFIGURAITON_ROOT']!; // TODO: find a better way to get the project root
+            const pathArray = [projectRoot, outputPath];
+            if (pluginSettings?.shouldCreateFolderPerSuite) {
+                pathArray.push(metadata.suiteName);
+            }
+            pathArray.push(metadata.testName);
+            const savePath = this.saveImageToFile(screenshotImage, join(...pathArray));
             console.info('\n Screenshot for failed test ' + metadata.testName + ': ' + savePath + '\n');
         } catch (error) {
-            console.error('Error saving screenshot:', (error as Error).message);
+            if (error instanceof Error) {
+                console.error('Error saving screenshot:', error.message);
+            } else {
+                console.error('Error saving screenshot');
+            }
         }
     }
 
@@ -29,16 +53,28 @@ export class ScreenshotOnFailPlugin extends Plugin {
      * @param outputPath - The path to save the image file
      */
     private saveImageToFile(image: Image, outputPath: string): string {
-        const outputDir = path.dirname(outputPath);
-        if (!fs.existsSync(outputDir)) {
-            fs.mkdirSync(outputDir, { recursive: true });
+        const outputDir = dirname(outputPath);
+        if (!existsSync(outputDir)) {
+            mkdirSync(outputDir, { recursive: true });
         }
 
-        const outputFilePath = path.extname(outputPath) ? outputPath : `${outputPath}.${image.type}`;
+        const outputFilePath = extname(outputPath) ? outputPath : `${outputPath}.${image.type}`;
 
         const binaryData = image.buffer;
-        const arrayBufferView: Uint8Array = new Uint8Array(binaryData.buffer, binaryData.byteOffset, binaryData.length);
-        fs.writeFileSync(outputFilePath, arrayBufferView);
+        const arrayBufferView = new Uint8Array(binaryData.buffer, binaryData.byteOffset, binaryData.length);
+        writeFileSync(outputFilePath, arrayBufferView);
         return outputFilePath;
     }
 }
+
+declare module '@bellatrix/core/types' {
+    interface BellatrixConfiguration {
+        screenshotOnFailPluginSettings?: ScreenshotOnFailPluginSettings;
+    }
+}
+
+interface ScreenshotOnFailPluginSettings {
+    isPluginEnabled: boolean;
+    outputPath: string,
+    shouldCreateFolderPerSuite?: boolean,
+}

example/bellatrix.config.ts

@@ -43,6 +43,11 @@ const config: BellatrixConfigurationOverride = {
                 browserName: 'chrome'
             }
         }
+    },
+    screenshotOnFailPluginSettings: {
+        isPluginEnabled: true,
+        outputPath: `./reports/screenshots${Date.now()}`,
+        shouldCreateFolderPerSuite: true,
     }
 };