Контрактне тестування
перевірка узгоджених вимог до інтерфейсу компонентів
Що це таке
Контрактне тестування перевіряє, чи узгоджено очікування двох компонентів щодо запитів,
відповідей або повідомлень. Екран відстеження посилок і сервіс можуть працювати окремо. Екран усе
одно не впорається, якщо очікує поле status, а сервіс поверне state. Перевірка інтерфейсу
описує, чим користується екран, і встановлює, що сервіс може це надати.
Pact описує підхід, за якого споживач працює з керованою заміною постачальника. Тест записує взаємодії до контракту. Постачальник перевіряє їх через власну реалізацію за певних умов. Для обміну повідомленнями перевіряють повідомлення, яке одна сторона створює, а інша читає. Сторони можуть розвиватися й випускати версії незалежно, коли докази стосуються саме версій, що працюватимуть разом.
Також цей термін може означати перевірку постачальника за його опублікованим описом інтерфейсу, наприклад документом OpenAPI. Це доречно, якщо специфікація є спільною домовленістю. Вона визначає поля, коди стану та припустимі значення. Приклади споживача додатково показують, які їх поєднання використовує певний клієнт і на що він покладається. Обидва методи можна поєднати. Наскрізний тест справжньої інтеграції також перевіряє маршрутизацію, доступ і налаштування середовища.
Чому це важливо
Інтерфейс часто існує довше, ніж його перша реалізація. Команда сервісу може перейменувати поле й оновити свої тести, не зачепивши клієнт в іншому проєкті. Мобільний застосунок здатен працювати кілька місяців у старій версії. Навіть проста зміна типу важлива, якщо поле визначає показаний текст. Контракт, який можна перевірити, робить залежність видимою до випуску.
Коли версії випускають у різний час, потрібно знати, які з них сумісні. Старий клієнт може розуміти лише кілька станів, а сервісу вже потрібен проміжний. Команди можуть спочатку підготувати клієнт, приймати обидві форми під час переходу й прибрати стару лише тоді, коли її не використовують підтримувані версії. Безпечний порядок залежить від контрактів, фактичного використання та правил випуску. Результат для нової пари не доводить сумісності зі старими клієнтами.
У тесті варто описувати важливі домовленості. Якщо придатний будь-який правильно оформлений номер, перевірте формат і не фіксуйте значення прикладу. Якщо поле визначає текст для людини, важливі тип і зрозумілі клієнту значення. За потреби команда може погодити поведінку для незнайомого значення, наприклад повідомлення «стан недоступний», яке лишає решту сторінки придатною до роботи.
Як це виглядає на практиці
Уявімо застосунок відстеження посилок. Він запитує посилку за номером. Якщо вона існує і прямує до адресата, екран очікує успішну відповідь, номер і текстове значення, яке перетворює на позначку «в дорозі». Для невідомого номера екран очікує іншу відповідь і пропонує перевірити введене значення. Для кожної взаємодії потрібна передумова, наприклад існування посилки в дорозі або відсутність потрібного запису.
Запустіть реальний код запиту споживача проти визначеної заміни. Перевірте результат, який бачить людина. Потім відтворіть ті самі взаємодії через шлях формування відповіді постачальника. Підготуйте передбачувані дані й відновіть їх між спробами. Якщо тест підміняє базу або стороннього перевізника, залиште в перевірці розбір запиту, логіку сервісу і формування відповіді, від якої залежить споживач.
Тимчасово замініть status на state, не змінюючи клієнт. Перевірка має показати, якого поля не
вистачає і якої взаємодії це стосується. Додаткове необов’язкове поле, яке клієнт ігнорує, може
бути дозволене. Прив’яжіть перевірку до точних версій. Якщо поєднати результати нового сервісу з
невідомим старим зразком, незрозуміло, що саме перевірено.
У нотатці про відкриття застосунків у мобільних гаманцях Solana описано інтеграції з різними шляхами посилань і правилами кодування параметрів. Перевірка сформованих адрес може захистити узгоджену форму для кожного гаманця. Реальний пристрій показує, чи передає браузер посилання встановленому застосунку і чи завершується шлях. Нотатка документує різницю та пропонує перевірки на пристроях.
Де виникають проблеми
Контракт може стати надто жорстким, коли кожний байт має відповідати одному збереженому прикладу. Постачальник може мати право додати невживане поле або інакше відформатувати повідомлення. Вимагайте порядку, точного тексту або одиниць там, де цього потребує клієнт чи специфікація.
Тест втрачає цінність, якщо обходить справжню межу. Рукописний об’єкт JSON може не запустити код формування відповіді. Заміна видасть очікуваний приклад навіть тоді, коли клієнт неправильно читає його в реальному процесі. Виконайте код запиту або відповіді для сторони, яку перевіряєте, і зафіксуйте замінені залежності.
Припустімо, клієнт не розпізнає новий стан посилки. Можна спочатку навчити його показувати загальне повідомлення, а згодом додати нову відповідь сервісу. Перед зміною перевірте, які версії встановлено і що вони роблять із новим значенням. Випуск нової версії ще не означає, що всі користувачі її отримали.
Один успішний випадок мало каже про відсутні дані, невідомі номери чи старі версії. Врахуйте помилки, які клієнт уміє обробляти, і сумісність, яку постачальник обіцяє. Збережіть інтеграційні тести налаштувань і маршрутизації. Контракт дає швидший, зосереджений доказ для відповідних змін.