Playwright元素截圖并保存至allure的實(shí)現(xiàn)示例

更新時(shí)間：2021年12月12日 10:55:36 作者：凌空摘星

在UI自動(dòng)化測(cè)試中，我們經(jīng)常需要獲取屏幕截圖，本文就介紹一下Playwright元素截圖并保存至allure的實(shí)現(xiàn)示例，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

引言

在UI自動(dòng)化測(cè)試中，我們經(jīng)常需要獲取屏幕截圖，尤其是在CI環(huán)境中，一般是使用瀏覽器的無頭模式執(zhí)行測(cè)試，此時(shí)對(duì)關(guān)鍵步驟進(jìn)行頁(yè)面截圖就很重要了。通常自動(dòng)化框架都提供了頁(yè)面截圖功能，但是基本都是只提供了頁(yè)面整體的截圖或者對(duì)頁(yè)面元素單獨(dú)截圖，無法做到在頁(yè)面整體截圖中將我想要的元素標(biāo)記出來（比如紅框標(biāo)出），而這種截圖在某些預(yù)期結(jié)果的場(chǎng)景下需要經(jīng)常用到，比如人工輔助結(jié)果判斷，或者在結(jié)果判斷不正確時(shí)標(biāo)記出不正確的元素以幫助錯(cuò)誤排查。因此，在項(xiàng)目中單獨(dú)封裝了標(biāo)記元素的截圖方法。

問題分析

獲取屏幕截圖：這個(gè)很簡(jiǎn)單，直接通過 page.screenshot 方法就可以獲得
獲取元素位置：通過 ElementHandle.bounding_box 獲得元素的邊界信息
在截圖中標(biāo)記出元素：通過PIL（python3使用pillow庫(kù)）和獲取到的元素位置將元素標(biāo)記出來
在報(bào)告中展示：這里選用的是allure作為測(cè)試報(bào)告框架，將最終結(jié)果保存至allure報(bào)告即可

需要注意的是，由截圖生成 PIL.Image 對(duì)象，和編輯之后保存至allure，都需要通過 io.BytesIO 進(jìn)行中轉(zhuǎn)

快速截圖：

screenshot方法可以進(jìn)行截圖，參數(shù)如下:

timeout:以毫秒為單位的超時(shí)時(shí)間，0為禁用超時(shí)

path:設(shè)置截圖的路徑

type：圖片類型，默認(rèn)jpg

quality：像素，不適用于jpg

omit_background: 隱藏默認(rèn)白色背景，并允許捕獲具有透明度的屏幕截圖。不適用于“jpeg”圖像。

full_page：如果為true，則獲取完整可滾動(dòng)頁(yè)面的屏幕截圖，而不是當(dāng)前可見的視口。默認(rèn)為`假`。

clip：指定結(jié)果圖像剪裁的對(duì)象clip={'x': 10 , 'y': 10, 'width': 10, 'height': 10}

代碼示例（以Playwright為例）

from io import BytesIO

import allure
from PIL import Image, ImageDraw
from playwright.sync_api import sync_playwright

def highlight_screenshot(page, element, tips='高亮截圖'):
    # 滾動(dòng)頁(yè)面將元素移動(dòng)到視野中
    element.scroll_into_view_if_needed()

    # 獲取元素的位置信息
    box = element.bounding_box()
    x, y, width, height = box['x'], box['y'], box['width'], box['height']

    # 獲取頁(yè)面截圖，并讀取為PIL.Image對(duì)象
    png = page.screenshot(type='png')
    img = Image.open(BytesIO(png))

    # 利用元素的位置信息在頁(yè)面截圖中標(biāo)記出元素
    draw = ImageDraw.Draw(img)
    draw.rectangle((x, y, x + width, y + height), outline='red', width=3)

    # 將標(biāo)記后的截圖保存至allure報(bào)告中
    with BytesIO() as output:
        img.save(output, format='png')
        allure.attach(output.getvalue(), tips, allure.attachment_type.PNG)

def test_screenshot():
    with sync_playwright() as pw:
        # 打開百度進(jìn)行搜索
        browser = pw.chromium.launch()
        page = browser.new_page()
        page.goto('https://www.baidu.com')  # 跳轉(zhuǎn)至百度頁(yè)面
        page.fill('#kw', 'playwright 選擇器')  # 搜索框中輸入內(nèi)容
        page.click('#su')  # 點(diǎn)擊搜索按鈕

        # 等待搜索結(jié)果加載
        page.wait_for_load_state('networkidle')

        # 判斷當(dāng)前頁(yè)面顯示10條搜索結(jié)果
        results = page.query_selector_all('h3')
        assert len(results) == 10

        # 將當(dāng)前頁(yè)面的搜索結(jié)果分別進(jìn)行截圖
        for i, result in enumerate(results):
            highlight_screenshot(page, result, f'搜索結(jié)果{i}')

上面以百度搜索為例，將所有搜索結(jié)果分別進(jìn)行截圖，最終報(bào)告效果如下：

在這里插入圖片描述