adding tests for roles endpoint

Author: bksh05

src/controllers/guildRoleHandler.ts

@@ -39,3 +39,16 @@ export async function addGroupRoleHandler(request: IRequest, env: env) {
     return new JSONResponse(response.BAD_SIGNATURE);
   }
 }
+
+export async function getGuildRolesHandler(request: IRequest, env: env) {
+  // To be implemented
+  return new JSONResponse(response.NOT_FOUND);
+}
+
+export async function getGuildRoleByRoleNameHandler(
+  request: IRequest,
+  env: env
+) {
+  // To be implemented
+  return new JSONResponse(response.NOT_FOUND);
+}

src/index.ts

@@ -9,6 +9,7 @@ import { verifyBot } from "./utils/verifyBot";
 import {
   addGroupRoleHandler,
   createGuildRoleHandler,
+  getGuildRolesHandler,
 } from "./controllers/guildRoleHandler";
 import { getMembersInServerHandler } from "./controllers/getMembersInServer";
 import { changeNickname } from "./controllers/changeNickname";
@@ -28,6 +29,8 @@ router.put("/roles/create", createGuildRoleHandler);
 
 router.put("/roles/add", addGroupRoleHandler);
 
+router.get("/roles", getGuildRolesHandler);
+
 router.get("/discord-members", getMembersInServerHandler);
 
 router.get("/member/:id", getGuildMemberDetailsHandler);

src/typeDefinitions/role.types.d.ts

@@ -0,0 +1,4 @@
+export type GuildRole = {
+  id: string;
+  name: string;
+};

src/utils/guildRole.ts

@@ -6,6 +6,7 @@ import {
   guildRoleResponse,
   memberGroupRole,
 } from "../typeDefinitions/discordMessage.types";
+import { GuildRole } from "../typeDefinitions/role.types";
 
 export async function createGuildRole(
   body: createNewRole,
@@ -55,3 +56,17 @@ export async function addGroupRole(body: memberGroupRole, env: env) {
     return INTERNAL_SERVER_ERROR;
   }
 }
+
+export async function getGuildRoles(env: env): Promise<Array<GuildRole>> {
+  return [];
+}
+
+export async function getGuildRoleByName(
+  roleName: string,
+  env: env
+): Promise<GuildRole> {
+  return {
+    id: "dummy-id",
+    name: "dummy-name",
+  };
+}

tests/fixtures/fixture.ts

@@ -1,3 +1,4 @@
+import { IRequest } from "itty-router";
 import {
   createNewRole,
   discordMessageRequest,
@@ -95,3 +96,19 @@ export const onlyRoleToBeTagged = {
     value: "1118201414078976192",
   },
 };
+
+export const generateDummyRequestObject = ({
+  url,
+  method,
+  params,
+  query,
+  headers, // Object of key value pair
+}: Partial<IRequest>): IRequest => {
+  return {
+    method: method ?? "GET",
+    url: url ?? "/roles",
+    params: params ?? {},
+    query: query ?? {},
+    headers: new Map(Object.entries(headers ?? {})),
+  };
+};

tests/unit/handlers/guildRoleHandler.test.ts

