[e2e] Improve teardown - full desktop screenshot (#993)

* [e2e] Always dispose temp dir

* [e2e] Screenshot entire desktop on close failure

* nit

Author: webfiltered

tests/integration/post-install.teardown.ts

@@ -2,8 +2,8 @@ import { pathExists } from '../shared/utils';
 import { TestEnvironment } from './testEnvironment';
 import { assertPlaywrightEnabled, expect, test as teardown } from './testExtensions';
 
-// This "test" is a setup process.  Any failure here should break all post-install tests.
-// After running, the test environment will contain an installed ComfyUI app, ready for other tests to use as a base.
+// This "test" is a setup process.
+// After running, the test environment should be completely uninstalled.
 
 teardown('Completely uninstalls the app', async ({}) => {
   assertPlaywrightEnabled();

tests/integration/testApp.ts

@@ -1,7 +1,8 @@
-import { type ElectronApplication, type JSHandle } from '@playwright/test';
+import type { ElectronApplication, JSHandle, TestInfo } from '@playwright/test';
 import electronPath, { type BrowserWindow } from 'electron';
 import { _electron as electron } from 'playwright';
 
+import { createDesktopScreenshot } from '../shared/utils';
 import { TestEnvironment } from './testEnvironment';
 
 // eslint-disable-next-line @typescript-eslint/no-base-to-string
@@ -17,6 +18,16 @@ async function localTestQoL(app: ElectronApplication) {
   window.on('console', console.log);
 }
 
+/** Screen shot entire desktop */
+async function attachScreenshot(testInfo: TestInfo, name: string) {
+  try {
+    const filePath = await createDesktopScreenshot(name);
+    await testInfo.attach(name, { path: filePath });
+  } catch (error) {
+    console.error(error);
+  }
+}
+
 /**
  * Base class for desktop e2e tests.
  */
@@ -27,14 +38,17 @@ export class TestApp implements AsyncDisposable {
   /** Remove the install directory when disposed. */
   shouldDisposeTestEnvironment: boolean = false;
 
-  private constructor(readonly app: ElectronApplication) {
+  private constructor(
+    readonly app: ElectronApplication,
+    readonly testInfo: TestInfo
+  ) {
     app.once('close', () => (this.#appProcessTerminated = true));
   }
 
   /** Async static factory */
-  static async create() {
+  static async create(testInfo: TestInfo) {
     const app = await TestApp.launchElectron();
-    return new TestApp(app);
+    return new TestApp(app, testInfo);
   }
 
   /** Get the first window that the app opens.  Wait if necessary. */
@@ -78,9 +92,15 @@ export class TestApp implements AsyncDisposable {
     const windows = this.app.windows();
     if (windows.length === 0) return;
 
-    const close = this.app.waitForEvent('close', { timeout: 60 * 1000 });
-    await Promise.all(windows.map((x) => x.close()));
-    await close;
+    try {
+      const close = this.app.waitForEvent('close', { timeout: 60 * 1000 });
+      await Promise.all(windows.map((x) => x.close()));
+      await close;
+    } catch (error) {
+      console.error('App failed to close; attaching screenshot to TestInfo');
+      await attachScreenshot(this.testInfo, 'test-app-close-failure');
+      throw error;
+    }
   }
 
   #appProcessTerminated = false;

tests/integration/testEnvironment.ts

@@ -125,5 +125,6 @@ export class TestEnvironment implements AsyncDisposable {
     await this.restoreInstallPath();
     await this.restoreVenv();
     await this.restoreServerStart();
+    await this.installLocation[Symbol.asyncDispose]();
   }
 }

tests/integration/testExtensions.ts

@@ -55,7 +55,7 @@ export const test = baseTest.extend<DesktopTestOptions & DesktopTestFixtures>({
   // Fixtures
   app: async ({ disposeTestEnvironment }, use, testInfo) => {
     // Launch Electron app.
-    await using app = await TestApp.create();
+    await using app = await TestApp.create(testInfo);
     app.shouldDisposeTestEnvironment = disposeTestEnvironment;
     await use(app);
 

tests/shared/utils.ts

@@ -1,4 +1,5 @@
 import envPaths from 'env-paths';
+import { exec } from 'node:child_process';
 import { randomUUID } from 'node:crypto';
 import { access, constants } from 'node:fs/promises';
 import { homedir } from 'node:os';
@@ -49,3 +50,38 @@ export function getDefaultInstallLocation() {
 export function addRandomSuffix(str: string) {
   return `${str}-${randomUUID().substring(0, 8)}`;
 }
+
+/**
+ * Create a screenshot of the entire desktop.
+ *
+ * Hard-coded to 1920x1080 resolution.
+ * @param filename - The name of the file to save the screenshot as.
+ * @returns The path to the screenshot file.
+ */
+export async function createDesktopScreenshot(filename: string) {
+  const width = 1920;
+  const height = 1080;
+  const powerShellScript = `
+Add-Type -AssemblyName System.Drawing
+
+$bounds = [Drawing.Rectangle]::FromLTRB(0, 0, ${width}, ${height})
+$bmp = New-Object Drawing.Bitmap $bounds.width, $bounds.height
+$graphics = [Drawing.Graphics]::FromImage($bmp)
+
+$graphics.CopyFromScreen($bounds.Location, [Drawing.Point]::Empty, $bounds.size)
+$bmp.Save("${filename}.png", "Png")
+
+$graphics.Dispose()
+$bmp.Dispose()
+`;
+
+  const process = exec(powerShellScript, { shell: 'powershell.exe' }, (error, stdout, stderr) => {
+    if (error) console.error(error);
+    if (stderr) console.error('Screenshot std error', stderr);
+    if (stdout) console.log('Screenshot std out', stdout);
+  });
+  await new Promise((resolve) => process.on('close', resolve));
+
+  const name = `${filename}.png`;
+  return path.resolve(globalThis.process.cwd(), name);
+}