Question: Missing equals() and hashCode() implementations

[mdeknowis]

Hello,

we stumbled across the fact none of the DTOs are implementing equals and hashCode (and toString).

Currently we are forced to use org.apache.commons.lang3.builder.ToStringBuilder.reflectionToString(Object) and org.mockito.ArgumentMatchers.refEq(T, String...) etc. to test our code and to generate log output.

So we wonder, if there is a particular reason for that fact?

Regards

[gmessner]

@mdeknowis
For these sorts of classes that are serializing and deserializing JSON toString() methods are not that useful, we provided org.gitlab4j.api.utils.JacksonJson.toJsonString() so you can simply do this:

String s = org.gitlab4j.api.utils.JacksonJson.toJsonString(obj)

For comparison, I suggest you look at how we do it in our unit tests, specifically TestGitLabApiBeans.java
I have been thinking about generalizing the comparison code from this and putting it in JacksonJson, if you believe that is a good idea, let me know.

[mdeknowis]

Thanks for that org.gitlab4j.api.utils.JacksonJson.toJsonString() hint. Currently we try avoid to build if (log.isDebugEnabled()) {...} blocks, so we rely on toString(). Also in our test we want still to use the advantages of AbstractObjectAssert e.g. org.assertj.core.api.AbstractObjectAssert.isEqualToComparingFieldByFieldRecursively(Object), which has more detailed output regarding actual and expected.

[mdeknowis]

The issue is also, that frameworks like Mockito use toString:

Argument(s) are different! Wanted:
org.gitlab4j.api.ProjectApi#0 bean.createProject(
    refEq(org.gitlab4j.api.models.Project@7495699f)
);
-> at my.GitlabProjectServiceTest.testAddProject(GitlabProjectServiceTest.java:202)
Actual invocation has different arguments:
org.gitlab4j.api.ProjectApi#0 bean.createProject(
    org.gitlab4j.api.models.Project@3047254d
);
-> at my.GitlabProjectService.addProject(GitlabProjectService.java:118)

	at my.GitlabProjectServiceTest.testAddProject(GitlabProjectServiceTest.java:202)
...

[mdeknowis]

Also during debugging, it would be more developer friendly:

[gmessner]

I could agree to support toString() implementations as long as they are using JacksonJson, that would be the only way to guarantee that the results will be accurate. This is a simple as adding the following toString() implementation to the model classes:

@Override
public String toString() {
    return (org.gitlab4j.api.utils.JacksonJson.toJsonString(this));
}

[mdeknowis]

Sounds like a good solution for this library.

[gmessner]

@mdeknowis
I've added the toString() implementation to all the necessary model classes. This has been released as 4.9.0. Went ahead and bumped the minor version since this impacted 63 files. Please verify that this meets your needs and close this issue when you have a chance.

[gmessner]

@mdeknowis
I believe your concerns have been met, so am closing this issue. Please feel free to open it back up if needed.