RabbitLabs/vylbot-app
RabbitLabs/vylbot-app
5
0
Fork 0
Code Issues 87 Pull requests Projects 1 Releases 23 Packages Wiki Activity Actions

Add placeholder tests
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
Ethan Lane 2024-02-03 19:29:28 +00:00
parent ea6bac2af1
commit 69ef94dbb5
84 changed files with 993 additions and 7394 deletions
Download patch file Download diff file Expand all files Collapse all files

13
tests/events/MemberEvents/GuildMemberAdd.test.ts Normal file
View file

@ -0,0 +1,13 @@
describe('GuildMemberAdd', () => {
test.todo('EXPECT embed to be logged');
test.todo("GIVEN member.guild is null, EXPECT nothing to happen");
test.todo("GIVEN event.member.add.enabled setting is not found, EXPECT nothing to happen");
test.todo("GIVEN event is not enabled, EXPECT nothing to happen");
test.todo("GIVEN event.member.add.channel setting is not found, EXPECT nothing to happen");
test.todo("GIVEN channel is not found, EXPECT nothing to happen");
});

15
tests/events/MemberEvents/GuildMemberRemove.test.ts Normal file
View file

@ -0,0 +1,15 @@
describe('GuildMemberRemove', () => {
test.todo("EXPECT embed to be logged");
test.todo("GIVEN member.guild is null, EXPECT nothing to happen");
test.todo("GIVEN event.member.remove.enabled setting is not found, EXPECT nothing to happen");
test.todo("GIVEN event is not enabled, EXPECT nothing to happen");
test.todo("GIVEN member.joinedAt is null, EXPECT value to be defaulted");
test.todo("GIVEN event.member.remove.channel setting is not found, EXPECT nothing to happen");
test.todo("GIVEN channel is not found, EXPECT nothing to happen");
});

236
tests/events/MemberEvents/GuildMemberUpdate.test.ts
View file

@ -1,235 +1,5 @@
import { GuildMember, TextChannel } from "discord.js";
import GuildMemberUpdate from "../../../src/events/MemberEvents/GuildMemberUpdate";
describe('GuildMemberUpdate', () => {
test.todo("GIVEN user nickname has changed, EXPECT function to be executed");
beforeEach(() => {
process.env = {};
});
describe('Constructor', () => {
test('Expect properties are set', () => {
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname'
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
expect(guildMemberUpdate.oldMember).toBe(oldMember);
expect(guildMemberUpdate.newMember).toBe(newMember);
});
});
describe('NicknameChanged', () => {
test('Given nickname has changed from one to another, expect embed to be sent with both', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname',
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('Old Nickname');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('New Nickname');
});
test('Given old nickname was null, expect embed to say old nickname was none', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {} as unknown as GuildMember;
const newMember = {
nickname: 'New Nickname',
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('*none*');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('New Nickname');
});
test('Given new nickname was null, expect embed to say new nickname was none', async () => {
process.env = {
CHANNELS_LOGS_MOD: 'mod-logs'
}
const channelSend = jest.fn();
const textChannel = {
name: 'mod-logs',
send: channelSend
} as unknown as TextChannel;
const memberGuildChannelsCacheFind = jest.fn()
.mockReturnValue(textChannel);
const memberUserDisplayAvatarURL = jest.fn();
const oldMember = {
nickname: 'Old Nickname'
} as unknown as GuildMember;
const newMember = {
guild: {
channels: {
cache: {
find: memberGuildChannelsCacheFind
}
}
},
user: {
tag: 'USERTAG',
id: 'USERID',
displayAvatarURL: memberUserDisplayAvatarURL
}
} as unknown as GuildMember;
const guildMemberUpdate = new GuildMemberUpdate(oldMember, newMember);
const result = await guildMemberUpdate.NicknameChanged();
expect(channelSend).toBeCalledTimes(1);
expect(memberGuildChannelsCacheFind).toBeCalledTimes(1);
expect(memberUserDisplayAvatarURL).toBeCalledTimes(1);
expect(result.embeds.length).toBe(1);
// Embed
const embed = result.embeds[0];
expect(embed.title).toBe('Nickname Changed');
expect(embed.footer?.text).toBe('Id: USERID');
expect(embed.fields.length).toBe(3);
// Embed -> User Field
const embedFieldUser = embed.fields[0];
expect(embedFieldUser.name).toBe('User');
expect(embedFieldUser.value).toBe('[object Object] `USERTAG`');
// Embed -> Before Field
const embedFieldBefore = embed.fields[1];
expect(embedFieldBefore.name).toBe('Before');
expect(embedFieldBefore.value).toBe('Old Nickname');
// Embed -> After Field
const embedFieldAfter = embed.fields[2];
expect(embedFieldAfter.name).toBe('After');
expect(embedFieldAfter.value).toBe('*none*');
});
test.todo("GIVEN nickname is the same, EXPECT nothing to happen");
});

15
tests/events/MemberEvents/GuildMemberUpdate/NicknameChanged.test.ts Normal file
View file

@ -0,0 +1,15 @@
describe('NicknameChanged', () => {
test.todo('EXPECT embed to be logged');
test.todo("GIVEN event.member.update.enabled setting is not found, EXPECT nothing to happen");
test.todo("GIVEN event is not enabled, EXPECT nothing to happen");
test.todo("GIVEN oldNickname is null, EXPECT oldNickname to be defaulted");
test.todo("GIVEN newNickname is null, EXPECT newNickname to be defaulted");
test.todo("GIVEN event.member.update.channel setting is not found, EXPECT nothing to happen");
test.todo("GIVEN log channel can not be found, EXPECT nothing to happen");
});