Feature/12 create tests (#102)

* Fix tests

* Update coverage

* Remove unrequired mock files

* Add about command test

* Update about tests

* Ban command tests

* eval command tests

* Start help command tests

* Add help command tests

* Add kick command tests

* Mute command tests

* Poll command tests

* Add role command tests

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Add rules command tests

* Add unmute command tests

* Add warn command tests

* Add MemberEvents tests

* Add GuildMemberUpdate tests

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Add MessageEvents tests

* Add StringTools test

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Add embed tests

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Add GitHub Actions

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Move to tslint

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Remove tslint

Signed-off-by: Ethan Lane <ethan@vylpes.com>

* Remove linting script

Signed-off-by: Ethan Lane <ethan@vylpes.com>

tests/helpers/StringTools.test.ts

@@ -0,0 +1,11 @@
+import StringTools from "../../src/helpers/StringTools";
+
+describe('Capitalise', () => {
+    test('Expect sentence to be captilised', () => {
+        const inputString = 'the big brown fox jumps over the lazy dog';
+
+        const result = StringTools.Capitalise(inputString);
+
+        expect(result).toBe('The Big Brown Fox Jumps Over The Lazy Dog');
+    });
+});

tests/helpers/embeds/ErrorEmbed.test.ts

@@ -0,0 +1,57 @@
+import { Message } from "discord.js";
+import { ICommandContext } from "../../../src/contracts/ICommandContext";
+import ErrorEmbed from "../../../src/helpers/embeds/ErrorEmbed";
+
+beforeEach(() => {
+    process.env = {};
+});
+
+describe('Constructor', () => {
+    test('Expect properties to be set', () => {
+        process.env = {
+            EMBED_COLOUR_ERROR: '0xd52803'
+        }
+
+        const message = {} as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new ErrorEmbed(context, 'Error Message');
+
+        expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
+        expect(errorEmbed.description).toBe('Error Message');
+        expect(errorEmbed.context).toBe(context);
+    });
+});
+
+describe('SendToCurrentChannel', () => {
+    test('Expect embed to be sent to the current channel in context', () => {
+        process.env = {
+            EMBED_COLOUR_ERROR: '0xd52803'
+        }
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new ErrorEmbed(context, 'Error Message');
+
+        errorEmbed.SendToCurrentChannel();
+
+        expect(messageChannelSend).toBeCalledWith(errorEmbed);
+    });
+});

tests/helpers/embeds/EventEmbed.test.ts

@@ -0,0 +1,222 @@
+import { Guild, Message, TextChannel, User } from "discord.js";
+import { ICommandContext } from "../../../src/contracts/ICommandContext";
+import EventEmbed from "../../../src/helpers/embeds/EventEmbed";
+
+beforeEach(() => {
+    process.env = {};
+    jest.resetAllMocks();
+});
+
+describe('Constructor', () => {
+    test('Expect properties to be set', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const guild = {} as unknown as Guild;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+
+        expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
+        expect(errorEmbed.title).toBe('Event Message');
+        expect(errorEmbed.guild).toBe(guild);
+    });
+});
+
+describe('AddUser', () => {
+    test('Given setThumbnail is false, add field WITHOUT user thumbnail', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const addField = jest.fn();
+        const setThumbnail = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const user = {
+            tag: 'USERTAG'
+        } as unknown as User;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+
+        errorEmbed.addField = addField;
+        errorEmbed.setThumbnail = setThumbnail;
+
+        errorEmbed.AddUser('User', user);
+
+        expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
+        expect(setThumbnail).not.toBeCalled();
+    });
+
+    test('Given setThumbnail is true, add field WITH user thumbnail', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const addField = jest.fn();
+        const setThumbnail = jest.fn();
+        const displayAvatarURL = jest.fn()
+            .mockReturnValue('image0.png');
+
+        const guild = {} as unknown as Guild;
+
+        const user = {
+            tag: 'USERTAG',
+            displayAvatarURL: displayAvatarURL
+        } as unknown as User;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+
+        errorEmbed.addField = addField;
+        errorEmbed.setThumbnail = setThumbnail;
+
+        errorEmbed.AddUser('User', user, true);
+
+        expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
+        expect(setThumbnail).toBeCalledWith('image0.png');
+        expect(displayAvatarURL).toBeCalled();
+    });
+});
+
+describe('SendToChannel', () => {
+    test('Given channel can be found, expect embed to be sent to that channel', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const channelSend = jest.fn();
+
+        const channel = {
+            send: channelSend
+        } as unknown as TextChannel;
+
+        const guildChannelsCacheFind = jest.fn()
+            .mockReturnValue(channel);
+
+        const guild = {
+            channels: {
+                cache: {
+                    find: guildChannelsCacheFind
+                }
+            }
+        } as unknown as Guild;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+
+        errorEmbed.SendToChannel('channel-name');
+
+        expect(guildChannelsCacheFind).toBeCalledTimes(1);
+        expect(channelSend).toBeCalledWith(errorEmbed);
+    });
+
+    test('Given channel can NOT be found, expect error logged', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const guildChannelsCacheFind = jest.fn()
+            .mockReturnValue(null);
+
+        const guild = {
+            channels: {
+                cache: {
+                    find: guildChannelsCacheFind
+                }
+            }
+        } as unknown as Guild;
+
+        console.error = jest.fn();
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+
+        errorEmbed.SendToChannel('channel-name');
+
+        expect(guildChannelsCacheFind).toBeCalledTimes(1);
+        expect(console.error).toBeCalledWith('Unable to find channel channel-name');
+    });
+});
+
+describe('SendToMessageLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MESSAGE as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToMessageLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('message-logs');
+    });
+});
+
+describe('SendToMemberLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MEMBER as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToMemberLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('member-logs');
+    });
+});
+
+describe('SendToModLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MOD as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const errorEmbed = new EventEmbed(guild, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToModLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('mod-logs');
+    });
+});

