Selenium hat eine scheinbar kleine Änderung an der Java-API angekündigt, die eindeutige Folgen für die Kompatibilität hat. Ab dem geplanten Release Selenium 4.51 soll ExpectedCondition<T> die Guava-Schnittstelle com.google.common.base.Function<WebDriver, T> nicht mehr erweitern und nur noch die JDK-Schnittstelle java.util.function.Function<WebDriver, T> verwenden.
Das ist weder ein Grund zur Panik noch dazu, auf ein noch nicht verfügbares Artefakt zu aktualisieren. Es ist eine Gelegenheit, Kopplungen an Abhängigkeiten zu identifizieren, bevor die Änderung Bestandteil eines regulären Upgrade-Pull-Requests wird.
1. Was Selenium bestätigt hat
Die offizielle Selenium-Ankündigung unterscheidet zwischen betroffenen und nicht betroffenen Verwendungsmustern:
| Verwendungsmuster | Erwartete Auswirkung |
|---|---|
Das Ergebnis einer ExpectedConditions-Factory-Methode wird direkt an WebDriverWait.until(...) übergeben | Nicht betroffen |
Eine ExpectedCondition wird mit einem Lambda-Ausdruck implementiert | Nicht betroffen |
Eine ExpectedCondition wird über den Guava-Typ Function gespeichert oder bereitgestellt | Inkompatibilität zur Compile-Zeit, nachdem die Schnittstelle entfernt wurde |
Guava wird an anderer Stelle verwendet, ohne mit Seleniums ExpectedCondition verbunden zu sein | Liegt außerhalb des Umfangs dieser konkreten Änderung |
Zum Zeitpunkt der Ankündigung war die Änderung für Selenium 4.51 vorgesehen und sollte nicht sofort veröffentlicht werden. Behandeln Sie diese Version als geplante Kompatibilitätsgrenze, bis ein offizielles Release-Artefakt und die zugehörigen Release Notes verfügbar sind.
Auch die aktuelle Dokumentation der Java-API ist als Ausgangsbasis hilfreich: Sie zeigt, dass ExpectedCondition derzeit sowohl die funktionale Guava-Schnittstelle als auch die entsprechende JDK-Schnittstelle erweitert. Damit steht Teams eine konkrete Referenz für den Vergleich mit der zukünftigen API zur Verfügung.
2. Die tatsächliche Kompatibilitätsgrenze ermitteln
Es reicht nicht aus, den Abhängigkeitsbaum nach Guava zu durchsuchen. Ein Projekt kann Guava berechtigterweise für andere Funktionen verwenden und dennoch von dieser Änderung unberührt bleiben. Entscheidend ist, ob Selenium-Bedingungen eine Typgrenze überschreiten, die als com.google.common.base.Function deklariert ist.
Beginnen Sie mit einer gezielten Code-Suche:
git grep -n "com.google.common.base.Function"
git grep -n "ExpectedCondition\|ExpectedConditions"Prüfen Sie Treffer insbesondere an folgenden Stellen:
- Felder, in denen wiederverwendbare Bedingungen gespeichert werden;
- Hilfsmethoden, die einen funktionalen Typ akzeptieren oder zurückgeben;
- Wrapper des Testframeworks für
WebDriverWait; - gemeinsam genutzte Bibliotheken, die von mehreren Test-Repositorys verwendet werden;
- Erweiterungspunkte, die anderen Teams zur Verfügung stehen;
- kompilierte Hilfsbibliotheken von Drittanbietern, deren öffentliche Signaturen Guava-Typen enthalten könnten.
Dokumentieren Sie für jeden Treffer die verantwortliche Person, die Nutzer des betroffenen Codes und den vorgesehenen Migrationsweg. Diese Übersicht der Typgrenzen ist hilfreicher als eine reine Liste von Abhängigkeiten, da sie zeigt, an welchen Stellen eine auf Quellcodeebene kompatible Änderung zu einem Breaking Change für nachgelagerte Nutzer werden könnte.
3. Die kleinste sichere Typänderung verwenden
Der offiziell empfohlene Migrationsweg ist unkompliziert.
Vorher:
com.google.common.base.Function<WebDriver, WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Nachher:
java.util.function.Function<WebDriver, WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Wenn der Wert spezifisch für Selenium ist, bietet sich eine ausdrucksstärkere Alternative an:
ExpectedCondition<WebElement> condition =
ExpectedConditions.elementToBeClickable(By.id("submit"));Bei einer kurzlebigen lokalen Variable kann die Typinferenz eine unnötige Kopplung vermeiden:
var condition = ExpectedConditions.elementToBeClickable(By.id("submit"));Führen Sie keine ungeprüften Adapter ein, nur um den bisherigen Typ beizubehalten. Wenn eine öffentliche Bibliothek Guava Function bereitstellt, muss eine Änderung dieser Signatur im Rahmen der üblichen Kompatibilitätsplanung für ihre Nutzer erfolgen.
4. Vor dem Release vorbereiten, ohne einen Test vorzutäuschen
Noch bevor ein offizielles kompatibles Artefakt verfügbar ist, können Teams sinnvolle Vorbereitungen abschließen:
- alle Selenium-bezogenen Referenzen auf Guava
Functionklassifizieren; - private Implementierungsdetails refaktorieren, wenn die beabsichtigte Änderung bereits eindeutig ist;
- öffentliche APIs identifizieren, deren Änderung mit den Nutzern abgestimmt werden muss;
- Tests für benutzerdefinierte Wait-Wrapper und deren Fehlerverhalten ergänzen;
- die aktuell bekannte funktionierende Selenium-Version dokumentieren;
- die für das zukünftige Upgrade erforderlichen Nachweise definieren.
Erstellen Sie keinen absichtlich nicht kompilierbaren Test, der anschließend aus regulären Builds ausgeschlossen wird. Ein solcher Test besitzt nur geringe Aussagekraft. Entscheidend ist, die tatsächlichen Produktions- und Test-Source-Sets gegen das zukünftige offizielle Artefakt zu kompilieren.
Auch ein langlebiger Upgrade-Branch kann veralten. Bevorzugen Sie deshalb einen kurzlebigen, kontrollierten Upgrade-Branch, sobald das Release verfügbar ist. Halten Sie das Inventar und den Testplan jedoch bereits im Voraus bereit.
5. Risikobasierter Verifikationsplan
Sobald eine offizielle Selenium-Version mit dieser Änderung verfügbar ist, sollte das Upgrade schrittweise geprüft werden:
| Risiko | Nachweis |
|---|---|
| Eine direkte Typisierung mit Guava verhindert die Kompilierung | Saubere Kompilierung aller Produktions-, Test-, Fixture- und Helper-Source-Sets |
| Die öffentliche API eines gemeinsam genutzten Wrappers beeinträchtigt ihre Nutzer | Consumer-Contract-Tests oder Builds repräsentativer nachgelagerter Projekte |
| Benutzerdefinierte Waits verhalten sich nach dem Refactoring anders | Gezielte Tests für erfolgreiche Ausführung, Timeouts, ignorierte Exceptions und Rückgabewerte |
| Die Auflösung von Abhängigkeiten ändert sich unerwartet | Vergleich der Abhängigkeitsbäume vor und nach dem Upgrade sowie Konvergenzprüfungen |
| Die CI ist erfolgreich, obwohl ein wichtiger Pfad nicht getestet wurde | Repräsentative Browser-Smoke-Tests mit anschließender regulärer Regressionstestsuite |
| Das gebaute Framework stellt weiterhin eine alte Signatur bereit | Bericht zur Kompatibilität der öffentlichen API oder des Bytecodes des erstellten Artefakts |
Die angekündigte Entfernung der Schnittstelle stellt in erster Linie ein Risiko zur Compile-Zeit dar. Laufzeitprüfungen bleiben dennoch wichtig, da Teams bei der Behebung von Kompilierungsfehlern möglicherweise ihre Wrapper refaktorieren. Die Selenium-Ankündigung selbst beschreibt jedoch keine Änderung am Timing der Waits oder am Verhalten bei Exceptions.
6. CI-Canary für das tatsächliche Upgrade
Erstellen Sie einen separaten Upgrade-Job oder einen temporären Branch, sobald das offizielle Artefakt verfügbar ist:
- aktualisieren Sie ausschließlich die Selenium-Abhängigkeit und die erforderlichen Typanpassungen;
- führen Sie einen sauberen Build mit kontrollierten Dependency-Caches aus;
- kompilieren Sie alle relevanten Source-Sets und nicht nur das Hauptmodul;
- führen Sie gezielte Tests für benutzerdefinierte Waits und Wrapper aus;
- führen Sie eine kleine Auswahl von Browser-Smoke-Tests in einer stabilen Umgebung aus;
- veröffentlichen Sie Compiler-Ausgaben, Abhängigkeitsberichte und Testergebnisse als Nachweise;
- starten Sie die vollständige Regressionstestsuite erst, nachdem die vorherigen Qualitätsprüfungen erfolgreich durchlaufen wurden.
Ein Canary liefert den größten Nutzen, wenn er dieselben Build-Dateien, dieselbe Java-Version, dasselbe Runner-Image und dieselben gemeinsam genutzten Bibliotheken wie die reguläre Pipeline verwendet. Eine erfolgreiche Anwendungstestsuite mit der bisherigen Abhängigkeit ist kein Nachweis dafür, dass die neue Abhängigkeit kompatibel ist.
7. Nachgelagerte Nutzer schützen
Interne Testframeworks können aus einer kleinen Upstream-Änderung eine umfangreichere Migration machen. Wenn eine gemeinsam genutzte Methode derzeit Guava Function zurückgibt, müssen ihre Nutzer vor einer Änderung der Signatur identifiziert werden.
Entscheiden Sie für jede öffentliche Typgrenze, ob Sie:
- eine koordinierte Version mit einem Breaking Change veröffentlichen;
- eine neue Methode mit einem JDK-Typ ergänzen und die bisherige Methode für einen klar definierten Übergangszeitraum als deprecated markieren;
- den Selenium-spezifischen Typ
ExpectedConditionim Vertrag beibehalten; - alle kontrollierten Nutzer innerhalb desselben Änderungszeitraums aktualisieren.
Die richtige Entscheidung hängt von den Verantwortlichkeiten und der Release-Richtlinie ab. Aus QA-Sicht ist entscheidend, den Vertrag mit den Nutzern zu testen und nicht nur das Repository des Frameworks.
8. Forward Fix und Rollback
Die dauerhafte Lösung besteht darin, Selenium-bezogene Abhängigkeiten von der funktionalen Guava-Schnittstelle zu entfernen. Verwenden Sie je nach Zweck der API bevorzugt den JDK-Typ, den Selenium-spezifischen Typ oder die lokale Typinferenz.
Auch der Rollback muss eindeutig definiert sein. Dokumentieren Sie vor dem Upgrade die exakte aktuell bekannte funktionierende Selenium-Version. Falls die neue Version ein ungelöstes Problem verursacht, stellen Sie diese exakte Version und die dazu passenden Quellcodeänderungen wieder her. Führen Sie anschließend den sauberen Build und die Smoke-Tests erneut aus. Verwenden Sie keinen offenen Versionsbereich als Sicherheitsmechanismus, da dadurch ohne bewusste Prüfung ein neueres Artefakt ausgewählt werden kann.
Ein Rollback ist eine vorübergehende Maßnahme zur Risikokontrolle und kein Ersatz für den Abschluss der Migration.
9. Checkliste vor dem Merge
- Alle Selenium-bezogenen Referenzen auf Guava
Functionwurden erfasst. - Öffentliche und private Typgrenzen wurden getrennt klassifiziert.
- Für das Upgrade wird ein offiziell veröffentlichtes Artefakt verwendet.
- Produktions-, Test-, Fixture- und Helper-Source-Sets werden fehlerfrei kompiliert.
- Repräsentative nachgelagerte Nutzer wurden überprüft.
- Erfolgs- und Fehlerpfade benutzerdefinierter Waits wurden getestet.
- Die Auflösung von Abhängigkeiten wurde vor und nach dem Upgrade verglichen.
- Die Browser-Smoke-Tests und der erforderliche Umfang der Regressionstests wurden erfolgreich ausgeführt.
- Die CI-Nachweise werden zusammen mit dem Pull Request aufbewahrt.
- Die exakte Rollback-Version und die verantwortliche Person sind dokumentiert.
- Das Review folgt der regulären Freigaberichtlinie des Teams.
10. Fünf Fragen für Reviewer
- Welche Codepfade verbinden
ExpectedConditionweiterhin mit GuavaFunction? - Haben wir die öffentlichen Nutzer getestet oder nur das Repository, das den Wrapper bereitstellt?
- Kompiliert der CI-Job jedes Source-Set, das Selenium-Hilfsklassen enthalten kann?
- Welche Laufzeittests decken den während der Typmigration geänderten Code ab?
- Können wir die exakte bekannte funktionierende Abhängigkeit wiederherstellen und den Rollback in einem kontrollierten Lauf verifizieren?
11. Wo Automatisierung hilft
Statische Suchen machen die anfängliche Bestandsaufnahme wiederholbar. Abhängigkeitsberichte zeigen transitive Änderungen auf. Die Kompilierung in der CI erkennt deterministische Inkompatibilitäten, während Contract-Tests fehlerhafte Verträge mit Nutzern sichtbar machen. Anschließende Browser-Smoke-Tests prüfen das Verhalten der refaktorierten Wait-Hilfsklassen.
Automatisierung kann nicht entscheiden, ob eine Änderung an einer öffentlichen API akzeptabel ist, mit welchen Nutzern sie abgestimmt werden muss oder ob die gesammelten Nachweise für das Release ausreichen. Diese Entscheidungen erfordern weiterhin ein menschliches Review.
Fazit
Die geplante Änderung an ExpectedCondition in Selenium 4.51 ist eng begrenzt, verdeutlicht jedoch eine allgemeinere QA-Erkenntnis: Bei Dependency-Upgrades müssen öffentliche Typgrenzen und nicht nur Laufzeitszenarien getestet werden. Ein präzises Inventar, ein kontrollierter Upgrade-Branch, mehrstufige CI-Nachweise und ein exakt definiertes Rollback-Ziel ermöglichen es Teams, die Kopplung zu beseitigen, bevor sie die Auslieferung blockiert.
Kommentar hinterlassen
Teilen Sie Ihre Gedanken zum Artikel. Kein Konto erforderlich.
Kommentare
Kommentare werden geladen…