Selenium оголосив про невелику на перший погляд зміну Java API, яка має чіткі наслідки для сумісності. Починаючи із запланованого випуску Selenium 4.51, інтерфейс ExpectedCondition<T> більше не розширюватиме Guava com.google.common.base.Function<WebDriver, T>, але й надалі розширюватиме JDK java.util.function.Function<WebDriver, T>.
Це не привід панікувати чи переходити на артефакт, якого ще немає. Натомість це можливість виявити залежність від стороннього типу до того, як зміна потрапить у звичайний pull request з оновленням.
1. Що підтвердив Selenium
В офіційному оголошенні Selenium розмежовано сценарії використання, яких зміна стосується, і ті, яких вона не зачіпає:
| Сценарій використання | Очікуваний вплив |
|---|---|
Результат фабричного методу ExpectedConditions передається безпосередньо в WebDriverWait.until(...) | Зміна не впливає |
ExpectedCondition реалізовано за допомогою лямбда-виразу | Зміна не впливає |
ExpectedCondition зберігається або надається через тип Guava Function | Несумісність на етапі компіляції після видалення інтерфейсу |
Guava використовується в інших місцях без зв’язку із Selenium ExpectedCondition | Не належить до сфери цієї конкретної зміни |
На момент оголошення зміну було заплановано для Selenium 4.51, але її не мали випускати негайно. Вважайте цю версію запланованою межею, доки не з’являться офіційний артефакт випуску та примітки до нього.
Поточна документація Java API також слугує корисною базовою точкою: у ній зазначено, що ExpectedCondition розширює функціональні інтерфейси і Guava, і JDK. Це дає командам конкретну основу для порівняння з майбутнім API.
2. Визначте справжню межу сумісності
Недостатньо просто знайти Guava в дереві залежностей. Проєкт може цілком обґрунтовано використовувати Guava для інших функцій і не зазнати впливу цієї зміни. Важливо з’ясувати, чи перетинають умови Selenium межу типів, оголошену як com.google.common.base.Function.
Почніть із цільового пошуку в коді:
git grep -n "com.google.common.base.Function"
git grep -n "ExpectedCondition\|ExpectedConditions"Перевірте збіги в таких місцях:
- поля, у яких зберігаються повторно використовувані умови;
- допоміжні методи, що приймають або повертають функціональний тип;
- обгортки тестового фреймворку навколо
WebDriverWait; - спільні бібліотеки, які використовують кілька репозиторіїв із тестами;
- точки розширення, надані іншим командам;
- скомпільовані сторонні допоміжні бібліотеки, які можуть надавати типи Guava у своїх публічних сигнатурах.
Для кожного збігу зафіксуйте відповідального, споживачів і запропонований спосіб міграції. Така карта меж корисніша за звичайний список залежностей, адже показує, де зміна у вихідному коді може порушити сумісність для залежних споживачів.
3. Застосуйте найменшу безпечну зміну типу
Офіційний напрям міграції однозначний.
До зміни:
com.google.common.base.Function<WebDriver, WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Після зміни:
java.util.function.Function<WebDriver, WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Якщо значення стосується саме Selenium, виразнішим варіантом буде:
ExpectedCondition<WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Для короткої локальної змінної виведення типу може усунути непотрібну залежність:
var condition = ExpectedConditions.elementToBeClickable(By.id("submit"));Не додавайте адаптери з неперевіреними перетвореннями типів лише для збереження старого типу. Якщо публічна бібліотека надає Guava Function, зміну такої сигнатури потрібно планувати з урахуванням сумісності для її споживачів.
4. Підготуйтеся до випуску, не вдаючи, що вже протестували його
До появи офіційного сумісного артефакту команди можуть виконати корисну підготовчу роботу:
- класифікувати всі пов’язані із Selenium посилання на Guava
Function; - виконати рефакторинг приватних деталей реалізації, якщо намір уже зрозумілий;
- визначити публічні API, зміни яких потрібно узгодити зі споживачами;
- додати тести для власних обгорток механізму очікування та оброблення помилок;
- задокументувати поточну перевірену робочу версію Selenium;
- визначити докази, потрібні для майбутнього оновлення.
Не створюйте навмисно некомпільований тест і не вилучайте його зі звичайних збірок. Такий тест мало що доводить. Справді корисна перевірка — компіляція реальних наборів продукційного й тестового вихідного коду з майбутнім офіційним артефактом.
Довготривала гілка оновлення також може застаріти. Коли випуск стане доступним, краще створити короткочасну контрольовану гілку оновлення, заздалегідь підготувавши інвентаризацію та план тестування.
5. План перевірки з урахуванням ризиків
Коли з’явиться офіційна версія Selenium, що містить цю зміну, виконуйте оновлення поетапно:
| Ризик | Доказ |
|---|---|
| Пряма залежність від типу Guava перешкоджає компіляції | Чиста компіляція всіх наборів продукційного й тестового вихідного коду, фікстур і допоміжних модулів |
| Зміна API спільної обгортки порушує роботу споживачів | Контрактні тести споживачів або збірки репрезентативних залежних проєктів |
| Після рефакторингу власні механізми очікування поводяться інакше | Цільові тести успішного виконання, тайм-аутів, ігнорованих винятків і повернених значень |
| Розв’язання залежностей неочікувано змінюється | Порівняння дерев залежностей до й після оновлення та перевірка узгодженості їхніх версій |
| CI проходить, хоча важливий сценарій не протестовано | Репрезентативні браузерні смоук-тести з подальшим запуском звичайного набору регресійних тестів |
| Пакет фреймворку досі надає стару сигнатуру | Звіт про сумісність публічного API або байткоду зібраного артефакту |
Оголошене видалення інтерфейсу створює передусім ризик на етапі компіляції. Перевірки під час виконання все одно важливі, оскільки під час усунення помилок компіляції команди можуть змінювати обгортки. Водночас в оголошенні Selenium не йдеться про зміну таймінгів очікування чи поведінки винятків.
6. CI-канарка для фактичного оновлення
Коли з’явиться офіційний артефакт, створіть окреме завдання оновлення або тимчасову гілку:
- оновіть лише залежність Selenium і внесіть необхідні виправлення типів;
- виконайте чисту збірку з контрольованими кешами залежностей;
- скомпілюйте всі відповідні набори вихідного коду, а не лише основний модуль;
- запустіть цільові тести власних механізмів очікування та обгорток;
- запустіть невеликий набір браузерних смоук-тестів у стабільному середовищі;
- опублікуйте як докази вивід компілятора, звіти про залежності й результати тестів;
- запускайте повний набір регресійних тестів лише після проходження попередніх контрольних етапів.
CI-канарка найкорисніша тоді, коли перевіряє ті самі файли збірки, версію Java, образ раннера та спільні бібліотеки, які використовує звичайний конвеєр. Успішний набір тестів застосунку зі старою залежністю не доводить сумісність нової залежності.
7. Захистіть залежних споживачів
Внутрішні тестові фреймворки часто перетворюють невелику зміну у зовнішній залежності на масштабнішу міграцію. Якщо спільний метод зараз повертає Guava Function, знайдіть усіх його споживачів до зміни сигнатури.
Для кожної публічної межі визначте, який варіант обрати:
- випустити узгоджену несумісну версію;
- додати новий метод із типом JDK і позначити старий метод як застарілий на визначений перехідний період;
- залишити в контракті специфічний для Selenium тип
ExpectedCondition; - оновити всіх контрольованих споживачів в одному вікні змін.
Правильний вибір залежить від розподілу відповідальності та політики випусків. Головна вимога QA — тестувати контракт зі споживачами, а не лише репозиторій фреймворку.
8. Виправлення без відкату та план відкату
Довгострокове виправлення полягає в усуненні пов’язаної із Selenium залежності від функціонального інтерфейсу Guava. Залежно від призначення API віддавайте перевагу типу JDK, специфічному для Selenium типу або локальному виведенню типу.
План відкату має бути таким само однозначним. До оновлення зафіксуйте точну поточну перевірену робочу версію Selenium. Якщо нова версія спричинить невирішену проблему, відновіть саме цю версію та відповідні зміни у вихідному коді, а потім ще раз виконайте чисту збірку й смоук-перевірки. Не використовуйте відкритий діапазон версій як запобіжний механізм: він може вибрати новіший артефакт без свідомого перегляду.
Відкат — це тимчасовий засіб контролю ризику, а не заміна завершеної міграції.
9. Перелік перевірок перед злиттям
- Інвентаризовано всі пов’язані із Selenium посилання на Guava
Function. - Публічні й приватні межі типів класифіковано окремо.
- Для оновлення використано офіційно випущений артефакт.
- Набори продукційного й тестового вихідного коду, фікстур і допоміжних модулів компілюються без помилок.
- Перевірено репрезентативних залежних споживачів.
- Протестовано успішні та невдалі сценарії власних механізмів очікування.
- Розв’язання залежностей порівняно до й після оновлення.
- Браузерні смоук-тести та необхідний обсяг регресійного тестування пройдено.
- Докази з CI збережено разом із pull request.
- Точну версію для відкату та відповідального задокументовано.
- Перевірка відповідає звичайній політиці схвалення команди.
10. П’ять запитань для рецензента
- Які шляхи виконання коду досі пов’язують
ExpectedConditionіз GuavaFunction? - Чи перевірили ми публічних споживачів, а не лише репозиторій, якому належить обгортка?
- Чи компілює завдання CI кожен набір вихідного коду, що може містити допоміжні засоби Selenium?
- Які перевірки під час виконання охоплюють код, змінений у межах міграції типів?
- Чи можемо ми відновити точну перевірену робочу версію залежності та перевірити відкат за один контрольований запуск?
11. Де допомагає автоматизація
Статичний пошук робить початкову інвентаризацію повторюваною. Звіти про залежності виявляють транзитивні зміни. Компіляція в CI знаходить детерміновані несумісності, а контрактні тести — порушення в роботі споживачів. Після цього браузерні смоук-тести перевіряють поведінку змінених допоміжних засобів очікування.
Автоматизація не може визначити, чи прийнятна зміна публічного API, з якими споживачами потрібно узгодити її або чи достатньо зібраних доказів для випуску. Ці рішення й надалі потребують перевірки людиною.
Висновок
Запланована для Selenium 4.51 зміна ExpectedCondition має вузьку сферу впливу, але ілюструє ширший урок для QA: під час оновлення залежностей потрібно перевіряти публічні межі типів, а не лише сценарії виконання. Точна інвентаризація, контрольована гілка оновлення, багаторівневі докази з CI та конкретна цільова версія для відкату дають командам змогу усунути залежність від стороннього типу до того, як вона заблокує доставлення змін.
Залишити коментар
Поділіться думкою про статтю. Реєстрація не потрібна.
Коментарі
Завантаження коментарів…