tests/helpers/embeds/LogEmbed.test.ts

@@ -0,0 +1,331 @@
+import { Guild, Message, TextChannel, User } from "discord.js";
+import { ICommandContext } from "../../../src/contracts/ICommandContext";
+import LogEmbed from "../../../src/helpers/embeds/LogEmbed";
+
+beforeEach(() => {
+    process.env = {};
+    jest.resetAllMocks();
+});
+
+describe('Constructor', () => {
+    test('Expect properties to be set', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Log Message');
+
+        expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
+        expect(errorEmbed.title).toBe('Log Message');
+        expect(errorEmbed.context).toBe(context);
+    });
+});
+
+describe('AddUser', () => {
+    test('Given setThumbnail is false, add field WITHOUT user thumbnail', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const addField = jest.fn();
+        const setThumbnail = jest.fn();
+
+        const user = {
+            tag: 'USERTAG'
+        } as unknown as User;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            },
+            author: user
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+
+        errorEmbed.addField = addField;
+        errorEmbed.setThumbnail = setThumbnail;
+
+        errorEmbed.AddUser('User', user);
+
+        expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
+        expect(setThumbnail).not.toBeCalled();
+    });
+
+    test('Given setThumbnail is true, add field WITH user thumbnail', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const addField = jest.fn();
+        const setThumbnail = jest.fn();
+        const displayAvatarURL = jest.fn()
+            .mockReturnValue('image0.png');
+
+        const user = {
+            tag: 'USERTAG',
+            displayAvatarURL: displayAvatarURL
+        } as unknown as User;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            },
+            author: user
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+
+        errorEmbed.addField = addField;
+        errorEmbed.setThumbnail = setThumbnail;
+
+        errorEmbed.AddUser('User', user, true);
+
+        expect(addField).toBeCalledWith('User', '[object Object] `USERTAG`', true);
+        expect(setThumbnail).toBeCalledWith('image0.png');
+        expect(displayAvatarURL).toBeCalled();
+    });
+});
+
+describe('SendToChannel', () => {
+    test('Given channel can be found, expect embed to be sent to that channel', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const channelSend = jest.fn();
+
+        const channel = {
+            send: channelSend
+        } as unknown as TextChannel;
+
+        const guildChannelsCacheFind = jest.fn()
+            .mockReturnValue(channel);
+
+        const guild = {
+            channels: {
+                cache: {
+                    find: guildChannelsCacheFind
+                }
+            }
+        } as unknown as Guild;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            },
+            guild: guild
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+
+        errorEmbed.SendToChannel('channel-name');
+
+        expect(guildChannelsCacheFind).toBeCalledTimes(1);
+        expect(channelSend).toBeCalledWith(errorEmbed);
+    });
+
+    test('Given channel can NOT be found, expect error logged', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const guildChannelsCacheFind = jest.fn()
+            .mockReturnValue(null);
+
+        const guild = {
+            channels: {
+                cache: {
+                    find: guildChannelsCacheFind
+                }
+            }
+        } as unknown as Guild;
+
+        console.error = jest.fn();
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            },
+            guild: guild
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+
+        errorEmbed.SendToChannel('channel-name');
+
+        expect(guildChannelsCacheFind).toBeCalledTimes(1);
+    });
+});
+
+describe('SendToMessageLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MESSAGE as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToMessageLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('message-logs');
+    });
+});
+
+describe('SendToMemberLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MEMBER as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToMemberLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('member-logs');
+    });
+});
+
+describe('SendToModLogsChannel', () => {
+    describe('Expect SendToChannel caleld with CHANNELS_LOGS_MOD as parameter', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const sendToChannel = jest.fn();
+
+        const guild = {} as unknown as Guild;
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new LogEmbed(context, 'Event Message');
+        
+        errorEmbed.SendToChannel = sendToChannel;
+        
+        errorEmbed.SendToModLogsChannel();
+
+        expect(sendToChannel).toBeCalledWith('mod-logs');
+    });
+});

