Add tests for messages

Author: MathyouMB

test/items/factories/itemFactory.ts test/factories/itemFactory.tstest/items/factories/itemFactory.ts renamed to test/factories/itemFactory.ts

@@ -9,7 +9,7 @@ import {
   filterOutStatus,
   filterUpcomingItems,
 } from "@src/items";
-import { itemFactory } from "./factories/itemFactory";
+import { itemFactory } from "../factories/itemFactory";
 
 describe("filterByStatus", () => {
   it("will return items with the given status", () => {

test/items/index.test.ts

@@ -0,0 +1,111 @@
+import { completeTaskReportMessage } from "@src/reminders/messages";
+import { itemFactory } from "../../factories/itemFactory";
+import { Item } from "@src/items";
+
+describe("completeTaskReportMessage", () => {
+  it("will show the default message when there are no urgent or unassigned items", () => {
+    const urgentItems: Item[] = [];
+    const unassignedItems: Item[] = [];
+    const upcomingItems: Item[] = [itemFactory()];
+
+    const result = completeTaskReportMessage({
+      urgentItems,
+      unassignedItems,
+      upcomingItems,
+    });
+
+    expect(result.title).toBe("Biweekly Tasks Reminder ☀️🌱");
+    expect(result.message).toBe("Nothing urgent or unassigned upcoming! 🐀🥂");
+    expect(result.sections).toEqual([
+      {
+        title: "📅 Assigned Items",
+        items: upcomingItems,
+        includeLinks: false,
+      },
+    ]);
+  });
+
+  it("will include the urgent section when there are urgent items", () => {
+    const urgentItems: Item[] = [itemFactory()];
+    const unassignedItems: Item[] = [];
+    const upcomingItems: Item[] = [];
+
+    const result = completeTaskReportMessage({
+      urgentItems,
+      unassignedItems,
+      upcomingItems,
+    });
+
+    expect(result.message).toContain("Check out all upcoming tasks");
+    expect(result.sections).toEqual([
+      {
+        title: "🔥 Urgent & Overdue",
+        items: urgentItems,
+        includeLinks: true,
+      },
+    ]);
+  });
+
+  it("will include the unassigned section when there are unassigned items", () => {
+    const urgentItems: Item[] = [];
+    const unassignedItems: Item[] = [itemFactory()];
+    const upcomingItems: Item[] = [];
+
+    const result = completeTaskReportMessage({
+      urgentItems,
+      unassignedItems,
+      upcomingItems,
+    });
+
+    expect(result.sections).toEqual([
+      {
+        title: "📥  Unassigned Items",
+        items: unassignedItems,
+        includeLinks: false,
+      },
+    ]);
+  });
+
+  it("includes all sections when all item types are present", () => {
+    const urgentItems: Item[] = [itemFactory()];
+    const unassignedItems: Item[] = [itemFactory()];
+    const upcomingItems: Item[] = [itemFactory()];
+
+    const result = completeTaskReportMessage({
+      urgentItems,
+      unassignedItems,
+      upcomingItems,
+    });
+
+    expect(result.sections).toEqual([
+      {
+        title: "🔥 Urgent & Overdue",
+        items: urgentItems,
+        includeLinks: true,
+      },
+      {
+        title: "📅 Assigned Items",
+        items: upcomingItems,
+        includeLinks: false,
+      },
+      {
+        title: "📥  Unassigned Items",
+        items: unassignedItems,
+        includeLinks: false,
+      },
+    ]);
+  });
+
+  it("returns no sections and default message when all item arrays are empty", () => {
+    const result = completeTaskReportMessage({
+      urgentItems: [],
+      unassignedItems: [],
+      upcomingItems: [],
+    });
+
+    expect(result.message).toBe(
+      "Check out all upcoming tasks [here.](https://github.com/orgs/CarletonComputerScienceSociety/projects/18) 🐀🐀",
+    );
+    expect(result.sections).toEqual([]);
+  });
+});

test/reminders/messages/completeTaskReportMessage.test.ts

@@ -0,0 +1,79 @@
+import { describe, expect, it, jest } from "@jest/globals";
+import { simpleTaskReportMessage } from "@src/reminders/messages";
+import { itemFactory } from "../../factories/itemFactory";
+
+// Mock @src/constants and override EMOJIS
+jest.mock("@src/constants", () => ({
+    EMOJIS: ["🧪"],
+}));
+
+describe("simpleTaskReportMessage", () => {
+  it("will return default message when both urgent and unassigned are empty", () => {
+    const result = simpleTaskReportMessage({
+      urgentItems: [],
+      unassignedItems: [],
+    });
+
+    expect(result.title).toBe("Daily Task Reminder 🧪");
+    expect(result.message).toBe("Nothing urgent or unassigned today! 🐀🥂");
+    expect(result.sections).toEqual([]);
+  });
+
+  it("will include urgent section when there are urgent items", () => {
+    const urgent = [itemFactory()];
+
+    const result = simpleTaskReportMessage({
+      urgentItems: urgent,
+      unassignedItems: [],
+    });
+
+    expect(result.message).toContain("Check out all upcoming tasks");
+    expect(result.sections).toEqual([
+      {
+        title: "🔥 Urgent & Overdue",
+        items: urgent,
+        includeLinks: true,
+      },
+    ]);
+  });
+
+  it("will include unassigned section when there are unassigned items", () => {
+    const unassigned = [itemFactory()];
+
+    const result = simpleTaskReportMessage({
+      urgentItems: [],
+      unassignedItems: unassigned,
+    });
+
+    expect(result.sections).toEqual([
+      {
+        title: "📥  Unassigned Items",
+        items: unassigned,
+        includeLinks: false,
+      },
+    ]);
+  });
+
+  it("will include both sections when both item types are present", () => {
+    const urgent = [itemFactory()];
+    const unassigned = [itemFactory()];
+
+    const result = simpleTaskReportMessage({
+      urgentItems: urgent,
+      unassignedItems: unassigned,
+    });
+
+    expect(result.sections).toEqual([
+      {
+        title: "🔥 Urgent & Overdue",
+        items: urgent,
+        includeLinks: true,
+      },
+      {
+        title: "📥  Unassigned Items",
+        items: unassigned,
+        includeLinks: false,
+      },
+    ]);
+  });
+});

test/reminders/messages/simpleTaskReportMessage.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it } from "@jest/globals";
+import { urgentPromotionMessage } from "@src/reminders/messages";
+import { itemFactory } from "../../factories/itemFactory";
+
+describe("urgentPromotionMessage", () => {
+  it("will return message without sections when there are no promotion items", () => {
+    const result = urgentPromotionMessage({ promotionItems: [] });
+
+    expect(result.title).toBe("Urgent Promotional Items Reminder 📬‼️");
+    expect(result.message).toBe(
+      "Check out all upcoming tasks [here.](https://github.com/orgs/CarletonComputerScienceSociety/projects/18) 🦆"
+    );
+    expect(result.sections).toEqual([]);
+  });
+
+  it("will include promotion section when promotion items are present", () => {
+    const promotionItems = [itemFactory(), itemFactory()];
+
+    const result = urgentPromotionMessage({ promotionItems });
+
+    expect(result.sections).toEqual([
+      {
+        title: "🔔 Urgent Promotion Items",
+        items: promotionItems,
+        includeLinks: true,
+      },
+    ]);
+  });
+});