Pearcleaner UI自动化测试：从零搭建XCTest与EarlGrey测试框架

Pearcleaner UI自动化测试：从零搭建XCTest与EarlGrey测试框架

【免费下载链接】Pearcleaner Open-source mac app cleaner 项目地址: https://gitcode.com/gh_mirrors/pe/Pearcleaner

引言：为什么UI自动化测试对macOS应用至关重要

作为一款开源的macOS应用清理工具，Pearcleaner需要确保其用户界面在各种场景下都能提供一致且可靠的体验。手动测试不仅耗时耗力，而且难以覆盖所有可能的用户交互组合。UI自动化测试（User Interface Automation Testing）通过模拟用户操作和验证界面响应，能够显著提高测试效率和覆盖率，同时确保应用在迭代过程中的稳定性。

本文将详细介绍如何为Pearcleaner项目从零开始搭建基于XCTest和EarlGrey的UI自动化测试框架，帮助开发团队构建健壮、可维护的测试套件。

技术选型：XCTest与EarlGrey的协同优势

XCTest框架简介

XCTest是Apple官方提供的测试框架，集成在Xcode中，用于编写单元测试、性能测试和UI测试。对于macOS应用，XCTest提供了XCTestCase基类和一系列断言方法，以及用于UI测试的XCUIApplication、XCUIElement等类，能够模拟用户交互并检查UI元素状态。

EarlGrey框架简介

EarlGrey是Google开源的iOS UI自动化测试框架，虽然主要面向iOS，但通过一定配置也可用于macOS。它建立在XCTest之上，提供了更强大的同步机制、更简洁的API和更丰富的交互能力。EarlGrey的核心优势在于：

1. 自动同步：自动等待UI元素就绪、网络请求完成和异步操作结束
2. 清晰的API：链式调用风格，使测试代码更易读、易维护
3. 丰富的交互操作：支持点击、输入、滑动等多种用户操作
4. 灵活的断言系统：可以验证元素属性、状态和行为

为什么选择XCTest+EarlGrey组合

• 官方兼容性：XCTest与Xcode深度集成，确保与最新macOS版本的兼容性
• 增强的功能：EarlGrey弥补了XCTest在UI同步和复杂交互方面的不足
• 社区支持：两者都有活跃的社区和丰富的学习资源
• 可扩展性：支持自定义匹配器、操作和断言，满足特定测试需求

环境准备：搭建测试开发环境

系统要求

• macOS 10.15+
• Xcode 11.0+
• Swift 5.0+

安装依赖

1. CocoaPods安装（如果项目未使用CocoaPods）：

sudo gem install cocoapods

2. 创建Podfile：

在项目根目录创建Podfile，添加以下内容：

platform :osx, '10.15'

target 'PearcleanerTests' do
  use_frameworks!
  pod 'EarlGrey', :git => 'https://github.com/google/EarlGrey.git', :branch => 'earlgrey2'
end

3. 安装依赖：

pod install

4. 打开工作空间：

open Pearcleaner.xcworkspace

项目配置：将测试目标添加到Xcode项目

创建UI测试目标

1. 在Xcode中，选择项目文件 -> 点击"+"按钮添加目标
2. 选择"macOS" -> "Test" -> "Cocoa Test Bundle"
3. 填写目标信息：
   • Product Name: PearcleanerUITests
   • Language: Swift
   • Target to be tested: Pearcleaner
4. 点击"Finish"完成创建

配置测试目标

1. 选择新创建的测试目标 -> "Build Settings"
2. 设置"Bundle Loader"为：$(BUILT_PRODUCTS_DIR)/Pearcleaner.app/Contents/MacOS/Pearcleaner
3. 设置"Test Host"为：$(BUNDLE_LOADER)
4. 在"Framework Search Paths"中添加：$(SRCROOT)/Pods/EarlGrey/EarlGrey-macOS

基础测试示例：首个UI自动化测试

创建测试类

在PearcleanerUITests目标中创建新的Swift文件MainWindowTests.swift：

import XCTest
import EarlGrey

class MainWindowTests: XCTestCase {
    var app: XCUIApplication!
    
