From e36acf7da0023fece9d1f2fb6683d05e26c5d6e7 Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Sun, 23 Jan 2022 15:48:53 +0000 Subject: [PATCH] Add MemberEvents tests --- .gitignore | 3 +- src/contracts/IEventReturnContext.ts | 6 + src/events/MemberEvents.ts | 19 +++- tests/events/MemberEvents.test.ts | 164 +++++++++++++++++++++++++++ 4 files changed, 188 insertions(+), 4 deletions(-) create mode 100644 src/contracts/IEventReturnContext.ts create mode 100644 tests/events/MemberEvents.test.ts diff --git a/.gitignore b/.gitignore index 83f9014..707ff92 100644 --- a/.gitignore +++ b/.gitignore @@ -103,4 +103,5 @@ dist # TernJS port file .tern-port -config.json \ No newline at end of file +config.json +.DS_Store \ No newline at end of file diff --git a/src/contracts/IEventReturnContext.ts b/src/contracts/IEventReturnContext.ts new file mode 100644 index 0000000..ccbe56d --- /dev/null +++ b/src/contracts/IEventReturnContext.ts @@ -0,0 +1,6 @@ +import { MessageEmbed } from "discord.js"; +import { ICommandContext } from "./ICommandContext"; + +export default interface ICommandReturnContext { + embeds: MessageEmbed[] +} \ No newline at end of file diff --git a/src/events/MemberEvents.ts b/src/events/MemberEvents.ts index 2aada07..5bcda27 100644 --- a/src/events/MemberEvents.ts +++ b/src/events/MemberEvents.ts @@ -2,35 +2,48 @@ import { Event } from "../type/event"; import { GuildMember } from "discord.js"; import EventEmbed from "../helpers/embeds/EventEmbed"; import GuildMemberUpdate from "./MemberEvents/GuildMemberUpdate"; +import IEventReturnContext from "../contracts/IEventReturnContext"; export default class MemberEvents extends Event { constructor() { super(); } - public override guildMemberAdd(member: GuildMember) { + public override guildMemberAdd(member: GuildMember): IEventReturnContext { const embed = new EventEmbed(member.guild, "Member Joined"); embed.AddUser("User", member.user, true); embed.addField("Created", member.user.createdAt); embed.setFooter(`Id: ${member.user.id}`); embed.SendToMemberLogsChannel(); + + return { + embeds: [embed] + }; } - public override guildMemberRemove(member: GuildMember) { + public override guildMemberRemove(member: GuildMember): IEventReturnContext { const embed = new EventEmbed(member.guild, "Member Left"); embed.AddUser("User", member.user, true); embed.addField("Joined", member.joinedAt); embed.setFooter(`Id: ${member.user.id}`); embed.SendToMemberLogsChannel(); + + return { + embeds: [embed] + }; } - public override guildMemberUpdate(oldMember: GuildMember, newMember: GuildMember) { + public override guildMemberUpdate(oldMember: GuildMember, newMember: GuildMember): IEventReturnContext { const handler = new GuildMemberUpdate(oldMember, newMember); if (oldMember.nickname != newMember.nickname) { // Nickname change handler.NicknameChanged(); } + + return { + embeds: [] + }; } } \ No newline at end of file diff --git a/tests/events/MemberEvents.test.ts b/tests/events/MemberEvents.test.ts new file mode 100644 index 0000000..ad16485 --- /dev/null +++ b/tests/events/MemberEvents.test.ts @@ -0,0 +1,164 @@ +import { GuildMember, TextChannel, User } from "discord.js"; +import MemberEvents from "../../src/events/MemberEvents"; +import GuildMemberUpdate from "../../src/events/MemberEvents/GuildMemberUpdate"; + +describe('GuildMemberAdd', () => { + test('When event is fired, expect embed to be sent to logs channel', () => { + const currentDate = new Date(); + + const textChannel = { + send: jest.fn() + } as unknown as TextChannel; + + const memberGuildChannelsCacheFind = jest.fn() + .mockReturnValue(textChannel); + const userDisplayAvatarURL = jest.fn(); + + const guildUser = { + tag: 'USERTAG', + createdAt: currentDate, + id: 'USERID', + displayAvatarURL: userDisplayAvatarURL + } as unknown as User; + + const guildMember = { + user: guildUser, + guild: { + channels: { + cache: { + find: memberGuildChannelsCacheFind + } + } + } + } as unknown as GuildMember; + + const memberEvents = new MemberEvents(); + + const result = memberEvents.guildMemberAdd(guildMember); + + expect(textChannel.send).toBeCalledTimes(1); + expect(userDisplayAvatarURL).toBeCalledTimes(1); + expect(result.embeds.length).toBe(1); + + // Embed + const embed = result.embeds[0]; + + expect(embed.title).toBe("Member Joined"); + expect(embed.footer?.text).toBe("Id: USERID"); + expect(embed.fields.length).toBe(2); + + // Embed -> User Field + const embedFieldUser = embed.fields[0]; + + expect(embedFieldUser.name).toBe("User"); + expect(embedFieldUser.value).toBe("[object Object] `USERTAG`"); + expect(embedFieldUser.inline).toBeTruthy(); + + // Embed -> Created Field + const embedFieldCreated = embed.fields[1]; + + expect(embedFieldCreated.name).toBe("Created"); + expect(embedFieldCreated.value).toBe(currentDate.toString()); + }); +}); + +describe('GuildMemberRemove', () => { + test('When event is fired, expect embed to be sent to logs channel', () => { + const currentDate = new Date(); + + const textChannel = { + send: jest.fn() + } as unknown as TextChannel; + + const memberGuildChannelsCacheFind = jest.fn() + .mockReturnValue(textChannel); + const userDisplayAvatarURL = jest.fn(); + + const guildUser = { + tag: 'USERTAG', + createdAt: currentDate, + id: 'USERID', + displayAvatarURL: userDisplayAvatarURL + } as unknown as User; + + const guildMember = { + user: guildUser, + guild: { + channels: { + cache: { + find: memberGuildChannelsCacheFind + } + } + }, + joinedAt: currentDate + } as unknown as GuildMember; + + const memberEvents = new MemberEvents(); + + const result = memberEvents.guildMemberRemove(guildMember); + + expect(textChannel.send).toBeCalledTimes(1); + expect(userDisplayAvatarURL).toBeCalledTimes(1); + expect(result.embeds.length).toBe(1); + + // Embed + const embed = result.embeds[0]; + + expect(embed.title).toBe("Member Left"); + expect(embed.footer?.text).toBe("Id: USERID"); + expect(embed.fields.length).toBe(2); + + // Embed -> User Field + const embedFieldUser = embed.fields[0]; + + expect(embedFieldUser.name).toBe("User"); + expect(embedFieldUser.value).toBe("[object Object] `USERTAG`"); + expect(embedFieldUser.inline).toBeTruthy(); + + // Embed -> Joined Field + const embedFieldJoined = embed.fields[1]; + + expect(embedFieldJoined.name).toBe("Joined"); + expect(embedFieldJoined.value).toBe(currentDate.toString()); + }); +}); + +describe('GuildMemberUpdate', () => { + test('Given nicknames are the same, expect NicknameChanged NOT to be called', () => { + const member = { + nickname: 'member' + } as unknown as GuildMember; + + const nicknameChanged = jest.fn(); + + GuildMemberUpdate.prototype.NicknameChanged = nicknameChanged; + + const memberEvents = new MemberEvents(); + + const result = memberEvents.guildMemberUpdate(member, member); + + expect(result.embeds.length).toBe(0); + expect(nicknameChanged).not.toBeCalled(); + }); + + test('Given nicknames are the different, expect NicknameChanged to be called', () => { + const oldMember = { + nickname: 'oldMember' + } as unknown as GuildMember; + + const newMember = { + nickname: 'newMember' + } as unknown as GuildMember; + + const nicknameChanged = jest.fn(); + + GuildMemberUpdate.prototype.NicknameChanged = nicknameChanged; + + const memberEvents = new MemberEvents(); + + const result = memberEvents.guildMemberUpdate(oldMember, newMember); + + expect(result.embeds.length).toBe(0); + expect(nicknameChanged).toBeCalledTimes(1); + }); +}); \ No newline at end of file