write tests

Author: devksingh4

src/api/functions/entraId.ts

@@ -180,7 +180,7 @@ export async function resolveEmailToOid(
   };
 
   if (!data.value || data.value.length === 0) {
-    throw new Error(`No user found with email: ${email}`);
+    throw new EntraFetchError({ message: "No user found with email", email });
   }
 
   return data.value[0].id;

src/api/functions/membership.ts

@@ -0,0 +1,18 @@
+import { FastifyBaseLogger, FastifyInstance } from "fastify";
+
+export async function checkPaidMembership(
+  endpoint: string,
+  log: FastifyBaseLogger,
+  netId: string,
+) {
+  const membershipApiPayload = (await (
+    await fetch(`${endpoint}?netId=${netId}`)
+  ).json()) as { netId: string; isPaidMember: boolean };
+  log.trace(`Got Membership API Payload for ${netId}: ${membershipApiPayload}`);
+  try {
+    return membershipApiPayload["isPaidMember"];
+  } catch (e: any) {
+    log.error(`Failed to get response from membership API: ${e.toString()}`);
+    throw e;
+  }
+}

src/api/routes/mobileWallet.ts

@@ -1,13 +1,15 @@
 import { FastifyPluginAsync } from "fastify";
 import { issueAppleWalletMembershipCard } from "../functions/mobileWallet.js";
 import {
+  EntraFetchError,
   UnauthenticatedError,
   UnauthorizedError,
   ValidationError,
 } from "../../common/errors/index.js";
-import { generateMembershipEmailCommand } from "api/functions/ses.js";
+import { generateMembershipEmailCommand } from "../functions/ses.js";
 import { z } from "zod";
-import { getEntraIdToken, getUserProfile } from "api/functions/entraId.js";
+import { getEntraIdToken, getUserProfile } from "../functions/entraId.js";
+import { checkPaidMembership } from "../functions/membership.js";
 
 const mobileWalletRoute: FastifyPluginAsync = async (fastify, _options) => {
   fastify.get<{ Querystring: { email: string } }>(
@@ -41,32 +43,26 @@ const mobileWalletRoute: FastifyPluginAsync = async (fastify, _options) => {
           message: "Email query parameter is not a valid email",
         });
       }
-
-      const membershipApiPayload = (await (
-        await fetch(
-          `${fastify.environmentConfig.MembershipApiEndpoint}?netId=${request.query.email.replace("@illinois.edu", "")}`,
-        )
-      ).json()) as { netId: string; isPaidMember: boolean };
-      try {
-        if (!membershipApiPayload["isPaidMember"]) {
-          throw new UnauthorizedError({
-            message: "User is not a paid member.",
-          });
-        }
-      } catch (e: any) {
-        request.log.error(
-          `Failed to get response from membership API: ${e.toString()}`,
-        );
-        throw e;
+      const isPaidMember = await checkPaidMembership(
+        fastify.environmentConfig.MembershipApiEndpoint,
+        request.log,
+        request.query.email.replace("@illinois.edu", ""),
+      );
+      if (!isPaidMember) {
+        throw new UnauthenticatedError({
+          message: `${request.query.email} is not a paid member.`,
+        });
       }
       const entraIdToken = await getEntraIdToken(
         fastify,
         fastify.environmentConfig.AadValidClientId,
       );
+
       const userProfile = await getUserProfile(
         entraIdToken,
         request.query.email,
       );
+
       const item = await issueAppleWalletMembershipCard(
         fastify,
         request,

tests/unit/mobileWallet.test.ts

@@ -0,0 +1,102 @@
+import { afterAll, expect, test, beforeEach, vi } from "vitest";
+import { SendRawEmailCommand, SESClient } from "@aws-sdk/client-ses";
+import { mockClient } from "aws-sdk-client-mock";
+import { secretObject } from "./secret.testdata.js";
+import init from "../../src/api/index.js";
+import { describe } from "node:test";
+import { EntraFetchError } from "../../src/common/errors/index.js";
+
+const sesMock = mockClient(SESClient);
+const jwt_secret = secretObject["jwt_key"];
+vi.stubEnv("JwtSigningKey", jwt_secret);
+
+vi.mock("fs", () => {
+  return {
+    ...vi.importActual("fs"),
+    promises: {
+      readFile: vi.fn(() => {
+        return "";
+      }),
+    },
+  };
+});
+
+vi.mock("../../src/api/functions/membership.js", () => {
+  return {
+    ...vi.importActual("../../src/api/functions/membership.js"),
+    checkPaidMembership: vi.fn(
+      (_endpoint: string, _log: any, netId: string) => {
+        if (netId === "valid") {
+          return true;
+        }
+        return false;
+      },
+    ),
+  };
+});
+
+vi.mock("../../src/api/functions/entraId.js", () => {
+  return {
+    ...vi.importActual("../../src/api/functions/entraId.js"),
+    getEntraIdToken: vi.fn().mockImplementation(async () => {
+      return "atokenofalltime";
+    }),
+    getUserProfile: vi
+      .fn()
+      .mockImplementation(async (_token: string, email: string) => {
+        if (email === "[email protected]") {
+          return { displayName: "John Doe" };
+        }
+        throw new EntraFetchError({
+          message: "User not found",
+          email,
+        });
+      }),
+    resolveEmailToOid: vi.fn().mockImplementation(async () => {
+      return "12345";
+    }),
+  };
+});
+
+const app = await init();
+describe("Mobile wallet pass issuance", async () => {
+  test("Test that passes will not be issued for non-emails", async () => {
+    const response = await app.inject({
+      method: "GET",
+      url: "/api/v1/mobileWallet/membership?email=notanemail",
+    });
+    expect(response.statusCode).toBe(400);
+    await response.json();
+  });
+  test("Test that passes will not be issued for non-members", async () => {
+    const response = await app.inject({
+      method: "GET",
+      url: "/api/v1/mobileWallet/[email protected]",
+    });
+    expect(response.statusCode).toBe(403);
+    await response.json();
+  });
+  test("Test that passes will be issued for members", async () => {
+    sesMock.on(SendRawEmailCommand).resolves({});
+    const response = await app.inject({
+      method: "GET",
+      url: "/api/v1/mobileWallet/[email protected]",
+    });
+    expect(response.statusCode).toBe(202);
+  });
+  test("Test that SES errors result in a server error", async () => {
+    sesMock.on(SendRawEmailCommand).rejects({});
+    const response = await app.inject({
+      method: "GET",
+      url: "/api/v1/mobileWallet/[email protected]",
+    });
+    expect(response.statusCode).toBe(500);
+  });
+  afterAll(async () => {
+    await app.close();
+  });
+  beforeEach(() => {
+    (app as any).nodeCache.flushAll();
+    vi.clearAllMocks();
+  });
+});

tests/unit/secret.testdata.ts

@@ -6,6 +6,9 @@ const secretObject = {
   discord_bot_token: "12345",
   entra_id_private_key: "",
   entra_id_thumbprint: "",
+  acm_passkit_signerCert_base64: "",
+  acm_passkit_signerKey_base64: "",
+  apple_signing_cert_base64: "",
 } as SecretConfig & { jwt_key: string };
 
 const secretJson = JSON.stringify(secretObject);