From a83de88c9caf10be4c5956bd53b2be5c1253c6fb Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Wed, 19 Jan 2022 18:13:15 +0000 Subject: [PATCH] Poll command tests --- src/commands/poll.ts | 14 +- tests/commands/poll.test.ts | 262 ++++++++++++++++++++++++++++++++++++ 2 files changed, 274 insertions(+), 2 deletions(-) create mode 100644 tests/commands/poll.test.ts diff --git a/src/commands/poll.ts b/src/commands/poll.ts index fb3ea55..c9233be 100644 --- a/src/commands/poll.ts +++ b/src/commands/poll.ts @@ -1,4 +1,5 @@ import { ICommandContext } from "../contracts/ICommandContext"; +import ICommandReturnContext from "../contracts/ICommandReturnContext"; import ErrorEmbed from "../helpers/embeds/ErrorEmbed"; import PublicEmbed from "../helpers/embeds/PublicEmbed"; import { Command } from "../type/command"; @@ -10,14 +11,18 @@ export default class Poll extends Command { super._category = "General"; } - public override async execute(context: ICommandContext) { + public override async execute(context: ICommandContext): Promise { const argsJoined = context.args.join(" "); const argsSplit = argsJoined.split(";"); if (argsSplit.length < 3 || argsSplit.length > 10) { const errorEmbed = new ErrorEmbed(context, "Usage: ;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options"); errorEmbed.SendToCurrentChannel(); - return; + + return { + commandContext: context, + embeds: [errorEmbed] + }; } const title = argsSplit[0]; @@ -53,5 +58,10 @@ export default class Poll extends Command { if (context.message.deletable) { await context.message.delete({ reason: "Poll command" }); } + + return { + commandContext: context, + embeds: [embed] + }; } } \ No newline at end of file diff --git a/tests/commands/poll.test.ts b/tests/commands/poll.test.ts new file mode 100644 index 0000000..4f3727d --- /dev/null +++ b/tests/commands/poll.test.ts @@ -0,0 +1,262 @@ +import { Message, MessageEmbed } from "discord.js"; +import Poll from "../../src/commands/poll"; +import { ICommandContext } from "../../src/contracts/ICommandContext"; + +describe('Constructor', () => { + test('Expect properties to be set', () => { + const poll = new Poll(); + + expect(poll._category).toBe('General'); + }); +}); + +describe('Execute', () => { + test('Given input is valid, expect poll to be generated', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: true + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: ['Test', 'title;', 'one;', 'two'], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).toBeCalledTimes(1); + expect(returnMessageReact).toBeCalledTimes(2); + + expect(result.embeds.length).toBe(1); + + // Embed + const embed = result.embeds[0]; + + expect(embed.title).toBe('Test title'); + expect(embed.description).toBe(':one: one\n:two: two'); + }); + + test('Given message is not deletable by client, expect it not to attempt deletion', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: false + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: ['Test', 'title;', 'one;', 'two'], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).not.toBeCalled(); + expect(returnMessageReact).toBeCalledTimes(2); + + expect(result.embeds.length).toBe(1); + + // Embed + const embed = result.embeds[0]; + + expect(embed.title).toBe('Test title'); + expect(embed.description).toBe(':one: one\n:two: two'); + }); + + test('Given no arguments, expect error embed', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: true + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: [], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).not.toBeCalled(); + expect(returnMessageReact).not.toBeCalled(); + + expect(result.embeds.length).toBe(1); + + // Error Embed + const errorEmbed = result.embeds[0]; + + expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options'); + }); + + test('Given only 1 option, expect error embed', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: true + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: ['Test', 'title;', 'one'], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).not.toBeCalled(); + expect(returnMessageReact).not.toBeCalled(); + + expect(result.embeds.length).toBe(1); + + // Error Embed + const errorEmbed = result.embeds[0]; + + expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options'); + }); + + test('Given 9 options, expect poll to be generated', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: true + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: ['Test', 'title;', 'one;', 'two;', 'three;', 'four;', 'five;', 'six;', 'seven;', 'eight;', 'nine'], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).toBeCalledTimes(1); + expect(returnMessageReact).toBeCalledTimes(9); + + expect(result.embeds.length).toBe(1); + + // Embed + const embed = result.embeds[0]; + + expect(embed.title).toBe('Test title'); + expect(embed.description).toBe(':one: one\n:two: two\n:three: three\n:four: four\n:five: five\n:six: six\n:seven: seven\n:eight: eight\n:nine: nine'); + }); + + test('Given 10 options, expect error embed', async () => { + const returnMessageReact = jest.fn(); + + const returnMessage = { + react: returnMessageReact + } as unknown as Message; + + const messageChannelSend = jest.fn() + .mockReturnValue(returnMessage); + const messageDelete = jest.fn(); + + const message = { + channel: { + send: messageChannelSend + }, + delete: messageDelete, + deletable: true + } as unknown as Message; + + const context: ICommandContext = { + name: 'poll', + args: ['Test', 'title;', 'one;', 'two;', 'three;', 'four;', 'five;', 'six;', 'seven;', 'eight;', 'nine;', 'ten'], + message: message + }; + + const poll = new Poll(); + + const result = await poll.execute(context); + + expect(messageChannelSend).toBeCalledTimes(1); + expect(messageDelete).not.toBeCalled(); + expect(returnMessageReact).not.toBeCalled(); + + expect(result.embeds.length).toBe(1); + + // Error Embed + const errorEmbed = result.embeds[0]; + + expect(errorEmbed.description).toBe('Usage: <title>;<option 1>;<option 2>... (separate options with semicolons), maximum of 9 options'); + }); +}); \ No newline at end of file