    override func setUp() {
        super.setUp()
        continueAfterFailure = false
        app = XCUIApplication()
        app.launch()
    }
    
    override func tearDown() {
        app.terminate()
        super.tearDown()
    }
}

测试主窗口启动

添加测试方法验证应用启动后主窗口是否显示：

func testMainWindowLaunch() {
    // 验证应用已启动
    XCTAssertTrue(app.exists)
    
    // 验证主窗口标题
    XCTAssertEqual(app.windows.firstMatch.title, "Pearcleaner")
    
    // 使用EarlGrey验证窗口可见
    EarlGrey.selectElement(with: grey_accessibilityLabel("Pearcleaner"))
        .assert(grey_sufficientlyVisible())
}

测试应用列表加载

func testAppListLoading() {
    // 等待应用列表加载
    EarlGrey.selectElement(with: grey_accessibilityID("appList"))
        .assert(grey_notNil())
        .perform(grey_waitForElement(withTimeout: 5))
    
    // 验证列表不为空
    let appList = app.tables["appList"]
    XCTAssertGreaterThan(appList.cells.count, 0)
}

核心功能测试：关键用户流程自动化

测试应用清理功能

func testAppCleaningWorkflow() {
    // 选择第一个应用
    EarlGrey.selectElement(with: grey_accessibilityID("appList"))
        .perform(grey_tap())
    
    // 点击"清理"按钮
    EarlGrey.selectElement(with: grey_accessibilityLabel("Clean"))
        .perform(grey_tap())
    
    // 验证清理确认对话框
    EarlGrey.selectElement(with: grey_accessibilityLabel("Confirm Cleaning"))
        .assert(grey_sufficientlyVisible())
    
    // 确认清理
    EarlGrey.selectElement(with: grey_accessibilityLabel("OK"))
        .perform(grey_tap())
    
    // 验证清理成功提示
    EarlGrey.selectElement(with: grey_accessibilityLabel("Cleaning Completed"))
        .assert(grey_sufficientlyVisible())
}

测试设置页面交互

func testSettingsNavigationAndSave() {
    // 点击设置按钮
    EarlGrey.selectElement(with: grey_accessibilityLabel("Settings"))
        .perform(grey_tap())
    
    // 验证设置页面加载
    EarlGrey.selectElement(with: grey_accessibilityLabel("Preferences"))
        .assert(grey_sufficientlyVisible())
    
    // 修改设置选项
    EarlGrey.selectElement(with: grey_accessibilityLabel("Show Advanced Options"))
        .perform(grey_tap())
    
    // 保存设置
    EarlGrey.selectElement(with: grey_accessibilityLabel("Save"))
        .perform(grey_tap())
    
    // 验证设置保存提示
    EarlGrey.selectElement(with: grey_accessibilityLabel("Settings Saved"))
        .assert(grey_sufficientlyVisible())
}

高级测试技巧：提升测试效率与可靠性

自定义匹配器

创建CustomMatchers.swift文件，定义项目特定的元素匹配器：

import EarlGrey

func grey_appWithName(_ name: String) -> GREYMatcher {
    return GREYElementMatcherBlock.matcher(withDescription: "app with name \(name)") { element, errorOrNil in
        guard let element = element as? XCUIElement else {
            return false
        }
        return element.staticTexts[name].exists
    }
}

使用自定义匹配器：

EarlGrey.selectElement(with: grey_appWithName("Safari"))
    .assert(grey_sufficientlyVisible())

测试数据管理

创建TestData.swift，集中管理测试中使用的数据：

enum TestApps {
    static let safari = "Safari"
    static let chrome = "Google Chrome"
    static let firefox = "Firefox"
}

enum TestPaths {
    static let testApp = "/Applications/TestApp.app"
}

截图与报告

在测试失败时自动截图：

override func recordFailure(withDescription description: String, inFile filePath: String, atLine lineNumber: Int, expected: Bool) {
    // 截图
    let screenshot = XCUIScreen.main.screenshot()
    let attachment = XCTAttachment(screenshot: screenshot)
    attachment.lifetime = .keepAlways
    add(attachment)
    
    super.recordFailure(withDescription: description, inFile: filePath, atLine: lineNumber, expected: expected)
}

