Replace Mockito mocked EmailSender in tests #2547
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As part of investigating removing the mocking from the tests (for #2534), this switches from using a `mock(EmailSender)` to creating a bean under test which tracks the calls made to it in a simple list. If the `replace.mailjet.factory` property is set in a test then the standard `MailJetFactory` is replaced by our factory. This generates EmailSender instances (for HTML and TEXT) which track the calls to their methods in a list of strings. We can also remove the `setEmailSender` methods which we had to use to force the mock bean into the running services. I believe this has uncovered a bug in the Guild Service whereby too many emails are being sent. (see `com.objectcomputing.checkins.services.guild.GuildControllerTest#testEmailSentToGuildLeadWhenGuildMembersAdded`) I would have expected a single email, but we are sending 2... 🤔
timyates
commented
Jul 12, 2024
Comment on lines
+101
to
110
| assertEquals(2, emailSender.events.size()); | ||
| assertEquals( | ||
| List.of( | ||
| // Email to the Guild lead | ||
| List.of("SEND_EMAIL", "null", "null", "Membership changes have been made to the Ninja guild", "<h3>Bill Charles has joined the Ninja guild.</h3><a href=\"https://checkins.objectcomputing.com/guilds\">Click here</a> to view the changes in the Check-Ins app.", memberProfile.getWorkEmail() + "," + memberProfile2.getWorkEmail()), | ||
| // Email to both the Guild leads | ||
| List.of("SEND_EMAIL", "null", "null", "Membership Changes have been made to the Ninja guild", "<h3>Changes have been made to the Ninja guild.</h3><h4>The following members have been added:</h4><ul><li>Bill Charles</li></ul><a href=\"https://checkins.objectcomputing.com/guilds\">Click here</a> to view the changes in the Check-Ins app.", memberProfile.getWorkEmail() + "," + memberProfile2.getWorkEmail()) | ||
| ), | ||
| emailSender.events | ||
| ); |
There was a problem hiding this comment.
I believe this is a bug and we may be sending too many emails
There was a problem hiding this comment.
potential PR to fix is in #2551
If that gets merged, we need to remove one of the Lists in this assert (and reduce the size assertion to 1)
timyates
commented
Jul 12, 2024
Comment on lines
+135
to
141
| assertEquals(2, emailSender.events.size()); | ||
| assertEquals(List.of( | ||
| List.of("SEND_EMAIL", "null", "null", "Membership Changes have been made to the Ninja guild", "<h3>Bill Charles has left the Ninja guild.</h3><a href=\"https://checkins.objectcomputing.com/guilds\">Click here</a> to view the changes in the Check-Ins app.", memberProfile.getWorkEmail()), | ||
| List.of("SEND_EMAIL", "null", "null", "Membership Changes have been made to the Ninja guild", "<h3>Changes have been made to the Ninja guild.</h3><h4>The following members have been removed:</h4><ul><li>Bill Charles</li></ul><a href=\"https://checkins.objectcomputing.com/guilds\">Click here</a> to view the changes in the Check-Ins app.", memberProfile.getWorkEmail()) | ||
| ), | ||
| emailSender.events | ||
| ); |
There was a problem hiding this comment.
And here... I believe this is too many emails being sent 🤔
There was a problem hiding this comment.
potential PR to fix is in #2551
If that gets merged, we need to remove one of the Lists in this assert (and reduce the size assertion to 1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of investigating removing the mocking from the tests (for #2534), this switches from using a
mock(EmailSender)to creating a bean under test which tracks the calls made to it in a simple list.If the
replace.mailjet.factoryproperty is set in a test then the standardMailJetFactoryis replaced by our factory.This generates EmailSender instances (for HTML and TEXT) which track the calls to their methods in a list of strings.
We can also remove the
setEmailSendermethods which we had to use to force the mock bean into the running services.I believe this has uncovered a bug in the Guild Service whereby too many emails are being sent. (see
com.objectcomputing.checkins.services.guild.GuildControllerTest#testEmailSentToGuildLeadWhenGuildMembersAdded) I would have expected a single email, but we are sending 2... 🤔