upload traces

Author: kaeizen

.github/scripts/unzip_traces.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# Path to the JSON file
+json_file="./playwright-traces/test-traces.json"
+
+# Function to check jq version
+check_jq_version() {
+    jq_version=$(jq --version | cut -d- -f2)
+    major_version=$(echo "$jq_version" | cut -d. -f1)
+    minor_version=$(echo "$jq_version" | cut -d. -f2)
+
+    if [ "$major_version" -eq 1 ] && [ "$minor_version" -ge 6 ]; then
+		echo "jq version: $jq_version"
+        return 0  # jq 1.6 or higher
+    else
+        return 1  # Unsupported jq version
+    fi
+}
+
+# Check if jq is installed
+if ! command -v jq &> /dev/null; then
+    echo "jq is not installed. Please install jq first."
+    exit 1
+fi
+
+# Check jq version
+if ! check_jq_version; then
+    echo "Unsupported jq version. Please use jq 1.6 or higher."
+    exit 1
+fi
+
+# Read the JSON file
+cat "$json_file" | jq .
+
+jq -r '.[] | "\(.id) \(.trace)"' "$json_file" | while read id trace_file; do
+    if [ -f "$trace_file" ]; then
+        # Create the directory for the trace file
+        output_dir="./traces/$id"
+        mkdir -p "$output_dir"
+
+        # Unzip the trace file into the directory
+        unzip -o "$trace_file" -d "$output_dir" > /dev/null 2>&1 && echo "Unzipped $trace_file to $output_dir/"
+    else
+        echo "Trace file not found: $trace_file"
+    fi
+done
+
+for dir in ./traces/*; do
+	if [ -d "$dir" ]; then
+	artifact_name=$(basename "$dir")
+	echo "Uploading artifact: $artifact_name"
+	# Upload each trace/{id} as an artifact using actions/upload-artifact
+	- name: Upload $artifact_name
+		uses: actions/upload-artifact@v3
+		with:
+			name: "$artifact_name"
+			path: "$dir"
+	fi
+done

.github/workflows/playwright.yml

@@ -34,6 +34,10 @@ jobs:
           WP_PASSWORD: password
           STACKABLE_SLUG: Stackable/plugin
       run: npm run test
+    - name: Run script to unzip and upload traces
+      run: |
+        chmod +x ./.github/scripts/unzip_traces.sh
+        ./.github/scripts/unzip_traces.sh
     - uses: actions/upload-artifact@v4
       if: ${{ !cancelled() }}
       id: artifact-upload-step

e2e/config/reporter.ts

@@ -0,0 +1,61 @@
+/* eslint-disable no-console */
+import type {
+	Reporter, TestCase, TestResult,
+} from '@playwright/test/reporter'
+
+import fs from 'fs'
+import path from 'path'
+
+class MyReporter implements Reporter {
+	outputFolder: string;
+	testResults: Array<{title: string, id: string, trace: any}>;
+
+	constructor() {
+		this.outputFolder = 'playwright-traces'
+		this.cleanupFolder()
+		this.testResults = []
+	}
+	cleanupFolder() {
+		const folderPath = path.resolve( this.outputFolder )
+
+		if ( fs.existsSync( folderPath ) ) {
+			// Read the directory and delete files
+			const files = fs.readdirSync( folderPath )
+			for ( const file of files ) {
+				const filePath = path.join( folderPath, file )
+				if ( fs.lstatSync( filePath ).isFile() ) {
+					fs.unlinkSync( filePath ) // Remove the file
+				}
+			}
+			console.log( `All files removed from: ${ folderPath }` )
+		} else {
+			// If folder doesn't exist, create it
+			fs.mkdirSync( folderPath, { recursive: true } )
+		}
+	}
+
+	onTestEnd( test: TestCase, result: TestResult ) {
+		if ( result.attachments.length !== 0 ) {
+			console.log( 'title:', test.title )
+			console.log( 'attachments', result.attachments )
+			this.testResults.push( {
+				id: test.id,
+				title: test.title,
+				trace: result.attachments.find( attachment => attachment.name === 'trace' ).path,
+			} )
+		}
+	}
+
+	async onEnd() {
+		// Ensure the output folder exists
+		const folderPath = path.resolve( this.outputFolder )
+		if ( ! fs.existsSync( folderPath ) ) {
+		  fs.mkdirSync( folderPath, { recursive: true } )
+		}
+
+		// Write the collected results to a JSON file
+		const reportPath = path.join( folderPath, 'test-traces.json' )
+		fs.writeFileSync( reportPath, JSON.stringify( this.testResults, null, 2 ) )
+	}
+}
+export default MyReporter

e2e/playwright.config.ts

@@ -13,7 +13,6 @@ dotenv.config( { path: path.resolve( __dirname, '../.env' ) } )
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig( {
-	testDir: '.',
 	// This is run before any tests. Check the file for more information.
 	// globalSetup: 'e2e-global-setup.ts',
 	globalSetup: fileURLToPath(
@@ -33,7 +32,7 @@ export default defineConfig( {
 	workers: 1,
 	/* Reporter to use. See https://playwright.dev/docs/test-reporters */
 	reporter: process.env.CI
-		? [ [ 'list' ], [ 'github', { useDetails: true, showError: true } ], [ 'html', { outputFolder: '../playwright-report' } ] ]
+		? [ [ 'list' ], [ 'github', { useDetails: true, showError: true } ], [ 'html', { outputFolder: '../playwright-report' } ], [ './config/reporter.ts' ] ]
 		: [ [ 'list' ], [ 'html', { outputFolder: '../playwright-report' } ] ],
 	reportSlowTests: null,
 	/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
@@ -70,7 +69,7 @@ export default defineConfig( {
 				storageState: process.env.WP_AUTH_STORAGE,
 				...devices[ 'Desktop Chrome' ],
 			},
-			testMatch: 'tests/*.ts',
+			testDir: './tests',
 		},
 		// {
 		// 	name: 'chromium',