googleapis/google-cloud-java

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

Open

#12,268 opened on Nov 3, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (1,082 forks)batch import
api: spannergood first issuehelp wantedtype: cleanup

Repository metrics

Stars
 (1,763 stars)
PR merge metrics
 (Avg merge 2d 21h) (145 merged PRs in 30d)

Description

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 direction
Examine Options.java and OptionsTest.java in the google cloud java repository's java spanner module. The issue suggests that the hashCode() method's behavior should either be documented or the tests should be updated to only assert the general contract. Look at the current implementation to see if it uses consistent hash codes across JVMs. Consider updating the test to use assertThat(options).isEqualTo(anotherOptions) or similar checks that rely on equals, as that is the standard way to test hashCode compliance. If opting for documentation, add a note in the class Javadoc that the hash code is deterministic and equals across JVMs.
Tech stack
java
Domain
testingbackend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Understanding of equals/hashCode contractFamiliarity with Java testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60