googleapis/google-cloud-java

[java-spanner] test: OptionsTest checks for fixed values being returned from hashCode()

Open

#12.268 geöffnet am 3. Nov. 2020

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.082 Forks)batch import
api: spannergood first issuehelp wantedtype: cleanup

Repository-Metriken

Stars
 (1.763 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 21h) (145 gemergte PRs in 30 T)

Beschreibung

The Options#hashCode() method does not guarantee to return a fixed value that is equal on all JVM's (at least; the documentation does not guarantee it). In reality it does, because the current implementation only uses hash codes that are guaranteed to be equal on all JVM's. The method should either be documented to have this behavior, or these tests should be replaced with tests that assert that the hashCode and equals methods comply with the general contract regarding these methods.

Contributor Guide

Research-Richtung
Untersuche Options.java und OptionsTest.java im java spanner Modul des google cloud java Repositorys. Das Problem schlägt vor, dass das Verhalten der hashCode() Methode entweder dokumentiert oder die Tests aktualisiert werden sollten, um nur den allgemeinen Vertrag zu prüfen. Sieh dir die aktuelle Implementierung an, um festzustellen, ob sie konsistente Hash Codes über JVMs hinweg verwendet. Erwäge, den Test zu aktualisieren, um assertThat(options).isEqualTo(anotherOptions) oder ähnliche Prüfungen zu verwenden, die auf equals basieren, da dies die Standardmethode zum Testen der hashCode Konformität ist. Wenn du dich für die Dokumentation entscheidest, füge eine Notiz im Javadoc der Klasse hinzu, die besagt, dass der Hash Code deterministisch und über JVMs hinweg gleich ist.
Tech Stack
java
Domain
testingbackend
Issue Type
Test
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Understanding of equals/hashCode contractFamiliarity with Java testing
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60