测试集成：持续集成与报告

配置Xcode Server CI

1. 在Xcode中，打开"Xcode Server"偏好设置
2. 创建新的Bot，选择项目和测试目标
3. 配置测试步骤：
   • 选择"Run test action"
   • 选择"PearcleanerUITests"目标
4. 设置触发条件（如每次提交或定时触发）
5. 配置通知选项，获取测试结果

命令行运行测试

xcodebuild test -workspace Pearcleaner.xcworkspace -scheme Pearcleaner -destination 'platform=macOS' -only-testing:PearcleanerUITests

生成测试报告

使用xcresulttool解析测试结果：

xcrun xcresulttool export --resultBundlePath TestResults.xcresult --outputPath TestReport --format json

常见问题与解决方案

测试稳定性问题

问题：测试有时通过，有时失败，出现间歇性问题。

解决方案：

1. 增加显式等待：

EarlGrey.selectElement(with: grey_accessibilityID("appList"))
    .perform(grey_waitForElement(withTimeout: 10))

2. 使用EarlGrey的同步API：

GREYCondition(name: "Wait for app list", block: {
    var errorOrNil: NSError?
    let success = EarlGrey.selectElement(with: grey_accessibilityID("appList"))
        .assert(grey_notNil(), error: &errorOrNil)
    return success
}).wait(withTimeout: 10)

元素定位困难

问题：难以可靠地定位某些UI元素。

解决方案：

1. 为UI元素添加可访问性标识：

// 在应用代码中
button.accessibilityIdentifier = "cleanButton"

2. 使用多个属性组合定位：

EarlGrey.selectElement(with: grey_allOf([
    grey_accessibilityLabel("Clean"),
    grey_kindOfClass(NSClassFromString("NSButton")!)
]))

测试速度缓慢

问题：测试套件执行时间过长。

解决方案：

1. 优化测试顺序，避免重复启动应用：

override class func setUp() {
    super.setUp()
    // 只启动一次应用
    if app == nil {
        app = XCUIApplication()
        app.launch()
    }
}

2. 并行运行测试：在Xcode测试方案中启用"Parallelize Tests"选项

总结与展望

通过本文介绍的方法，我们为Pearcleaner项目构建了一个基于XCTest和EarlGrey的UI自动化测试框架。这个框架能够覆盖关键用户流程，提高测试效率，并确保应用质量。

下一步改进方向

1. 测试覆盖率扩展：增加更多边缘情况和错误处理测试
2. 性能测试：集成性能测试，监控关键操作响应时间
3. 视觉测试：添加Snapshot测试，检测UI意外变化
4. 测试数据自动化：实现测试数据的自动生成和清理
5. CI/CD集成：将测试完全集成到持续集成和部署流程中

UI自动化测试是一个持续改进的过程。随着Pearcleaner功能的扩展，测试框架也需要不断完善，以确保应用的稳定性和用户体验。通过自动化测试，开发团队可以更自信地迭代产品，同时减少回归错误，最终为用户提供更可靠的应用。

附录：测试框架API速查

XCTest常用类

类名	用途
XCTestCase	测试用例基类
XCUIApplication	应用实例，用于启动和控制应用
XCUIElement	UI元素，用于模拟交互
XCTAssert	断言函数集合
XCTAttachment	测试附件，用于添加截图等

EarlGrey常用方法

方法	用途
selectElement(with:)	选择UI元素
perform(_:)	执行操作（点击、输入等）
assert(_:)	验证元素状态
grey_waitForElement(withTimeout:)	等待元素出现
grey_allOf(_:)	组合多个匹配条件

常用访问ibility属性

属性	用途
accessibilityIdentifier	唯一标识元素
accessibilityLabel	元素标签
accessibilityValue	元素值
accessibilityHint	元素提示信息
isAccessibilityElement	是否为可访问元素

【免费下载链接】Pearcleaner Open-source mac app cleaner 项目地址: https://gitcode.com/gh_mirrors/pe/Pearcleaner