RabbitLabs/vylbot-app
RabbitLabs/vylbot-app
5
0
Fork 0
Code Issues 90 Pull requests 6 Projects 1 Releases 22 Packages Wiki Activity Actions

Compare commits

base: RabbitLabs:166bd8011331a4ce210d5a31c313acdb626d5063
Branches Tags
RabbitLabs:main
RabbitLabs:renovate/typescript-5.x-lockfile
RabbitLabs:renovate/np-10.x-lockfile
RabbitLabs:renovate/node-22.x-lockfile
RabbitLabs:renovate/appleboy-ssh-action-1.x
RabbitLabs:feature/300-moon-set
RabbitLabs:develop
RabbitLabs:hotfix/3.2.4
RabbitLabs:renovate/minimatch-10.x
RabbitLabs:v3.2.3
RabbitLabs:v3.2.2
RabbitLabs:v3.2.1
RabbitLabs:v3.2.0
RabbitLabs:v3.1.3
RabbitLabs:v3.1.2
RabbitLabs:v3.1.1
RabbitLabs:v3.1.0
RabbitLabs:v3.0.7
RabbitLabs:v3.0.6
RabbitLabs:v3.0.5
RabbitLabs:v3.1-alpha1
RabbitLabs:v3.0.4
RabbitLabs:v3.0.3
RabbitLabs:v3.0.2
RabbitLabs:v3.0.1
RabbitLabs:v3.0
RabbitLabs:v3.0-rc2
RabbitLabs:v3.0-rc1
RabbitLabs:v3.0-beta2
RabbitLabs:v3.0-beta1
RabbitLabs:v2.1.3
..
compare: RabbitLabs:7e625b232e8fa0228268e0022e207de8416340c3
Branches Tags
RabbitLabs:renovate/typescript-5.x-lockfile
RabbitLabs:renovate/np-10.x-lockfile
RabbitLabs:renovate/node-22.x-lockfile
RabbitLabs:renovate/appleboy-ssh-action-1.x
RabbitLabs:feature/300-moon-set
RabbitLabs:develop
RabbitLabs:hotfix/3.2.4
RabbitLabs:main
RabbitLabs:renovate/minimatch-10.x
RabbitLabs:v3.2.3
RabbitLabs:v3.2.2
RabbitLabs:v3.2.1
RabbitLabs:v3.2.0
RabbitLabs:v3.1.3
RabbitLabs:v3.1.2
RabbitLabs:v3.1.1
RabbitLabs:v3.1.0
RabbitLabs:v3.0.7
RabbitLabs:v3.0.6
RabbitLabs:v3.0.5
RabbitLabs:v3.1-alpha1
RabbitLabs:v3.0.4
RabbitLabs:v3.0.3
RabbitLabs:v3.0.2
RabbitLabs:v3.0.1
RabbitLabs:v3.0
RabbitLabs:v3.0-rc2
RabbitLabs:v3.0-rc1
RabbitLabs:v3.0-beta2
RabbitLabs:v3.0-beta1
RabbitLabs:v2.1.3

No commits in common. "166bd8011331a4ce210d5a31c313acdb626d5063" and "7e625b232e8fa0228268e0022e207de8416340c3" have entirely different histories.
166bd80113 ... 7e625b232e

3 changed files with 15 additions and 393 deletions
Show stats Expand all files Collapse all files

2
src/commands/config.ts
View file

@ -61,7 +61,7 @@ export default class Config extends Command {
]);
if (!server) {
await interaction.reply('Server not setup. Please use the setup command.');
await interaction.reply('Server not setup. Please use the setup command,');
return;
}

254
tests/commands/code.test.ts
View file

