快速開始:使用 劇作家工作區 的報告功能進行進階診斷

在這個快速入門中,你將學習如何透過 劇作家工作區 的報告功能來除錯 Playwright 測試。 透過將測試報告儲存到 Azure 儲存體,並在 Azure 入口網站使用 劇作家工作區 報告器檢視以執行進階診斷。

先決條件

  • 具有有效訂閱的 Azure 帳戶。 如尚未擁有 Azure 訂用帳戶,請在開始之前先建立免費帳戶。
  • 您的 Azure 帳戶需要擁有者 (部分機器翻譯)、參與者 (部分機器翻譯) 或其中一個傳統管理員角色 (部分機器翻譯)。
  • 一個使用 Playwright 運行工具和 JavaScript SDK 的 Playwright 專案(目前不支援 NUnit 和其他運行工具)。 如果你還沒有專案,可以用 Playwright 入門文件 或 劇作家工作區 範例專案來建立。
  • Playwright 專案必須使用 Playwright 套件(@plawright/測試)版本 1.57 或更新版本。
  • Azure CLI。 如果您沒有 Azure CLI,請參閱安裝 Azure CLI。
  • Playwright Workspace 必須使用 Microsoft Entra ID 認證。 報告不支援使用存取權杖來進行驗證。

要開始使用 劇作家工作區 的報告,第一步是在你的工作區啟用報告功能,並連結一個儲存帳號來儲存你的報告產物。 你可以先用新工作區,或是使用現有的工作區。

  1. 使用您 Azure 訂閱的認證來登入 Azure 入口網站。

  2. 從入口網站首頁搜尋並選擇 Azure 應用程式測試。

    截圖顯示如何開啟 Azure 應用程式測試。

  3. 在 Azure App 測試中心,選擇 Create 於 劇作家工作區 下

    顯示 Azure 應用程式測試首頁的截圖。

  4. 在 「建立劇作家工作空間」資源 頁面,請輸入以下資訊:

    領域 Description
    Subscription 選取要用於此 Playwright 工作區的 Azure 訂閱。
    資源群組 選取現有的資源群組。 或選取 [新建],然後為新的資源群組輸入唯一的名稱。
    名稱 為您的工作區輸入一個獨特的名稱。
    名稱只能由英數字元和連字號組成,長度介於 3 到 24 個字元之間。
    地點 選擇一個地理位置作為工作區。
    此位置還決定了測試執行結果的儲存位置。
    報告 Toggle 預設為啟用,以讓使用者能從 Playwright Workspace 儲存並查看他們的測試報告。 如果你想關閉報告,請將設定切換為停用。
    記憶體帳戶 Toggle 預設為啟用,以讓使用者能從 Playwright Workspace 儲存並查看他們的測試報告。 如果你想關閉報告,請將設定切換為停用。

    備註

    劇作家工作區 的報告使用 Azure 儲存體 來儲存你的測試報告和其他相關檔案。 儲存費用是根據你儲存帳戶的資料保留設定來決定的。

    備註

    或者,您也可以在 [標籤] 索引標籤中設定更多詳細資料。標籤為成對的名稱和值,可讓您將相同的標籤套用至多個資源與資源群組,以便為資源分類及檢視合併的帳單。

    備註

    目前要將報告產件上傳到客戶管理的 Azure 儲存體 帳號,需要對該儲存帳號的公開端點進行網路存取。 設定為僅限私有端點存取的儲存帳號,不支援在產物上傳情境下。

  5. 完成資源設定後,請選取 [檢閱 + 建立]。

  6. 檢閱您提供的設定,然後選取 建立。 建立工作區需要幾分鐘。 繼續進行之前,請等候入口網站頁面顯示 [您的部署已完成] 訊息。

    顯示 Azure 入口網站中部署完成資訊的螢幕擷取畫面。

為連結的儲存帳號新增基於角色的存取控制(RBAC)角色

  1. 在 Azure 入口網站開啟連結的儲存帳號。

  2. 前往 [存取控制 (IAM)] 索引標籤。

    顯示儲存帳號首頁的截圖。

  3. 點擊新增角色指派。

    顯示儲存體帳戶新增角色頁面的螢幕擷取畫面。

  4. 在 工作函式角色中,搜尋並選擇 儲存區資料貢獻 者角色,然後點擊 下一步。

    顯示儲存帳戶角色功能頁面的截圖。

  5. 選取並新增所有執行測試的成員。

    顯示儲存體帳戶作業功能角色新增成員頁面的螢幕擷取畫面。

  6. 點擊 檢視 + 指派。

安裝 劇作家工作區 套件

要使用 劇作家工作區,請安裝 劇作家工作區 套件。

npm init @azure/playwright@latest

此指令會產生一個 playwright.service.config.ts 檔案,將 Playwright 導向並認證至 Playwright 工作區。

如果您已經有此檔案,套件會要求您覆寫它。

啟用 HTML 與 劇作家工作區 報告器

要使用 劇作家工作區 報告功能,請在 playwright.service.config.ts 檔案中新增以下設定,啟用 HTML 和 劇作家工作區 報告器 –

reporter: [
    ["html", { open: "never" }], // HTML reporter must come first
    ["@azure/playwright/reporter"], // Azure reporter uploads HTML report
]

在 Playwright 設定中啟用成品

在你的專案 playwright.config.ts 檔案中,確保你收集了所有所需的文物。

use: 
{
    trace: 'on-first-retry',
    video:'retain-on-failure',
    screenshot:'on'
}

設定瀏覽器端點

