Mark Ku's Blog
首頁 關於我
用微軟 playwright 輕易搭建 End to End Testing 自動化測試環境,保護公司的核心商業網站,並整合 Teams 通知及外部觸發
Frontend
用微軟 playwright 輕易搭建 End to End Testing 自動化測試環境,保護公司的核心商業網站,並整合 Teams 通知及外部觸發
Mark Ku
Mark Ku
January 08, 2023
1 min

解決問題

我目前任職流量不小的 B2C 電子商務公司,為避免不小心將結帳畫面改壞了,而沒被發現,而我著手研究 UI TEST,用於保護我們的結帳流程,之前就有用 playwright 來做 SEO 的預渲染,在評估了幾套 UI 測試後,發現 playwright 這幾年生態變得很完整及簡單,非常適合我們,其優點如下

  • 微軟推出的開源 UI-Test 框架
  • 整合 Jest
  • 支援 vs code 開發及除錯
  • 預設整合 Github
  • 提供完整的 Report
  • 不用像 Python 要設定很多環境
  • 支援 node js

我預期的運作流程

步驟

首先,我們先建立 playwright 測試專案 官方文件

npm init [email protected]

選擇 Typescript 及 github action flow 整合

打開剛剛建立的測試專案,在資料夾裡其實己寫好基本的測試範例

請先在 vscode 安裝 jest 套件Playwright Test for VSCode 套件

並加入中斷點,並對綠色的啟動箭頭 >右鍵 > 對測試偵錯

此時就會跳出瀏覽器,並可以逐行除錯

看到這邊爽度就爽度超高,過去寫過 python selenium 都還要花很多時間配置系統環境。

接著,將你的專案推上 github,此時就會自動建置( 測試 ),點開工作記錄

隨後我們可以發現測試己成功完成建置,並發現主控台入口及報表的入口

點擊進入測試主控台,可以看 job 執行了些什麼

打開下載的報表

接著,因我們預期將測試的結果及報表推送到 Teams

請先至 github repo 的 Settings > Secrets > 建立 Actions secrets 參數。

修改 .github/workflows/playwright.yml 參考以下程式碼,加入通知

name: Playwright Tests
on:
  repository_dispatch:
    types: remote-trigger-ui-test
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
    - uses: actions/[email protected]
    - uses: actions/[email protected]
      with:
        node-version: 16
    - name: Install dependencies
      run: npm ci
    - name: Install Playwright Browsers
      run: npx playwright install --with-deps
    - name: Run Playwright tests
      run: npx playwright test
    - uses: actions/[email protected]
      if: always()
      with:
        name: playwright-report
        path: playwright-report/
        retention-days: 30
  success_notify:
    needs: test
    name: notify
    runs-on: ubuntu-18.04    
    steps:  
      - name: 📣 Send teams notification
        uses: simbo/[email protected]
        with:
          webhook: ${{ secrets.MSTEAMS_WEBHOOK }}
          title: 😊 UI - Test Success 
          message: <p>UI - Test Success<strong>\ ^ ^ /</strong></p>
          color: 007FFF
          buttons: |
            See Test Report! ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}      
  error_notify:
    needs: test
    name: error_notify
    if: ${{ always() && needs.test.result == 'failure' }}
    runs-on: ubuntu-18.04    
    steps:        
      - name: Send fail notification
        uses: simbo/[email protected]        
        with:
          webhook: ${{ secrets.MSTEAMS_WEBHOOK }}
          title: 💩UI - Test Fail 
          message: <p>Ba Be Q ...<strong>= =...</strong></p>
          color: FF0000
          buttons: |
            See Test Report! ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

測試執行完的圖表

在欲應用程式,新增外部觸發 wrokflows,可參考此篇設定遠程觸發 git action,並將下面的程式碼參數換掉

:owner/:repo => markku636/first-ui-teset
:token => Github token 點我申請

on: push
jobs:
  test-curl-action:
    name: "Call Test CICD"
    runs-on: ubuntu-latest
    steps:      
      - name: "Call Github API"
        uses: indiesdev/[email protected]
        id: api2
        with:
          url: https://api.github.com/repos/:owner/:repo/dispatches
          method: "POST"
          accept: 200,201,204
          headers: '{ "authorization": "token :token", "accept": "application/vnd.github.everest-preview+json","content-type":"application/x-www-form-urlencoded" }'

          # you can use multiline format to construct json data object, the content should be yml format.
           
          # this format apply to inputs: body, headers and params
          "body": '{ "event_type": "remote-trigger-ui-test" }'
          log-response: true
      - name: "Use response"
        run: echo ${{ steps.api.outputs.response }}

錄製腳本

超酷的,什麼環境也沒特別配置,居然能夠跳出瀏覽器錄製,真的是太好用了

npx playwright codegen www.ibuypower.com --output ./tests/ibuypower.spec.ts

結論

使用 playwright 最大的好處,微軟挾著完整的生態,把整個工作流程都整合起來,我僅用很短的時間,就能將 vscode + github + teams 整合完成,爽度超級高。

補充

如果無法在 vscode 中使用 jest 偵錯測試檔,請執行以下指令

npm install -D jest jest-playwright-preset playwright

參考資料


Tags

Mark Ku

Mark Ku

Software Developer

擁有豐富網站開發經驗,直播系統、POS系統、電子商務、平台網站、SEO,專業的網站開發鐵三工程師。

Expertise

前端(React)
後端(C#)
網路管理

Social Media

facebook github website

Related Posts

NEXTJS 13 昇級筆記
NEXTJS 13 昇級筆記
December 22, 2022
1 min

Quick Links

關於我

Social Media