Skip to main content

重試

簡介​

測試重試是一種在測試失敗時自動重新執行測試的方法。這在測試不穩定且偶爾失敗時非常有用。測試重試在配置文件中配置。

失敗​

Playwright Test 在工作程序中執行測試。這些程序是作業系統程序，獨立執行，由測試執行器協調。所有工作程序都有相同的環境，每個都啟動自己的瀏覽器。

考慮以下程式碼片段:

import { test } from '@playwright/test';

test.describe('suite', () => {
  test.beforeAll(async () => { /* ... */ });
  test('first good', async ({ page }) => { /* ... */ });
  test('second flaky', async ({ page }) => { /* ... */ });
  test('third good', async ({ page }) => { /* ... */ });
  test.afterAll(async () => { /* ... */ });
});

當所有測試通過時，它們將在相同的工作程序中按順序執行。

  • Worker process 開始
    • beforeAll hook 執行
    • first good 通過
    • second flaky 通過
    • third good 通過
    • afterAll hook 執行

如果任何測試失敗，Playwright Test 會丟棄整個工作程序以及瀏覽器，並啟動一個新的。測試將在新的工作程序中從下一個測試開始繼續。

  • Worker process #1 starts
    • beforeAll hook 執行
    • first good 通過
    • second flaky 失敗
    • afterAll hook 執行
  • Worker process #2 starts
    • beforeAll hook 再次執行
    • third good 通過
    • afterAll hook 執行

如果你啟用 retries, 第二個 worker process 將會從重試失敗的測試開始並繼續。

  • Worker process #1 starts
    • beforeAll hook 執行
    • first good 通過
    • second flaky 失敗
    • afterAll hook 執行
  • Worker process #2 starts
    • beforeAll hook 再次執行
    • second flaky 重試並通過
    • third good 通過
    • afterAll hook 執行

這個方案對於獨立測試完美運作，並保證失敗的測試不會影響正常的測試。

重試​

Playwright 支援測試重試。啟用後，失敗的測試將會被重試多次，直到通過為止，或直到達到最大重試次數為止。預設情況下，失敗的測試不會被重試。

# Give failing tests 3 retry attempts
npx playwright test --retries=3

您可以在配置文件中配置重試次數:

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  // Give failing tests 3 retry attempts
  retries: 3,
});

Playwright Test 會將測試分類如下:

  • "passed" - 第一次執行時通過的測試;
  • "flaky" - 第一次執行時失敗，但重試時通過的測試;
  • "failed" - 第一次執行時失敗且所有重試都失敗的測試。
Running 3 tests using 1 worker

  ✓ example.spec.ts:4:2 › first passes (438ms)
  x example.spec.ts:5:2 › second flaky (691ms)
  ✓ example.spec.ts:5:2 › second flaky (522ms)
  ✓ example.spec.ts:6:2 › third passes (932ms)

  1 flaky
    example.spec.ts:5:2 › second flaky
  2 passed (4s)

您可以在執行時使用 testInfo.retry 檢測重試，這對任意測試、掛鉤或固定裝置都是可訪問的。這裡有一個範例，在重試之前清除一些伺服器端狀態。

import { test, expect } from '@playwright/test';

test('my test', async ({ page }, testInfo) => {
  if (testInfo.retry)
    await cleanSomeCachesOnTheServer();
  // ...
});

您可以為特定的一組測試或單個檔案指定重試次數，請參閱 test.describe.configure()。

import { test, expect } from '@playwright/test';

test.describe(() => {
  // All tests in this describe group will get 2 retry attempts.
  test.describe.configure({ retries: 2 });

  test('test 1', async ({ page }) => {
    // ...
  });

  test('test 2', async ({ page }) => {
    // ...
  });
});

序列模式​

使用 test.describe.serial() 將相依測試分組，以確保它們始終一起且按順序執行。如果其中一個測試失敗，所有後續測試將被跳過。該組中的所有測試將一起重試。

考慮以下使用 test.describe.serial 的程式碼片段:

import { test } from '@playwright/test';

test.describe.configure({ mode: 'serial' });

test.beforeAll(async () => { /* ... */ });
test('first good', async ({ page }) => { /* ... */ });
test('second flaky', async ({ page }) => { /* ... */ });
test('third good', async ({ page }) => { /* ... */ });

執行時沒有 重試 的情況下，失敗後的所有測試都會被跳過：

  • Worker process #1:
    • beforeAll hook 執行
    • first good 通過
    • second flaky 失敗
    • third good 完全跳過

執行 retries 時，所有測試會一起重試：

  • Worker process #1:
    • beforeAll hook 執行
    • first good 通過
    • second flaky 失敗
    • third good 被跳過
  • Worker process #2:
    • beforeAll hook 再次執行
    • first good 再次通過
    • second flaky 通過
    • third good 通過
note

通常最好使您的測試保持獨立，這樣它們可以有效地獨立執行和重試。

在測試之間重用單頁​

Playwright Test 為每個測試建立一個獨立的 Page 物件。然而，如果你想在多個測試之間重複使用單個 Page 物件，你可以在 test.beforeAll() 中建立自己的物件，並在 test.afterAll() 中關閉它。

example.spec.ts
import { test, type Page } from '@playwright/test';

test.describe.configure({ mode: 'serial' });

let page: Page;

test.beforeAll(async ({ browser }) => {
  page = await browser.newPage();
});

test.afterAll(async () => {
  await page.close();
});

test('runs first', async () => {
  await page.goto('https://playwright.dev/');
});

test('runs second', async () => {
  await page.getByText('Get Started').click();
});