WIP: Start creating buttonEvent moons list tests

3

@@ -0,0 +1,225 @@
+import {ButtonInteraction} from "discord.js";
+import List from "../../../../src/buttonEvents/304276391837302787/moons/list";
+import UserSetting from "../../../../src/database/entities/UserSetting";
+import Moon from "../../../../src/database/entities/304276391837302787/Moon";
+
+describe("GIVEN interaction.guild is null", () => {
+    const interaction = {
+        guild: null,
+        reply: jest.fn(),
+        update: jest.fn(),
+    } as unknown as ButtonInteraction;
+
+    UserSetting.FetchOneByKey = jest.fn();
+
+    beforeAll(async () => {
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
+});
+
+describe("GIVEN userId parameter is undefined", () => {
+    const interaction = {
+        guild: {},
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list",
+    } as unknown as ButtonInteraction;
+
+    UserSetting.FetchOneByKey = jest.fn();
+
+    beforeAll(async () => {
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
+});
+
+describe("GIVEN page parameter is undefined", () => {
+    const interaction = {
+        guild: {},
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list userId",
+    } as unknown as ButtonInteraction;
+
+    UserSetting.FetchOneByKey = jest.fn();
+
+    beforeAll(async () => {
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
+});
+
+describe("GIVEN no moons for the user is returned", () => {
+    const interaction = {
+        guild: {
+            members: {
+                cache: {
+                    find: jest.fn().mockReturnValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+        },
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list userId 0",
+    } as unknown as ButtonInteraction;
+
+    UserSetting.FetchOneByKey = jest.fn();
+    Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+    beforeAll(async () => {
+        await List(interaction);
+    });
+
+    test("EXPECT moons function to be called", () => {
+        expect(Moon.FetchPaginatedMoonsByUserId).toHaveBeenCalledTimes(1);
+    });
+
+    test("EXPECT error replied", () => {
+        expect(interaction.reply).toHaveBeenCalledTimes(1);
+        expect(interaction.reply).toHaveBeenCalledWith("username does not have any moons or page is invalid.");
+    });
+
+    describe("GIVEN member is not in cache", () => {
+        const interaction = {
+            guild: {
+                members: {
+                    cache: {
+                        find: jest.fn().mockReturnValue(undefined),
+                    },
+                    fetch: jest.fn().mockResolvedValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+            reply: jest.fn(),
+            update: jest.fn(),
+            customId: "moons list userId 0",
+        } as unknown as ButtonInteraction;
+
+        UserSetting.FetchOneByKey = jest.fn();
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+        beforeAll(async () => {
+            await List(interaction);
+        });
+
+        test("EXPECT API to be called", () => {
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledTimes(1);
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledWith("userId");
+        });
+
+        test("EXPECT error replied with username", () => {
+            expect(interaction.reply).toHaveBeenCalledTimes(1);
+            expect(interaction.reply).toHaveBeenCalledWith("username does not have any moons or page is invalid.");
+        });
+    });
+
+    describe("GIVEN member can not be found", () => {
+        const interaction = {
+            guild: {
+                members: {
+                    cache: {
+                        find: jest.fn().mockReturnValue(undefined),
+                    },
+                    fetch: jest.fn().mockResolvedValue(undefined),
+                },
+            },
+            reply: jest.fn(),
+            update: jest.fn(),
+            customId: "moons list userId 0",
+        } as unknown as ButtonInteraction;
+
+        UserSetting.FetchOneByKey = jest.fn();
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+        beforeAll(async () => {
+            await List(interaction);
+        });
+
+        test("EXPECT API to be called", () => {
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledTimes(1);
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledWith("userId");
+        });
+
+        test("EXPECT error replied with username", () => {
+            expect(interaction.reply).toHaveBeenCalledTimes(1);
+            expect(interaction.reply).toHaveBeenCalledWith("This user does not have any moons or page is invalid.");
+        });
+    });
+});
+
+describe("GIVEN no moons on current page", () => {
+    const interaction = {
+        guild: {
+            members: {
+                cache: {
+                    find: jest.fn().mockReturnValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+        },
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list userId 0",
+    } as unknown as ButtonInteraction;
+
+    UserSetting.FetchOneByKey = jest.fn();
+    Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+        [],
+        0,
+    ]);
+
+    beforeAll(async () => {
+        await List(interaction);
+    });
+    test.todo("EXPECT description to say so");
+});
+
+describe("GIVEN happy flow", () => {
+    test.todo("EXPECT moons to be fetched");
+
+    test.todo("EXPECT embed to be updated");
+
+    test.todo("EXPECT row to be updated");
+
+    describe("GIVEN it is the first page", () => {
+        test.todo("EXPECT Previous button to be disabled");
+    });
+
+    describe("GIVEN it is the last page", () => {
+        test.todo("EXPECT Next button to be disabled");
+
+        describe("GIVEN there are more moons in the counter than in the database", () => {
+            test.todo("EXPECT untracked counter to be present");
+        });
+    });
+
+    describe("GIVEN no moons on the current page", () => {
+        test.todo("EXPECT Next button to be disabled");
+    });
+});

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

@@ -1,21 +1,213 @@
+import {ButtonInteraction, EmbedBuilder} from "discord.js";
+import List from "../../../../src/buttonEvents/304276391837302787/moons/list";
+import UserSetting from "../../../../src/database/entities/UserSetting";
+import Moon from "../../../../src/database/entities/304276391837302787/Moon";
+
 describe("GIVEN interaction.guild is null", () => {
-    test.todo("EXPECT function to return");
+    const interaction = {
+        guild: null,
+        reply: jest.fn(),
+        update: jest.fn(),
+    } as unknown as ButtonInteraction;
+
+    beforeAll(async () => {
+        UserSetting.FetchOneByKey = jest.fn();
+
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
 });
 
 describe("GIVEN userId parameter is undefined", () => {
-    test.todo("EXPECT function to return");
+    const interaction = {
+        guild: {},
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list",
+    } as unknown as ButtonInteraction;
+
+    beforeAll(async () => {
+        UserSetting.FetchOneByKey = jest.fn();
+
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
 });
 
 describe("GIVEN page parameter is undefined", () => {
-    test.todo("EXPECT function to return");
+    const interaction = {
+        guild: {},
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list userId",
+    } as unknown as ButtonInteraction;
+
+    beforeAll(async () => {
+        UserSetting.FetchOneByKey = jest.fn();
+
+        await List(interaction);
+    });
+
+    test("EXPECT function to return", () => {
+        expect(interaction.reply).not.toHaveBeenCalled();
+        expect(interaction.update).not.toHaveBeenCalled();
+        expect(UserSetting.FetchOneByKey).not.toHaveBeenCalled();
+    });
 });
 
 describe("GIVEN no moons for the user is returned", () => {
-    test.todo("EXPECT error replied");
+    const interaction = {
+        guild: {
+            members: {
+                cache: {
+                    find: jest.fn().mockReturnValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+        },
+        reply: jest.fn(),
+        update: jest.fn(),
+        customId: "moons list userId 0",
+    } as unknown as ButtonInteraction;
+
+    beforeAll(async () => {
+        UserSetting.FetchOneByKey = jest.fn();
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+        await List(interaction);
+    });
+
+    test("EXPECT moons function to be called", () => {
+        expect(Moon.FetchPaginatedMoonsByUserId).toHaveBeenCalledTimes(1);
+    });
+
+    test("EXPECT error replied", () => {
+        expect(interaction.reply).toHaveBeenCalledTimes(1);
+        expect(interaction.reply).toHaveBeenCalledWith("username does not have any moons or page is invalid.");
+    });
+
+    describe("GIVEN member is not in cache", () => {
+        const interaction = {
+            guild: {
+                members: {
+                    cache: {
+                        find: jest.fn().mockReturnValue(undefined),
+                    },
+                    fetch: jest.fn().mockResolvedValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+            reply: jest.fn(),
+            update: jest.fn(),
+            customId: "moons list userId 0",
+        } as unknown as ButtonInteraction;
+
+        beforeAll(async () => {
+            UserSetting.FetchOneByKey = jest.fn();
+            Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+            await List(interaction);
+        });
+
+        test("EXPECT API to be called", () => {
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledTimes(1);
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledWith("userId");
+        });
+
+        test("EXPECT error replied with username", () => {
+            expect(interaction.reply).toHaveBeenCalledTimes(1);
+            expect(interaction.reply).toHaveBeenCalledWith("username does not have any moons or page is invalid.");
+        });
+    });
+
+    describe("GIVEN member can not be found", () => {
+        const interaction = {
+            guild: {
+                members: {
+                    cache: {
+                        find: jest.fn().mockReturnValue(undefined),
+                    },
+                    fetch: jest.fn().mockResolvedValue(undefined),
+                },
+            },
+            reply: jest.fn(),
+            update: jest.fn(),
+            customId: "moons list userId 0",
+        } as unknown as ButtonInteraction;
+
+        beforeAll(async () => {
+            UserSetting.FetchOneByKey = jest.fn();
+            Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue(undefined)
+
+            await List(interaction);
+        });
+
+        test("EXPECT API to be called", () => {
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledTimes(1);
+            expect(interaction.guild?.members.fetch).toHaveBeenCalledWith("userId");
+        });
+
+        test("EXPECT error replied with username", () => {
+            expect(interaction.reply).toHaveBeenCalledTimes(1);
+            expect(interaction.reply).toHaveBeenCalledWith("This user does not have any moons or page is invalid.");
+        });
+    });
 });
 
 describe("GIVEN no moons on current page", () => {
-    test.todo("EXPECT description to say so");
+    let updatedWith: EmbedBuilder[] | undefined;
+
+    const interaction = {
+        guild: {
+            members: {
+                cache: {
+                    find: jest.fn().mockReturnValue({
+                        user: {
+                            username: "username",
+                        },
+                    }),
+                },
+            },
+        },
+        reply: jest.fn(),
+        update: jest.fn((options: any) => {
+            updatedWith = options.embeds;
+        }),
+        customId: "moons list userId 0",
+    } as unknown as ButtonInteraction;
+
+    beforeAll(async () => {
+        UserSetting.FetchOneByKey = jest.fn();
+        Moon.FetchPaginatedMoonsByUserId = jest.fn().mockResolvedValue([
+            [],
+            0,
+        ]);
+
+        await List(interaction);
+    });
+
+    test("EXPECT description to say so", () => {
+        expect(updatedWith).toBeDefined();
+        expect(updatedWith?.length).toBe(1);
+        
+        expect(updatedWith![0].data.description).toBe("*none*");
+    });
 });
 
 describe("GIVEN happy flow", () => {