firebase / firebase/firebase-admin-java

com.google.firebase.auth.UserRecord.CreateRequest doesn't override .equals making it hard to test

Open
#600 4 comments 0 reactions 0 assignees View on GitHub
help wanted needs-triage type: feature request
Dominant language
Java
Stars
620
Forks
305
Avg merge
3h 23m
Merged PRs (30d)
1

Description

### [READ] Step 1: Are you in the right place?

* For issues or feature requests related to __the code in this repository__
file a Github issue.
* If this is a __feature request__ make sure the issue title starts with "FR:".
* For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/)
with the firebase tag.
* For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk)
google group.
* For help troubleshooting your application that does not fall under one
of the above categories, reach out to the personalized
[Firebase support channel](https://firebase.google.com/support/).

### [REQUIRED] Step 2: Describe your environment

* Operating System version: _____
* Firebase SDK version: _____
* Library version: _____
* Firebase Product: _____ (auth, database, storage, etc)

### [REQUIRED] Step 3: Describe the problem

#### Steps to reproduce:

What happened? How can we make the problem occur?
This could be a description, log/console output, etc.

#### Relevant Code:

```
// TODO(you): code here to reproduce the problem
```

I built an application with a function that call `firebaseAuth.createUserAsync(CreateRequest request)`. To test the logic in this function, I created a unit test for it with a mock:
```java
CreateRequest createRequest = // creates some request
UserRecord userRecord = // build a record

FirebaseAuth auth = mock(FirebaseAuth.class);
when(auth.createUserAsync(createRequest)).thenReturn(ApiFutures.immediateFuture(userRecord))
```
but when I ran the test I got a Null Pointer Exception from Mockito. On further inspection, I realized that two instances of CreateRequest with the same payload value return `false` when compared via `.equals`. This leads Mockito to think the function is not defined for this argument.

I am happy to contribute this simple (probably IntelliJ-generated) code, is there a reason you don't want this in there?

Contributor guide

Open the contributing guide

Research direction

Start by locating com.google.firebase.auth.UserRecord.CreateRequest and the createUserAsync(CreateRequest request) entry point. Review the existing authentication tests, then verify that two requests with the same payload compare as expected and that the Mockito-based test no longer receives a null result.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
authentication
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.