Как мы начали тестировать SwiftUI-компоненты без UI-тестов

—

от автора

Опыт iOS-проекта с AI-функциональностью

В iOS-проекте с AI-функциональностью интерфейс меняется постоянно: сообщения, действия над ними, состояния ввода, оформление под разные темы. Проверять это руками дорого, а UI-тесты на XCUITest медленные и хрупкие. Мы искали способ проверять SwiftUI-компоненты на уровне обычных юнит-тестов. Ниже: что из этого вышло, во что мы упёрлись и почему главной проблемой оказался не инструмент.

Зачем нужен ViewInspector

ViewInspector позволяет в юнит-тесте обойти иерархию SwiftUI-вью, найти нужный элемент, прочитать текст, проверить состояние кнопки или вызвать её действие. Приложение для этого не запускается, а тест выполняется за миллисекунды.

Важно понимать границы. Он проверяет структуру и поведение вью: что элемент есть, что текст верный, что нажатие вызывает нужное действие. Пиксели, анимации, реальную раскладку и системные эффекты он не проверяет. Для этого нужны другие инструменты или человеческий взгляд.

Пример учебного компонента:

import SwiftUIstruct MessageActionsView: View {    let onCopy: () -> Void    let onRetry: () -> Void    var body: some View {        HStack {            Button("Копировать", action: onCopy)            Button("Повторить", action: onRetry)        }    }}

И тесты к нему:

import XCTestimport ViewInspector@testable import ChatUIfinal class MessageActionsViewTests: XCTestCase {    func test_tapOnCopy_callsHandler() throws {        var copied = false        let sut = MessageActionsView(onCopy: { copied = true }, onRetry: {})        try sut.inspect().find(button: "Копировать").tap()        XCTAssertTrue(copied)    }    func test_containsRetryAction() throws {        let sut = MessageActionsView(onCopy: {}, onRetry: {})        XCTAssertNoThrow(try sut.inspect().find(button: "Повторить"))    }}

Где мы споткнулись: дело было не в библиотеке

Первые тесты на ViewInspector мы написали быстро, но стабильно запустить их в пайплайне не получалось. Это был не один сбой, а целый комплекс ошибок. Общим источником оказались неправильно настроенные тестовые таргеты.

Главная проблема: UI-тесты, юнит-тесты и снепшот-тесты лежали в одном общем таргете. У разных видов тестов разные требования к окружению и зависимостям, и в одном таргете они мешали друг другу. Документация ViewInspector при этом требует подключать библиотеку к юнит-тестовому таргету и не добавлять её в основной таргет сборки. Пока тестовый код был простым, беспорядок не мешал. Первый инструмент, которому нужен чёткий граф зависимостей, всё вскрыл.

Откуда взялся беспорядок, мы знали. При переезде в новый модуль тестовую архитектуру переносили на скорую руку: важнее было, чтобы всё собиралось. Это нормальный компромисс на момент переезда, но у него есть срок годности. Спустя время мы заплатили за него отдельной задачей.

Параллельно возник второй вопрос: как подключать сам ViewInspector. Можно как Swift Package, то есть исходниками, а можно готовым бинарём. Мы выбрали бинарь и пересборку после обновлений версии библиотеки. Причина практическая: так обновляться проще, чем следить за выходом новых версий и вручную дописывать изменения.

Итогом стала переработка тестовой архитектуры: UI-, юнит- и снепшот-тесты мы развели по отдельным таргетам с явными зависимостями. Примерно так это может выглядеть в XcodeGen:

targets:  ChatUITests:    type: bundle.unit-test    platform: iOS    sources: [Tests/ChatUITests]    dependencies:      - target: ChatUI      - framework: Frameworks/ViewInspector.xcframework

Продуктовый таргет ChatUI о ViewInspector ничего не знает. Библиотека живёт только в тестовом таргете.

Вывод: если новый тестовый инструмент не заводится на CI, проверьте, как устроены ваши тестовые таргеты. Быстрый перенос тестов «лишь бы работало» откладывает проблему, а не решает её.

Сравнение значений без Equatable

Отдельная практическая тема: как проверять результат работы use case, если возвращаемый тип нельзя просто сравнить через ==. Типичный случай: enum с ассоциированными значениями, внутри которых лежат типы без Equatable.

Один из приёмов, которым мы пользовались, это сравнение по структуре через рефлексию:

enum MessageAction {    case copy(text: String)    case retry(messageID: Int)    case share(Attachment)      // Attachment не Equatable}/// Сравнивает значения по структуре через рефлексию.func assertEqualByStructure<T>(    _ lhs: T, _ rhs: T,    file: StaticString = #filePath, line: UInt = #line) {    XCTAssertEqual(structure(of: lhs), structure(of: rhs), file: file, line: line)}private func structure<T>(of value: T) -> String {    var output = ""    dump(value, to: &output)    return output}

Использование в тесте:

func test_useCase_returnsCopyAction() {    let result = useCase.action(for: .copy, message: message)    assertEqualByStructure(result, MessageAction.copy(text: "Привет"))}

Функция dump печатает структуру значения вместе с именами case и свойств, поэтому два значения совпадают, только если совпадает вся структура.

Плюсы: не нужно добавлять Equatable в продуктовый код только ради тестов, и один небольшой хелпер подходит для многих типов.

Минусы, о которых стоит помнить: замыкания так не сравнить, тест становится чувствительным к переименованию свойств, то есть к рефакторингу, а сообщения об ошибках менее понятны, чем у явного сравнения.

Мы считаем приём разумным компромиссом для тестов, но не заменой нормальной модели данных там, где Equatable можно добавить без ущерба.

Что получилось

Покрытие автотестами на момент, когда я работал с проектом, составляло примерно 50-60%. Для компонентов интерфейса это хороший уровень: большая часть проверок, которые не требуют человеческого взгляда, выполняется автоматически.

Что мы всё же оставляем людям: внешний вид, анимации, плавность прокрутки и всё, что нужно увидеть глазами. Автотесты проверяют логику и структуру, а оценить, как это выглядит и ощущается, они не могут.

Итого

  1. ViewInspector хорош для структурных проверок SwiftUI без запуска UI.

  2. Если он не заводится на CI, проверьте архитектуру тестовых таргетов, а не только библиотеку.

  3. Спешный перенос тестовой инфраструктуры потом возвращается долгом.

  4. Автоматизируйте всё, что может проверить машина, а человека оставьте для того, что нужно увидеть.

ссылка на оригинал статьи https://habr.com/ru/articles/1110662/