* Change rules.txt to rules.json (#31) * Migrate to yarn * Add role configs to config template * Install packges and setup typescript * Migrate entry point * Migrate about command * Migrate ban command * Migrate clear command * Migrate kick command * Migrate mute command * Migrate poll command * Migrate bunny command * Update required roles checker * Migrate role command * Migrate unmute command * Migrate warn command * Migrate eval command * Migrate help command * Migrate rules command * Migrate events to typescript * Update about command to use the PublicEmbed class * Update ErrorMessage to ChannelNotFound * Update messageDelete event to ignore bots * Feature/74 merge vylbot core (#80) * Merge VylBot-Core * Update commands to new system * Fix issue where events would not load * 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> * Update rules with blog website and event spoilers rule" (#106) Signed-off-by: Ethan Lane <ethan@vylpes.com> * Containerise bot (#107) * Add moderator names to audit reason (#108) * Feature/48 database (#114) * Add database and default values * Add ability to save a setting to the database * Get commands and events to use database * Setup and config command * Update commands to check roles per server * Different rules per server Signed-off-by: Ethan Lane <ethan@vylpes.com> * Different prefix per server Signed-off-by: Ethan Lane <ethan@vylpes.com> * Add verification system Signed-off-by: Ethan Lane <ethan@vylpes.com> * Disabled commands per server * Add devmode for default prefix * Update embeds * Fix broken tests * Feature/66 add different commands per server (#122) * Add ability for server exclusive commands * Add MankBot server-exclusive commands * Add lobby entity to database * Add documentation * Add setup command for lobby (#123) * Update bot to discord.js v13 (#125) * Update bot to discord.js v13 * Remove debug code * 110 commandshelp about command errors which causes command to not run (#126) * Change onMessage to onMessageCreate * Fix help command * Add override for bot owner and server owner (#135) * Change help command so exclusive commands can only be seen for the server they're assigned to (#136) * Change parsing to not crash if invalid (#142) * 137 role command cannot read properties of undefined (#141) * Fix issue with bot crashing * Fix server prefix not showing * Add easy way to configure role command * Move help text to its own directory * Make role config command to use role id * Get lobby command to use IDs instead of names (#144) Co-authored-by: Vylpes <getgravitysoftware@gmail.com>
485 lines
14 KiB
TypeScript
485 lines
14 KiB
TypeScript
import { GuildMember, Message, TextChannel, User } from "discord.js";
|
|
import Warn from "../../src/commands/warn";
|
|
import { ICommandContext } from "../../src/contracts/ICommandContext";
|
|
|
|
beforeEach(() => {
|
|
process.env = {};
|
|
});
|
|
|
|
describe('Constructor', () => {
|
|
test('Expect values to be set', () => {
|
|
process.env.ROLES_MODERATOR = 'Moderator';
|
|
|
|
const warn = new Warn();
|
|
|
|
expect(warn._category).toBe('Moderation');
|
|
expect(warn._roles.length).toBe(1);
|
|
expect(warn._roles[0]).toBe('Moderator');
|
|
});
|
|
});
|
|
|
|
describe('Execute', () => {
|
|
test('Given user has permission, expect user to be warnned', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedUser = {
|
|
displayAvatarURL: jest.fn(),
|
|
tag: 'USERTAG'
|
|
} as unknown as User;
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(mentionedUser);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(mentionedMember);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: true
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
expect(messageChannelSend).toBeCalledTimes(1);
|
|
expect(logChannel.send).toBeCalledTimes(1);
|
|
});
|
|
|
|
test('Given user has permissions, expect embeds to be correct', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedUser = {
|
|
displayAvatarURL: jest.fn(),
|
|
tag: 'USERTAG'
|
|
} as unknown as User;
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(mentionedUser);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(mentionedMember);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: true
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
expect(result.embeds.length).toBe(2);
|
|
|
|
const logEmbed = result.embeds[0];
|
|
const publicEmbed = result.embeds[1];
|
|
|
|
expect(logEmbed.title).toBe('Member Warned');
|
|
expect(publicEmbed.title).toBe("");
|
|
expect(publicEmbed.description).toBe('[object Object] has been warned');
|
|
expect(logEmbed.fields.length).toBe(3);
|
|
expect(publicEmbed.fields.length).toBe(1);
|
|
expect(publicEmbed.fields[0].name).toBe('Reason');
|
|
expect(publicEmbed.fields[0].value).toBe('Test Reason');
|
|
});
|
|
|
|
test('Given user has permission, expect logEmbed fields to be correct', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedUser = {
|
|
displayAvatarURL: jest.fn().mockReturnValue('URL'),
|
|
tag: 'USERTAG'
|
|
} as unknown as User;
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(mentionedUser);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(mentionedMember);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: true
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
const logEmbed = result.embeds[0];
|
|
|
|
const fieldUser = logEmbed.fields[0];
|
|
const fieldModerator = logEmbed.fields[1];
|
|
const fieldReason = logEmbed.fields[2];
|
|
|
|
expect(fieldUser.name).toBe("User");
|
|
expect(fieldUser.value).toBe("[object Object] `USERTAG`");
|
|
expect(logEmbed.thumbnail?.url).toBe("URL");
|
|
|
|
expect(fieldModerator.name).toBe('Moderator');
|
|
expect(fieldModerator.value).toBe('[object Object] `AUTHORTAG`');
|
|
|
|
expect(fieldReason.name).toBe('Reason');
|
|
expect(fieldReason.value).toBe('Test Reason');
|
|
});
|
|
|
|
test('Given user is not mentioned, expect error embed to be sent', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(null);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(mentionedMember);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: true
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
expect(messageChannelSend).toBeCalledTimes(1);
|
|
expect(logChannel.send).not.toBeCalled();
|
|
|
|
expect(result.embeds.length).toBe(1);
|
|
|
|
const embedError = result.embeds[0];
|
|
|
|
expect(embedError.description).toBe('User does not exist');
|
|
});
|
|
|
|
test('Given member is not in server, expect error embed to be sent', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedUser = {
|
|
displayAvatarURL: jest.fn(),
|
|
tag: 'USERTAG'
|
|
} as unknown as User;
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(mentionedUser);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(null);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: true
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
expect(messageChannelSend).toBeCalledTimes(1);
|
|
expect(logChannel.send).not.toBeCalled();
|
|
|
|
expect(result.embeds.length).toBe(1);
|
|
|
|
const embedError = result.embeds[0];
|
|
|
|
expect(embedError.description).toBe('User is not in this server');
|
|
});
|
|
|
|
test('Given guild is unavailable, expect return and do nothing', async () => {
|
|
process.env = {
|
|
ROLES_MODERATOR: 'Moderator',
|
|
CHANNELS_LOGS_MOD: 'mod-logs'
|
|
};
|
|
|
|
const mentionedUser = {
|
|
displayAvatarURL: jest.fn(),
|
|
tag: 'USERTAG'
|
|
} as unknown as User;
|
|
const mentionedMember = {
|
|
warnnable: true,
|
|
warn: jest.fn()
|
|
} as unknown as GuildMember;
|
|
const logChannel = {
|
|
name: 'mod-logs',
|
|
send: jest.fn()
|
|
} as unknown as TextChannel;
|
|
|
|
const messageChannelSend = jest.fn();
|
|
const messageMentionsUsersFirst = jest.fn()
|
|
.mockReturnValue(mentionedUser);
|
|
const messageGuildMember = jest.fn()
|
|
.mockReturnValue(mentionedMember);
|
|
const messageGuildChannelsCacheFind = jest.fn()
|
|
.mockImplementation((callback): TextChannel | undefined => {
|
|
const result = callback(logChannel);
|
|
|
|
if (!result) {
|
|
return undefined;
|
|
}
|
|
|
|
return logChannel;
|
|
});
|
|
|
|
const message = {
|
|
channel: {
|
|
send: messageChannelSend
|
|
},
|
|
mentions: {
|
|
users: {
|
|
first: messageMentionsUsersFirst
|
|
}
|
|
},
|
|
guild: {
|
|
member: messageGuildMember ,
|
|
channels: {
|
|
cache: {
|
|
find: messageGuildChannelsCacheFind
|
|
}
|
|
},
|
|
available: false
|
|
},
|
|
author: {
|
|
tag: 'AUTHORTAG'
|
|
}
|
|
} as unknown as Message;
|
|
|
|
const context: ICommandContext = {
|
|
name: 'warn',
|
|
args: ['warn', 'Test', 'Reason'],
|
|
message: message
|
|
};
|
|
|
|
const warn = new Warn();
|
|
|
|
const result = await warn.execute(context);
|
|
|
|
expect(messageChannelSend).not.toBeCalled();
|
|
expect(logChannel.send).not.toBeCalled();
|
|
expect(result.embeds.length).toBe(0);
|
|
});
|
|
}); |