在GitHub Actions中运行Sitespeed.io性能测试的最佳实践

Sitespeed.io是一个强大的开源工具，用于测量网站性能并收集关键指标。本文将详细介绍如何在GitHub Actions工作流中配置和运行Sitespeed.io测试，特别针对使用自托管运行器的情况。

工作流配置要点

一个典型的Sitespeed.io GitHub Actions工作流包含以下几个关键部分：

1. 触发器配置：使用workflow_dispatch触发器，允许手动运行工作流并传入自定义参数
2. 输入参数：定义项目名称、迭代次数和脚本路径等可配置项
3. 运行环境：指定自托管运行器（如hephaestus-ctci-medium）
4. 执行步骤：包括代码检出、Docker镜像拉取、结果目录创建、测试执行和结果上传

完整工作流示例

以下是一个经过验证可用的工作流配置示例：

name: Sitespeed.io性能测试

on:
  workflow_dispatch:
    inputs:
      project:
        description: '输入要运行的项目名称'
        required: true
        default: 'ClientsideScripts'
      iterations:
        description: '输入要运行的迭代次数'
        required: true
        default: '1'
      script:
        description: '输入要运行的脚本路径'
        required: true
        default: 'script/01-PageLoad.js'

jobs:
  run_sitespeed:
    runs-on: hephaestus-ctci-medium

    steps:
      - name: 检出代码
        uses: actions/checkout@v3

      - name: 拉取Sitespeed.io Docker镜像
        run: |
          docker pull sitespeedio/sitespeed.io:latest

      - name: 创建结果目录
        run: |
          mkdir -p ClientsideScripts/sitespeed-result

      - name: 运行Sitespeed.io测试
        run: |
          docker run -v "$(pwd)/ClientsideScripts:/sitespeed.io" sitespeedio/sitespeed.io \
            --multi "/sitespeed.io/${{ github.event.inputs.script}}" \
            -b chrome \
            --browsertime.headless \
            --browsertime.chromeOptions.args='["--headless", "--disable-gpu", "--no-sandbox", "--remote-debugging-port=9222"]' \
            --browsertime.iterations ${{ github.event.inputs.iterations }} \
            --output "/sitespeed.io/ClientsideScripts/sitespeed-result"

      - name: 上传测试结果
        uses: actions/upload-artifact@v3
        with:
          name: sitespeed-result
          path: ClientsideScripts/sitespeed-result

关键配置解析

1. Docker卷挂载：将本地目录挂载到容器中，使测试脚本和结果可以持久化
2. Chrome无头模式：通过--browsertime.headless和chromeOptions.args参数配置无头Chrome
3. 多脚本支持：使用--multi参数指定要执行的脚本路径
4. 迭代控制：通过--browsertime.iterations设置测试迭代次数
5. 结果输出：明确指定输出目录，便于后续结果收集

常见问题解决方案

在配置过程中可能会遇到Chrome浏览器无法启动的问题，这通常是由于缺少必要的依赖或配置不当导致的。解决方案包括：

1. 确保自托管运行器上安装了所有必要的依赖项
2. 正确配置Chrome的无头模式参数
3. 为Chrome添加--no-sandbox参数以解决沙箱限制问题
4. 设置适当的远程调试端口

通过以上配置，开发者可以轻松地将Sitespeed.io性能测试集成到CI/CD流程中，实现自动化性能监控和回归测试。