Github Copilot - 軟體測試

編寫測試是軟體開發生命週期中重要的一部分，用於確保程式碼在部署之前按預期工作。GitHub Copilot 可以幫助生成跨各種框架的測試程式碼，節省時間並幫助開發人員維護高質量的程式碼庫。在本節中，我們將透過示例探討 GitHub Copilot 如何協助建立和自動化測試。

使用 Copilot 簡化軟體測試

GitHub Copilot 透過生成單元測試、整合測試，甚至自動化的端到端測試來簡化測試過程。它可以處理各種程式語言和框架（如 Python、JavaScript 等）的測試。以下是一些示例，演示了 Copilot 如何在測試的不同階段提供幫助。

為函式編寫單元測試

單元測試驗證單個函式或元件的隔離性，確保每個程式碼單元都能正確工作。GitHub Copilot 可以為 pytest、JUnit 等常用框架生成單元測試。

示例：我們想要為一個計算兩個數字之和的 Python 函式編寫單元測試。一個簡單的註釋允許 Copilot 生成相應的單元測試。

# Unit test for the sum function in app.py file

import pytest
from app import sum

def test_sum():
    assert sum(2, 3) == 5
    assert sum(-1, 1) == 0
    assert sum(0, 0) == 0

在此示例中，Copilot 為簡單的求和函式生成了測試用例，包括各種輸入和斷言。

整合測試

整合測試確保不同的模組或服務能夠按預期協同工作。GitHub Copilot 可以幫助生成整合測試，以驗證元件之間的互動。

示例：我們正在測試 Flask API 與資料庫的整合。Copilot 透過生成整合測試來幫助檢查資料是否可以正確儲存和檢索。

# Integration test for Flask API and database

import pytest
from app import app, db

@pytest.fixture
def client():
    with app.test_client() as client:
        yield client

def test_create_user(client):
    response = client.post('/user', json={"id": 1, "name": "John Doe"})
    assert response.status_code == 201

    response = client.get('/user/1')
    assert response.status_code == 200
    assert response.get_json() == {"id": 1, "name": "John Doe"}

在這裡，Copilot 自動生成了一個整合測試，檢查 Flask API 是否可以處理 POST 和 GET 請求，並正確儲存和檢索使用者資料。

端到端 (E2E) 測試

端到端測試模擬真實世界的場景和使用者互動，確保整個應用程式都能按預期工作。GitHub Copilot 可以使用 Selenium、Cypress 等框架生成 E2E 測試。

示例：讓我們編寫一個 E2E 測試，模擬使用者使用 Selenium 登入 Web 應用程式。Copilot 生成必要的測試指令碼。

# End-to-end test using Selenium for user login

from selenium import webdriver
from selenium.webdriver.common.by import By

def test_user_login():
    driver = webdriver.Chrome()
    driver.get("http://example.com/login")

    username_field = driver.find_element(By.NAME, "username")
    password_field = driver.find_element(By.NAME, "password")
    login_button = driver.find_element(By.ID, "login-btn")

    username_field.send_keys("testuser")
    password_field.send_keys("password123")
    login_button.click()

    assert "Dashboard" in driver.title
    driver.quit()

在此示例中，Copilot 生成了一個基於 Selenium 的端到端測試，自動化了登入 Web 應用程式並驗證使用者是否被重定向到儀表板的過程。

測試中的模擬

在編寫測試時，我們有時需要模擬外部依賴項，例如資料庫或 API。GitHub Copilot 幫助生成使用 `unittest.mock` 等模擬庫進行模擬的測試，以模擬這些依賴項。

示例：我們想要測試一個與外部服務互動的 API 函式。Copilot 為我們生成必要的模擬。

# Test with mocking an external API call

from unittest import mock
import requests
from app import get_weather

@mock.patch('requests.get')
def test_get_weather(mock_get):
    mock_response = mock.Mock()
    mock_response.json.return_value = {"temperature": 22}
    mock_get.return_value = mock_response

    temperature = get_weather("New York")
    assert temperature == 22

Copilot 自動生成了帶有模擬 API 請求的測試，以測試 `get_weather` 函式，而無需進行實際的網路請求。

自動化測試

在 CI/CD 管道中，執行自動化測試以確保新程式碼不會破壞現有功能。GitHub Copilot 可以幫助在 GitHub Actions 等持續整合環境中設定測試自動化指令碼。

示例：讓我們編寫一個 GitHub Actions 工作流，每次推送新程式碼時都執行 Python 測試。Copilot 為我們生成 YAML 檔案。

# GitHub Actions workflow for running Python tests

name: Python Tests

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.x
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: Run tests
      run: |
        pytest

Copilot 生成了必要的 GitHub Actions YAML 檔案，以自動化每次推送時執行測試，確保程式碼庫保持穩定。

GitHub Copilot 在測試中的優勢

更快的測試編寫：GitHub Copilot 加速了單元測試、整合測試和端到端測試的建立，減少了開發人員花費在重複性任務上的時間。
自動測試生成：Copilot 可以自動生成樣板測試程式碼，使開發人員能夠專注於其應用程式的細節。
一致性和覆蓋率：Copilot 幫助維護測試用例的一致性，並透過建議邊緣情況場景來確保更好的覆蓋率。
與 CI/CD 整合：Copilot 透過為 GitHub Actions 等流行的 CI/CD 平臺生成配置檔案來幫助自動化測試執行，使測試成為開發管道的一部分。

GitHub Copilot 在測試中的侷限性

業務邏輯上下文有限：雖然 Copilot 可以生成測試用例，但開發人員仍然需要確保測試與業務邏輯保持一致，並涵蓋所有邊緣情況。
測試最佳化：Copilot 並不總是提供最最佳化或最有效的測試用例，開發人員需要重構或最佳化測試以提高效能。
依賴於框架：Copilot 的測試生成高度依賴於使用的框架或庫，這意味著它可能並不總是為自定義框架生成最佳解決方案。

列印頁面