tests/helpers/embeds/PublicEmbed.test.ts

@@ -0,0 +1,67 @@
+import { Guild, Message, TextChannel, User } from "discord.js";
+import { ICommandContext } from "../../../src/contracts/ICommandContext";
+import PublicEmbed from "../../../src/helpers/embeds/PublicEmbed";
+
+beforeEach(() => {
+    process.env = {};
+});
+
+describe('Constructor', () => {
+    test('Expect properties to be set', () => {
+        process.env = {
+            EMBED_COLOUR: '0xd52803',
+            CHANNELS_LOGS_MESSAGE: 'message-logs',
+            CHANNELS_LOGS_MEMBER: 'member-logs',
+            CHANNELS_LOGS_MOD: 'mod-logs'
+        }
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new PublicEmbed(context, 'Log Message', 'Log Description');
+
+        expect(errorEmbed.color?.toString()).toBe('13969411'); // 0xd52803 in decimal
+        expect(errorEmbed.title).toBe('Log Message');
+        expect(errorEmbed.description).toBe('Log Description');
+        expect(errorEmbed.context).toBe(context);
+    });
+});
+
+describe('SendToCurrentChannel', () => {
+    test('Expect embed to be sent to the current channel in context', () => {
+        process.env = {
+            EMBED_COLOUR_ERROR: '0xd52803'
+        }
+
+        const messageChannelSend = jest.fn();
+
+        const message = {
+            channel: {
+                send: messageChannelSend
+            }
+        } as unknown as Message;
+
+        const context: ICommandContext = {
+            name: 'command',
+            args: [],
+            message: message
+        };
+
+        const errorEmbed = new PublicEmbed(context, 'Message', 'Description');
+
+        errorEmbed.SendToCurrentChannel();
+
+        expect(messageChannelSend).toBeCalledWith(errorEmbed);
+    });
+});