在您的設定中,您必須提供特定於區域的瀏覽器端點。 此端點取決於您在建立工作區時選取的 Azure 區域。

若要取得瀏覽器端點 URL,請執行下列步驟:

  1. 使用您的 Azure 帳戶登入 Azure 入口網站,並瀏覽至您的工作區。

  2. 選取 [開始使用] 頁面。

    顯示如何瀏覽至 [開始使用] 頁面的螢幕擷取畫面。

  3. 在將 瀏覽器端點新增至您的設定中,複製端點 URL。

    確保這個網址在 PLAYWRIGHT_SERVICE_URL 環境變數中可用。

    顯示如何複製服務端點 URL 的螢幕擷取畫面。

設定您的環境

若要設定您的環境,必須使用您在先前步驟中取得的值來設定 PLAYWRIGHT_SERVICE_URL 環境變數。

利用這個 dotenv 模組來管理你的環境。 利用 dotenv,你可以在檔案中 .env 定義環境變數。

  1. 將 dotenv 模組新增至您的專案:

    npm i --save-dev dotenv
    
  2. 請在 playwright.service.config.ts 中加入以下程式碼片段:

    require('dotenv').config();
    
  3. 在 Playwright 專案中,連同 .env 檔案一起建立 playwright.config.ts 檔案:

    PLAYWRIGHT_SERVICE_URL={MY-REGION-ENDPOINT}
    

    請務必將 {MY-REGION-ENDPOINT} 文字預留位置取代為您稍早複製的值。

設定驗證

若要在 Playwright 工作區中執行 Playwright 測試,您需要將執行測試的 Playwright 用戶端與服務進行驗證。 從你本地的開發機或 CI 機進行驗證。

備註

劇作家工作區 reporter 僅支援基於 Microsoft Entra ID 的認證。 如果你用存取權杖來認證,就不能用報告功能。

使用 Microsoft Entra ID 設定驗證

Microsoft Entra ID 是 Playwright Workspace 中唯一支援的報告功能認證。 從你的本機開發機,你可以用 Azure CLI 登入

az login

備註

如果您屬於多個 Microsoft Entra 租用戶,請務必登入您的工作區所屬的租用戶。 您可以從 Azure 入口網站取得租用戶識別碼。 請參閱尋找您的 Microsoft Entra 租用戶。 拿到 ID 後,用指令登入 az login --tenant <TenantID>

請使用 劇作家工作區 進行測試

你已經完成了用 劇作家工作區 在雲端執行 Playwright 測試的設定。 您可以使用 Playwright CLI 來執行測試,或使用 Playwright Test Visual Studio Code 擴充功能。

  1. 開啟終端機視窗。

  2. 輸入下列命令,在工作區中的遠端瀏覽器上執行 Playwright 測試套件:

    npx playwright test --config=playwright.service.config.ts --workers=20
    

    視測試套件的大小而定,此命令最多可在 20 個平行背景工作角色上執行測試。

在 Azure 入口網站中對測試執行與結果進行除錯

為連結儲存帳號新增基於角色的存取控制(RBAC)角色

  1. 在 Azure 入口網站開啟連結的儲存帳號。

  2. 前往 [存取控制 (IAM)] 索引標籤。

    截圖顯示 RBAC 的儲存帳戶首頁。

  3. 點擊新增角色指派。

    顯示儲存體帳戶新增角色頁面的螢幕擷取畫面。

  4. 在 特殊權限管理員角色 下,搜尋並選取 Contributor 角色,然後按一下 下一步。

    顯示儲存帳號管理員角色頁面的截圖。

  5. 選取並新增所有能查看測試報告的成員。

    顯示儲存體帳戶管理角色新增成員頁面的螢幕擷取畫面。

  6. 點擊 檢視 + 指派。

(僅在啟用追蹤時)允許在連結的儲存帳號中列出公開追蹤檢視器

  1. 在 Azure 入口網站開啟連結的儲存帳號。

  2. 前往設定 -> 資源共享(CORS)。

    截圖顯示 CORS 儲存帳號首頁。

  3. 在 Blob 服務下,新增一條紀錄:

    • 允許的原始來源:https://trace.playwright.dev
    • 允許的方法: GET, OPTIONS
    • 最大年齡:輸入介於0到2147483647之間的數值。

    顯示儲存體帳戶 cors 頁面的螢幕擷取畫面。

  4. 選取 [儲存]。

在 Azure 入口網站查看已儲存的測試報告

你現在可以在 Azure 入口網站中排解失敗的測試案例。

  1. 測試執行結束後,報告器會在 Azure 入口網站產生一個測試執行頁面的連結。 開啟此連結以檢視詳細的測試結果和相關聯的成品。

    顯示測試運行頁面的截圖。

  2. 測試執行頁面提供所有故障排除所需的資訊。 您可以:

    • 查看 詳細的錯誤日誌、 測試步驟,以及附帶的影像,如 截圖 或 影片。
    • 直接瀏覽至追蹤檢視器以進行更深入的分析。

    顯示測試報告頁面的截圖。

  3. Trace Viewer 讓你能以視覺方式逐步檢視測試執行過程。 您可以:

    • 使用時間軸將滑鼠停留在個別步驟上,並顯示每個動作前後的頁面狀態。
    • 檢查 詳細日誌、 DOM 快照、 網路活動、 錯誤及每個步驟的 主控台輸出 。

    顯示追蹤頁面的截圖。

小提示

為了獲得更好的體驗,請在新的瀏覽器分頁中按 Ctrl 鍵並選擇 「檢視追蹤」來開啟追蹤檢視器。