@ -1,261 +1,25 @@
import { APIEmbed, APIVersion, ChatInputCommandInteraction, CommandInteraction, SlashCommandBuilder, SlashCommandSubcommandBuilder } from "discord.js";
import Command from "../../src/commands/code";
import StringTools from "../../src/helpers/StringTools";
import SettingsHelper from "../../src/helpers/SettingsHelper";
describe('constructor', () => {
test("EXPECT properties to be set", () => {
const command = new Command();
expect(command.CommandBuilder).toBeDefined();
const commandBuilder = command.CommandBuilder as SlashCommandBuilder;
expect(commandBuilder.name).toBe("code");
expect(commandBuilder.description).toBe("Manage the verification code of the server");
expect(commandBuilder.options.length).toBe(2);
const commandBuilderRandomiseSubcommand = commandBuilder.options[0] as SlashCommandSubcommandBuilder;
expect(commandBuilderRandomiseSubcommand.name).toBe("randomise");
expect(commandBuilderRandomiseSubcommand.description).toBe("Regenerates the verification code for this server");
const commandBuilderEmbedSubcommand = commandBuilder.options[1] as SlashCommandSubcommandBuilder;
expect(commandBuilderEmbedSubcommand.name).toBe("embed");
expect(commandBuilderEmbedSubcommand.description).toBe("Sends the embed with the current code to the current channel");
});
test.todo("EXPECT properties to be set");
});
describe("execute", () => {
test("GIVEN interaction is not a chat input command, EXPECT nothing to happen", async () => {
// Assert
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(false),
reply: jest.fn(),
} as unknown as CommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.reply).not.toHaveBeenCalled();
});
test.todo("GIVEN interaction is not a chat input command, EXPECT nothing to happen");
});
describe("randomise", () => {
test("EXPECT entry code to be randomised", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("randomise"),
},
reply: jest.fn(),
guildId: "guildId",
} as unknown as ChatInputCommandInteraction;
test.todo("EXPECT entry code to be randomised");
StringTools.RandomString = jest.fn().mockReturnValue("12345");
SettingsHelper.SetSetting = jest.fn();
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.options.getSubcommand).toHaveBeenCalledTimes(1);
expect(StringTools.RandomString).toHaveBeenCalledTimes(1);
expect(StringTools.RandomString).toHaveBeenCalledWith(5);
expect(SettingsHelper.SetSetting).toHaveBeenCalledTimes(1);
expect(SettingsHelper.SetSetting).toHaveBeenCalledWith("verification.code", "guildId", "12345");
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Entry code has been set to `12345`");
});
test("GIVEN interaction.guildId is null, EXPECT nothing to happen", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("randomise"),
},
reply: jest.fn(),
guildId: null,
} as unknown as ChatInputCommandInteraction;
StringTools.RandomString = jest.fn().mockReturnValue("12345");
SettingsHelper.SetSetting = jest.fn();
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).not.toHaveBeenCalled();
expect(SettingsHelper.SetSetting).not.toHaveBeenCalled();
expect(StringTools.RandomString).not.toHaveBeenCalled();
});
test.todo("GIVEN interaction.guildId is null, EXPECT nothing to happen");
});
describe("embed", () => {
test("EXPECT embed to be sent", async () => {
let repliedWithEmbed: any;
test.todo("EXPECT embed to be sent");
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("embed"),
},
reply: jest.fn(),
guildId: "guildId",
channel: {
send: jest.fn().mockImplementation((options: any) => {
repliedWithEmbed = options.embeds[0];
}),
},
} as unknown as ChatInputCommandInteraction;
test.todo("GIVEN interaction.guildId is null, EXPECT nothing to happen");
SettingsHelper.GetSetting = jest.fn().mockResolvedValue("12345");
test.todo("GIVEN interaction.channel is null, EXPECT nothing to happen");
// Act
const command = new Command();
await command.execute(interaction);
test.todo("GIVEN verification.code setting is null, EXPECT error");
// Assert
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.options.getSubcommand).toHaveBeenCalledTimes(1);
expect(SettingsHelper.GetSetting).toHaveBeenCalledTimes(1);
expect(SettingsHelper.GetSetting).toHaveBeenCalledWith("verification.code", "guildId");
expect(interaction.channel!.send).toHaveBeenCalledTimes(1);
expect(repliedWithEmbed).toBeDefined();
expect(repliedWithEmbed.data.title).toBe("Entry Code");
expect(repliedWithEmbed.data.description).toBe("12345");
});
test("GIVEN interaction.guildId is null, EXPECT nothing to happen", async () => {
let repliedWithEmbed: any;
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("embed"),
},
reply: jest.fn(),
guildId: null,
channel: {
send: jest.fn().mockImplementation((options: any) => {
repliedWithEmbed = options.embeds[0];
}),
},
} as unknown as ChatInputCommandInteraction;
SettingsHelper.GetSetting = jest.fn().mockResolvedValue("12345");
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.channel!.send).not.toHaveBeenCalled();
expect(SettingsHelper.GetSetting).not.toHaveBeenCalled();
expect(repliedWithEmbed).toBeUndefined();
});
test("GIVEN interaction.channel is null, EXPECT nothing to happen", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("embed"),
},
reply: jest.fn(),
guildId: "guildId",
channel: null,
} as unknown as ChatInputCommandInteraction;
SettingsHelper.GetSetting = jest.fn().mockResolvedValue("12345");
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(SettingsHelper.GetSetting).not.toHaveBeenCalled();
});
test("GIVEN verification.code setting is undefined, EXPECT error", async () => {
let repliedWithEmbed: any;
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("embed"),
},
reply: jest.fn(),
guildId: "guildId",
channel: {
send: jest.fn().mockImplementation((options: any) => {
repliedWithEmbed = options.embeds[0];
}),
},
} as unknown as ChatInputCommandInteraction;
SettingsHelper.GetSetting = jest.fn().mockResolvedValue(undefined);
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("There is no code for this server setup.");
expect(interaction.channel! .send).not.toHaveBeenCalled();
});
test("GIVEN verification.code setting is empty, EXPECT error", async () => {
let repliedWithEmbed: any;
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("embed"),
},
reply: jest.fn(),
guildId: "guildId",
channel: {
send: jest.fn().mockImplementation((options: any) => {
repliedWithEmbed = options.embeds[0];
}),
},
} as unknown as ChatInputCommandInteraction;
SettingsHelper.GetSetting = jest.fn().mockResolvedValue("");
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("There is no code for this server setup.");
expect(interaction.channel!.send).not.toHaveBeenCalled();
});
test.todo("GIVEN verification.code setting is empty, EXPECT error");
});

