WIP: Create moons list command tests

package.json

@@ -8,7 +8,7 @@
     "clean": "rm -rf node_modules/ dist/",
     "build": "tsc",
     "start": "node ./dist/vylbot",
-    "test": "jest .",
+    "test": "jest",
     "db:up": "typeorm migration:run -d dist/database/dataSources/appDataSource.js",
     "db:down": "typeorm migration:revert -d dist/database/dataSources/appDataSource.js",
     "db:create": "typeorm migration:create ./src/database/migrations",

src/buttonEvents/304276391837302787/moons.ts

@@ -1,5 +1,5 @@
 import {ButtonInteraction} from "discord.js";
-import {ButtonEvent} from "../type/buttonEvent";
+import {ButtonEvent} from "../../type/buttonEvent";
 import List from "./moons/list";
 
 export default class Moons extends ButtonEvent {

src/buttonEvents/304276391837302787/moons/list.ts

@@ -1,7 +1,7 @@
 import {ActionRowBuilder, ButtonBuilder, ButtonInteraction, ButtonStyle, EmbedBuilder} from "discord.js";
-import Moon from "../../database/entities/304276391837302787/Moon";
+import Moon from "../../../database/entities/304276391837302787/Moon";
-import EmbedColours from "../../constants/EmbedColours";
+import EmbedColours from "../../../constants/EmbedColours";
-import UserSetting from "../../database/entities/UserSetting";
+import UserSetting from "../../../database/entities/UserSetting";
 
 export default async function List(interaction: ButtonInteraction) {
     if (!interaction.guild) return;

src/registry.ts

@@ -42,7 +42,7 @@ import MessageCreate from "./events/MessageEvents/MessageCreate";
 
 // Button Event Imports
 import Verify from "./buttonEvents/verify";
-import MoonsButtonEvent from "./buttonEvents/moons";
+import MoonsButtonEvent from "./buttonEvents/304276391837302787/moons";
 
 export default class Registry {
     public static RegisterCommands() {

tests/buttonEvents/304276391837302787/moons.test.ts

@@ -0,0 +1,3 @@
+describe("GIVEN interaction action is list", () => {
+    test.todo("EXPECT List function to be called");
+});

tests/commands/304276391837302787/moons.test.ts

@@ -0,0 +1,17 @@
+describe("constructor", () => {
+    test.todo("EXPECT CommandBuilder to be defined correctly");
+});
+
+describe("execute", () => {
+    describe("GIVEN interaction is not a chat input command", () => {
+        test.todo("EXPECT nothing to happen");
+    });
+
+    describe("GIVEN interaction subcommand is list", () => {
+        test.todo("EXPECT ListMoons to be called");
+    });
+
+    describe("GIVEN interaction subcommand is add", () => {
+        test.todo("EXPECT AddMoon to be called");
+    });
+});

tests/commands/304276391837302787/moons/__snapshots__/list.test.ts.snap

@@ -0,0 +1,40 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`GIVEN happy flow EXPECT interaction to be replied 1`] = `
+{
+  "components": [
+    {
+      "components": [
+        {
+          "custom_id": "moons list userId -1",
+          "disabled": true,
+          "emoji": undefined,
+          "label": "Previous",
+          "style": 1,
+          "type": 2,
+        },
+        {
+          "custom_id": "moons list userId 01",
+          "disabled": true,
+          "emoji": undefined,
+          "label": "Next",
+          "style": 1,
+          "type": 2,
+        },
+      ],
+      "type": 1,
+    },
+  ],
+  "embeds": [
+    {
+      "color": 3166394,
+      "description": "**1 -** Test Descriptio",
+      "footer": {
+        "icon_url": undefined,
+        "text": "Page 01 of 1 · 0 moons",
+      },
+      "title": "undefined's Moons",
+    },
+  ],
+}
+`;

tests/commands/304276391837302787/moons/list.test.ts

@@ -1,29 +1,249 @@
+import { ActionRowBuilder, APIEmbed, ButtonBuilder, CommandInteraction, EmbedBuilder, InteractionReplyOptions } from "discord.js";
+import List from "../../../../src/commands/304276391837302787/moons/list";
+import Moon from "../../../../src/database/entities/304276391837302787/Moon";
+import UserSetting from "../../../../src/database/entities/UserSetting";
+
+describe("GIVEN happy flow", () => {
+    let repliedWith: InteractionReplyOptions | undefined;
+
+    const interaction = {
+        reply: jest.fn((options) => {
+            repliedWith = options;
+        }),
+        options: {
+            get: jest.fn()
+                .mockReturnValueOnce(undefined) // User
+                .mockReturnValue({
+                    value: "0",
+                }), // Page
+        },
+        user: {
+            id: "userId",
+        }
+    } as unknown as CommandInteraction;
+
+    beforeAll(async () => {
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [
+                {
+                    MoonNumber: 1,
+                    Description: "Test Description",
+                }
+            ],
+            1,
+        ]);
+
+        UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+            Value: "0",
+        });
+
+        await List(interaction);
+    });
+
+    test("EXPECT interaction to be replied", () => {
+        expect(interaction.reply).toHaveBeenCalledTimes(1);
+        expect(repliedWith).toMatchSnapshot();
+    });
+});
+
 describe("GIVEN moons returned is empty", () => {
-    test.todo("EXPECT none description");
+    let repliedWith: InteractionReplyOptions | undefined;
+
+    const interaction = {
+        reply: jest.fn((options) => {
+            repliedWith = options;
+        }),
+        options: {
+            get: jest.fn()
+                .mockReturnValueOnce(undefined) // User
+                .mockReturnValue({
+                    value: "0",
+                }), // Page
+        },
+        user: {
+            id: "userId",
+        }
+    } as unknown as CommandInteraction;
+
+    beforeAll(async () => {
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [],
+            0,
+        ]);
+
+        UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+            Value: "0",
+        });
+
+        await List(interaction);
+    });
+
+    test("EXPECT none description", () => {
+        expect(repliedWith).toBeDefined();
+
+        expect(repliedWith!.embeds).toBeDefined();
+        expect(repliedWith!.embeds!.length).toBe(1);
+
+        const repliedWithEmbed = repliedWith!.embeds![0] as EmbedBuilder;
+
+        expect(repliedWithEmbed.data.description).toBe("*none*");
+    });
 });
 
 describe("GIVEN it is the first page", () => {
-    test.todo("EXPECT Previous button to be disabled");
+    let repliedWith: InteractionReplyOptions | undefined;
+
+    const interaction = {
+        reply: jest.fn((options) => {
+            repliedWith = options;
+        }),
+        options: {
+            get: jest.fn()
+                .mockReturnValueOnce(undefined) // User
+                .mockReturnValue({
+                    value: "0",
+                }), // Page
+        },
+        user: {
+            id: "userId",
+        }
+    } as unknown as CommandInteraction;
+
+    beforeAll(async () => {
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [
+                {
+                    MoonNumber: 1,
+                    Description: "Test Description",
+                }
+            ],
+            1,
+        ]);
+
+        UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+            Value: "0",
+        });
+
+        await List(interaction);
+    });
+
+    test("EXPECT Previous button to be disabled", () => {
+        expect(repliedWith).toBeDefined();
+
+        expect(repliedWith!.components).toBeDefined();
+        expect(repliedWith!.components!.length).toBe(1);
+
+        const repliedWithRow = repliedWith!.components![0] as ActionRowBuilder<ButtonBuilder>;
+
+        expect(repliedWithRow.components[0].data.disabled).toBe(true);
+    });
 });
 
 describe("GIVEN it is the last page", () => {
-    test.todo("EXPECT Next button to be disabled");
+    let repliedWith: InteractionReplyOptions | undefined;
+
+    const interaction = {
+        reply: jest.fn((options) => {
+            repliedWith = options;
+        }),
+        options: {
+            get: jest.fn()
+                .mockReturnValueOnce(undefined) // User
+                .mockReturnValue({
+                    value: "0",
+                }), // Page
+        },
+        user: {
+            id: "userId",
+        }
+    } as unknown as CommandInteraction;
+
+    beforeAll(async () => {
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [
+                {
+                    MoonNumber: 1,
+                    Description: "Test Description",
+                }
+            ],
+            1,
+        ]);
+
+        UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+            Value: "0",
+        });
+
+        await List(interaction);
+    });
+
+    test("EXPECT Next button to be disabled", () => {
+        expect(repliedWith).toBeDefined();
+
+        expect(repliedWith!.components).toBeDefined();
+        expect(repliedWith!.components!.length).toBe(1);
+
+        const repliedWithRow = repliedWith!.components![0] as ActionRowBuilder<ButtonBuilder>;
+
+        expect(repliedWithRow.components[1].data.disabled).toBe(true);
+    });
 
     describe("GIVEN moon count is greater than the amount of moons in the database", () => {
-        test.todo("EXPECT untracked counter to be shown");
+        beforeAll(async () => {
+            UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+                Value: "2",
+            });
+
+            await List(interaction);
+        });
+
+        test("EXPECT untracked counter to be shown", () => {
+            const repliedWithEmbed = repliedWith!.embeds![0] as EmbedBuilder;
+
+            expect(repliedWithEmbed.data.description).toContain("...plus 1 more untracked");
+        });
     });
 });
 
 describe("GIVEN moon count is empty", () => {
-    test.todo("EXPECT Next button to be disabled");
+    let repliedWith: InteractionReplyOptions | undefined;
 
-    describe("GIVEN moon count is greater than the amount of moons in the database", () => {
+    const interaction = {
-        test.todo("EXPECT untracked counter to be shown");
+        reply: jest.fn((options) => {
-    });
+            repliedWith = options;
+        }),
+        options: {
+            get: jest.fn()
+                .mockReturnValueOnce(undefined) // User
+                .mockReturnValue({
+                    value: "0",
+                }), // Page
+        },
+        user: {
+            id: "userId",
+        }
+    } as unknown as CommandInteraction;
+
+    beforeAll(async () => {
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [],
+            0,
+        ]);
+
+        UserSetting.FetchOneByKey = jest.fn().mockResolvedValue({
+            Value: "0",
         });
 
-test.todo("EXPECT interaction to be replied");
+        await List(interaction);
+    });
 
-test.todo("EXPECT embed to be replied");
+    test("EXPECT Next button to be disabled", () => {
+        expect(repliedWith).toBeDefined();
 
-test.todo("EXPECT row to be replied");
+        expect(repliedWith!.components).toBeDefined();
+        expect(repliedWith!.components!.length).toBe(1);
+
+        const repliedWithRow = repliedWith!.components![0] as ActionRowBuilder<ButtonBuilder>;
+
+        expect(repliedWithRow.components[1].data.disabled).toBe(true);
+    });
+});