Upload images feature

Author: estruyf

.github/workflows/testing.yml

@@ -6,6 +6,7 @@ on:
     branches:
       - main
       - dev
+      - feature/*
 
 jobs:
   testing:

.gitignore

@@ -4,4 +4,6 @@ node_modules
 test-results
 summary.html
 playwright-report
-coverage
+coverage
+
+results.json

playwright.config.ts

@@ -12,7 +12,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
   retries: process.env.CI ? 2 : 2,
   workers: process.env.CI ? 1 : 1,
   reporter: [
-    // ["list"],
+    // ["json", { outputFile: "results.json" }],
     [
       "./src/index.ts",
       <GitHubActionOptions>{

src/models/GitHubActionOptions.ts

@@ -8,4 +8,8 @@ export interface GitHubActionOptions {
   showError?: boolean;
   quiet?: boolean;
   includeResults?: DisplayLevel[];
+
+  // Azure Storage
+  azureStorageUrl?: string;
+  azureStorageSAS?: string;
 }

src/utils/getTableRows.ts

@@ -8,13 +8,18 @@ import { getTestAnnotations } from "./getTestAnnotations";
 import { getTestDuration } from "./getTestDuration";
 import { getTestStatusIcon } from "./getTestStatusIcon";
 import { DisplayLevel } from "../models";
+import { processAttachments } from "./processAttachments";
 
 export const getTableRows = async (
   tests: TestCase[],
   showAnnotations: boolean,
   showTags: boolean,
   showError: boolean,
-  displayLevel: DisplayLevel[]
+  displayLevel: DisplayLevel[],
+  azure?: {
+    azureStorageUrl?: string;
+    azureStorageSAS?: string;
+  }
 ): Promise<SummaryTableRow[]> => {
   const convert = new Convert();
 
@@ -49,6 +54,10 @@ export const getTableRows = async (
       data: "Error",
       header: true,
     });
+    tableHeaders.push({
+      data: "Attachments",
+      header: true,
+    });
   }
 
   const tableRows: SummaryTableRow[] = [];
@@ -70,6 +79,7 @@ export const getTableRows = async (
       }
       if (showError) {
         colLength++;
+        colLength++;
       }
 
       const annotations = await getTestAnnotations(test);
@@ -116,6 +126,22 @@ export const getTableRows = async (
         data: convert.toHtml(error),
         header: false,
       });
+
+      const mediaFiles =
+        (azure &&
+          (await processAttachments(
+            azure?.azureStorageUrl,
+            azure?.azureStorageSAS,
+            result.attachments
+          ))) ||
+        [];
+
+      tableRow.push({
+        data: (mediaFiles || [])
+          .map((m) => `<img src="${m.url}" alt="${m.name}" height: 25px; />`)
+          .join("\n"),
+        header: false,
+      });
     }
 
     tableRows.push(tableRow);

src/utils/processAttachments.ts

@@ -0,0 +1,60 @@
+import { parse } from "path";
+import { readFile } from "fs/promises";
+
+export const processAttachments = async (
+  azureContainerUrl?: string,
+  azureContainerSas?: string,
+  attachments?: { name: string; path?: string; contentType: string }[]
+) => {
+  if (
+    !attachments ||
+    attachments.length === 0 ||
+    !azureContainerUrl ||
+    !azureContainerSas
+  ) {
+    return;
+  }
+
+  const mediaFiles: { name: string; url: string }[] = [];
+
+  if (attachments.length > 0) {
+    attachments = attachments.filter(
+      (a) => a.contentType.startsWith("image/") && a.path
+    );
+
+    for (const attachment of attachments) {
+      try {
+        if (attachment.path && azureContainerUrl && azureContainerSas) {
+          const parsedFile = parse(attachment.path);
+          const fileUrl = `${azureContainerUrl}/${
+            parsedFile.name
+          }_${Date.now()}${parsedFile.ext}`;
+
+          const putResponse = await fetch(`${fileUrl}?${azureContainerSas}`, {
+            method: "PUT",
+            headers: {
+              "x-ms-blob-type": "BlockBlob",
+              "x-ms-blob-content-type": attachment.contentType,
+            },
+            body: await readFile(attachment.path),
+          });
+
+          if (putResponse.ok) {
+            mediaFiles.push({
+              name: attachment.name,
+              url: fileUrl,
+            });
+          } else {
+            console.log(`Failed to upload attachment: ${attachment.name}`);
+            console.log(`Response: ${putResponse.statusText}`);
+          }
+        }
+      } catch (e) {
+        console.log(`Failed to upload attachment: ${attachment.name}`);
+        console.log((e as Error).message);
+      }
+    }
+  }
+
+  return mediaFiles;
+};

src/utils/processResults.ts

@@ -76,7 +76,11 @@ export const processResults = async (
             options.showAnnotations,
             options.showTags,
             !!options.showError,
-            options.includeResults as DisplayLevel[]
+            options.includeResults as DisplayLevel[],
+            {
+              azureStorageSAS: options.azureStorageSAS,
+              azureStorageUrl: options.azureStorageUrl,
+            }
           );
 
           if (tableRows.length !== 0) {