Compare commits

..

No commits in common. "7e625b232e8fa0228268e0022e207de8416340c3" and "60972e57820638cf0773bf21eb14b61b06da9ea9" have entirely different histories.

6 changed files with 16 additions and 209 deletions

View file

@ -12,7 +12,7 @@ jobs:
runs-on: node runs-on: node
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v2
- name: Use Node.js - name: Use Node.js
uses: actions/setup-node@v1 uses: actions/setup-node@v1
with: with:

View file

@ -12,7 +12,7 @@ jobs:
runs-on: node runs-on: node
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v2
- name: Use Node.js - name: Use Node.js
uses: actions/setup-node@v1 uses: actions/setup-node@v1
with: with:

View file

@ -14,7 +14,7 @@ jobs:
runs-on: node runs-on: node
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v2
- name: Use Node.js - name: Use Node.js
uses: actions/setup-node@v1 uses: actions/setup-node@v1
with: with:

8
package-lock.json generated
View file

@ -17,7 +17,7 @@
"emoji-regex": "^10.0.0", "emoji-regex": "^10.0.0",
"jest": "^29.0.0", "jest": "^29.0.0",
"jest-mock-extended": "^3.0.0", "jest-mock-extended": "^3.0.0",
"minimatch": "9.0.4", "minimatch": "9.0.3",
"mysql": "^2.18.1", "mysql": "^2.18.1",
"random-bunny": "^2.1.6", "random-bunny": "^2.1.6",
"ts-jest": "^29.0.0", "ts-jest": "^29.0.0",
@ -5968,9 +5968,9 @@
} }
}, },
"node_modules/minimatch": { "node_modules/minimatch": {
"version": "9.0.4", "version": "9.0.3",
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
"integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
"dependencies": { "dependencies": {
"brace-expansion": "^2.0.1" "brace-expansion": "^2.0.1"
}, },

View file

@ -35,7 +35,7 @@
"emoji-regex": "^10.0.0", "emoji-regex": "^10.0.0",
"jest": "^29.0.0", "jest": "^29.0.0",
"jest-mock-extended": "^3.0.0", "jest-mock-extended": "^3.0.0",
"minimatch": "9.0.4", "minimatch": "9.0.3",
"mysql": "^2.18.1", "mysql": "^2.18.1",
"random-bunny": "^2.1.6", "random-bunny": "^2.1.6",
"ts-jest": "^29.0.0", "ts-jest": "^29.0.0",

View file

@ -1,216 +1,23 @@
import { ChatInputCommandInteraction, PermissionsBitField, SlashCommandBuilder, SlashCommandNumberOption, TextChannel } from "discord.js";
import Command from "../../src/commands/clear";
beforeEach(() => { beforeEach(() => {
process.env = {}; process.env = {};
}); });
describe('Constructor', () => { describe('Constructor', () => {
test("EXPECT values to be set", () => { test.todo("EXPECT values to be set");
const command = new Command();
expect(command.CommandBuilder).toBeDefined();
const commandBuilder = command.CommandBuilder as SlashCommandBuilder;
expect(commandBuilder.name).toBe("clear");
expect(commandBuilder.description).toBe("Clears the channel of messages");
expect(commandBuilder.default_member_permissions).toBe(PermissionsBitField.Flags.ManageMessages.toString());
expect(commandBuilder.options.length).toBe(1);
const commandBuilderCountOption = commandBuilder.options[0] as SlashCommandNumberOption;
expect(commandBuilderCountOption.name).toBe("count");
expect(commandBuilderCountOption.description).toBe("The amount to delete");
expect(commandBuilderCountOption.required).toBe(true);
expect(commandBuilderCountOption.min_value).toBe(1);
expect(commandBuilderCountOption.max_value).toBe(100);
});
}); });
describe('Execute', () => { describe('Execute', () => {
test("GIVEN input is valid, EXPECT messages to be cleared", async () => { test.todo("GIVEN input is valid, EXPECT messages to be cleared");
// Arrange
const channel = {
manageable: true,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = { test.todo("GIVEN interaction is NOT a chat input command, EXPECT nothing to happen");
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(50),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act test.todo("GIVEN interaction.channel is null, EXPECT nothing to happen");
const command = new Command();
await command.execute(interaction);
// Assert test.todo("GIVEN totalClear input is NOT supplied, EXPECT invalid error");
expect(interaction.isChatInputCommand).toHaveBeenCalledTimes(1);
expect(interaction.options.getNumber).toHaveBeenCalledTimes(1); test.todo("GIVEN totalClear is less than or equal to 0, EXPECT invalid error");
expect(interaction.options.getNumber).toHaveBeenCalledWith("count");
expect(channel.bulkDelete).toHaveBeenCalledTimes(1); test.todo("GIVEN totalClear is greater than 100, EXPECT invalid error");
expect(channel.bulkDelete).toHaveBeenCalledWith(50);
expect(interaction.reply).toHaveBeenCalledTimes(1); test.todo("GIVEN channel is NOT manageable, EXPECT insufficient permissions error");
expect(interaction.reply).toHaveBeenCalledWith("50 message(s) were removed.");
});
test("GIVEN interaction is NOT a chat input command, EXPECT nothing to happen", async () => {
// Arrange
const channel = {
manageable: true,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(false),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(50),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).not.toHaveBeenCalled();
expect(channel.bulkDelete).not.toHaveBeenCalled();
});
test("GIVEN interaction.channel is null, EXPECT nothing to happen", async () => {
// Arrange
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: null,
options: {
getNumber: jest.fn().mockReturnValue(50),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).not.toHaveBeenCalled();
});
test("GIVEN totalClear input is NOT supplied, EXPECT invalid error", async () => {
// Arrange
const channel = {
manageable: true,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(null),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Please specify an amount between 1 and 100.");
expect(channel.bulkDelete).not.toHaveBeenCalled();
});
test("GIVEN totalClear is less than or equal to 0, EXPECT invalid error", async () => {
// Arrange
const channel = {
manageable: true,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(0),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Please specify an amount between 1 and 100.");
expect(channel.bulkDelete).not.toHaveBeenCalled();
});
test("GIVEN totalClear is greater than 100, EXPECT invalid error", async () => {
// Arrange
const channel = {
manageable: true,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(101),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Please specify an amount between 1 and 100.");
expect(channel.bulkDelete).not.toHaveBeenCalled();
});
test("GIVEN channel is NOT manageable, EXPECT insufficient permissions error", async () => {
// Arrange
const channel = {
manageable: false,
bulkDelete: jest.fn(),
} as unknown as TextChannel;
const interaction = {
isChatInputCommand: jest.fn().mockReturnValue(true),
channel: channel,
options: {
getNumber: jest.fn().mockReturnValue(50),
},
reply: jest.fn(),
} as unknown as ChatInputCommandInteraction;
// Act
const command = new Command();
await command.execute(interaction);
// Assert
expect(interaction.reply).toHaveBeenCalledTimes(1);
expect(interaction.reply).toHaveBeenCalledWith("Insufficient permissions. Please contact a moderator.");
expect(channel.bulkDelete).not.toHaveBeenCalled();
});
}); });