152
tests/commands/config.test.ts
View file

@ -1,157 +1,15 @@
import { ChatInputCommandInteraction, PermissionsBitField, SlashCommandBuilder, SlashCommandStringOption, SlashCommandSubcommandBuilder } from "discord.js";
import Command from "../../src/commands/config";
import Server from "../../src/database/entities/Server";
describe("constructor", () => {
test("EXPECT properties to be set", () => {
const command = new Command();
expect(command.CommandBuilder).toBeDefined();
const commandBuilder = command.CommandBuilder as SlashCommandBuilder;
expect(commandBuilder.name).toBe("config");
expect(commandBuilder.description).toBe("Configure the current server");
expect(commandBuilder.default_member_permissions).toBe(PermissionsBitField.Flags.Administrator.toString());
expect(commandBuilder.options.length).toBe(4);
const commandBuilderResetSubcommand = commandBuilder.options[0] as SlashCommandSubcommandBuilder;
expect(commandBuilderResetSubcommand.name).toBe("reset");
expect(commandBuilderResetSubcommand.description).toBe("Reset a setting to the default");
expect(commandBuilderResetSubcommand.options.length).toBe(1);
const commandBuilderResetSubcommandKeyOption = commandBuilderResetSubcommand.options[0] as SlashCommandStringOption;
expect(commandBuilderResetSubcommandKeyOption.name).toBe("key");
expect(commandBuilderResetSubcommandKeyOption.description).toBe("The key");
expect(commandBuilderResetSubcommandKeyOption.required).toBe(true);
const commandBuilderGetSubcommand = commandBuilder.options[1] as SlashCommandSubcommandBuilder;
expect(commandBuilderGetSubcommand.name).toBe("get");
expect(commandBuilderGetSubcommand.description).toBe("Gets a setting for the server");
expect(commandBuilderGetSubcommand.options.length).toBe(1);
const commandBuilderGetSubcommandKeyOption = commandBuilderGetSubcommand.options[0] as SlashCommandStringOption;
expect(commandBuilderGetSubcommandKeyOption.name).toBe("key");
expect(commandBuilderGetSubcommandKeyOption.description).toBe("The key");
expect(commandBuilderGetSubcommandKeyOption.required).toBe(true);
const commandBuilderSetSubcommand = commandBuilder.options[2] as SlashCommandSubcommandBuilder;
expect(commandBuilderSetSubcommand.name).toBe("set");
expect(commandBuilderSetSubcommand.description).toBe("Sets a setting to a specified value");
expect(commandBuilderSetSubcommand.options.length).toBe(2);
const commandBuilderSetSubcommandKeyOption = commandBuilderSetSubcommand.options[0] as SlashCommandStringOption;
expect(commandBuilderSetSubcommandKeyOption.name).toBe("key");
expect(commandBuilderSetSubcommandKeyOption.description).toBe("The key");
expect(commandBuilderSetSubcommandKeyOption.required).toBe(true);
const commandBuilderSetSubcommandValueOption = commandBuilderSetSubcommand.options[1] as SlashCommandStringOption;
expect(commandBuilderSetSubcommandValueOption.name).toBe("value");
expect(commandBuilderSetSubcommandValueOption.description).toBe("The value");
expect(commandBuilderSetSubcommandValueOption.required).toBe(true);
const commandBuilderListSubcommand = commandBuilder.options[3] as SlashCommandSubcommandBuilder;
expect(commandBuilderListSubcommand.name).toBe("list");
expect(commandBuilderListSubcommand.description).toBe("Lists all settings");
});
test.todo("EXPECT properties to be set");
});
describe("execute", () => {
test("GIVEN interaction is not a chat input command, EXPECT nothing to happen", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(false),
options: {
getSubcommand: jest.fn(),
},
} as unknown as ChatInputCommandInteraction;
test.todo("GIVEN interaction is not a chat input command, EXPECT nothing to happen");
// Act
const command = new Command();
await command.execute(interaction);
test.todo("GIVEN interaction.guildId is null, EXPECT nothing to happen");
// Assert
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.options.getSubcommand).not.toHaveBeenCalled();
});
test.todo("GIVEN server is not set up in the database, EXPECT error");
test("GIVEN interaction.guildId is null, EXPECT nothing to happen", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn(),
},
guildId: null,
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.options.getSubcommand).not.toHaveBeenCalled();
});
test("GIVEN server is not set up in the database, EXPECT error", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn(),
},
guildId: "guildId",
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
Server.FetchOneById = jest.fn().mockResolvedValue(null);
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(Server.FetchOneById).toHaveBeenCalledTimes(1);
expect(Server.FetchOneById).toHaveBeenCalledWith(Server, "guildId", [ "Settings" ]);
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Server not setup. Please use the setup command.");
expect(interaction.options.getSubcommand).not.toHaveBeenCalled();
});
test("GIVEN subcommand is invalid, EXPECT error", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
options: {
getSubcommand: jest.fn().mockReturnValue("invalid"),
},
guildId: "guildId",
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
Server.FetchOneById = jest.fn().mockResolvedValue({});
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.options.getSubcommand).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Subcommand not found.");
});
test.todo("GIVEN subcommand is invalid, EXPECT error");
});
describe("list", () => {