Баг 🐞

Баг — тип данных предоставляющий отчёт о баге.

Тесты позволяют разработчикам доказать, что написанный ими код работает так, как и ожидается. Если код работает неправильно, то используются системы учёта ошибок (баг-трекеры). Устоявшейся практикой считается прикрепить ошибку к конкретному тесту, чтобы проверить и/или уточнить статус — баг исправлен или нет.

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

Для указания на конкретный баг, используй трейт .bug(...) в атрибуте @Test:

@Test(
    "Вход с неправильными данными", 
    .bug("https://example.com/bug/71")
)
func loginInvalidCredentials() async {
    let profile = UserProfile()
    await profile.login(option: .singInWithApple)
    #expect(profile.isSuccessLogin)
}

В самом простом варианте, ты передаешь ссылку в баг-трекинг:

.bug("https://example.com/bug/71")

Возникает вопрос, как тебе посмотреть информацию о этом баге?
Для начала перейди в отчет тестов, например: как показано на скриншоте Jump to Report. При переходе в отчет ты увидишь ссылку иконку бага с указанным URL:

В правом вверхнем углу иконка бага и кликабельная ссылка для перехода в баг-трекер.

Помимо ссылки, трейт .bug(...) может принимать айди бага:

@Test(
	"Вход с неправильными данными",
	.bug(id: 71)
)
func loginInvalidCredentials() async {
    // ...
}

В таком случае, ты ссылаешь на айди бага для баг-трекинга. Кнопка не кликабельна, поскольку мы не указали URL.

Айди (ID) — уникальный признак, позволяющий отличить один объект от другого.

В последнем варианте ты можешь указать айди в дополнение или вместо URL:

@Test(
	"Вход с неправильными данными",
	.bug(id: 483),
	.bug("https://example.com/bug/71", id: 71)
)
func loginInvalidCredentials() async {
    // ...
}

Однако, одного айди может быть недостаточно для однозначной идентификации бага связанного с тестом, поэтому трейт .bug(...) предоставляет еще одно свойство title:

@Test(
	"Вход с неправильными данными",
	.bug(id: 483, "Вход с такими данными невозможен во всех сценариях")
)
func loginInvalidCredentials() async {
    // ...
}

Централизация багов

Идея централизации багов в баг-трекере отличная, это удобно при работе в одиночку или целой команды, поиск и ведение беседы, ты сам понимаешь преимущества. Возникает вопрос:

Как централизировать (организовать) баги в коде?

Вместо отдельных URL ссылок на баг-трекинг систему, лучшей идей будет использовать централизорованную систему, по аналогии с веб версиями баг-трекеров. Посмотри на пример:

enum ProfileBugs {
    case createNewOne
    case updateWithInvalidData
    case deleteConfirmation
    case pictureUploadFileSize
    case updateTimeout
    // ...

    var url: String {
        switch self {
            case .createNewOne: "https://example.com/bug/24"
            case .updateWithInvalidData: "https://example.com/bug/71"
            // ...
        }
    }

    var title: String {
        switch self {
            case .createNewOne: "Ошибка при создании профиля"
            case .updateWithInvalidData: "Ошибка при обновлении с невалидными данными"
            // ...
        }
    }
}

Данный пример лиш один из множества возможных вариантов организовать баги. Теперь осталось передать URL в инициализатор трейта:

@Test(.bug(ProfileBugs.createNewOne.url))
func createNewProfile() async {
    // ...
}

Как ты догадался, централизованная система делает код более организованным, удобным для поддержки и менее подверженным человеческим ошибкам. Это особенно полезно в проектах с большим количеством тестов.

Обработка параметров

Библиотека тестирования предоставляет 2 способа обработки параметров:

1. Ссылка (URL) предоставляющая больше информации о баге
2. Уникальный идентификатор связанный с баг-трекинг системами

Ты уже ознакомился и знаешь, что трейт .bug(...) должен принимать один из указанных выше параметров для корректной обработки библиотекой тестирования. Проверка валидности строки осуществляется в соответсвии RFC 3986 и происходит на этапе компиляции:

@Test(.bug("com.invalid.domain/id?=63"))
func handleOutput() async {
	// ...
}

⚠️ URL "com.invalid.domain/id?=63" is invalid and cannot be used with trait 'bug' in attribute 'Test' (from macro 'Test')

В случае, если URL не прошел валидацию, ты получишь предупреждение о неправильности строки. Поскольку это предупреждение, сборке и запуску тестов это не мешает.

Другим валидным примером URL послужит компания Apple, которая использует внутреннюю систему баг-трекинга, называемой Radar:

@Test(.bug("rdar://16488816"))
func anotherBug() {
    // ...
}

Ниже представлена таблица с примера на различные баг-трекинг системы.

^[1]RFC 3986 — это стандарт, который определяет единообразный синтаксис URI (Uniform Resource Identifier)