@@ -0,0 +1,119 @@
+import {
+  getGuildRoleByRoleNameHandler,
+  getGuildRolesHandler,
+} from "../../../src/controllers/guildRoleHandler";
+import { GuildRole } from "../../../src/typeDefinitions/role.types";
+import JSONResponse from "../../../src/utils/JsonResponse";
+import { generateDummyRequestObject } from "../../fixtures/fixture";
+import * as responseConstants from "../../../src/constants/responses";
+
+jest.mock("../../../src/utils/verifyAuthToken", () => ({
+  verifyAuthToken: jest.fn().mockReturnValue(true),
+}));
+
+describe.skip("get roles", () => {
+  it("should return a instance of JSONResponse", async () => {
+    const mockRequest = generateDummyRequestObject({ url: "/roles" });
+    const response = await getGuildRolesHandler(mockRequest, {});
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+
+  it("should return Bad Signature object if no auth headers provided", async () => {
+    const mockRequest = generateDummyRequestObject({ url: "/roles" });
+    const response: JSONResponse = await getGuildRolesHandler(mockRequest, {});
+    const jsonResponse: { error: string } = await response.json();
+    expect(response.status).toBe(401);
+    expect(jsonResponse.error).toBe(responseConstants.BAD_SIGNATURE);
+  });
+
+  it("should return empty array if there is no roles in guild", async () => {
+    const mockRequest = generateDummyRequestObject({
+      url: "/roles",
+      headers: { Authorization: "Bearer testtoken" },
+    });
+
+    const response: JSONResponse = await getGuildRolesHandler(mockRequest, {});
+    const jsonRespose: { roles: Array<{ id: string; name: string }> } =
+      await response.json();
+    expect(response.status).toBe(200);
+    expect(Array.isArray(jsonRespose.roles)).toBeTruthy();
+    expect(jsonRespose.roles.length).toBe(0);
+  });
+
+  it("should return array of id and name of roles present in guild", async () => {
+    const expectedResponse = [
+      {
+        id: "role_id_one",
+        name: "role_name_one",
+      },
+      {
+        id: "role_id_two",
+        name: "role_name_two",
+      },
+    ];
+    const mockRequest = generateDummyRequestObject({
+      url: "/roles",
+      headers: { Authorization: "Bearer testtoken" },
+    });
+
+    const response: JSONResponse = await getGuildRolesHandler(mockRequest, {});
+    const jsonRespose: { roles: Array<GuildRole> } = await response.json();
+    expect(response.status).toBe(200);
+    expect(Array.isArray(jsonRespose.roles)).toBeTruthy();
+    expect(jsonRespose.roles).toEqual(expectedResponse);
+  });
+});
+
+describe.skip("get role by role name", () => {
+  it("should return a instance of JSONResponse", async () => {
+    const mockRequest = generateDummyRequestObject({ url: "/roles/everyone" });
+    const response = await getGuildRoleByRoleNameHandler(mockRequest, {});
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+
+  it("should return Bad Signature object if no auth headers provided", async () => {
+    const mockRequest = generateDummyRequestObject({ url: "/roles/everyone" });
+    const response: JSONResponse = await getGuildRoleByRoleNameHandler(
+      mockRequest,
+      {}
+    );
+    const jsonResponse: { error: string } = await response.json();
+    expect(response.status).toBe(401);
+    expect(jsonResponse.error).toBe("🚫 Bad Request Signature");
+  });
+
+  it("should return not found object if there is no roles with given name in guild", async () => {
+    const mockRequest = generateDummyRequestObject({
+      url: "/roles/everyone",
+      headers: { Authorization: "Bearer testtoken" },
+    });
+
+    const response: JSONResponse = await getGuildRoleByRoleNameHandler(
+      mockRequest,
+      {}
+    );
+    const jsonRespose: { error: string } = await response.json();
+    expect(response.status).toBe(404);
+    expect(jsonRespose.error).toBe(responseConstants.NOT_FOUND);
+  });
+
+  it("should return object of id and name corresponding to the role name recieved", async () => {
+    const expectedResponse = {
+      id: "role_id_one",
+      name: "everyone",
+    };
+
+    const mockRequest = generateDummyRequestObject({
+      url: "/roles/everyone",
+      headers: { Authorization: "Bearer testtoken" },
+    });
+
+    const response: JSONResponse = await getGuildRoleByRoleNameHandler(
+      mockRequest,
+      {}
+    );
+    const jsonRespose: { roles: Array<GuildRole> } = await response.json();
+    expect(response.status).toBe(200);
+    expect(jsonRespose).toEqual(expectedResponse);
+  });
+});