Add happy flow test

tests/commands/timeout.test.ts

@@ -1,8 +1,12 @@
-import { APIEmbed, CommandInteraction, CommandInteractionOption, Embed, EmbedBuilder, Guild, GuildChannel, GuildMember, InteractionReplyOptions, JSONEncodable, SlashCommandBuilder, TextChannel, User } from "discord.js";
+import { APIEmbed, CommandInteraction, CommandInteractionOption, DMChannel, Embed, EmbedBuilder, Guild, GuildChannel, GuildMember, InteractionReplyOptions, JSONEncodable, MessageCreateOptions, SlashCommandBuilder, TextChannel, User } from "discord.js";
 import { mock } from "jest-mock-extended";
 import Timeout from "../../src/commands/timeout";
 import SettingsHelper from "../../src/helpers/SettingsHelper";
 import Audit from "../../src/entity/Audit";
+import EmbedColours from "../../src/constants/EmbedColours";
+import { DeepPartial, EntityTarget } from "typeorm";
+import BaseEntity from "../../src/contracts/BaseEntity";
+import { AuditType } from "../../src/constants/AuditType";
 
 describe('Constructor', () => {
     test('EXPECT CommandBuilder to be configured', () => {
@@ -29,16 +33,32 @@ describe('execute', () => {
             embeds = options.embeds as APIEmbed[];
         });
 
+        let savedAudit: DeepPartial<Audit> | undefined;
+
         const getSetting = jest.spyOn(SettingsHelper, 'GetSetting').mockResolvedValue('mod-logs');
-        const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation();
+        const auditSave = jest.spyOn(Audit.prototype, 'Save').mockImplementation((target: EntityTarget<BaseEntity>, entity: DeepPartial<BaseEntity>): Promise<void> => {
+            savedAudit = entity;
+
+            return Promise.resolve();
+        });
 
         const timeoutFunc = jest.fn();
 
+        let dmChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
+        let logsChannelSentEmbeds: (APIEmbed | JSONEncodable<APIEmbed>)[] | undefined;
+
+        const dmChannel = {
+            send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
+                dmChannelSentEmbeds = options.embeds;
+            }),
+        } as unknown as DMChannel;
+
         const userInput = {
             user: {
                 id: 'userId',
                 tag: 'userTag',
-            } as User,
+                createDM: jest.fn().mockResolvedValue(dmChannel),
+            } as unknown as User,
             member: {
                 manageable: true,
                 timeout: timeoutFunc,
@@ -55,7 +75,9 @@ describe('execute', () => {
 
         const logsChannel = {
             name: 'mod-logs',
-            send: jest.fn(),
+            send: jest.fn().mockImplementation((options: MessageCreateOptions) => {
+                logsChannelSentEmbeds = options.embeds;
+            }),
         } as unknown as TextChannel;
 
         const interaction = {
@@ -65,7 +87,8 @@ describe('execute', () => {
                         find: jest.fn()
                             .mockReturnValue(logsChannel),
                     }
-                }
+                },
+                name: "Test Guild",
             } as unknown as Guild,
             guildId: 'guildId',
             reply: interactionReply,
@@ -102,9 +125,59 @@ describe('execute', () => {
         expect(resultEmbedDMField.name).toBe("DM Sent");
         expect(resultEmbedDMField.value).toBe("true");
 
-        // TODO: DM Embed check
-        // TODO: Log Embed check
-        // TODO: Audit check
+        // EXPECT user to be DM's with embed
+        expect(dmChannel.send).toBeCalled();
+        expect(dmChannelSentEmbeds).toBeDefined();
+        expect(dmChannelSentEmbeds?.length).toBe(1);
+
+        const dmChannelSentEmbed = (dmChannelSentEmbeds![0] as any).data;
+
+        expect(dmChannelSentEmbed.color).toBe(EmbedColours.Ok);
+        expect(dmChannelSentEmbed.description).toBe("You have been timed out in Test Guild");
+        expect(dmChannelSentEmbed.fields?.length).toBe(3);
+
+        expect(dmChannelSentEmbed.fields![0].name).toBe("Reason");
+        expect(dmChannelSentEmbed.fields![0].value).toBe("Test reason");
+
+        expect(dmChannelSentEmbed.fields![1].name).toBe("Length");
+        expect(dmChannelSentEmbed.fields![1].value).toBe("1s");
+
+        expect(dmChannelSentEmbed.fields![2].name).toBe("Until");
+        expect(dmChannelSentEmbed.fields![2].value).toBeDefined();
+
+        // EXPECT log embed to be sent
+        expect(logsChannel.send).toBeCalled();
+        expect(logsChannelSentEmbeds).toBeDefined();
+        expect(logsChannelSentEmbeds?.length).toBe(1);
+
+        const logsChannelSentEmbed = (logsChannelSentEmbeds![0] as any).data;
+
+        expect(logsChannelSentEmbed.color).toBe(EmbedColours.Ok);
+        expect(logsChannelSentEmbed.title).toBe("Member Timed Out");
+        expect(logsChannelSentEmbed.description).toBe("<@userId> `userTag`");
+        expect(logsChannelSentEmbed.fields?.length).toBe(4);
+
+        expect(logsChannelSentEmbed.fields![0].name).toBe("Moderator");
+        expect(logsChannelSentEmbed.fields![0].value).toBe("<@moderatorId>");
+
+        expect(logsChannelSentEmbed.fields![1].name).toBe("Reason");
+        expect(logsChannelSentEmbed.fields![1].value).toBe("Test reason");
+
+        expect(logsChannelSentEmbed.fields![2].name).toBe("Length");
+        expect(logsChannelSentEmbed.fields![2].value).toBe("1s");
+
+        expect(logsChannelSentEmbed.fields![3].name).toBe("Until");
+        expect(logsChannelSentEmbed.fields![3].value).toBeDefined();
+
+        // EXPECT Audit to be saved
+        expect(auditSave).toBeCalled();
+
+        expect(savedAudit).toBeDefined();
+        expect(savedAudit?.UserId).toBe('userId');
+        expect(savedAudit?.AuditType).toBe(AuditType.Timeout);
+        expect(savedAudit?.Reason).toBe("Test reason");
+        expect(savedAudit?.ModeratorId).toBe('moderatorId');
+        expect(savedAudit?.ServerId).toBe('guildId');
     });
 
     // Null checks